StageVideoConfiguration.Simulcast

java.lang.Object

com.amazonaws.ivs.broadcast.StageVideoConfiguration.Simulcast

Enclosing class:: StageVideoConfiguration

public static class StageVideoConfiguration.Simulcast extends Object

Simulcast configuration. Currently only enable/disable simulcast is allowed

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

StageVideoConfiguration.Simulcast.Layer
Method Summary

Modifier and Type

Method

Description

List<StageVideoConfiguration.Simulcast.Layer>

getLayers()

boolean

isEnabled()

Whether simulcast is enabled.

void

setEnabled(boolean enable)

void

setLayers(List<StageVideoConfiguration.Simulcast.Layer> layers)

Sets the layers for the publishing video stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- isEnabled
  
  public boolean isEnabled()
  
  Whether simulcast is enabled.
- setEnabled
  
  public void setEnabled(boolean enable)
- getLayers
  
  public List<StageVideoConfiguration.Simulcast.Layer> getLayers()
  
  Returns:
  
  The current layers. By default this is an empty list.
- setLayers
  
  public void setLayers(List<StageVideoConfiguration.Simulcast.Layer> layers)
  
  Sets the layers for the publishing video stream. The number of layers must be 3 or less. Each layer must have different configurations. maxBitrate, size and targetFramerate must be set on each layer. If the provided layers are invalid, the layers will not be set and an IllegalArgumentException will be thrown. If no layers are defined, the default internal layer configurations is used.
  
  Parameters:
  
  layers - the desired layers