public static class BroadcastProperties.Builder
extends java.lang.Object
BroadcastProperties| Constructor and Description |
|---|
Builder() |
| Modifier and Type | Method and Description |
|---|---|
BroadcastProperties.Builder |
addRtmpProperties(RtmpProperties rtmpProps)
Call this method to set a list of RTMP broadcast streams.
|
BroadcastProperties |
build()
Builds the BroadcastProperties object.
|
BroadcastProperties.Builder |
hasAudio(boolean hasAudio)
Whether to include audio in the broadcast (
true by default). |
BroadcastProperties.Builder |
hasHls(boolean hasHls)
Call this method to include an HLS broadcast (
true) or not false). |
BroadcastProperties.Builder |
hasVideo(boolean hasVideo)
Whether to include video in the broadcast (
true by default). |
BroadcastProperties.Builder |
hls(Hls hls)
Call this method to include HLS options.
|
BroadcastProperties.Builder |
layout(BroadcastLayout layout)
Customizes the layout of the broadcast.
|
BroadcastProperties.Builder |
maxBitrate(int maxBitrate)
Sets the maximum bitrate in bits per second for broadcast composing.
|
BroadcastProperties.Builder |
maxDuration(int maxDuration)
Sets the maximum duration, in seconds, of the broadcast.
|
BroadcastProperties.Builder |
multiBroadcastTag(java.lang.String multiBroadcastTag)
Set this to support multiple broadcasts for the same session simultaneously.
|
BroadcastProperties.Builder |
resolution(java.lang.String resolution)
Sets the resolution of the broadcast stream.
|
BroadcastProperties.Builder |
streamMode(Broadcast.StreamMode streamMode)
Sets the stream mode for this broadcast
When streams are selected automatically (
StreamMode.AUTO, the default), all
streams in the session can be included in the archive. |
public BroadcastProperties.Builder layout(BroadcastLayout layout)
layout - An object of type BroadcastLayout.public BroadcastProperties.Builder maxDuration(int maxDuration) throws InvalidArgumentException
maxDuration - The maximum duration in seconds.InvalidArgumentExceptionpublic BroadcastProperties.Builder maxBitrate(int maxBitrate) throws InvalidArgumentException
maxBitrate - The maximum bitrate in bits per second.InvalidArgumentException - If the bitrate is out of bounds.public BroadcastProperties.Builder hasHls(boolean hasHls)
true) or not false).hasHls - Whether the HLS broadcast is enabled or not.public BroadcastProperties.Builder hls(Hls hls)
hasHls to true.hls - The HLS object.public BroadcastProperties.Builder hasAudio(boolean hasAudio)
true by default).hasAudio - true if audio should be included, false otherwise.public BroadcastProperties.Builder hasVideo(boolean hasVideo)
true by default).hasVideo - true if video should be included, false otherwise.public BroadcastProperties.Builder addRtmpProperties(RtmpProperties rtmpProps) throws InvalidArgumentException
rtmpProps - The RtmpProperties object defining the RTMP streams.InvalidArgumentExceptionpublic BroadcastProperties.Builder resolution(java.lang.String resolution)
resolution - The resolution of the broadcast, either "640x480" (SD, the default),
"1280x720" (HD) or "1920x1080" (FHD).public BroadcastProperties.Builder streamMode(Broadcast.StreamMode streamMode)
StreamMode.AUTO, the default), all
streams in the session can be included in the archive. When streams are selected manually
(StreamMode.MANUAL), you specify streams to be included based on calls
to the OpenTok.addBroadcastStream(String, String, boolean, boolean) and
OpenTok.removeBroadcastStream(String, String) methods. With
StreamMode.MANUAL, you can specify whether a stream's audio, video, or both
are included in the archive. Un both automatic and manual modes, the archive composer
includes streams based on
stream
prioritization rules.streamMode - Set to a value defined in the Broadcast.StreamMode enum.public BroadcastProperties.Builder multiBroadcastTag(java.lang.String multiBroadcastTag)
multiBroadcastTag - A unique multi-broadcast tag.public BroadcastProperties build()