Protobuf definitions

View as Markdown

To send and parse Realtime Media Streams (RTMS) messages as protobuf, generate code from the schema on this page, then wrap each typed message in an RtmsMessage envelope. Protobuf works on both the WebSocket signaling connection and SRT data connections. It requires protocol V2. JSON works with both V1 and V2, and the signaling and data connections must use the same format.

Protobuf has several advantages over JSON. Messages are smaller, they parse faster with lower CPU and memory use, and binary data is sent without Base64 encoding. These benefits matter most for high-throughput, low-latency streams.

Generate code from the schema

Save the schema as rtms.proto. Then install the tools and load or generate code from the file.

Install protobufjs. It loads the .proto file at runtime, so you don't need a build step.

npm install protobufjs

Load the schema and look up the RtmsMessage type.

const protobuf = require('protobufjs');

async function loadRtmsMessageType() {
    const root = await protobuf.load('rtms.proto');
    return root.lookupType('zoom.rtms.protobuf.RtmsMessage');
}

Use the RtmsMessage envelope

Every protobuf message is sent as an RtmsMessage. Set msg_type to the enum value for the message you're sending, then pack the typed message into payload as a google.protobuf.Any. Don't serialize the typed message on its own.

If the signaling connection rejects a request, it sends an RtmsMessage with msg_type set to RTMS_MESSAGE_TYPE_REQUEST_ERROR_RESP (30). The payload is an RtmsRequestErrorResp. Use its request_msg_type to match the error to the request that caused it, and use status_code and reason to find the cause. For more information, see request error response.

Enum values

Each enum value has a name and a number in the schema.

Your code uses the enum names from the generated bindings, such as RTMS_MESSAGE_TYPE_SIGNALING_HAND_SHAKE_REQ. Protobuf sends only the number, such as 1. Logs, the JSON examples, and the other RTMS topics show the number, so compare values using the number.

Schema

The following schema defines every enum, sub-message, and top-level message in the RTMS protobuf protocol.

syntax = "proto3";

package zoom.rtms.protobuf;

import "google/protobuf/any.proto";

option cc_enable_arenas = true;

// --- Enums ---

enum RtmsMessageType {
    RTMS_MESSAGE_TYPE_UNDEFINED = 0;
    RTMS_MESSAGE_TYPE_SIGNALING_HAND_SHAKE_REQ = 1;
    RTMS_MESSAGE_TYPE_SIGNALING_HAND_SHAKE_RESP = 2;
    RTMS_MESSAGE_TYPE_DATA_HAND_SHAKE_REQ = 3;
    RTMS_MESSAGE_TYPE_DATA_HAND_SHAKE_RESP = 4;
    RTMS_MESSAGE_TYPE_EVENT_SUBSCRIPTION = 5;
    RTMS_MESSAGE_TYPE_EVENT_UPDATE = 6;
    RTMS_MESSAGE_TYPE_CLIENT_READY_ACK = 7;
    RTMS_MESSAGE_TYPE_STREAM_STATE_UPDATE = 8;
    RTMS_MESSAGE_TYPE_SESSION_STATE_UPDATE = 9;
    RTMS_MESSAGE_TYPE_SESSION_STATE_REQ = 10;
    RTMS_MESSAGE_TYPE_SESSION_STATE_RESP = 11;
    RTMS_MESSAGE_TYPE_KEEP_ALIVE_REQ = 12;
    RTMS_MESSAGE_TYPE_KEEP_ALIVE_RESP = 13;
    RTMS_MESSAGE_TYPE_MEDIA_DATA_AUDIO = 14;
    RTMS_MESSAGE_TYPE_MEDIA_DATA_VIDEO = 15;
    RTMS_MESSAGE_TYPE_MEDIA_DATA_SHARE = 16;
    RTMS_MESSAGE_TYPE_MEDIA_DATA_TRANSCRIPT = 17;
    RTMS_MESSAGE_TYPE_MEDIA_DATA_CHAT = 18;
    RTMS_MESSAGE_TYPE_STREAM_STATE_REQ = 19;
    RTMS_MESSAGE_TYPE_STREAM_STATE_RESP = 20;
    RTMS_MESSAGE_TYPE_STREAM_CLOSE_REQ = 21;
    RTMS_MESSAGE_TYPE_STREAM_CLOSE_RESP = 22;
    RTMS_MESSAGE_TYPE_META_DATA_AUDIO = 23;
    RTMS_MESSAGE_TYPE_META_DATA_VIDEO = 24;
    RTMS_MESSAGE_TYPE_META_DATA_SHARE = 25;
    RTMS_MESSAGE_TYPE_META_DATA_TRANSCRIPT = 26;
    RTMS_MESSAGE_TYPE_META_DATA_CHAT = 27;
    RTMS_MESSAGE_TYPE_VIDEO_SUBSCRIPTION_REQ = 28;
    RTMS_MESSAGE_TYPE_VIDEO_SUBSCRIPTION_RESP = 29;
    RTMS_MESSAGE_TYPE_REQUEST_ERROR_RESP = 30;
}

