Package com.vonage.client.video

Class Broadcast

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.video.StreamComposition

com.vonage.client.video.Broadcast

All Implemented Interfaces:

Jsonable

public class Broadcast
extends StreamComposition

Represents properties of a live-streaming broadcast.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Broadcast.Builder	Used to construct a Broadcast object.

Field Summary

Fields inherited from class com.vonage.client.video.StreamComposition

applicationId, createdAt, hasAudio, hasVideo, id, layout, maxBitrate, resolution, sessionId, streamMode, streams

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Broadcast.Builder	builder(String sessionId)	Instantiates a Builder, used to construct this object.
static Broadcast	fromJson(String json)	Creates an instance of this class from a JSON payload.
BroadcastUrls	getBroadcastUrls()	Details on the HLS and RTMP broadcast streams.
Hls	getHlsSettings()
Duration	getMaxDuration()	The maximum duration for the broadcast (if one was set).
Integer	getMaxDurationSeconds()	The maximum duration for the broadcast (if one was set), in seconds.
String	getMultiBroadcastTag()	The unique tag for simultaneous broadcasts (if one was set).
BroadcastStatus	getStatus()	The status of the broadcast at the time this object was created.
Instant	getUpdatedAt()	For this start method, this timestamp matches the StreamComposition.getCreatedAt() timestamp.
Long	getUpdatedAtMillis()	For this start method, this timestamp matches the StreamComposition.getCreatedAtMillis() timestamp.

Methods inherited from class com.vonage.client.video.StreamComposition

getApplicationId, getCreatedAt, getCreatedAtMillis, getId, getLayout, getMaxBitrate, getResolution, getSessionId, getStreamMode, getStreams, hasAudio, hasVideo

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

Constructor Details

Broadcast

protected Broadcast()

Broadcast

protected Broadcast(Broadcast.Builder builder)

Method Details

getMultiBroadcastTag

public String getMultiBroadcastTag()

The unique tag for simultaneous broadcasts (if one was set).

Returns:

The multi broadcast tag, or null if unset.

getUpdatedAtMillis

public Long getUpdatedAtMillis()

For this start method, this timestamp matches the StreamComposition.getCreatedAtMillis() timestamp.

Returns:

The update time in milliseconds since the Unix epoch.

getUpdatedAt

public Instant getUpdatedAt()

For this start method, this timestamp matches the StreamComposition.getCreatedAt() timestamp.

Returns:

The updatedAt time as an Instant, or null if unset / not applicable.

getMaxDurationSeconds

public Integer getMaxDurationSeconds()

The maximum duration for the broadcast (if one was set), in seconds.

Returns:

The maximum duration of this broadcast in seconds as an integer, or null if unset.

getMaxDuration

public Duration getMaxDuration()

The maximum duration for the broadcast (if one was set).

Returns:

The maximum duration (precision in seconds), or null if unset.

getStatus

public BroadcastStatus getStatus()

The status of the broadcast at the time this object was created.

Returns:

Current status of the broadcast as an enum.

getBroadcastUrls

public BroadcastUrls getBroadcastUrls()

Details on the HLS and RTMP broadcast streams. For an HLS stream, the URL is provided.

Returns:

The URLs for this broadcast, or null if unknown.

getHlsSettings

public Hls getHlsSettings()

Returns:

Further details on the HLS broadcast stream, or null if not applicable.

fromJson

public static Broadcast fromJson(String json)

Creates an instance of this class from a JSON payload.

Parameters:

json - The JSON string to parse.

Returns:

An instance of this class with the fields populated, if present.

builder

public static Broadcast.Builder builder(String sessionId)

Instantiates a Builder, used to construct this object. Note that you must specify at least one RTMP stream or HLS properties.

Parameters:

sessionId - ID of the Vonage Video session to broadcast.

Returns:

A new Broadcast.Builder.