Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LiveStreamClient

The live streaming client. Video SDK supports live streaming of a session to Facebook Live, YouTube Live, and a number of other custom live streaming platforms.

Index

Functions

Functions

getLiveStreamStatus

isLiveStreamEnabled

  • isLiveStreamEnabled(): boolean

  • Whether live streaming is enabled or not.

    Returns boolean

    boolean

startLiveStream

  • startLiveStream(streamUrl: string, streamKey: string, broadcastUrl: string): ExecutedResult

  • Start live streaming

    • Only the host can start live streaming.

    Parameters

    • streamUrl: string

      Third-party live stream URL.

    • streamKey: string

      Third-party live streaming key.

    • broadcastUrl: string

      Broadcast URL.

    Returns ExecutedResult

stopLiveStream

  • Stops live streaming.

    • Only the host can stop live streaming.

    Returns ExecutedResult