Agora RTM C++ API Reference for Linux & Windows

类
struct	agora::rtm::RtmServiceContext

枚举
enum	agora::rtm::RTM_AREA_CODE { agora::rtm::AREA_CODE_CN = (1 << 0) , agora::rtm::AREA_CODE_NA = (1 << 1) , agora::rtm::AREA_CODE_EU = (1 << 2) , agora::rtm::AREA_CODE_AS = (1 << 3) , agora::rtm::AREA_CODE_JP = (1 << 4) , agora::rtm::AREA_CODE_IN = (1 << 5) , agora::rtm::AREA_CODE_GLOB = (0xFFFFFFFF) }

enum	agora::rtm::RTM_CLOUD_PROXY_TYPE { agora::rtm::RTM_NONE_PROXY = 0 , agora::rtm::RTM_TCP_PROXY = 1 }

enum	agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_CODE { agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_OK = 0 , agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_FAILURE = 1 }

函数
AGORA_API const char *AGORA_CALL	agora::rtm::getRtmSdkVersion ()

AGORA_API SET_RTM_SERVICE_CONTEXT_ERR_CODE AGORA_CALL	agora::rtm::setRtmServiceContext (const RtmServiceContext &context)

详细描述

Agora RTM 服务的限定区域。设置限定区域之后，Agora RTM SDK 只能连接位于限定区域的 Agora RTM 服务。

枚举值
RTM_NONE_PROXY	不使用云代理。
RTM_TCP_PROXY	TLS 云代理。

setRtmServiceContext 返回的错误码。

枚举值
SET_RTM_SERVICE_CONTEXT_ERR_OK	0: Agora RTM 服务上下文设置成功。
SET_RTM_SERVICE_CONTEXT_ERR_FAILURE	1: Agora RTM 服务上下文设置失败，因为 IRtmService 实例已经存在。你需要调用 release 方法销毁现有的 `IRtmservice` 实例再设置 `IRtmservice` 实例的上下文。

AGORA_API const char *AGORA_CALL agora::rtm::getRtmSdkVersion ( )

获取 Agora RTM SDK 的版本号。

AGORA_API SET_RTM_SERVICE_CONTEXT_ERR_CODE AGORA_CALL agora::rtm::setRtmServiceContext ( const RtmServiceContext & context )

设置所有 IRtmService 实例的上下文。你在成功调用此方法之后创建的所有 IRtmService 实例都符合此方法设置的上下文。

注解: 你必须在调用 createRtmService 创建 IRtmservice 实例之前或销毁现有的 IRtmservice 实例之后调用该方法。否则该方法会返回 SET_RTM_SERVICE_CONTEXT_ERR_FAILURE 错误码。

参数

context IRtmservice 实例的上下文，包括 Agora RTM 服务的限定区域和云代理设置。参考 RtmServiceContext。