@zoom/react-native-videosdk
    Preparing search index...

    Type Alias ZoomVideoSdkBroadcastStreamingHelperType

    Broadcast streaming controller (host side).

    Lets the local user start, stop, and query a broadcast streaming session. Status updates arrive via EventType.onStartBroadcastResponse, onStopBroadcastResponse, and onGetBroadcastControlStatus.

    Requires an active session (after EventType.onSessionJoin).

    type ZoomVideoSdkBroadcastStreamingHelperType = {
        canStartBroadcast: () => Promise<boolean>;
        getBroadcastStatus: (channelID: string) => Promise<Errors>;
        isBroadcastStreamingSupported: () => Promise<boolean>;
        startBroadcast: () => Promise<Errors>;
        stopBroadcast: (channelID: string) => Promise<Errors>;
    }

    Implemented by

    Index

    Properties

    canStartBroadcast getBroadcastStatus isBroadcastStreamingSupported startBroadcast stopBroadcast

    Properties

    canStartBroadcast: () => Promise<boolean>

    Determines whether the local user has permission to start broadcast.

    getBroadcastStatus: (channelID: string) => Promise<Errors>

    Queries broadcast status asynchronously. Result arrives via EventType.onGetBroadcastControlStatus.

    isBroadcastStreamingSupported: () => Promise<boolean>

    Determines whether the session supports broadcast streaming.

    startBroadcast: () => Promise<Errors>

    Starts broadcast streaming asynchronously. Result arrives via EventType.onStartBroadcastResponse.

    stopBroadcast: (channelID: string) => Promise<Errors>

    Stops broadcast streaming asynchronously. Result arrives via EventType.onStopBroadcastResponse.

    Settings

    Member Visibility

    On This Page

    Properties