enum RtmsEventCode {
    RTMS_EVENT_CODE_UNDEFINED = 0;

    // Common events: 1-999.
    RTMS_EVENT_CODE_FIRST_PACKET_TIMESTAMP = 1;
    RTMS_EVENT_CODE_MEDIA_CONNECTION_INTERRUPTED = 2;
    RTMS_EVENT_CODE_VIDEO_SUBSCRIPTION_TERMINATED_BY_USER_LEAVE = 3;
    RTMS_EVENT_CODE_MEDIA_DATA_USER_INFO = 4;

    // Meeting events: 1000-1999.
    RTMS_EVENT_CODE_MEETING_ACTIVE_SPEAKER_CHANGE = 1000;
    RTMS_EVENT_CODE_MEETING_PARTICIPANT_JOIN = 1001;
    RTMS_EVENT_CODE_MEETING_PARTICIPANT_LEAVE = 1002;
    RTMS_EVENT_CODE_MEETING_SHARING_START = 1003;
    RTMS_EVENT_CODE_MEETING_SHARING_STOP = 1004;
    RTMS_EVENT_CODE_MEETING_PARTICIPANT_VIDEO_ON = 1005;
    RTMS_EVENT_CODE_MEETING_PARTICIPANT_VIDEO_OFF = 1006;
    RTMS_EVENT_CODE_MEETING_CHAT_GROUP_CREATE = 1007;
    RTMS_EVENT_CODE_MEETING_CHAT_GROUP_DELETE = 1008;
    RTMS_EVENT_CODE_MEETING_CHAT_GROUP_MEMBERS_ADD = 1009;
    RTMS_EVENT_CODE_MEETING_CHAT_GROUP_MEMBERS_DELETE = 1010;
    RTMS_EVENT_CODE_MEETING_CHAT_GROUP_MEMBER_STATUS_UPDATE = 1011;

    // Zoom Contact Center events: 2000-2999.
    RTMS_EVENT_CODE_ZCC_VOICE_CONSUMER_ANSWERED = 2000;
    RTMS_EVENT_CODE_ZCC_VOICE_CONSUMER_END = 2001;
    RTMS_EVENT_CODE_ZCC_VOICE_USER_ANSWERED = 2002;
    RTMS_EVENT_CODE_ZCC_VOICE_USER_END = 2003;
    RTMS_EVENT_CODE_ZCC_VOICE_USER_HOLD = 2004;
    RTMS_EVENT_CODE_ZCC_VOICE_USER_UNHOLD = 2005;
    RTMS_EVENT_CODE_ZCC_VOICE_MONITOR_STARTED = 2006;
    RTMS_EVENT_CODE_ZCC_VOICE_MONITOR_TRANSITIONED = 2007;
    RTMS_EVENT_CODE_ZCC_VOICE_MONITOR_ENDED = 2008;
    RTMS_EVENT_CODE_ZCC_VOICE_TAKEOVER_STARTED = 2009;
    RTMS_EVENT_CODE_ZCC_VOICE_TRANSFER_INITIATED = 2010;
    RTMS_EVENT_CODE_ZCC_VOICE_TRANSFER_CANCELED = 2011;
    RTMS_EVENT_CODE_ZCC_VOICE_TRANSFER_ACCEPTED = 2012;
    RTMS_EVENT_CODE_ZCC_VOICE_TRANSFER_COMPLETED = 2013;
    RTMS_EVENT_CODE_ZCC_VOICE_TRANSFER_REJECTED = 2014;
    RTMS_EVENT_CODE_ZCC_VOICE_TRANSFER_TIMEOUT = 2015;
    RTMS_EVENT_CODE_ZCC_VOICE_CONFERENCE_CANCELED = 2016;
    RTMS_EVENT_CODE_ZCC_VOICE_CONFERENCE_PARTICIPANT_CANCELED = 2017;
    RTMS_EVENT_CODE_ZCC_VOICE_CONFERENCE_PARTICIPANT_INVITED = 2018;
    RTMS_EVENT_CODE_ZCC_VOICE_CONFERENCE_PARTICIPANT_REJECTED = 2019;
    RTMS_EVENT_CODE_ZCC_VOICE_CONFERENCE_PARTICIPANT_TIMEOUT = 2020;
    RTMS_EVENT_CODE_ZCC_VOICE_CONFERENCE_PARTICIPANT_LEFT = 2021;
    RTMS_EVENT_CODE_ZCC_VOICE_FLOW_ENTER = 2022;
    RTMS_EVENT_CODE_ZCC_VOICE_FLOW_EXIT = 2023;
    RTMS_EVENT_CODE_ZCC_VOICE_DTMF_STARTED = 2024;
    RTMS_EVENT_CODE_ZCC_VOICE_DTMF_ENDED = 2025;
    RTMS_EVENT_CODE_ZCC_VOICE_QUEUE_WAITING = 2026;

