Package com.amazonaws.ivs.broadcast

Class StageConfiguration

java.lang.Object

com.amazonaws.ivs.broadcast.StageConfiguration

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

Properties for Stage. If the application does not support Stage, use the default properties. They will have no effect outside of Stage use cases.

Field Summary

Fields

Modifier and Type	Field	Description
StageAudioConfiguration	audioConfiguration
BroadcastConfiguration.Mixer	mixer
StageVideoConfiguration	videoConfiguration

Constructor Summary

Constructors

Constructor	Description
StageConfiguration()

Method Summary

Modifier and Type	Method	Description
BroadcastConfiguration.Vec2	getMixerCanvasSize()
void	setMixerCanvasSize(int width, int height)	Sets the frame image size for the video stream.
void	setMixerCanvasSize(BroadcastConfiguration.Vec2 size)

Methods inherited from class java.lang.Object

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

Field Details

videoConfiguration

public StageVideoConfiguration videoConfiguration

audioConfiguration

public StageAudioConfiguration audioConfiguration

mixer

public BroadcastConfiguration.Mixer mixer

Constructor Details

StageConfiguration

public StageConfiguration()

Method Details

getMixerCanvasSize

public BroadcastConfiguration.Vec2 getMixerCanvasSize()

setMixerCanvasSize

public void setMixerCanvasSize(int width,
 int height)

Sets the frame image size for the video stream. The width and height must both be between 160 and 1920, and the maximum total number of pixels is 2,073,600. So the smallest size you can provide is 160x160, and the largest is either 1080x1920 or 1920x1080. However something like 1920x1200 would not be supported. 1280x180 however is supported. If these restrictions are violated a IllegalArgumentException will be thrown.

Parameters:

width - the desired width in pixels

height - the desired height in pixels

setMixerCanvasSize

public void setMixerCanvasSize(BroadcastConfiguration.Vec2 size)