@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. Use the Client class to connect to meetings and receive real-time media streams.

      Callback Types

      EventParticipantInfo
      ActiveSpeakerEventCallback
      AudioDataCallback
      DeskshareCallback
      EventExCallback
      JoinConfirmCallback
      LeaveCallback
      ParticipantEventCallback
      RawWebhookCallback
      SessionUpdateCallback
      SharingEventCallback
      TranscriptDataCallback
      UserUpdateCallback
      VideoDataCallback
      WebhookCallback

      Client Instance

      Client

      Common

      LogFormat
      LogLevel
      LoggerConfig

      Common Functions

      configureLogger
      createWebhookHandler
      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
      EVENT_ACTIVE_SPEAKER_CHANGE
      EVENT_CONSUMER_ANSWERED
      EVENT_CONSUMER_END
      EVENT_FIRST_PACKET_TIMESTAMP
      EVENT_MEDIA_CONNECTION_INTERRUPTED
      EVENT_PARTICIPANT_JOIN
      EVENT_PARTICIPANT_LEAVE
      EVENT_SHARING_START
      EVENT_SHARING_STOP
      EVENT_UNDEFINED
      EVENT_USER_ANSWERED
      EVENT_USER_END
      EVENT_USER_HOLD
      EVENT_USER_UNHOLD
      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_JOIN
      USER_LEAVE

      Settings

      Member Visibility

      On This Page

      Callback Types
      Client Instance
      Common
      Common Functions
      Common Interfaces
      Data Interfaces
      Media Configuration
      Other
      <internal>AudioChannelAudioCodecAudioContentTypeAudioDataOptionAudioSampleRateEventTypeMediaDataTypeMessageTypeSessionStateStopReasonStreamStateVideoCodecVideoContentTypeVideoDataOptionVideoResolutiondefaultEVENT_ACTIVE_SPEAKER_CHANGEEVENT_CONSUMER_ANSWEREDEVENT_CONSUMER_ENDEVENT_FIRST_PACKET_TIMESTAMPEVENT_MEDIA_CONNECTION_INTERRUPTEDEVENT_PARTICIPANT_JOINEVENT_PARTICIPANT_LEAVEEVENT_SHARING_STARTEVENT_SHARING_STOPEVENT_UNDEFINEDEVENT_USER_ANSWEREDEVENT_USER_ENDEVENT_USER_HOLDEVENT_USER_UNHOLDMEDIA_TYPE_ALLMEDIA_TYPE_AUDIOMEDIA_TYPE_CHATMEDIA_TYPE_DESKSHAREMEDIA_TYPE_TRANSCRIPTMEDIA_TYPE_VIDEORTMS_SDK_FAILURERTMS_SDK_INVALID_ARGSRTMS_SDK_INVALID_STATUSRTMS_SDK_NOT_EXISTRTMS_SDK_OKRTMS_SDK_TIMEOUTRTMS_SDK_WRONG_TYPESESS_STATUS_ACTIVESESS_STATUS_PAUSEDSESSION_EVENT_ADDSESSION_EVENT_PAUSESESSION_EVENT_RESUMESESSION_EVENT_STOPUSER_JOINUSER_LEAVE