Package com.amazonaws.ivs.broadcast

Class BroadcastConfiguration.Mixer

java.lang.Object

com.amazonaws.ivs.broadcast.BroadcastConfiguration.Mixer

Enclosing class:

BroadcastConfiguration

public static class BroadcastConfiguration.Mixer
extends Object

Audio and Video Mixer properties. The canvas size and canvas aspect mode will be the same as the size and aspect mode specified in the Video properties. The mixer renders on-screen and audible elements, called "Slots", to the final mix. You can bind and unbind Audio and Image devices to the mixer. See Mixer.bind and Mixer.unbind.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BroadcastConfiguration.Mixer.Slot	A slot represents an on-screen and audible element that can be transitioned over time and bound and unbound to input devices.

Field Summary

Fields

Modifier and Type	Field	Description
BroadcastConfiguration.Mixer.Slot[]	slots

Method Summary

Modifier and Type	Method	Description
BroadcastConfiguration.Mixer	changing(Builder<BroadcastConfiguration.Mixer> op)
BroadcastConfiguration.AspectMode	getCanvasAspectMode()
void	setCanvasAspectMode(BroadcastConfiguration.AspectMode value)	Sets the canvas aspect mode, which is the default aspect mode used by slots that were not explicitly configured with an aspect mode.
static BroadcastConfiguration.Mixer	with(Builder<BroadcastConfiguration.Mixer> op)

Methods inherited from class java.lang.Object

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

Field Details

slots

public BroadcastConfiguration.Mixer.Slot[] slots

Method Details

getCanvasAspectMode

public BroadcastConfiguration.AspectMode getCanvasAspectMode()

setCanvasAspectMode

public void setCanvasAspectMode(BroadcastConfiguration.AspectMode value)

Sets the canvas aspect mode, which is the default aspect mode used by slots that were not explicitly configured with an aspect mode. Be aware that it is possible for the slot, the device screen containing the preview, and the camera feeding the slot to have different aspect ratios. Different aspect ratios in each of those layers may lead to unexpected results.

Parameters:

value - the desired default AspectMode.

changing

public BroadcastConfiguration.Mixer changing(@NonNull
 Builder<BroadcastConfiguration.Mixer> op)

with

public static BroadcastConfiguration.Mixer with(@NonNull
 Builder<BroadcastConfiguration.Mixer> op)