    // Zoom Phone events: 3000-3999.
    RTMS_EVENT_CODE_ZP_CALL_INFO_UPDATED = 3000;
    RTMS_EVENT_CODE_ZP_CALL_HOLD = 3001;
    RTMS_EVENT_CODE_ZP_CALL_RESUME = 3002;
    RTMS_EVENT_CODE_ZP_CALL_TRANSFER_COMPLETED = 3003;
}

enum RtmsMediaKeyWrapAlgorithm {
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_UNSPECIFIED = 0;
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_DHKEM_P256_HKDF_SHA256 = 1;
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_DHKEM_P384_HKDF_SHA384 = 2;
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_DHKEM_P521_HKDF_SHA512 = 3;
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_RSA_OAEP_SHA256 = 10;
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_RSA_OAEP_SHA384 = 11;
    RTMS_MEDIA_KEY_WRAP_ALGORITHM_RSA_OAEP_SHA512 = 12;
}

enum RtmsMediaPayloadEncryptionAlgorithm {
    RTMS_MEDIA_PAYLOAD_ENCRYPTION_ALGORITHM_UNSPECIFIED = 0;
    RTMS_MEDIA_PAYLOAD_ENCRYPTION_ALGORITHM_AES_256_GCM = 1;
    RTMS_MEDIA_PAYLOAD_ENCRYPTION_ALGORITHM_CHACHA20_POLY1305 = 2;
}

enum RtmsMediaPayloadKeyMode {
    RTMS_MEDIA_PAYLOAD_KEY_MODE_UNSPECIFIED = 0;
    RTMS_MEDIA_PAYLOAD_KEY_MODE_PER_MEDIA_DERIVED = 1;
    RTMS_MEDIA_PAYLOAD_KEY_MODE_MASTER_KEY_DIRECT = 2;
}

enum RtmsMediaKeyDerivationAlgorithm {
    RTMS_MEDIA_KEY_DERIVATION_UNSPECIFIED = 0;
    RTMS_MEDIA_KEY_DERIVATION_HKDF_SHA256 = 1;
}

enum RtmsMediaEncryptionKeySource {
    RTMS_MEDIA_ENCRYPTION_KEY_SOURCE_UNSPECIFIED = 0;
    RTMS_MEDIA_ENCRYPTION_KEY_SOURCE_SERVER_GENERATED = 1;
    RTMS_MEDIA_ENCRYPTION_KEY_SOURCE_CUSTOMER_KMS = 2;
}

enum RtmsAudioDataSource {
    RTMS_AUDIO_DATA_SOURCE_UNSPECIFIED = 0;
    RTMS_AUDIO_DATA_SOURCE_MICROPHONE = 1;
    RTMS_AUDIO_DATA_SOURCE_SHARED_CONTENT = 2;
}

