Class AgoraRteEngineConfig

Hierarchy

AgoraRteEngineConfig

Constructors

constructor

new AgoraRteEngineConfig(appId: string, opts?: AgoraRteOptions): AgoraRteEngineConfig

Parameters
- appId: string
- Optional opts: AgoraRteOptions
Returns AgoraRteEngineConfig

Properties

SCENE_JOIN_RETRY_ATTEMPTS

SCENE_JOIN_RETRY_ATTEMPTS: number

appId

appId: string

domainPoolDisabled

domainPoolDisabled: boolean

ignoreUrlRegionPrefix

ignoreUrlRegionPrefix: boolean

latencyLevel

latencyLevel: AgoraLatencyLevel

Optional logFilePath

logFilePath?: string

region

region: AgoraRegion

rtcConfigs

rtcConfigs: AGRtcConfig

rtcSDKExtensions

rtcSDKExtensions: AgoraRtcSDKExtension[]

rtcSDKParameters

rtcSDKParameters: any[]

service

service: AgoraRteServiceConfig

token

token: string

userId

userId: string

Static consoleHijackEnabled

consoleHijackEnabled: boolean

Static logLevel

logLevel: AgoraRteLogLevel

Static rtcLogUploadEnabled

rtcLogUploadEnabled: boolean

Static rtmLogUploadEnabled

rtmLogUploadEnabled: boolean

Static sequenceVersion

sequenceVersion: AgoraRteSequenceVersion

Static volumeIndicatorInterval

volumeIndicatorInterval: number

Accessors

rtcCloudProxyType

get rtcCloudProxyType(): undefined | AgoraCloudProxyType

Returns undefined | AgoraCloudProxyType

rtcRegion

get rtcRegion(): AgoraComponentRegion

Returns AgoraComponentRegion

rtmCloudProxyEnabled

get rtmCloudProxyEnabled(): boolean

Returns boolean

rtmRegion

get rtmRegion(): AgoraComponentRegion

Returns AgoraComponentRegion

Static platform

get platform(): AgoraRteRuntimePlatform

Returns AgoraRteRuntimePlatform

Static shared

get shared(): AgoraRteEngineConfig

Returns AgoraRteEngineConfig

Static version

get version(): string

Returns string

Methods

setRtcRegion

setRtcRegion(region: AgoraComponentRegion): void

Parameters
- region: AgoraComponentRegion
Returns void

setRtmRegion

setRtmRegion(region: AgoraComponentRegion): void

Parameters
- region: AgoraComponentRegion
Returns void

Static setConfig

setConfig(config: AgoraRteEngineConfig): void

Parameters
- config: AgoraRteEngineConfig
Returns void