Package com.amazonaws.ivs.broadcast

Class SubscribeConfiguration

java.lang.Object

com.amazonaws.ivs.broadcast.SubscribeConfiguration

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

Configuration properties for subscribing

Field Summary

Fields

Modifier and Type	Field	Description
JitterBufferConfiguration	jitterBuffer	Jitter buffer configuration
SubscribeSimulcastConfiguration	simulcast	Subscribe simulcast configuration

Constructor Summary

Constructors

Constructor	Description
SubscribeConfiguration()

Method Summary

Modifier and Type	Method	Description
float	getInitialGain()	The initial gain that will be set on any incoming audio streams.
void	setInitialGain(float initialGain)	Set the initial gain to set on any incoming audio streams.

Methods inherited from class java.lang.Object

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

Field Details

jitterBuffer

public JitterBufferConfiguration jitterBuffer

Jitter buffer configuration

simulcast

public SubscribeSimulcastConfiguration simulcast

Subscribe simulcast configuration

Constructor Details

SubscribeConfiguration

public SubscribeConfiguration()

Method Details

getInitialGain

public float getInitialGain()

The initial gain that will be set on any incoming audio streams. By default this value will be 1.0.

Returns:

The initial gain that will be set on any incoming audio streams.

setInitialGain

public void setInitialGain(float initialGain)

Set the initial gain to set on any incoming audio streams. This can be used to mute streams (by setting a gain of 0) before any audio samples have a chance to be played.

Parameters:

initialGain - the gain (clamped between 0 and 2) to set on any incoming audio streams.