enum RtmsStatusCode {
    RTMS_STATUS_CODE_OK = 0;
    RTMS_STATUS_CODE_INVALID_MESSAGE_TYPE = 1;
    RTMS_STATUS_CODE_INVALID_RTMS_STREAM_ID = 2;
    RTMS_STATUS_CODE_INVALID_SIGNATURE = 3;
    RTMS_STATUS_CODE_INVALID_PAYLOAD = 4;
    RTMS_STATUS_CODE_INVALID_EVENTS = 5;
    RTMS_STATUS_CODE_INVALID_EVENT_TYPE = 6;
    RTMS_STATUS_CODE_INVALID_MEDIA_TYPE = 7;
    RTMS_STATUS_CODE_DUPLICATE_SIGNAL_REQUEST = 8;
    RTMS_STATUS_CODE_MEDIA_TYPE_AUDIO_NOT_SUPPORT = 9;
    RTMS_STATUS_CODE_MEDIA_TYPE_VIDEO_NOT_SUPPORT = 10;
    RTMS_STATUS_CODE_MEDIA_TYPE_DESKSHARE_NOT_SUPPORT = 11;
    RTMS_STATUS_CODE_MEDIA_TYPE_TRANSCRIPT_NOT_SUPPORT = 12;
    RTMS_STATUS_CODE_MEDIA_TYPE_CHAT_NOT_SUPPORT = 13;
    RTMS_STATUS_CODE_MEDIA_TYPE_INVALID_VALUE = 14;
    RTMS_STATUS_CODE_MEDIA_DATA_ALL_CONNECTION_EXIST = 15;
    RTMS_STATUS_CODE_DUPLICATE_MEDIA_DATA_CONNECTION = 16;
    RTMS_STATUS_CODE_INVALID_MEDIA_PARAMS = 17;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_PARAMS = 18;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_CONTENT_TYPE = 19;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_SAMPLE_RATE = 20;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_CHANNEL = 21;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_CODEC = 22;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_DATA_OPT = 23;
    RTMS_STATUS_CODE_INVALID_MEDIA_AUDIO_SEND_RATE = 24;
    RTMS_STATUS_CODE_INVALID_MEDIA_VIDEO_PARAMS = 25;
    RTMS_STATUS_CODE_INVALID_MEDIA_VIDEO_CONTENT_TYPE = 26;
    RTMS_STATUS_CODE_INVALID_MEDIA_VIDEO_CODEC = 27;
    RTMS_STATUS_CODE_INVALID_MEDIA_VIDEO_RESOLUTION = 28;
    RTMS_STATUS_CODE_INVALID_MEDIA_VIDEO_DATA_OPT = 29;
    RTMS_STATUS_CODE_INVALID_MEDIA_VIDEO_FPS = 30;
    RTMS_STATUS_CODE_INVALID_MEDIA_DESKSHARE_PARAMS = 31;
    RTMS_STATUS_CODE_INVALID_MEDIA_DESKSHARE_CONTENT_TYPE = 32;
    RTMS_STATUS_CODE_INVALID_MEDIA_DESKSHARE_CODEC = 33;
    RTMS_STATUS_CODE_INVALID_MEDIA_DESKSHARE_RESOLUTION = 34;
    RTMS_STATUS_CODE_INVALID_MEDIA_DESKSHARE_FPS = 35;
    RTMS_STATUS_CODE_INVALID_MEDIA_TRANSCRIPT_PARAMS = 36;
    RTMS_STATUS_CODE_INVALID_MEDIA_TRANSCRIPT_CONTENT_TYPE = 37;
    RTMS_STATUS_CODE_INVALID_MEDIA_CHAT_PARAMS = 38;
    RTMS_STATUS_CODE_INVALID_MEDIA_CHAT_CONTENT_TYPE = 39;
    RTMS_STATUS_CODE_INVALID_RTMS_SESSION_ID = 40;
    RTMS_STATUS_CODE_INVALID_CLIENT_READY_ACK = 41;
    RTMS_STATUS_CODE_INVALID_EVENT_SUBSCRIBE = 42;
    RTMS_STATUS_CODE_INVALID_MEDIA_TRANSCRIPT_SOURCE_LANGUAGE = 43;
    RTMS_STATUS_CODE_DUPLICATE_VIDEO_SUBSCRIPTION = 44;
    RTMS_STATUS_CODE_INTERNAL_EXCEPTION = 45;
    RTMS_STATUS_CODE_INVALID_MEDIA_TRANSCRIPT_TARGET_LANGUAGE = 46;
    RTMS_STATUS_CODE_CHAT_SESSION_KEY_NOT_AVAILABLE = 47;
    RTMS_STATUS_CODE_MEDIA_DATA_TYPE_ALL_NOT_SUPPORTED = 48;
    RTMS_STATUS_CODE_PROTOCOL_V2_REQUIRED = 49;
    RTMS_STATUS_CODE_PROTOBUF_V2_REQUIRED = 50;
    RTMS_STATUS_CODE_DATA_HANDSHAKE_REQUIRES_ACTIVE_SIGNAL = 51;
    RTMS_STATUS_CODE_HANDSHAKE_MESSAGE_FORMAT_MISMATCH = 52;
    RTMS_STATUS_CODE_INVALID_VIDEO_SUBSCRIPTION_USER = 53;
    RTMS_STATUS_CODE_INVALID_MEDIA_CONNECTION_ID = 54;
    RTMS_STATUS_CODE_VIDEO_SUBSCRIPTION_CAP_EXCEEDED = 55;
    RTMS_STATUS_CODE_FEATURE_NOT_SUPPORTED = 56;
    RTMS_STATUS_CODE_INVALID_EVENT_CODE = 57;
    RTMS_STATUS_CODE_MEDIA_PNG_NOT_SUPPORTED_IN_V2 = 58;
}

