Package com.amazonaws.ivs.broadcast

Class AudioDevice

java.lang.Object

com.amazonaws.ivs.broadcast.Device

com.amazonaws.ivs.broadcast.AudioDevice

Direct Known Subclasses:

AudioSource

public abstract class AudioDevice
extends Device

Audio input sources must conform to this interface

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AudioDevice.Format	Audio data representations
static interface	AudioDevice.PCMBufferCallback	Callback interface for receiving the raw PCM audio moving through this device.
static interface	AudioDevice.StatsCallback

Nested classes/interfaces inherited from class com.amazonaws.ivs.broadcast.Device

Device.Descriptor

Constructor Summary

Constructors

Constructor	Description
AudioDevice()

Method Summary

Modifier and Type	Method	Description
abstract int	appendBuffer(ByteBuffer buffer, long count, long presentationTimeUs)	Append an audio buffer.
abstract void	setGain(Float gain)	Set the input gain
abstract void	setOnPCMBufferCallback(AudioDevice.PCMBufferCallback callback)	Set a callback to receive the raw PCM audio buffers as they move through this device.
abstract void	setStatsCallback(AudioDevice.StatsCallback callback)	Set a callback to receive audio stats for this device.

Methods inherited from class com.amazonaws.ivs.broadcast.Device

getDescriptor, getTag, isValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AudioDevice

public AudioDevice()

Method Details

setGain

public abstract void setGain(Float gain)

Set the input gain

Parameters:

gain - Generally between 0 and 1, but values up to 2 are accepted. Any value over 1 amplifies the signal and may cause clipping.

appendBuffer

public abstract int appendBuffer(ByteBuffer buffer,
 long count,
 long presentationTimeUs)

Append an audio buffer. This can only be used with Device.Descriptor.DeviceType.USER_AUDIO

Parameters:

buffer - The buffer of audio data to append. This must be allocated as a Direct ByteBuffer

count - The number of bytes to use

presentationTimeUs - The presentation time, in microseconds

Returns:

The number of samples processed

setStatsCallback

public abstract void setStatsCallback(AudioDevice.StatsCallback callback)

Set a callback to receive audio stats for this device. This will be called on the main thread.

Parameters:

callback - A callback lambda that takes two floats: peak and rms.

setOnPCMBufferCallback

public abstract void setOnPCMBufferCallback(AudioDevice.PCMBufferCallback callback)

Set a callback to receive the raw PCM audio buffers as they move through this device. The callback fires on the audio thread for lowest latency; it must not block. Pass null to clear.

The callback must not call setOnPCMBufferCallback(com.amazonaws.ivs.broadcast.AudioDevice.PCMBufferCallback) re-entrantly, or a deadlock will occur.

Parameters:

callback - A AudioDevice.PCMBufferCallback, or null to clear.