Class AgoraRteWebClientBase

Hierarchy

AGEventEmitter
- AgoraRteWebClientBase
  - AgoraRteWebClientMain
  - AgoraRteWebClientSub

Index

Constructors

constructor

Properties

logger

Accessors

Methods

Constructors

constructor

new AgoraRteWebClientBase(channelName: string, configs: RtcAdapterWebConfig, base: RtcAdapterBase, connectionType: AGRtcConnectionType, audioRawDataDispatcher: AGAudioRawDataDispatcher): AgoraRteWebClientBase

Overrides AGEventEmitter.constructor
Parameters
- channelName: string
- configs: RtcAdapterWebConfig
- base: RtcAdapterBase
- connectionType: AGRtcConnectionType
- audioRawDataDispatcher: AGAudioRawDataDispatcher
Returns AgoraRteWebClientBase

Properties

logger

logger: "agora-rte-sdk/src/core/logger/type".Logger

Accessors

base

get base(): RtcAdapterWeb

Returns RtcAdapterWeb

ready

get ready(): boolean

Returns boolean

Methods

emit

emit(evt: string, ...args: any[]): AgoraRteWebClientBase

Inherited from AGEventEmitter.emit
Parameters
- evt: string
- Rest ...args: any[]
Returns AgoraRteWebClientBase

getClientSessionId

getClientSessionId(): any

Returns any

join

join(appId: string, token: string, streamUuid: string): Promise<void>

Parameters
- appId: string
- token: string
- streamUuid: string
Returns Promise<void>

leave

leave(): Promise<void>

Returns Promise<void>

off

off(evt: string, cb: CallableFunction): AgoraRteWebClientBase

Inherited from AGEventEmitter.off
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraRteWebClientBase

on

on(evt: string, cb: CallableFunction): AgoraRteWebClientBase

Inherited from AGEventEmitter.on
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraRteWebClientBase

once

once(evt: string, cb: CallableFunction): AgoraRteWebClientBase

Inherited from AGEventEmitter.once
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraRteWebClientBase

removeAllEventListeners

removeAllEventListeners(): void

Inherited from AGEventEmitter.removeAllEventListeners
Returns void

setCloudProxy

setCloudProxy(proxyType: AgoraCloudProxyType): void

Parameters
- proxyType: AgoraCloudProxyType
Returns void

setLatencyLevel

setLatencyLevel(level: AgoraLatencyLevel): void

Parameters
- level: AgoraLatencyLevel
Returns void