AudioPlaybackStreamBuilder

[wants]
[[wants.service]]
id = "com.amazon.audio.stream"
[[wants.service]]
id = "com.amazon.audio.control"

/*
Returns a promise resolving to an AudioPlaybackStream object and stores it in
playbackStream
*\/
const builder = new AudioPlaybackStreamBuilder();
const playbackStream = builder.buildAsync()
.then((stream) => {return stream;}).catch((error) => console.log(error));

/*
Destroys playbackStream and returns and stores returned AudioStatus type in
status after promise resolves

Assume playbackStream is an AudioPlaybackStream object
*\/

const status = AudioPlaybackStreamBuilder.destroyAsync(playbackStream)
.then((status) => {return status;}).catch((error) => console.log(error));

/*
Resets audio playback builder configuration

Assume builder is a AudioPlaybackStreamBuilder object
*\/

builder.reset();

/*
Sets audio attributes to what is specified in attributes
Any playback stream that is created by calling buildAysnc() will now have these audio
attributes
Assume builder is a AudioPlaybackStreamBuilder object
*\/
const attributes: AudioAttributes = {
    contentType: AudioContentType.CONTENT_TYPE_NONE,
    usage: AudioUsageType.USAGE_NONE,
    flags: AudioFlags.FLAG_NONE
};

builder.setAudioAttributes(attributes);

/*
Sets audio playback configuration to what is specified in config
Any playback stream that is created by calling buildAysnc() will now have this audio
configuration

Assume builder is a AudioPlaybackStreamBuilder object
*\/
const config: AudioConfig = {
    sampleRate: AudioSampleRate.SAMPLE_RATE_8_KHZ,
    channelMask: AudioChannelMask.CHANNEL_STEREO,
    format: AudioSampleFormat.FORMAT_PCM_16_BIT,
};

builder.setAudioConfig(config);

/*
Sets session id to 1

Assume builder is a AudioPlaybackStreamBuilder object
*\/

builder.setAudioFocusSessionId(session.getAudioSessionId());

const createAudioSourceInstance = async () => {
    const builder = new AudioPlaybackStreamBuilder();
    /*Other confingurations
    ...
    ...
    ...*\/
    builder.setDuckingPolicy(StreamDuckingPolicy.EXPLICIT); // Set policy to explicit
    const stream = await builder.buildAsync();
    playbackStream.current = stream;
}

createAudioSourceInstance();

/*
Sets frames per buffer for the builder

Assume builder is a AudioPlaybackStreamBuilder object
*\/const framesPerBuffer = 200;
builder.setFramesPerBuffer(framesPerBuffer);

const createAudioSourceInstance = async () => {
    const builder = new AudioPlaybackStreamBuilder();
    /*Other confingurations
    ...
    ...
    ...*\/
    builder.setUnderrunThreshold(3); // Set threshold to 3
    const stream = await builder.buildAsync();
    playbackStream.current = stream;
}

createAudioSourceInstance();