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
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
Modifier and TypeClassDescriptionstatic class
A remote stage stream layer.static class
Constraints on remote stage stream layer.static enum
The reasons for a layer changing.static interface
RemoteStageStream delegate interface to receive callbacks when layers has changedNested classes/interfaces inherited from class com.amazonaws.ivs.broadcast.StageStream
StageStream.Type
-
Method Summary
Modifier and TypeMethodDescriptiongetFirstLayerWithConstraintsOr
(RemoteStageStream.LayerConstraints constraints, RemoteStageStream.Layer defaultValue) Return the first available layer which match the constraints given.Return the layer with the largest combined surface area (width x height).Return the list of layers.Return the list of available layers which match the constraints given.Return the layer with the smallest combined surface area (width x height).Return the most recently selected layer.boolean
Return if dynamic simulcast adaption is enabled.void
setListener
(RemoteStageStream.Listener listener) Set the callback to receive layersMethods inherited from class com.amazonaws.ivs.broadcast.StageStream
getDevice, getMuted, getPreview, getPreviewSurfaceTarget, getPreviewSurfaceView, getPreviewTextureView, getStreamType, requestQualityStats, requestRTCStats, setListener
-
Method Details
-
setListener
Set the callback to receive layers- Parameters:
listener
- aRemoteStageStream.Listener
object
-
getLayers
Return the list of layers.- Returns:
- The list of layers.
-
getSelectedLayer
Return the most recently selected layer.- 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.- 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.- Parameters:
constraints
- The layer constraints.- Returns:
- The layer.
-
getHighestQualityLayer
Return the layer with the largest combined surface area (width x height).- Returns:
- The layer.
-
getLowestQualityLayer
Return the layer with the smallest combined surface area (width x height).- Returns:
- The layer.
-
isAdapting
public boolean isAdapting()Return if dynamic simulcast adaption is enabled.- Returns:
- if dynamic simulcast adaption is enabled.
-