@zoom/rtms
    Preparing search index...

    Variable defaultConst

    default: {
        AudioChannel: AudioChannel;
        AudioCodec: AudioCodec;
        AudioContentType: AudioContentType;
        AudioDataOption: AudioDataOption;
        AudioSampleRate: AudioSampleRate;
        Client: typeof Client;
        configureLogger: typeof configureLogger;
        createWebhookHandler: typeof createWebhookHandler;
        EVENT_ACTIVE_SPEAKER_CHANGE: number;
        EVENT_CONSUMER_ANSWERED: number;
        EVENT_CONSUMER_END: number;
        EVENT_FIRST_PACKET_TIMESTAMP: number;
        EVENT_MEDIA_CONNECTION_INTERRUPTED: number;
        EVENT_PARTICIPANT_JOIN: number;
        EVENT_PARTICIPANT_LEAVE: number;
        EVENT_SHARING_START: number;
        EVENT_SHARING_STOP: number;
        EVENT_UNDEFINED: number;
        EVENT_USER_ANSWERED: number;
        EVENT_USER_END: number;
        EVENT_USER_HOLD: number;
        EVENT_USER_UNHOLD: number;
        EventType: EventType;
        generateSignature: typeof generateSignature;
        isInitialized: typeof isInitialized;
        LogFormat: typeof LogFormat;
        LogLevel: typeof LogLevel;
        MEDIA_TYPE_ALL: number;
        MEDIA_TYPE_AUDIO: number;
        MEDIA_TYPE_CHAT: number;
        MEDIA_TYPE_DESKSHARE: number;
        MEDIA_TYPE_TRANSCRIPT: number;
        MEDIA_TYPE_VIDEO: number;
        MediaDataType: MediaDataType;
        MessageType: MessageType;
        onWebhookEvent: typeof onWebhookEvent;
        RTMS_SDK_FAILURE: number;
        RTMS_SDK_INVALID_ARGS: number;
        RTMS_SDK_INVALID_STATUS: number;
        RTMS_SDK_NOT_EXIST: number;
        RTMS_SDK_OK: number;
        RTMS_SDK_TIMEOUT: number;
        RTMS_SDK_WRONG_TYPE: number;
        SESS_STATUS_ACTIVE: number;
        SESS_STATUS_PAUSED: number;
        SESSION_EVENT_ADD: number;
        SESSION_EVENT_PAUSE: number;
        SESSION_EVENT_RESUME: number;
        SESSION_EVENT_STOP: number;
        SessionState: SessionState;
        StopReason: StopReason;
        StreamState: StreamState;
        USER_JOIN: number;
        USER_LEAVE: number;
        VideoCodec: VideoCodec;
        VideoContentType: VideoContentType;
        VideoDataOption: VideoDataOption;
        VideoResolution: VideoResolution;
    }

    Default export of the RTMS module

    This object contains all exported functions and classes for the RTMS SDK. Use the Client class for connecting to Zoom RTMS streams.

    Type Declaration

    • AudioChannel: AudioChannel
    • AudioCodec: AudioCodec
    • AudioContentType: AudioContentType
    • AudioDataOption: AudioDataOption
    • AudioSampleRate: AudioSampleRate
    • Client: typeof Client
    • configureLogger: typeof configureLogger
    • createWebhookHandler: typeof createWebhookHandler
    • EVENT_ACTIVE_SPEAKER_CHANGE: number
    • EVENT_CONSUMER_ANSWERED: number
    • EVENT_CONSUMER_END: number
    • EVENT_FIRST_PACKET_TIMESTAMP: number
    • EVENT_MEDIA_CONNECTION_INTERRUPTED: number
    • EVENT_PARTICIPANT_JOIN: number
    • EVENT_PARTICIPANT_LEAVE: number
    • EVENT_SHARING_START: number
    • EVENT_SHARING_STOP: number
    • EVENT_UNDEFINED: number
    • EVENT_USER_ANSWERED: number
    • EVENT_USER_END: number
    • EVENT_USER_HOLD: number
    • EVENT_USER_UNHOLD: number
    • EventType: EventType
    • generateSignature: typeof generateSignature
    • isInitialized: typeof isInitialized
    • LogFormat: typeof LogFormat
    • LogLevel: typeof LogLevel
    • MEDIA_TYPE_ALL: number
    • MEDIA_TYPE_AUDIO: number
    • MEDIA_TYPE_CHAT: number
    • MEDIA_TYPE_DESKSHARE: number
    • MEDIA_TYPE_TRANSCRIPT: number
    • MEDIA_TYPE_VIDEO: number
    • MediaDataType: MediaDataType
    • MessageType: MessageType
    • onWebhookEvent: typeof onWebhookEvent
    • RTMS_SDK_FAILURE: number
    • RTMS_SDK_INVALID_ARGS: number
    • RTMS_SDK_INVALID_STATUS: number
    • RTMS_SDK_NOT_EXIST: number
    • RTMS_SDK_OK: number
    • RTMS_SDK_TIMEOUT: number
    • RTMS_SDK_WRONG_TYPE: number
    • SESS_STATUS_ACTIVE: number
    • SESS_STATUS_PAUSED: number
    • SESSION_EVENT_ADD: number
    • SESSION_EVENT_PAUSE: number
    • SESSION_EVENT_RESUME: number
    • SESSION_EVENT_STOP: number
    • SessionState: SessionState
    • StopReason: StopReason
    • StreamState: StreamState
    • USER_JOIN: number
    • USER_LEAVE: number
    • VideoCodec: VideoCodec
    • VideoContentType: VideoContentType
    • VideoDataOption: VideoDataOption
    • VideoResolution: VideoResolution