Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncomingLiveStreamStatus

Status of the incoming live stream

Hierarchy

  • IncomingLiveStreamStatus

Index

Properties

Properties

isRTMPConnected

isRTMPConnected: boolean

Whether the streaming software (OBS, vMix, etc.) has connected to the Zoom RTMP endpoint.

  • false: Streaming software hasn't connected yet. Check your RTMP URL and stream key configuration.
  • true: Connected to the Zoom RTMP endpoint.

isStreamPushed

isStreamPushed: boolean

Whether the stream is active as a virtual participant in the session.

  • false: Streaming software is connected but startIncomingLiveStream has not yet been called (or has not completed).
  • true: Stream is active as a virtual participant. Call stopIncomingLiveStream to remove it.

streamId

streamId: string

The stream key ID (stream_id) obtained from the Zoom OpenAPI. Empty string if no stream is currently bound.