需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

枚举类

  • C++

更新时间不可用

RTM_AREA_CODE

访问区域，即 SDK 连接的服务器所在的区域。

枚举值描述
RTM_AREA_CODE_CN0x00000001: 中国大陆。
RTM_AREA_CODE_NA0x00000002: 北美区域。
RTM_AREA_CODE_EU0x00000004: 欧洲区域。
RTM_AREA_CODE_AS0x00000008: 除中国大陆以外的亚洲区域。
RTM_AREA_CODE_JP0x00000010: 日本。
RTM_AREA_CODE_IN0x00000020: 印度。
RTM_AREA_CODE_GLOB0xFFFFFFFF: 全球。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_CHANNEL_TYPE

频道类型。

枚举值描述
RTM_CHANNEL_TYPE_MESSAGE1: Message Channel
RTM_CHANNEL_TYPE_STREAM2: Stream Channel
RTM_CHANNEL_TYPE_USER3: User Channel
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_ENCRYPTION_MODE

加密方式。

枚举值描述
RTM_ENCRYPTION_MODE_NONE0: 不加密。
RTM_ENCRYPTION_MODE_AES_128_GCM1: 128 位 AES 加密，GCM 模式。
RTM_ENCRYPTION_MODE_AES_256_GCM2: 256 位 AES 加密，GCM 模式。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_LOCK_EVENT_TYPE

Lock 事件类型。

枚举值描述
RTM_LOCK_EVENT_TYPE_SNAPSHOT1: 加入频道时 Lock 的快照信息。
RTM_LOCK_EVENT_TYPE_LOCK_SET2: 已设置 Lock。
RTM_LOCK_EVENT_TYPE_LOCK_REMOVED3: 已删除 Lock。
RTM_LOCK_EVENT_TYPE_LOCK_ACQUIRED4: 已获取 Lock。
RTM_LOCK_EVENT_TYPE_LOCK_RELEASED5: 已释放 Lock。
RTM_LOCK_EVENT_TYPE_LOCK_EXPIRED6: Lock 已过期。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_LOG_LEVEL

日志信息的输出等级。

枚举值描述
RTM_LOG_LEVEL_NONE0x0000: 不输出任何日志。
RTM_LOG_LEVEL_INFO0x0001: 输出 RTM_LOG_LEVEL_FATAL、RTM_LOG_LEVEL_ERROR、RTM_LOG_LEVEL_WARN、RTM_LOG_LEVEL_INFO 级别的日志。我们推荐你将日志级别设为该等级。
RTM_LOG_LEVEL_WARN0x0002: 仅输出 RTM_LOG_LEVEL_FATAL、RTM_LOG_LEVEL_ERROR、RTM_LOG_LEVEL_WARN 级别的日志。
RTM_LOG_LEVEL_ERROR0x0004: 仅输出 RTM_LOG_LEVEL_FATAL、RTM_LOG_LEVEL_ERROR 级别的日志。
RTM_LOG_LEVEL_FATAL0x0008: 仅输出 RTM_LOG_LEVEL_FATAL 级别的日志。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_MESSAGE_PRIORITY

消息优先级。

枚举值描述
RTM_MESSAGE_PRIORITY_HIGHEST0: 优先级最高。
RTM_MESSAGE_PRIORITY_HIGH1: 优先级高。
RTM_MESSAGE_PRIORITY_NORMAL4: 优先级正常。
RTM_MESSAGE_PRIORITY_LOW8: 优先级低。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_MESSAGE_QOS

发送 Topic 消息时的 QoS 保障。

枚举值描述
RTM_MESSAGE_QOS_UNORDERED0: 消息数据到达时不保序。
RTM_MESSAGE_QOS_ORDERED1: 消息数据到达时保序。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_MESSAGE_TYPE

消息类型。

枚举值描述
RTM_MESSAGE_TYPE_BINARY0: 二进制类型。
RTM_MESSAGE_TYPE_STRING1: 字符串类型。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_PRESENCE_EVENT_TYPE

Presence 事件类型。

枚举值描述
RTM_PRESENCE_EVENT_TYPE_SNAPSHOT1: 加入频道时 Presence 的快照信息。
RTM_PRESENCE_EVENT_TYPE_INTERVAL2: 当频道内人数达到设定值后，频道内的事件通知将由实时通知转为定时通知。
RTM_PRESENCE_EVENT_TYPE_REMOTE_JOIN_CHANNEL3: 远端用户加入频道。
RTM_PRESENCE_EVENT_TYPE_REMOTE_LEAVE_CHANNEL4: 远端用户离开频道。
RTM_PRESENCE_EVENT_TYPE_REMOTE_TIMEOUT5: 远端用户连接超时。
RTM_PRESENCE_EVENT_TYPE_REMOTE_STATE_CHANGED6: 远端用户的临时用户状态改变。
RTM_PRESENCE_EVENT_TYPE_ERROR_OUT_OF_SERVICE7: 用户加入频道时未启用 Presence。
表格内容超出当前宽度，可横向滚动查看更多列。

