Package com.opentok

Class BroadcastProperties

java.lang.Object

com.opentok.BroadcastProperties

public class BroadcastProperties
extends Object

Defines values for the properties parameter of the OpenTok.startBroadcast(String sessionId, BroadcastProperties properties) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BroadcastProperties.Builder	Used to create a BroadcastProperties object.

Method Summary

Modifier and Type	Method	Description
String	getMultiBroadcastTag()	Returns the multiBroadcastTag, if present.
boolean	hasAudio()	Whether the broadcast has audio (true) or not (false).
boolean	hasHls()	Whether the broadcast has HLS (true) or not (false).
boolean	hasVideo()	Whether the broadcast has video (true) or not (false).
Hls	hls()	The HLS configuration object, or null if hasHls is false.
BroadcastLayout	layout()	The layout of the broadcast.
int	maxBitrate()	The maximum bitrate in bits per second of the broadcast.
int	maxDuration()	The maximum duration in seconds of the broadcast.
String	resolution()	Returns the resolution of the broadcast.
List<RtmpProperties>	rtmpList()	Returns the RtmpProperties list.
Broadcast.StreamMode	streamMode()	The stream mode of the broadcast.

Methods inherited from class java.lang.Object

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

Method Details

layout

public BroadcastLayout layout()

The layout of the broadcast.

maxDuration

public int maxDuration()

The maximum duration in seconds of the broadcast.

maxBitrate

public int maxBitrate()

The maximum bitrate in bits per second of the broadcast.

hasHls

public boolean hasHls()

Whether the broadcast has HLS (true) or not (false).

hasAudio

public boolean hasAudio()

Whether the broadcast has audio (true) or not (false).

hasVideo

public boolean hasVideo()

Whether the broadcast has video (true) or not (false).

hls

public Hls hls()

The HLS configuration object, or null if hasHls is false.

rtmpList

public List<RtmpProperties> rtmpList()

Returns the RtmpProperties list.

resolution

public String resolution()

Returns the resolution of the broadcast.

getMultiBroadcastTag

public String getMultiBroadcastTag()

Returns the multiBroadcastTag, if present.

streamMode

public Broadcast.StreamMode streamMode()

The stream mode of the broadcast.