Package com.opentok

Class Broadcast

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getCreatedAt()
      The time at which the broadcast was started, in milliseconds since the Unix epoch.
      java.lang.String getHls()
      The HLS URL (if there is one) of the broadcast.
      java.lang.String getHlsStatus()
      The HLS status of the broadcast if known.
      java.lang.String getId()
      The broadcast ID.
      int getMaxBitrate()
      Maximum bitrate (bits per second) is an optional value allowed for the broadcast composing.
      int getMaxDuration()
      The maximum duration of the broadcast in seconds.
      java.lang.String getMultiBroadcastTag()
      Returns the multiBroadcastTag if set for the Broadcast.
      int getProjectId()
      The OpenTok API key associated with the broadcast.
      java.lang.String getResolution()
      The broadcast resolution.
      java.util.List<Rtmp> getRtmpList()
      A list of RTMP URLs (if there are any) of the broadcast.
      java.lang.String getSessionId()
      The session ID of the OpenTok session associated with this broadcast.
      java.lang.String getStatus()
      The broadcast status, either "started" or "stopped".
      Broadcast.StreamMode getStreamMode()
      The stream mode to used for selecting streams to be included in this archive: StreamMode.AUTO or StreamMode.MANUAL.
      long getUpdatedAt()
      The time at which the broadcast was updated, in milliseconds since the Unix epoch.
      boolean hasAudio()
      Whether the broadcast has audio (true) or not (false).
      boolean hasVideo()
      Whether the broadcast has video (true) or not (false).
      static Broadcast makeBroadcast()
      Do not call the makeBroadcast() method.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • makeBroadcast

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

      • getId

        public java.lang.String getId()
        The broadcast ID.

      • getSessionId

        public java.lang.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 java.lang.String getResolution()
        The broadcast resolution.

      • getStatus

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

      • getMultiBroadcastTag

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

      • getHls

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

      • getHlsStatus

        public java.lang.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 java.util.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object