Package com.vonage.client.video

Class StreamComposition

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.video.StreamComposition

All Implemented Interfaces:

Jsonable

Direct Known Subclasses:

Archive, Broadcast

public abstract class StreamComposition
extends JsonableBaseObject

Base class for Broadcast and Archive. Represents the common features of a video call consisting of multiple streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	StreamComposition.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected UUID	applicationId
protected Long	createdAt
protected Boolean	hasAudio
protected Boolean	hasVideo
protected UUID	id
protected StreamCompositionLayout	layout
protected Integer	maxBitrate
protected Resolution	resolution
protected String	sessionId
protected StreamMode	streamMode
protected List<VideoStream>	streams

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamComposition()
protected	StreamComposition(StreamComposition.Builder builder)

Method Summary

Modifier and Type	Method	Description
UUID	getApplicationId()	Vonage video application ID (as used to create the client).
Instant	getCreatedAt()	The time at which this composition was started or created.
Long	getCreatedAtMillis()	The time at which this composition was started or created, in milliseconds since the Unix epoch.
UUID	getId()	Unique ID of the composition.
protected StreamCompositionLayout	getLayout()	Describes how the streams in this composition are displayed.
Integer	getMaxBitrate()	The maximum bitrate for the stream in bits per second (if one was set).
Resolution	getResolution()	The video resolution of the composition.
String	getSessionId()	The ID of the video session associated with this composition.
StreamMode	getStreamMode()	The stream mode to used for selecting streams to be included in this composition: StreamMode.AUTO or StreamMode.MANUAL.
List<VideoStream>	getStreams()	Returns the streams associated with this composition.
Boolean	hasAudio()	Whether the archive has an audio track (true) or not (false).
Boolean	hasVideo()	Whether the composition has a video track (true) or not (false).

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Field Details

id

protected UUID id

applicationId

protected UUID applicationId

sessionId

protected String sessionId

streamMode

protected StreamMode streamMode

resolution

protected Resolution resolution

layout

protected StreamCompositionLayout layout

hasVideo

protected Boolean hasVideo

hasAudio

protected Boolean hasAudio

createdAt

protected Long createdAt

streams

protected List<VideoStream> streams

maxBitrate

protected Integer maxBitrate

Constructor Details

StreamComposition

protected StreamComposition()

StreamComposition

protected StreamComposition(StreamComposition.Builder builder)

Method Details

getId

public UUID getId()

Unique ID of the composition.

Returns:

The composition ID.

getApplicationId

public UUID getApplicationId()

Vonage video application ID (as used to create the client).

Returns:

The application ID.

getSessionId

public String getSessionId()

The ID of the video session associated with this composition.

Returns:

The session ID.

getResolution

public Resolution getResolution()

The video resolution of the composition.

Returns:

The resolution as an enum.

hasVideo

public Boolean hasVideo()

Whether the composition has a video track (true) or not (false).

Returns:

Whether this composition has video.

hasAudio

public Boolean hasAudio()

Whether the archive has an audio track (true) or not (false).

Returns:

Whether this composition has sound.

getStreamMode

public StreamMode getStreamMode()

The stream mode to used for selecting streams to be included in this composition: StreamMode.AUTO or StreamMode.MANUAL.

Returns:

The StreamMode.

getStreams

public List<VideoStream> getStreams()

Returns the streams associated with this composition. This is only set when the status is "started" and the stream mode is "manual".

Returns:

The details for each video stream, or null if not applicable.

getLayout

protected StreamCompositionLayout getLayout()

Describes how the streams in this composition are displayed.

Returns:

Layout information for the stream compositions.

getMaxBitrate

public Integer getMaxBitrate()

The maximum bitrate for the stream in bits per second (if one was set).

Returns:

The maximum bits per second as an integer, or null if unset.

getCreatedAtMillis

public Long getCreatedAtMillis()

The time at which this composition was started or created, in milliseconds since the Unix epoch.

Returns:

The created time as a long, or null if absent / not applicable.

getCreatedAt

public Instant getCreatedAt()

The time at which this composition was started or created.

Returns:

The creation time, or null if absent / not applicable.