enum RtmsMediaDataType {
    RTMS_MEDIA_DATA_TYPE_UNDEFINED = 0;
    RTMS_MEDIA_DATA_TYPE_AUDIO = 1;
    RTMS_MEDIA_DATA_TYPE_VIDEO = 2;
    RTMS_MEDIA_DATA_TYPE_DESKSHARE = 4;
    RTMS_MEDIA_DATA_TYPE_TRANSCRIPT = 8;
    RTMS_MEDIA_DATA_TYPE_CHAT = 16;
    RTMS_MEDIA_DATA_TYPE_ALL = 32;
}

enum RtmsMediaContentType {
    RTMS_MEDIA_CONTENT_TYPE_UNDEFINED = 0;
    RTMS_MEDIA_CONTENT_TYPE_RTP = 1;
    RTMS_MEDIA_CONTENT_TYPE_RAW_AUDIO = 2;
    RTMS_MEDIA_CONTENT_TYPE_RAW_VIDEO = 3;
    RTMS_MEDIA_CONTENT_TYPE_FILE_STREAM = 4;
    RTMS_MEDIA_CONTENT_TYPE_TEXT = 5;
}

enum RtmsMediaPayloadType {
    RTMS_MEDIA_PAYLOAD_TYPE_UNDEFINED = 0;
    RTMS_MEDIA_PAYLOAD_TYPE_L16 = 1;
    RTMS_MEDIA_PAYLOAD_TYPE_G711 = 2;
    RTMS_MEDIA_PAYLOAD_TYPE_G722 = 3;
    RTMS_MEDIA_PAYLOAD_TYPE_OPUS = 4;
    RTMS_MEDIA_PAYLOAD_TYPE_JPG = 5;
    RTMS_MEDIA_PAYLOAD_TYPE_PNG = 6;
    RTMS_MEDIA_PAYLOAD_TYPE_H264 = 7;
}

enum RtmsMediaDataOption {
    RTMS_MEDIA_DATA_OPTION_UNDEFINED = 0;
    RTMS_MEDIA_DATA_OPTION_AUDIO_MIXED_STREAM = 1;
    RTMS_MEDIA_DATA_OPTION_AUDIO_MULTI_STREAMS = 2;
    RTMS_MEDIA_DATA_OPTION_VIDEO_SINGLE_ACTIVE_STREAM = 3;
    RTMS_MEDIA_DATA_OPTION_VIDEO_SINGLE_INDIVIDUAL_STREAM = 4;
    RTMS_MEDIA_DATA_OPTION_VIDEO_SINGLE_INDIVIDUAL_SELFIE = 5;
    RTMS_MEDIA_DATA_OPTION_VIDEO_MULTI_INDIVIDUAL_STREAM = 6;
    RTMS_MEDIA_DATA_OPTION_VIDEO_MULTI_INDIVIDUAL_SELFIE = 7;
    RTMS_MEDIA_DATA_OPTION_VIDEO_MIXED_GALLERY_VIEW = 8;
}

enum RtmsMediaResolution {
    RTMS_MEDIA_RESOLUTION_UNDEFINED = 0;
    RTMS_MEDIA_RESOLUTION_SD = 1;
    RTMS_MEDIA_RESOLUTION_HD = 2;
    RTMS_MEDIA_RESOLUTION_FHD = 3;
    RTMS_MEDIA_RESOLUTION_QHD = 4;
}

enum RtmsMediaTextOutputMode {
    RTMS_MEDIA_TEXT_OUTPUT_MODE_UNSPECIFIED = 0;
    RTMS_MEDIA_TEXT_OUTPUT_MODE_SOURCE = 1;
    RTMS_MEDIA_TEXT_OUTPUT_MODE_TARGET = 2;
    RTMS_MEDIA_TEXT_OUTPUT_MODE_SOURCE_AND_TARGET = 3;
}

enum RtmsAudioSampleRate {
    RTMS_AUDIO_SAMPLE_RATE_8K = 0;
    RTMS_AUDIO_SAMPLE_RATE_16K = 1;
    RTMS_AUDIO_SAMPLE_RATE_32K = 2;
    RTMS_AUDIO_SAMPLE_RATE_48K = 3;
}

enum RtmsAudioChannel {
    RTMS_AUDIO_CHANNEL_UNDEFINED = 0;
    RTMS_AUDIO_CHANNEL_MONO = 1;
    RTMS_AUDIO_CHANNEL_STEREO = 2;
}

enum RtmsSessionState {
    RTMS_SESSION_STATE_INACTIVE = 0;
    RTMS_SESSION_STATE_INITIALIZE = 1;
    RTMS_SESSION_STATE_STARTED = 2;
    RTMS_SESSION_STATE_PAUSED = 3;
    RTMS_SESSION_STATE_RESUMED = 4;
    RTMS_SESSION_STATE_STOPPED = 5;
}

