@zoom/rtms
    Preparing search index...

    @zoom/rtms

    Zoom Realtime Media Streams (RTMS) SDK

    The RTMS SDK provides access to real-time audio, video, and transcript data from Zoom meetings. It offers both class-based and singleton approaches for connecting to meetings.

    Callback Types

    AudioDataCallback
    DeskshareCallback
    JoinConfirmCallback
    LeaveCallback
    SessionUpdateCallback
    TranscriptDataCallback
    UserUpdateCallback
    VideoDataCallback
    WebhookCallback

    Client Instance

    Client

    Common

    LogFormat
    LogLevel
    LoggerConfig

    Common Functions

    configureLogger
    generateSignature
    isInitialized
    onWebhookEvent

    Common Interfaces

    JoinParams
    MediaTypes
    SignatureParams

    Data Interfaces

    Metadata
    ParticipantInfo
    SessionInfo

    Media Configuration

    AudioParams
    DeskshareParams
    VideoParams

    Other

    <internal>
    AudioChannel
    AudioCodec
    AudioContentType
    AudioDataOption
    AudioSampleRate
    EventType
    MediaDataType
    MessageType
    SessionState
    StopReason
    StreamState
    VideoCodec
    VideoContentType
    VideoDataOption
    VideoResolution
    default
    MEDIA_TYPE_ALL
    MEDIA_TYPE_AUDIO
    MEDIA_TYPE_CHAT
    MEDIA_TYPE_DESKSHARE
    MEDIA_TYPE_TRANSCRIPT
    MEDIA_TYPE_VIDEO
    RTMS_SDK_FAILURE
    RTMS_SDK_INVALID_ARGS
    RTMS_SDK_INVALID_STATUS
    RTMS_SDK_NOT_EXIST
    RTMS_SDK_OK
    RTMS_SDK_TIMEOUT
    RTMS_SDK_WRONG_TYPE
    SESS_STATUS_ACTIVE
    SESS_STATUS_PAUSED
    SESSION_EVENT_ADD
    SESSION_EVENT_PAUSE
    SESSION_EVENT_RESUME
    SESSION_EVENT_STOP
    USER_EVENT_JOIN
    USER_EVENT_LEAVE

    Singleton API

    join
    leave
    onAudioData
    onJoinConfirm
    onLeave
    onSessionUpdate
    onTranscriptData
    onUserUpdate
    onVideoData
    poll
    streamId
    uuid