@zoom/rtms
    Preparing search index...

    Interface JoinParams

    Parameters for joining a Zoom RTMS session

    For Meeting SDK events (meeting.rtms_started), use meeting_uuid. For Webinar events (webinar.rtms_started), use webinar_uuid. For Video SDK events (session.rtms_started), use session_id. Priority: meeting_uuid > webinar_uuid > session_id.

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

    Properties

    agent? ca? client? is_verify_cert? meeting_uuid? pollInterval? rtms_stream_id secret? server_urls session_id? signature? timeout? webinar_uuid?

    Properties

    agent?: string

    User agent string to send in requests

    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)

    is_verify_cert?: number

    Whether to verify TLS certificates (1 = verify, 0 = don't verify, defaults to 1)

    meeting_uuid?: string

    The UUID of the Zoom meeting (for Meeting SDK events)

    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

    session_id?: string

    The session ID (for Video SDK events) - used when meeting_uuid is not provided

    signature?: string

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

    timeout?: number

    The timeout for the join operation in milliseconds

    webinar_uuid?: string

    The UUID of the Zoom webinar (for Webinar events)

    Settings

    Member Visibility

    On This Page

    Properties