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()
The aspect mode of the mixer slot.
| ||||||||||
| BroadcastConfiguration.Vec4 | getFillColor() | ||||||||||
| float |
getGain()
The gain of the mixer slot
By default this is `1`.
| ||||||||||
| boolean |
getMatchCanvasAspectMode()
Whether or not this mixer slot automatically matches the canvas aspect mode.
| ||||||||||
| boolean |
getMatchCanvasSize()
Whether or not this mixer slot automatically matches the canvas size.
| ||||||||||
| String |
getName()
The name of this mixer slot.
| ||||||||||
| BroadcastConfiguration.Vec2 |
getPosition()
The position of the mixer slot.
| ||||||||||
| Device.Descriptor.DeviceType |
getPreferredAudioInput()
The preferred audio input device for the mixer slot.
| ||||||||||
| Device.Descriptor.DeviceType |
getPreferredVideoInput()
The preferred video input device for the mixer slot.
| ||||||||||
| BroadcastConfiguration.Vec2 |
getSize()
The size for the mixer slot.
| ||||||||||
| float |
getTransparency()
The transparency for the mixer slot.
| ||||||||||
| int |
getzIndex()
The z-index of the mixer slot.
| ||||||||||
| 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.AspectMode getAspect ()
The aspect mode of the mixer slot. By default this is BroadcastConfiguration.AspectMode#Fit.
public BroadcastConfiguration.Vec4 getFillColor ()
Returns
- The fill color of this mixer in the RGBA format By default this is a color with RGBA values of 0. The alpha value will be ignored if Video.enableTransparency is false.
public float getGain ()
The gain of the mixer slot By default this is `1`.
public boolean getMatchCanvasAspectMode ()
Whether or not this mixer slot automatically matches the canvas aspect mode. This defaults to `true` but will be set to `false` automatically if `aspect` is changed. Setting this back to `true` will once again match the canvas aspect mode, but will leave the `aspect` property unchanged, i.e. it will still be the custom value you set it to.
public boolean getMatchCanvasSize ()
Whether or not this mixer slot automatically matches the canvas size. This defaults to `true` but will be set to `false` automatically if `size` is changed. Setting this back to `true` will once again match the canvas size, but will leave the `size` property unchanged, i.e. it will still be the custom value you set it to.
public String getName ()
The name of this mixer slot. By default this is `default`.
public BroadcastConfiguration.Vec2 getPosition ()
The position of the mixer slot. By default this is `0x0`.
public Device.Descriptor.DeviceType getPreferredAudioInput ()
The preferred audio input device for the mixer slot. By default this is Device.Descriptor.DeviceType#Microphone.
public Device.Descriptor.DeviceType getPreferredVideoInput ()
The preferred video input device for the mixer slot. By default this is Device.Descriptor.DeviceType#Camera.
public BroadcastConfiguration.Vec2 getSize ()
The size for the mixer slot. By default this is `720x1280`. However, note that when `matchCanvasSize` is `true`, the slot will use `configuration.video.size` instead.
public float getTransparency ()
The transparency for the mixer slot. 0 = fully opaque, 1 = fully transparent. By default this is `0`. This value will be ignored if Video.enableTransparency is false.
public int getzIndex ()
The z-index of the mixer slot. Higher values are rendered in front of lower values. By default this is `0`.
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. The alpha value will be ignored if Video.enableTransparency is false.
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 setSize (int width, int height)
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. This value will be ignored if Video.enableTransparency is false.
Parameters
| transparency | The desired transparency for this mixer. |
|---|
public void setzIndex (int zIndex)
higher values are rendered in front of lower values