public abstract class

AudioDevice

extends Device
java.lang.Object
   ↳ com.amazonaws.ivs.broadcast.Device
     ↳ com.amazonaws.ivs.broadcast.AudioDevice
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Audio input sources must conform to this interface

Summary

Nested Classes
enum AudioDevice.Format Audio data representations  
interface AudioDevice.StatsCallback  
Public Constructors
AudioDevice()
Public Methods
abstract int appendBuffer(ByteBuffer buffer, long count, long presentationTimeUs)
Append an audio buffer.
abstract void setGain(Float gain)
Set the input gain
abstract void setStatsCallback(AudioDevice.StatsCallback callback)
Set a callback to receive audio stats for this device.
[Expand]
Inherited Methods
From class com.amazonaws.ivs.broadcast.Device
From class java.lang.Object

Public Constructors

public AudioDevice ()

Public Methods

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

Append an audio buffer. This can only be used with 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

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.

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.