Class RtmConfig

Configurations for RTM Client.

Hierarchy

  • RtmConfig

Constructors

constructor

Properties

appId? areaCode? context? encryptionConfig? eventHandler? heartbeatInterval? logConfig? multipath? presenceTimeout? privateConfig? protocolType? proxyConfig? useStringUserId? userId?

Constructors

constructor

Properties

Optional appId

appId?: string

The App ID of your project.

Optional areaCode

areaCode?: RtmAreaCode = RtmAreaCode.glob

The region for connection. This advanced feature applies to scenarios that have regional restrictions.

For the regions that Agora supports, see #AREA_CODE.

After specifying the region, the SDK connects to the Agora servers within that region.

Optional context

context?: any
  • For Android, it is the context of Activity or Application.
  • For Windows, it is the window handle of app. Once set, this parameter enables you to plug or unplug the video devices while they are powered.

Optional encryptionConfig

encryptionConfig?: RtmEncryptionConfig

The config for encryption setting

Optional eventHandler

eventHandler?: IRtmEventHandler

The callbacks handler

Optional heartbeatInterval

heartbeatInterval?: number

Heartbeat interval in seconds, specify the interval value of sending heartbeat between sdk and rtm service.

Optional logConfig

logConfig?: RtmLogConfig

The config for customer set log path, log size and log level.

Optional multipath

multipath?: boolean = false

Whether to enable multipath, introduced from 2.2.0, for now , only effect on stream channel.

Optional presenceTimeout

presenceTimeout?: number

Presence timeout in seconds, specify the timeout value when you lost connection between sdk and rtm service.

Optional privateConfig

privateConfig?: RtmPrivateConfig

The config for private setting

Optional protocolType

protocolType?: RtmProtocolType = RtmProtocolType.tcpUdp

The protocol used for connecting to the Agora RTM service.

Optional proxyConfig

proxyConfig?: RtmProxyConfig

The config for proxy setting

Optional useStringUserId

useStringUserId?: boolean = true

Whether to use String user IDs, if you are using RTC products with Int user IDs, set this value as 'false'. Otherwise errors might occur.

Optional userId

userId?: string

The ID of the user.

Settings

Member Visibility

Theme

On This Page