enum RtmsChatSessionType {
    RTMS_CHAT_SESSION_TYPE_UNDEFINED = 0;
    RTMS_CHAT_SESSION_TYPE_EVERYONE = 1;
    RTMS_CHAT_SESSION_TYPE_INDIVIDUAL = 2;
    RTMS_CHAT_SESSION_TYPE_CHAT_GROUP = 3;
    RTMS_CHAT_SESSION_TYPE_HOSTS_AND_PANELISTS = 4;
    RTMS_CHAT_SESSION_TYPE_INDIVIDUAL_CC_HOSTS_AND_PANELISTS = 5;
}

enum RtmsChatOperationType {
    RTMS_CHAT_OPERATION_TYPE_UNDEFINED = 0;
    RTMS_CHAT_OPERATION_TYPE_ADD = 1;
    RTMS_CHAT_OPERATION_TYPE_DELETE = 2;
    RTMS_CHAT_OPERATION_TYPE_UPDATE = 3;
    RTMS_CHAT_OPERATION_TYPE_ADD_EMOJI_REACTION = 4;
    RTMS_CHAT_OPERATION_TYPE_REMOVE_EMOJI_REACTION = 5;
}

enum RtmsStreamState {
    RTMS_STREAM_STATE_INACTIVE = 0;
    RTMS_STREAM_STATE_ACTIVE = 1;
    RTMS_STREAM_STATE_INTERRUPTED = 2;
    RTMS_STREAM_STATE_TERMINATING = 3;
    RTMS_STREAM_STATE_TERMINATED = 4;
    RTMS_STREAM_STATE_PAUSED = 5;
    RTMS_STREAM_STATE_RESUMED = 6;
}

enum RtmsStopReason {
    RTMS_STOP_REASON_UNDEFINED = 0;
    RTMS_STOP_REASON_HOST_TRIGGERED = 1;
    RTMS_STOP_REASON_USER_TRIGGERED = 2;
    RTMS_STOP_REASON_USER_LEFT = 3;
    RTMS_STOP_REASON_USER_EJECTED = 4;
    RTMS_STOP_REASON_HOST_DISABLED_APP = 5;
    RTMS_STOP_REASON_MEETING_ENDED = 6;
    RTMS_STOP_REASON_STREAM_CANCELED = 7;
    RTMS_STOP_REASON_STREAM_REVOKED = 8;
    RTMS_STOP_REASON_ALL_APPS_DISABLED = 9;
    RTMS_STOP_REASON_INTERNAL_EXCEPTION = 10;
    RTMS_STOP_REASON_CONNECTION_TIMEOUT = 11;
    RTMS_STOP_REASON_INSTANCE_CONNECTION_INTERRUPTED = 12;
    RTMS_STOP_REASON_SIGNAL_CONNECTION_INTERRUPTED = 13;
    RTMS_STOP_REASON_DATA_CONNECTION_INTERRUPTED = 14;
    RTMS_STOP_REASON_SIGNAL_CONNECTION_CLOSED_ABNORMALLY = 15;
    RTMS_STOP_REASON_DATA_CONNECTION_CLOSED_ABNORMALLY = 16;
    RTMS_STOP_REASON_EXIT_SIGNAL = 17;
    RTMS_STOP_REASON_AUTHENTICATION_FAILURE = 18;
    RTMS_STOP_REASON_AWAIT_RECONNECTION_TIMEOUT = 19;
    RTMS_STOP_REASON_RECEIVER_REQUEST_CLOSE = 20;
    RTMS_STOP_REASON_CUSTOMER_DISCONNECTED = 21;
    RTMS_STOP_REASON_AGENT_DISCONNECTED = 22;
    RTMS_STOP_REASON_ADMIN_DISABLED_APP = 23;
    RTMS_STOP_REASON_KEEP_ALIVE_TIMEOUT = 24;
    RTMS_STOP_REASON_MANUAL_API_TRIGGERED = 25;
    RTMS_STOP_REASON_STREAMING_NOT_SUPPORTED = 26;
    RTMS_STOP_REASON_IVR_STOPPED = 27;
}

// --- Sub-messages ---

message RtmsServerUrls {
    string audio = 1;
    string video = 2;
    string deskshare = 3;
    string transcript = 4;
    string chat = 5;
    string all = 6;
}

message RtmsMediaServer {
    RtmsServerUrls server_urls = 1;
}

message RtmsAudioParams {
    optional RtmsMediaContentType content_type = 1;
    optional RtmsMediaPayloadType codec = 2;
    optional RtmsMediaDataOption data_opt = 3;
    optional RtmsAudioSampleRate sample_rate = 4;
    optional RtmsAudioChannel channel = 5;
    optional uint32 send_rate = 6;
}

