Package com.amazonaws.ivs.broadcast

Class MixedAudioDeviceSourceConfiguration

java.lang.Object

com.amazonaws.ivs.broadcast.MixedAudioDeviceSourceConfiguration

public class MixedAudioDeviceSourceConfiguration
extends Object

Configuration for a MixedAudioDeviceSource.

Constructor Summary

Constructors

Constructor	Description
MixedAudioDeviceSourceConfiguration()

Method Summary

Modifier and Type	Method	Description
float	getGain()	Get the gain of the source.
MixedAudioDeviceSourceConfiguration	setGain(float gain)	Sets the gain applied to the output of the associated source.

Methods inherited from class java.lang.Object

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

Constructor Details

MixedAudioDeviceSourceConfiguration

public MixedAudioDeviceSourceConfiguration()

Method Details

getGain

public float getGain()

Get the gain of the source.

Returns:

The gain value.

setGain

@NonNull
public MixedAudioDeviceSourceConfiguration setGain(float gain)
                                            throws BroadcastException

Sets the gain applied to the output of the associated source. This must be between 0 and 2. A gain of 1 means no change. A gain less than 1 will suppress, and greater than 1 will amplify.

Parameters:

gain - The gain applied to the output of the associated source.

Returns:

This configuration object for chaining.

Throws:

BroadcastException - If the gain value is not valid.