@zoom/rtms
    Preparing search index...

    Interface JoinParams

    Parameters for joining a Zoom RTMS session

    interface JoinParams {
        ca?: string;
        client?: string;
        meeting_uuid: string;
        pollInterval?: number;
        rtms_stream_id: string;
        secret?: string;
        server_urls: string;
        signature?: string;
        timeout?: number;
    }
    Index

    Properties

    ca? client? meeting_uuid pollInterval? rtms_stream_id secret? server_urls signature? timeout?

    Properties

    ca?: string

    The path to a CA certificate file (defaults to system CA)

    client?: string

    The Zoom OAuth client ID (defaults to ZM_RTMS_CLIENT environment variable)

    meeting_uuid: string

    The UUID of the Zoom meeting

    pollInterval?: number

    The interval between poll operations in milliseconds

    rtms_stream_id: string

    The RTMS stream ID for this connection

    secret?: string

    The Zoom OAuth client secret (defaults to ZM_RTMS_SECRET environment variable)

    server_urls: string

    The server URL(s) to connect to

    signature?: string

    The authentication signature (optional if client and secret are provided)

    timeout?: number

    The timeout for the join operation in milliseconds

    Settings

    Member Visibility

    On This Page

    Properties