枚举类
Enum
AgoraRtmAreaCode
访问区域，即 SDK 连接的服务器所在的区域。| 枚举值 | 描述 |
|---|---|
AgoraRtmAreaCodeCN | 0x00000001: 中国大陆。 |
AgoraRtmAreaCodeNA | 0x00000002: 北美区域。 |
AgoraRtmAreaCodeEU | 0x00000004: 欧洲区域。 |
AgoraRtmAreaCodeAS | 0x00000008: 除中国大陆以外的亚洲区域。 |
AgoraRtmAreaCodeJP | 0x00000010: 日本。 |
AgoraRtmAreaCodeIN | 0x00000020: 印度。 |
AgoraRtmAreaCodeGLOB | 0xFFFFFFFF: 全球。 |
AgoraRtmChannelType
频道类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmChannelTypeMessage | 1: Message Channel |
AgoraRtmChannelTypeStream | 2: Stream Channel |
AgoraRtmChannelTypeUser | 3: User Channel |
AgoraRtmClientConnectionChangeReason
SDK 连接状态改变的原因。| 枚举值 | 描述 |
|---|---|
AgoraRtmClientConnectionChangedConnecting | 0: 建立网络连接中。 |
AgoraRtmClientConnectionChangedJoinSuccess | 1: 成功加入频道。 |
AgoraRtmClientConnectionChangedInterrupted | 2: 网络连接中断。 |
AgoraRtmClientConnectionChangedBannedByServer | 3: 网络连接被服务器禁止。 |
AgoraRtmClientConnectionChangedJoinFailed | 4: SDK 连续 20 分钟无法加入频道，停止重连频道。 |
AgoraRtmClientConnectionChangedLeaveChannel | 5: 离开频道。 |
AgoraRtmClientConnectionChangedInvalidAppId | 6: 不是有效的 App ID，无法加入频道。 |
AgoraRtmClientConnectionChangedInvalidChannelName | 7: 不是有效的频道名，无法加入频道。 |
AgoraRtmClientConnectionChangedInvalidToken | 8: Token 无效，无法加入频道。 |
AgoraRtmClientConnectionChangedTokenExpired | 9: Token 过期，无法加入频道。 |
AgoraRtmClientConnectionChangedRejectedByServer | 10: 被服务器禁止连接。 |
AgoraRtmClientConnectionChangedSettingProxyServer | 11: 由于设置了代理服务器，SDK 尝试重连。 |
AgoraRtmClientConnectionChangedRenewToken | 12: 更新 Token 引起网络连接状态改变。 |
AgoraRtmClientConnectionChangedClientIpAddressChanged | 13: 由于网络类型，或网络运营商的 IP 或端口发生改变，客户端 IP 地址变更，SDK 尝试重连。 |
AgoraRtmClientConnectionChangedKeepAliveTimeout | 14: SDK 和服务器连接保活超时，进入自动重连状态。 |
AgoraRtmClientConnectionChangedRejoinSuccess | 15: 重新加入频道成功。 |
AgoraRtmClientConnectionChangedChangedLost | 16: SDK 丢失与服务器的连接。 |
AgoraRtmClientConnectionChangedEchoTest | 17: 通话回声测试引起连接状态改变。 |
AgoraRtmClientConnectionChangedClientIpAddressChangedByUser | 18: 用户变更客户端 IP 地址，SDK 尝试重连。 |
AgoraRtmClientConnectionChangedSameUidLogin | 19: 使用相同的用户 ID 从不同的设备加入同一频道。 |
AgoraRtmClientConnectionChangedTooManyBroadcasters | 20: 频道内主播人数已达上限。 |
AgoraRtmClientConnectionChangedLicenseValidationFailure | 21: License 校验失败。 |
AgoraRtmClientConnectionChangedCertificationVerifyFailure | 22: 服务器证书校验失败。 |
AgoraRtmClientConnectionChangedStreamChannelNotAvailable | 23: Stream Channel 不存在。 |
AgoraRtmClientConnectionChangedInconsistentAppId | 24: App ID 与 Token 不匹配。 |
AgoraRtmClientConnectionChangedLoginSuccess | 10001: SDK 登录 RTM 系统成功。 |
AgoraRtmClientConnectionChangedLogout | 10002: SDK 已退出 RTM 系统。 |
AgoraRtmClientConnectionChangedPresenceNotReady | 10003: Presence 服务未就绪。你需要重新调用 loginByToken 方法登录 RTM 系统并重新执行对 SDK 的所有操作。 |
AgoraRtmClientConnectionState
SDK 连接状态。| 枚举值 | 描述 |
|---|---|
AgoraRtmClientConnectionStateDisconnected | 1: SDK 已和服务器断开连接。 |
AgoraRtmClientConnectionStateConnecting | 2: SDK 正在连接服务器。 |
AgoraRtmClientConnectionStateConnected | 3: SDK 已连上服务器。 |
AgoraRtmClientConnectionStateReconnecting | 4: SDK 和服务器断开连接，正在重新连接服务器。 |
AgoraRtmClientConnectionStateFailed | 5: SDK 无法连接服务器。 |
AgoraRtmEncryptionMode
加密方式。| 枚举值 | 描述 |
|---|---|
AgoraRtmEncryptionNone | 0: 不加密。 |
AgoraRtmEncryptionAES128GCM | 1: 128 位 AES 加密，GCM 模式。 |
AgoraRtmEncryptionAES256GCM | 2: 256 位 AES 加密，GCM 模式。 |
AgoraRtmJoinChannelFeature
加入频道时设置的事件通知类型，你可以通过位操作同时设置多种事件通知。| 枚举值 | 描述 |
|---|---|
AgoraRtmJoinChannelFeaturePresence | 1: 设置 Presence 事件通知。 |
AgoraRtmJoinChannelFeatureMetadata | 1 << 1: 设置 Storage 事件通知。 |
AgoraRtmJoinChannelFeatureLock | 1 << 2: 设置 Lock 事件通知。 |
AgoraRtmJoinChannelFeatureBeQuiet |
|
AgoraRtmLockEventType
Lock 事件类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmLockEventTypeSnapshot | 1: 加入频道时 Lock 的快照信息。 |
AgoraRtmLockEventTypeLockSet | 2: 已设置 Lock。 |
AgoraRtmLockEventTypeLockRemoved | 3: 已删除 Lock。 |
AgoraRtmLockEventTypeLockAcquired | 4: 已获取 Lock。 |
AgoraRtmLockEventTypeLockReleased | 5: 已释放 Lock。 |
AgoraRtmLockEventTypeLockExpired | 6: Lock 已过期。 |
AgoraRtmLogLevel
日志信息的输出等级。| 枚举值 | 描述 |
|---|---|
AgoraRtmLogLevelNone | 0x0000: 不输出任何日志。 |
AgoraRtmLogLevelInfo | 0x0001: 输出 AgoraRtmLogLevelFatal、AgoraRtmLogLevelError、AgoraRtmLogLevelWarn、AgoraRtmLogLevelInfo 级别的日志。我们推荐你将日志级别设为该等级。 |
AgoraRtmLogLevelWarn | 0x0002: 仅输出 AgoraRtmLogLevelFatal、AgoraRtmLogLevelError、AgoraRtmLogLevelWarn 级别的日志。 |
AgoraRtmLogLevelError | 0x0004: 仅输出 AgoraRtmLogLevelFatal、AgoraRtmLogLevelError 级别的日志。 |
AgoraRtmLogLevelFatal | 0x0008: 仅输出 AgoraRtmLogLevelFatal 级别的日志。 |
AgoraRtmMessagePriority
消息优先级。| 枚举值 | 描述 |
|---|---|
AgoraRtmMessagePriorityHighest | 0: 优先级最高。 |
AgoraRtmMessagePriorityHigh | 1: 优先级高。 |
AgoraRtmMessagePriorityNormal | 4: 优先级正常。 |
AgoraRtmMessagePriorityLow | 8: 优先级低。 |
AgoraRtmMessageQos
发送 Topic 消息时的 QoS 保障。| 枚举值 | 描述 |
|---|---|
AgoraRtmMessageQosUnordered | 0: 消息数据到达时不保序。 |
AgoraRtmMessageQosOrdered | 1: 消息数据到达时保序。 |
AgoraRtmPresenceEventType
Presence 事件类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmPresenceEventTypeSnapshot | 1: 加入频道时 Presence 的快照信息。 |
AgoraRtmPresenceEventTypeInterval | 2: 当频道内人数达到设定值后，频道内的事件通知将由实时通知转为定时通知。 |
AgoraRtmPresenceEventTypeRemoteJoinChannel | 3: 远端用户加入频道。 |
AgoraRtmPresenceEventTypeRemoteLeaveChannel | 4: 远端用户离开频道。 |
AgoraRtmPresenceEventTypeRemoteConnectionTimeout | 5: 远端用户连接超时。 |
AgoraRtmPresenceEventTypeRemoteStateChanged | 6: 远端用户的临时用户状态改变。 |
AgoraRtmPresenceEventTypeErrorOutOfService | 7: 用户加入频道时未启用 Presence。 |
AgoraRtmLinkOperation
操作类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmLinkOperationLogin | 0: 登录。 |
AgoraRtmLinkOperationLogout | 1: 登出。 |
AgoraRtmLinkOperationJoin | 2: 加入 Stream Channel。 |
AgoraRtmLinkOperationLeave | 3: 离开 Stream Channel。 |
AgoraRtmLinkOperationServerReject | 4: 服务器拒绝。 |
AgoraRtmLinkOperationAutoReconnect | 5: 自动重连。 |
AgoraRtmLinkOperationReconnected | 6: 已重连。 |
AgoraRtmLinkOperationHeartbeatTimeout | 7: 超时未收到心跳包。 |
AgoraRtmLinkOperationServerTimeout | 8: 服务器超时。 |
AgoraRtmLinkOperationNetworkChange | 9: 网络发生变化。 |
AgoraRtmLinkState
连接状态类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmLinkStateIdle | 0: 初始状态。 |
AgoraRtmLinkStateConnecting | 1: 正在连接。 |
AgoraRtmLinkStateConnected | 2: 已连接。 |
AgoraRtmLinkStateDisconnected | 3: 已断开连接。 |
AgoraRtmLinkStateSuspended | 4: 挂起状态。 |
AgoraRtmLinkStateFailed | 5: 连接失败。 |
AgoraRtmProtocolType
消息传输协议类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmProtocolTypeTcpUdp | 0: TCP 和 UDP 协议。 |
AgoraRtmProtocolTypeTcpOnly | 1: 仅 TCP 协议，即双环境都是 TCP 协议。 |
AgoraRtmServiceType
服务类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmServiceTypeMessage | 基础服务，包含 Message Channel、User Channel、Presence、Storage 和 Lock 服务。 |
AgoraRtmServiceTypeStream | Stream Channel 服务。 |
信息
如需使用 RTM 的全部服务，你可以使用位操作同时设置两种服务类型。
AgoraRtmProxyType
代理类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmProxyTypeNone | 0: 不开启 Proxy。 |
AgoraRtmProxyTypeHttp | 1: 开启 HTTP 协议的 Proxy。 |
AgoraRtmProxyTypeCloudTcp | 2: 开启 TCP 协议的 Cloud Proxy。 |
AgoraRtmStorageEventType
Storage 事件类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmStorageEventTypeSnapshot | 1: 用户第一次订阅 Channl Metadata 或 User Metadata，或加入频道时触发，本地用户会收到此类事件通知。 |
AgoraRtmStorageEventTypeSet | 2: 当调用 setChannelMetadata 或者 setUserMetadata 时触发。该事件仅在增量数据更新模式下返回。 |
AgoraRtmStorageEventTypeUpdate | 3: 当调用设置、更新或删除 Channel Metadata 或 User Metadata 的方法时会返回该类型事件。 |
AgoraRtmStorageEventTypeRemove | 4: 当调用 removeChannelMetadata 或者 removeUserMetadata 时触发。该事件仅在增量数据更新模式下返回。 |
AgoraRtmStorageType
Storage 类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmStorageTypeUser | 1: User Metadata 事件。 |
AgoraRtmStorageTypeChannel | 2: Channel Metadata 事件。 |
AgoraRtmSubscribeChannelFeature
订阅频道时设置的事件通知类型，你可以通过位操作同时设置多种事件通知。| 枚举值 | 描述 |
|---|---|
AgoraRtmSubscribeChannelFeatureNone | 0: 不设置事件通知。 |
AgoraRtmSubscribeChannelFeaturePresence | 1: 设置 Presence 事件通知。 |
AgoraRtmSubscribeChannelFeatureMetadata | 1 << 1: 设置 Storage 事件通知。 |
AgoraRtmSubscribeChannelFeatureMessage | 1 << 2: 设置消息事件通知。 |
AgoraRtmSubscribeChannelFeatureLock | 1 << 3: 设置 Lock 事件通知。 |
AgoraRtmSubscribeChannelFeatureBeQuiet |
|
AgoraRtmTopicEventType
Topic 事件类型。| 枚举值 | 描述 |
|---|---|
AgoraRtmTopicEventTypeSnapshot | 1: 加入频道时 Topic 的快照信息。 |
AgoraRtmTopicEventTypeRemoteJoinTopic | 2: 远端用户加入 Topic。 |
AgoraRtmTopicEventTypeRemoteLeaveTopic | 3: 远端用户离开 Topic。 |