Package com.amazonaws.ivs.broadcast

Class StageAudioManager

java.lang.Object

com.amazonaws.ivs.broadcast.StageAudioManager

@RequiresApi(api=28)
public class StageAudioManager
extends Object

Manages audio settings for all stages.

Note that the first time you use this class (either to create a StageAudioManager object or to access one of its static methods), you must ensure that you are not asynchronously accessing one of the following classes at the same time: Device, DeviceDiscovery, BroadcastSession or Stage. Otherwise there is a risk of deadlock due to loading the underlying native library.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StageAudioManager.ContentType
static enum	StageAudioManager.Source
static enum	StageAudioManager.Usage
static enum	StageAudioManager.UseCasePreset

Method Summary

Modifier and Type	Method	Description
StageAudioManager.ContentType	getContentType()
static StageAudioManager	getInstance(android.content.Context context)	Returns an instance of the StageAudioManager.
StageAudioManager.Source	getSource()
StageAudioManager.Usage	getUsage()
void	setConfiguration(StageAudioManager.Source source, StageAudioManager.ContentType contentType, StageAudioManager.Usage usage)
void	setPreset(StageAudioManager.UseCasePreset preset)

Methods inherited from class java.lang.Object

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

Method Details

setPreset

public void setPreset(@NonNull
 StageAudioManager.UseCasePreset preset)
               throws IllegalStateException

Throws:

IllegalStateException

setConfiguration

public void setConfiguration(@NonNull
 StageAudioManager.Source source,
 @NonNull
 StageAudioManager.ContentType contentType,
 @NonNull
 StageAudioManager.Usage usage)
                      throws IllegalStateException

Throws:

IllegalStateException

getSource

@NonNull
public StageAudioManager.Source getSource()

getContentType

@NonNull
public StageAudioManager.ContentType getContentType()

getUsage

@NonNull
public StageAudioManager.Usage getUsage()

getInstance

public static StageAudioManager getInstance(@NonNull
 android.content.Context context)

Returns an instance of the StageAudioManager.

Parameters:

context - The current application context

Returns:

the instance of the StageAudioManager