操作类型。

枚举值描述
RTM_LINK_OPERATION_LOGIN0: 登录。
RTM_LINK_OPERATION_LOGOUT1: 登出。
RTM_LINK_OPERATION_JOIN2: 加入 Stream Channel。
RTM_LINK_OPERATION_LEAVE3: 离开 Stream Channel。
RTM_LINK_OPERATION_SERVER_REJECT4: 服务器拒绝。
RTM_LINK_OPERATION_AUTO_RECONNECT5: 自动重连。
RTM_LINK_OPERATION_RECONNECTED6: 已重连。
RTM_LINK_OPERATION_HEARTBEAT_LOST7: 超时未收到心跳包。
RTM_LINK_OPERATION_SERVER_TIMEOUT8: 服务器超时。
RTM_LINK_OPERATION_NETWORK_CHANGE9: 网络发生变化。
表格内容超出当前宽度，可横向滚动查看更多列。

连接状态类型。

枚举值描述
RTM_LINK_STATE_IDLE0: 初始状态。
RTM_LINK_STATE_CONNECTING1: 正在连接。
RTM_LINK_STATE_CONNECTED2: 已连接。
RTM_LINK_STATE_DISCONNECTED3: 已断开连接。
RTM_LINK_STATE_SUSPENDED4: 挂起状态。
RTM_LINK_STATE_FAILED5: 连接失败。
表格内容超出当前宽度，可横向滚动查看更多列。

连接状态改变的原因。

枚举值描述
RTM_LINK_STATE_CHANGE_REASON_UNKNOWN0: 未知原因。
RTM_LINK_STATE_CHANGE_REASON_LOGIN1: 正在登录。
RTM_LINK_STATE_CHANGE_REASON_LOGIN_SUCCESS2: 登录成功。
RTM_LINK_STATE_CHANGE_REASON_LOGIN_TIMEOUT3: 登录超时。
RTM_LINK_STATE_CHANGE_REASON_LOGIN_NOT_AUTHORIZED4: 登录未授权。
RTM_LINK_STATE_CHANGE_REASON_LOGIN_REJECTED5: 登录被拒绝。
RTM_LINK_STATE_CHANGE_REASON_RELOGIN6: 重新登录。
RTM_LINK_STATE_CHANGE_REASON_LOGOUT7: 登出。
RTM_LINK_STATE_CHANGE_REASON_AUTO_RECONNECT8: 自动重连。
RTM_LINK_STATE_CHANGE_REASON_RECONNECT_TIMEOUT9: 重连超时。
RTM_LINK_STATE_CHANGE_REASON_RECONNECT_SUCCESS10: 重连成功。
RTM_LINK_STATE_CHANGE_REASON_JOIN11: 正在加入频道。
RTM_LINK_STATE_CHANGE_REASON_JOIN_SUCCESS12: 加入频道成功。
RTM_LINK_STATE_CHANGE_REASON_JOIN_FAILED13: 加入频道失败。
RTM_LINK_STATE_CHANGE_REASON_REJOIN14: 重新加入频道。
RTM_LINK_STATE_CHANGE_REASON_LEAVE15: 离开频道。
RTM_LINK_STATE_CHANGE_REASON_INVALID_TOKEN16: Token 无效。
RTM_LINK_STATE_CHANGE_REASON_TOKEN_EXPIRED17: Token 过期。
RTM_LINK_STATE_CHANGE_REASON_INCONSISTENT_APP_ID18: App ID 不一致。
RTM_LINK_STATE_CHANGE_REASON_INVALID_CHANNEL_NAME19: 频道名无效。
RTM_LINK_STATE_CHANGE_REASON_INVALID_USER_ID20: 用户 ID 无效。
RTM_LINK_STATE_CHANGE_REASON_NOT_INITIALIZED21: SDK 未初始化。
RTM_LINK_STATE_CHANGE_REASON_RTM_SERVICE_NOT_CONNECTED22: RTM 服务未连接。
RTM_LINK_STATE_CHANGE_REASON_CHANNEL_INSTANCE_EXCEED_LIMITATION23: 频道实例超出限制。
RTM_LINK_STATE_CHANGE_REASON_OPERATION_RATE_EXCEED_LIMITATION24: 操作频率超出限制。
RTM_LINK_STATE_CHANGE_REASON_CHANNEL_IN_ERROR_STATE25: 频道处于错误状态。
RTM_LINK_STATE_CHANGE_REASON_PRESENCE_NOT_CONNECTED26: Presence 服务未连接。
RTM_LINK_STATE_CHANGE_REASON_SAME_UID_LOGIN27: 使用相同用户 ID 登录。
RTM_LINK_STATE_CHANGE_REASON_KICKED_OUT_BY_SERVER28: 被服务器踢出。
RTM_LINK_STATE_CHANGE_REASON_KEEP_ALIVE_TIMEOUT29: 心跳超时。
RTM_LINK_STATE_CHANGE_REASON_CONNECTION_ERROR30: 连接错误。
RTM_LINK_STATE_CHANGE_REASON_PRESENCE_NOT_READY31: Presence 服务未就绪。
RTM_LINK_STATE_CHANGE_REASON_NETWORK_CHANGE32: 网络发生变化。
RTM_LINK_STATE_CHANGE_REASON_SERVICE_NOT_SUPPORTED33: 服务不支持。
RTM_LINK_STATE_CHANGE_REASON_STREAM_CHANNEL_NOT_AVAILABLE34: Stream Channel 不存在。
RTM_LINK_STATE_CHANGE_REASON_STORAGE_NOT_AVAILABLE35: Storage 服务不可用。
RTM_LINK_STATE_CHANGE_REASON_LOCK_NOT_AVAILABLE36: Lock 服务不可用。
RTM_LINK_STATE_CHANGE_REASON_LOGIN_TOO_FREQUENT37: 登录操作太频繁。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_PROTOCOL_TYPE

