Package com.amazonaws.ivs.broadcast

Class RemoteStageStream

java.lang.Object

com.amazonaws.ivs.broadcast.StageStream

com.amazonaws.ivs.broadcast.RemoteStageStream

Direct Known Subclasses:

AudioStageStream, ImageStageStream

@RequiresApi(api=28)
public abstract class RemoteStageStream
extends StageStream

This class represents either remote audio stream or remote video stream, and it is used in Stage.Strategy to guide SDK what layer to subscribe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteStageStream.Layer	A remote stage stream layer.
static class	RemoteStageStream.LayerConstraints	Constraints on remote stage stream layer.
static enum	RemoteStageStream.LayerSelectedReason	The reasons for a layer changing.
static interface	RemoteStageStream.Listener	RemoteStageStream delegate interface to receive callbacks when layers has changed

Nested classes/interfaces inherited from class com.amazonaws.ivs.broadcast.StageStream

StageStream.Type

Method Summary

Modifier and Type	Method	Description
RemoteStageStream.Layer	getFirstLayerWithConstraintsOr(RemoteStageStream.LayerConstraints constraints, RemoteStageStream.Layer defaultValue)	Return the first available layer which match the constraints given.
RemoteStageStream.Layer	getHighestQualityLayer()	Return the layer with the largest combined surface area (width x height).
List<RemoteStageStream.Layer>	getLayers()	Return the list of layers.
List<RemoteStageStream.Layer>	getLayersWithConstraints(RemoteStageStream.LayerConstraints constraints)	Return the list of available layers which match the constraints given.
RemoteStageStream.Layer	getLowestQualityLayer()	Return the layer with the smallest combined surface area (width x height).
RemoteStageStream.Layer	getSelectedLayer()	Return the most recently selected layer.
boolean	isAdapting()	Return if dynamic simulcast adaption is enabled.
void	setListener(RemoteStageStream.Listener listener)	Set the callback to receive layers.

Methods inherited from class com.amazonaws.ivs.broadcast.StageStream

getDevice, getMuted, getPreview, getPreviewSurfaceTarget, getPreviewSurfaceView, getPreviewTextureView, getStreamType, requestQualityStats, requestRTCStats, setListener

Methods inherited from class java.lang.Object

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

Method Details

setListener

public void setListener(RemoteStageStream.Listener listener)

Set the callback to receive layers. Must be called on main thread.

Parameters:

listener - a RemoteStageStream.Listener object

getLayers

public List<RemoteStageStream.Layer> getLayers()

Return the list of layers. Must be called on main thread.

Returns:

The list of layers.

getSelectedLayer

@Nullable
public RemoteStageStream.Layer getSelectedLayer()

Return the most recently selected layer. Must be called on main thread.

Returns:

The most recently selected layer.

getLayersWithConstraints

public List<RemoteStageStream.Layer> getLayersWithConstraints(RemoteStageStream.LayerConstraints constraints)

Return the list of available layers which match the constraints given. Must be called on main thread.

Parameters:

constraints - The layer constraints.

Returns:

The list of layers.

getFirstLayerWithConstraintsOr

public RemoteStageStream.Layer getFirstLayerWithConstraintsOr(RemoteStageStream.LayerConstraints constraints,
 RemoteStageStream.Layer defaultValue)

Return the first available layer which match the constraints given. Must be called on main thread.

Parameters:

constraints - The layer constraints.

Returns:

The layer.

getHighestQualityLayer

public RemoteStageStream.Layer getHighestQualityLayer()

Return the layer with the largest combined surface area (width x height). Must be called on main thread.

Returns:

The layer.

getLowestQualityLayer

public RemoteStageStream.Layer getLowestQualityLayer()

Return the layer with the smallest combined surface area (width x height). Must be called on main thread.

Returns:

The layer.

isAdapting

public boolean isAdapting()

Return if dynamic simulcast adaption is enabled. Must be called on main thread.

Returns:

if dynamic simulcast adaption is enabled.