Package com.opentok

Class Broadcast

java.lang.Object
com.opentok.Broadcast
public class Broadcast extends Object
Represents a live streaming broadcast of an OpenTok session.

  • Method Details

    • makeBroadcast

      public static Broadcast makeBroadcast()
      Do not call the makeBroadcast() method. To start a live streaming broadcast, call the OpenTok.startBroadcast() method.

    • getId

      public String getId()
      The broadcast ID.

    • getSessionId

      public String getSessionId()
      The session ID of the OpenTok session associated with this broadcast.

    • getProjectId

      public int getProjectId()
      The OpenTok API key associated with the broadcast.

    • getCreatedAt

      public long getCreatedAt()
      The time at which the broadcast was started, in milliseconds since the Unix epoch.

    • getUpdatedAt

      public long getUpdatedAt()
      The time at which the broadcast was updated, in milliseconds since the Unix epoch.

    • getMaxDuration

      public int getMaxDuration()
      The maximum duration of the broadcast in seconds.
      Returns:
      The maximum duration.

    • getMaxBitrate

      public int getMaxBitrate()
      Maximum bitrate (bits per second) is an optional value allowed for the broadcast composing.
      Returns:
      The maximum bitrate.

    • getResolution

      public String getResolution()
      The broadcast resolution.

    • getStatus

      public String getStatus()
      The broadcast status, either "started" or "stopped".

    • getMultiBroadcastTag

      public String getMultiBroadcastTag()
      Returns the multiBroadcastTag if set for the Broadcast.

    • getHls

      public String getHls()
      The HLS URL (if there is one) of the broadcast.

    • getHlsStatus

      public String getHlsStatus()
      The HLS status of the broadcast if known. One of: "connecting", "ready", "live", "ended", "error".
      Returns:
      The HLS status as a string (if applicable).

    • getRtmpList

      public List<Rtmp> getRtmpList()
      A list of RTMP URLs (if there are any) of the broadcast.

    • 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).

    • getStreamMode

      public Broadcast.StreamMode getStreamMode()
      The stream mode to used for selecting streams to be included in this archive: StreamMode.AUTO or StreamMode.MANUAL.

    • toString

      public String toString()
      Overrides:
      toString in class Object