Package com.amazonaws.ivs.broadcast

Class MixedImageDeviceSource

java.lang.Object

com.amazonaws.ivs.broadcast.MixedImageDeviceSource

All Implemented Interfaces:

MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

public class MixedImageDeviceSource
extends Object
implements MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

A source for a MixedImageDevice.

Constructor Summary

Constructors

Constructor	Description
MixedImageDeviceSource(MixedImageDeviceSourceConfiguration configuration, ImageDevice device)	Creates a new MixedImageDeviceSource with the given configuration and device.

Method Summary

Modifier and Type	Method	Description
MixedImageDeviceSourceConfiguration	getConfiguration()	Get the configuration for this source.
ImageDevice	getDevice()	Get the device for this source.
String	getID()	Get the ID of this source.
void	setDevice(ImageDevice device)	Set the device for this source.
void	transitionToConfiguration(MixedImageDeviceSourceConfiguration nextConfiguration, long durationMs, TypedLambda<Boolean> onComplete)	Transitions this source to a new configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

MixedImageDeviceSource

public MixedImageDeviceSource(@NonNull
 MixedImageDeviceSourceConfiguration configuration,
 @Nullable
 ImageDevice device)

Creates a new MixedImageDeviceSource with the given configuration and device.

Parameters:

configuration - The configuration for this source.

device - The image device to use as a source, or null.

Method Details

getID

public String getID()

Description copied from interface: MixedDeviceSource

Get the ID of this source. This ID is constant for the life of the source and does not change when the device or configuration is changed.

Specified by:

getID in interface MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

Returns:

A unique identifier for this source.

getConfiguration

@NonNull
public MixedImageDeviceSourceConfiguration getConfiguration()

Description copied from interface: MixedDeviceSource

Get the configuration for this source.

Specified by:

getConfiguration in interface MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

Returns:

The configuration.

getDevice

@Nullable
public ImageDevice getDevice()

Description copied from interface: MixedDeviceSource

Get the device for this source.

Specified by:

getDevice in interface MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

Returns:

The device, or null if no device is set.

setDevice

public void setDevice(@Nullable
 ImageDevice device)

Description copied from interface: MixedDeviceSource

Set the device for this source.

It is important that the device has not been released yet. Releasing a device while it is still bound to a MixedDeviceSource will result in undefined behavior.

Specified by:

setDevice in interface MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

Parameters:

device - The device to use, or null to remove the device.

transitionToConfiguration

public void transitionToConfiguration(@NonNull
 MixedImageDeviceSourceConfiguration nextConfiguration,
 long durationMs,
 @Nullable
 TypedLambda<Boolean> onComplete)

Description copied from interface: MixedDeviceSource

Transitions this source to a new configuration.

Multiple concurrent transitions are not supported on the same source. If you initiate a second transition before the first is finished, the transition will start over from the original state and transition to the new state as if the first transition had never been made.

If there are no devices attached to this source, the duration parameter will be ignored and the slot will be updated immediately.

Specified by:

transitionToConfiguration in interface MixedDeviceSource<ImageDevice,MixedImageDeviceSourceConfiguration>

Parameters:

nextConfiguration - The new configuration for this source

durationMs - The amount of time to animate the transition for in milliseconds

onComplete - An optional callback that will be called when the animation has completed. The boolean provided will be `true` if the transition finished, or `false` if it was interrupted.