message RtmsVideoParams {
    optional RtmsMediaContentType content_type = 1;
    optional RtmsMediaPayloadType codec = 2;
    optional RtmsMediaResolution resolution = 3;
    optional RtmsMediaDataOption data_opt = 4;
    optional uint32 fps = 5;
}

message RtmsTranscriptParams {
    optional RtmsMediaContentType content_type = 1;
    optional RtmsMediaTextOutputMode text_output_mode = 2;
    optional int32 src_language = 3;
    optional int32 target_language = 4;
    optional bool enable_lid = 5;
}

message RtmsChatParams {
    optional RtmsMediaContentType content_type = 1;
}

message RtmsMediaParams {
    RtmsAudioParams audio = 1;
    RtmsVideoParams video = 2;
    RtmsVideoParams deskshare = 3;
    RtmsTranscriptParams transcript = 4;
    RtmsChatParams chat = 5;
}

message RtmsPayloadEncryption {
    RtmsMediaKeyWrapAlgorithm key_wrap_algorithm = 1;
    RtmsMediaPayloadEncryptionAlgorithm payload_encryption_algorithm = 2;
    optional string public_key = 3;
    optional string wrapped_key = 4;
    optional string key_id = 5;
}

message RtmsMediaDerivation {
    RtmsMediaDataType media_type = 1;
    bytes salt = 2;
    bytes info = 3;
}

message RtmsMediaKeyDerivation {
    RtmsMediaKeyDerivationAlgorithm algorithm = 1;
    uint32 derived_key_length = 2;
    uint32 derivation_version = 3;
    repeated RtmsMediaDerivation media_derivations = 4;
}

message RtmsParticipant {
    uint32 user_id = 1;
    string user_name = 2;
    uint32 state = 3;
    string participant_uuid = 4;
}

message RtmsChatGroupMember {
    optional uint32 user_id = 1;
    optional string user_name = 2;
}

message RtmsChatGroupMembersUpdate {
    string chat_group_id = 1;
    repeated RtmsChatGroupMember members = 2;
}

message RtmsChatGroup {
    string chat_group_id = 1;
    string chat_group_name = 2;
    uint32 chat_group_type = 3;
    uint32 creator_user_id = 4;
    repeated RtmsChatGroupMember members = 5;
}

message RtmsChatGroupMemberStatusUpdate {
    string chat_group_id = 1;
    uint32 user_id = 2;
    string user_name = 3;
    uint32 member_status = 4;
}

message RtmsEventPayload {
    RtmsEventCode event_code = 1;
    uint64 timestamp = 2;
    optional uint32 user_id = 3;
    optional string user_name = 4;
    optional RtmsMediaDataType media_type = 5;
    repeated RtmsParticipant participants = 6;
    repeated RtmsChatGroup chat_groups = 7;
    repeated RtmsChatGroupMembersUpdate members_update_list = 8;
    repeated RtmsChatGroupMemberStatusUpdate member_status_update_list = 9;
    optional bool subscribe = 10;
    optional string connection_id = 11;
}

// --- Top-level messages ---

message RtmsSignalingHandShakeReq {
    uint32 protocol_version = 1;
    string rtms_stream_id = 2;
    string signature = 3;
    optional uint32 sequence = 4;
    optional string meeting_uuid = 5;
    optional string engagement_id = 6;
    optional string call_id = 7;
    repeated RtmsPayloadEncryption payload_encryptions = 8;
    optional RtmsMediaPayloadKeyMode media_payload_key_mode = 9;
    optional bool buffer_data = 10;
}

message RtmsSignalingHandShakeResp {
    uint32 protocol_version = 1;
    RtmsStatusCode status_code = 2;
    string reason = 3;
    optional uint32 sequence = 4;
    RtmsMediaServer media_server = 5;
    optional bytes srt_passphrase = 6;
    optional uint32 srt_pbkey_length = 7;
    optional bool payload_encrypted = 8;
    repeated RtmsPayloadEncryption payload_encryptions = 9;
    optional RtmsMediaEncryptionKeySource media_encryption_key_source = 10;
    optional RtmsMediaPayloadKeyMode media_payload_key_mode = 11;
    RtmsMediaKeyDerivation media_key_derivation = 12;
}

message RtmsDataHandShakeReq {
    uint32 protocol_version = 1;
    string rtms_stream_id = 2;
    string signature = 3;
    RtmsMediaDataType media_type = 4;
    optional uint32 sequence = 5;
    optional string meeting_uuid = 6;
    optional string engagement_id = 7;
    optional string call_id = 8;
    optional RtmsMediaParams media_params = 9;
}

message RtmsDataHandShakeResp {
    uint32 protocol_version = 1;
    RtmsStatusCode status_code = 2;
    string reason = 3;
    optional uint32 sequence = 4;
    optional bool payload_encrypted = 5;
    RtmsMediaParams media_params = 6;
    optional string connection_id = 7;
}