消息传输协议类型。

枚举值描述
RTM_PROTOCOL_TYPE_TCP_UDP0: TCP 和 UDP 协议。
RTM_PROTOCOL_TYPE_TCP_ONLY1: 仅 TCP 协议，即双环境都是 TCP 协议。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_SERVICE_TYPE

服务类型。

枚举值描述
RTM_SERVICE_TYPE_MESSAGE基础服务，包含 Message Channel、User Channel、Presence、Storage 和 Lock 服务。
RTM_SERVICE_TYPE_STREAMStream Channel 服务。
表格内容超出当前宽度，可横向滚动查看更多列。

信息

如需使用 RTM 的全部服务，你可以使用位操作同时设置两种服务类型。

RTM_PROXY_TYPE

代理类型。

枚举值描述
RTM_PROXY_TYPE_NONE0: 不开启 Proxy。
RTM_PROXY_TYPE_HTTP1: 开启 HTTP 协议的 Proxy。
RTM_PROXY_TYPE_CLOUD_TCP2: 开启 TCP 协议的 Cloud Proxy。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_STORAGE_EVENT_TYPE

Storage 事件类型。

枚举值描述
RTM_STORAGE_EVENT_TYPE_SNAPSHOT1: 用户第一次订阅 Channl Metadata 或 User Metadata，或加入频道时触发，本地用户会收到此类事件通知。
RTM_STORAGE_EVENT_TYPE_SET2: 当调用 setChannelMetadata 或者 setUserMetadata 时触发。该事件仅在增量数据更新模式下返回。
RTM_STORAGE_EVENT_TYPE_UPDATE3: 当调用设置、更新或删除 Channel Metadata 或 User Metadata 的方法时会返回该类型事件。
RTM_STORAGE_EVENT_TYPE_REMOVE4: 当调用 removeChannelMetadata 或者 removeUserMetadata 时触发。该事件仅在增量数据更新模式下返回。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_STORAGE_TYPE

Storage 类型。

枚举值描述
RTM_STORAGE_TYPE_USER1: User Metadata 事件。
RTM_STORAGE_TYPE_CHANNEL2: Channel Metadata 事件。
表格内容超出当前宽度，可横向滚动查看更多列。

RTM_TOPIC_EVENT_TYPE

Topic 事件类型。

枚举值描述
RTM_TOPIC_EVENT_TYPE_SNAPSHOT1: 加入频道时 Topic 的快照信息。
RTM_TOPIC_EVENT_TYPE_REMOTE_JOIN_TOPIC2: 远端用户加入 Topic。
RTM_TOPIC_EVENT_TYPE_REMOTE_LEAVE_TOPIC3: 远端用户离开 Topic。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利