Package com.amazonaws.ivs.broadcast

Class StageAudioConfiguration

java.lang.Object

com.amazonaws.ivs.broadcast.StageAudioConfiguration

public class StageAudioConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
StageAudioConfiguration()

Method Summary

Modifier and Type	Method	Description
void	enableEchoCancellation(boolean enable)	Sets whether echo cancellation should be enabled.
void	enableNoiseSuppression(boolean enable)	Setting this to true will enable noise suppression.
int	getMaxBitrate()
boolean	isEchoCancellationEnabled()
boolean	isNoiseSuppressionEnabled()
void	setMaxBitrate(int maxBitrate)	Sets the maximum bitrate for the publishing audio stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

StageAudioConfiguration

public StageAudioConfiguration()

Method Detail

getMaxBitrate

public int getMaxBitrate()

Returns:

The maximum bitrate for the publishing audio stream. By default this is 64k.

setMaxBitrate

public void setMaxBitrate(int maxBitrate)

Sets the maximum bitrate for the publishing audio stream. This value must be between 12k and 128k. If the provided bitrate falls outside this range, the bitrate will not be set and an IllegalArgumentException will be thrown.

Parameters:

maxBitrate - the desired maximum bitrate

Throws:

java.lang.IllegalArgumentException - if bitrate is not valid

isNoiseSuppressionEnabled

public boolean isNoiseSuppressionEnabled()

Returns:

Whether noise suppression is enabled.

enableNoiseSuppression

public void enableNoiseSuppression(boolean enable)

Setting this to true will enable noise suppression. By default this is true.

Parameters:

enable - whether to enable noise suppression

isEchoCancellationEnabled

public boolean isEchoCancellationEnabled()

Returns:

whether echo cancellation is enabled.

enableEchoCancellation

public void enableEchoCancellation(boolean enable)

Sets whether echo cancellation should be enabled. By default, echo cancellation is enabled.

Parameters:

enable - whether to enable echo cancellation.