public static class

BroadcastConfiguration.Mixer.Slot

extends Object
java.lang.Object
   ↳ com.amazonaws.ivs.broadcast.BroadcastConfiguration.Mixer.Slot

Class Overview

A slot represents an on-screen and audible element that can be transitioned over time and bound and unbound to input devices. See Mixer.bind and Mixer.unbind

Summary

Public Methods
BroadcastConfiguration.Mixer.Slot changing(Builder<BroadcastConfiguration.Mixer.Slot> op)
BroadcastConfiguration.AspectMode getAspect()
BroadcastConfiguration.Vec4 getFillColor()
float getGain()
boolean getMatchCanvasAspectMode()
boolean getMatchCanvasSize()
String getName()
BroadcastConfiguration.Vec2 getPosition()
Device.Descriptor.DeviceType getPreferredAudioInput()
Device.Descriptor.DeviceType getPreferredVideoInput()
BroadcastConfiguration.Vec2 getSize()
float getTransparency()
int getzIndex()
void setAspect(BroadcastConfiguration.AspectMode aspect)
void setFillColor(BroadcastConfiguration.Vec4 fillColor)
Sets the fill color for this mixer in the RGBA format.
void setGain(float gain)
Sets the gain for this mixer.
void setName(String name)
Sets the name for this mixer.
void setPosition(BroadcastConfiguration.Vec2 position)
void setPreferredAudioInput(Device.Descriptor.DeviceType preferredAudioInput)
void setPreferredVideoInput(Device.Descriptor.DeviceType preferredVideoInput)
void setSize(int width, int height)
void setSize(BroadcastConfiguration.Vec2 size)
void setTransparency(float transparency)
Sets the transparency of this mixer.
void setzIndex(int zIndex)
higher values are rendered in front of lower values
static BroadcastConfiguration.Mixer.Slot with(Builder<BroadcastConfiguration.Mixer.Slot> op)
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public BroadcastConfiguration.Mixer.Slot changing (Builder<BroadcastConfiguration.Mixer.Slot> op)

public BroadcastConfiguration.AspectMode getAspect ()

public BroadcastConfiguration.Vec4 getFillColor ()

Returns
  • The fill color of this mixer in the RGBA format

public float getGain ()

public boolean getMatchCanvasAspectMode ()

public boolean getMatchCanvasSize ()

public String getName ()

public BroadcastConfiguration.Vec2 getPosition ()

public Device.Descriptor.DeviceType getPreferredAudioInput ()

public Device.Descriptor.DeviceType getPreferredVideoInput ()

public BroadcastConfiguration.Vec2 getSize ()

public float getTransparency ()

public int getzIndex ()

public void setAspect (BroadcastConfiguration.AspectMode aspect)

public void setFillColor (BroadcastConfiguration.Vec4 fillColor)

Sets the fill color for this mixer in the RGBA format. All 4 values in the RGBA format must be between 0 and 1, otherwise a IllegalArgumentException will be thrown.

Parameters
fillColor A RGBA vector representing a fill color

public void setGain (float gain)

Sets the gain for this mixer. A gain of 1 means no change, a gain less than 1 will suppress, and greater than 1 will amplify. The value must be between 0 and 2 otherwise a IllegalArgumentException will be thrown.

Parameters
gain The desired gain for this filter.

public void setName (String name)

Sets the name for this mixer. The length of the name must be between 1 and 50 characters in length, otherwise a IllegalArgumentException will be thrown.

Parameters
name the desired name for this mixer.

public void setPosition (BroadcastConfiguration.Vec2 position)

public void setPreferredAudioInput (Device.Descriptor.DeviceType preferredAudioInput)

public void setPreferredVideoInput (Device.Descriptor.DeviceType preferredVideoInput)

public void setSize (int width, int height)

public void setSize (BroadcastConfiguration.Vec2 size)

public void setTransparency (float transparency)

Sets the transparency of this mixer. 0 = fully opaque, 1 = fully transparent The value must be between 0 and 1 otherwise a IllegalArgumentException will be thrown.

Parameters
transparency The desired transparency for this mixer.

public void setzIndex (int zIndex)

higher values are rendered in front of lower values

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