message RtmsRequestErrorResp {
    RtmsMessageType request_msg_type = 1;
    RtmsStatusCode status_code = 2;
    string reason = 3;
    uint64 timestamp = 4;
}

message RtmsEventSubscription {
    repeated RtmsEventPayload events = 1;
}

message RtmsEventUpdate {
    RtmsEventPayload event = 1;
}

message RtmsClientReadyAck {
    string rtms_stream_id = 1;
}

message RtmsStreamStateUpdate {
    string rtms_stream_id = 1;
    RtmsStreamState state = 2;
    uint64 timestamp = 3;
    optional RtmsStopReason reason = 4;
}

message RtmsStreamStateReq {
    string rtms_stream_id = 1;
}

message RtmsStreamStateResp {
    string rtms_stream_id = 1;
    RtmsStreamState state = 2;
    uint64 timestamp = 3;
}

message RtmsSessionStateUpdate {
    string rtms_session_id = 1;
    RtmsSessionState state = 2;
    uint64 timestamp = 3;
    optional RtmsStopReason reason = 4;
}

message RtmsSessionStateReq {
    string rtms_session_id = 1;
}

message RtmsSessionStateResp {
    string rtms_session_id = 1;
    RtmsSessionState state = 2;
    uint64 timestamp = 3;
}

message RtmsKeepAliveReq {
    uint64 timestamp = 1;
    uint64 sequence = 2;
}

message RtmsKeepAliveResp {
    uint64 timestamp = 1;
}

message RtmsAudioContent {
    bytes data = 1;
    uint64 timestamp = 2;
    optional uint32 user_id = 3;
    optional string user_name = 4;
    optional string channel_id = 5;
    RtmsAudioDataSource source = 6;
    uint64 length = 7;
}

message RtmsVideoContent {
    bytes data = 1;
    uint64 timestamp = 2;
    optional uint32 user_id = 3;
    optional string user_name = 4;
    optional string channel_id = 5;
    uint64 length = 6;
}

message RtmsShareContent {
    bytes data = 1;
    uint64 timestamp = 2;
    optional uint32 user_id = 3;
    optional string user_name = 4;
    optional string channel_id = 5;
    uint64 length = 6;
}

message RtmsTranscriptContent {
    optional uint32 user_id = 1;
    optional string user_name = 2;
    uint32 attribute = 3;
    optional int32 language = 4;
    optional bytes data = 5;
    uint64 timestamp = 6;
    uint64 start_time = 7;
    uint64 end_time = 8;
    optional int32 target_language = 9;
    optional bytes target_data = 10;
    optional string channel_id = 11;
    optional int32 sentence_id = 12;
}

message RtmsChatSession {
    RtmsChatSessionType type = 1;
    optional string id = 2;
}

message RtmsChatParticipant {
    uint32 user_id = 1;
    string user_name = 2;
}

message RtmsChatFile {
    string file_id = 1;
    string file_name = 2;
    uint64 file_size = 3;
}

message RtmsChatContent {
    uint64 timestamp = 1;
    optional bytes data = 2;
    RtmsChatSession chat_session = 3;
    RtmsChatOperationType operation_type = 4;
    string message_id = 5;
    optional string parent_message_id = 6;
    RtmsChatParticipant sender = 7;
    optional RtmsChatParticipant receiver = 8;
    repeated RtmsChatFile files = 9;
    repeated string delete_file_id_list = 10;
}

message RtmsMediaDataAudio {
    RtmsAudioContent content = 1;
}

message RtmsMediaDataVideo {
    RtmsVideoContent content = 1;
}

message RtmsMediaDataShare {
    RtmsShareContent content = 1;
}

message RtmsMediaDataTranscript {
    RtmsTranscriptContent content = 1;
}

message RtmsMediaDataChat {
    RtmsChatContent content = 1;
}

message RtmsStreamCloseReq {
    string rtms_stream_id = 1;
}

message RtmsStreamCloseResp {
    string rtms_stream_id = 1;
    RtmsStatusCode status_code = 2;
    string reason = 3;
    uint64 timestamp = 4;
}

message RtmsVideoSubscriptionReq {
    uint32 user_id = 1;
    bool subscribe = 2;
    optional uint64 timestamp = 3;
    optional string connection_id = 4;
}

message RtmsVideoSubscriptionResp {
    uint32 user_id = 1;
    RtmsStatusCode status_code = 2;
    string reason = 3;
    uint64 timestamp = 4;
    optional string connection_id = 5;
}

// Envelope message that wraps all message types via google.protobuf.Any
message RtmsMessage {
    RtmsMessageType msg_type = 1;
    google.protobuf.Any payload = 2;
}