Agora RTM CPP API Reference for Linux & Windows

Classes
struct	agora::rtm::RtmServiceContext

Enumerations
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 }

Functions
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)

Detailed Description

Region for the Agora RTM service. After setting a region, the RTM SDK can only connect to the Agora RTM service in the specified region.

Enumerator
AREA_CODE_CN	Mainland China.
AREA_CODE_NA	North America.
AREA_CODE_EU	Europe.
AREA_CODE_AS	Asia excluding Mainland China.
AREA_CODE_JP	Japan.
AREA_CODE_IN	India.
AREA_CODE_GLOB	(Default) Global.

Enumerator
RTM_NONE_PROXY	No cloud proxy.
RTM_TCP_PROXY	TLS cloud proxy.

Enumerator
SET_RTM_SERVICE_CONTEXT_ERR_OK	0: Successfully configured the context for the Agora RTM service.
SET_RTM_SERVICE_CONTEXT_ERR_FAILURE	1: Failed to configure the context for the Agora RTM service because at least one IRtmService instance already exists. Call release to destroy any existing `IRtmService` instance before configuring the context for the Agora RTM service.

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

Gets the version of the Agora RTM SDK.

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

Sets the context of all IRtmService instances. All IRtmservice instances you create after calling this method match the context.

Note: You must call this method before calling createRtmService to create an IRtmservice instance or after destroying any existing IRtmservice instance. Otherwise, this method returns the SET_RTM_SERVICE_CONTEXT_ERR_FAILURE error code.

Parameters

context Context of the IRtmservice instance, including geofencing and cloud proxy. See RtmServiceContext.