Class AgoraRteWebClientMain

Hierarchy

AgoraRteWebClientBase
- AgoraRteWebClientMain

Constructors

constructor

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

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

Properties

logger

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

Accessors

base

get base(): RtcAdapterWeb

Inherited from AgoraRteWebClientBase.base
Returns RtcAdapterWeb

ready

get ready(): boolean

Inherited from AgoraRteWebClientBase.ready
Returns boolean

remoteRtcUsers

get remoteRtcUsers(): Map<string, IAgoraRTCRemoteUser>

Returns Map<string, IAgoraRTCRemoteUser>

Methods

emit

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

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

enableDualStream

enableDualStream(enable: boolean): Promise<void>

Parameters
- enable: boolean
Returns Promise<void>

getClientSessionId

getClientSessionId(): any

Inherited from AgoraRteWebClientBase.getClientSessionId
Returns any

join

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

Inherited from AgoraRteWebClientBase.join
Parameters
- appId: string
- token: string
- streamUuid: string
Returns Promise<void>

leave

leave(): Promise<void>

Overrides AgoraRteWebClientBase.leave
Returns Promise<void>

muteLocalAudio

muteLocalAudio(mute: boolean): number

Parameters
- mute: boolean
Returns number

muteLocalScreenShare

muteLocalScreenShare(mute: boolean): number

Parameters
- mute: boolean
Returns number

muteLocalVideo

muteLocalVideo(mute: boolean): number

Parameters
- mute: boolean
Returns number

muteRemoteAudio

muteRemoteAudio(streamUuid: string, mute: boolean): number

Parameters
- streamUuid: string
- mute: boolean
Returns number

muteRemoteVideo

muteRemoteVideo(streamUuid: string, mute: boolean): number

Parameters
- streamUuid: string
- mute: boolean
Returns number

muteRemoteVideoMass

muteRemoteVideoMass(streamUuids: string[], mute: boolean): Promise<string[]>

Parameters
- streamUuids: string[]
- mute: boolean
Returns Promise<string[]>

notifyAudioPlaybackUpdate

notifyAudioPlaybackUpdate(deviceId: string): void

Parameters
- deviceId: string
Returns void

off

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

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

on

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

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

once

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

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

removeAllEventListeners

removeAllEventListeners(): void

Inherited from AgoraRteWebClientBase.removeAllEventListeners
Returns void

setCloudProxy

setCloudProxy(proxyType: AgoraCloudProxyType): void

Inherited from AgoraRteWebClientBase.setCloudProxy
Parameters
- proxyType: AgoraCloudProxyType
Returns void

setLatencyLevel

setLatencyLevel(level: AgoraLatencyLevel): void

Inherited from AgoraRteWebClientBase.setLatencyLevel
Parameters
- level: AgoraLatencyLevel
Returns void

setLowStreamParameter

setLowStreamParameter(streamParameter: AGLowStreamParameter): number

Parameters
- streamParameter: AGLowStreamParameter
Returns number

setRemoteTrackVolume

setRemoteTrackVolume(streamUuid: string, volume: number): void

Parameters
- streamUuid: string
- volume: number
Returns void

setRemoteVideoStreamType

setRemoteVideoStreamType(streamUuid: string, streamType: AGRemoteVideoStreamType): number

Parameters
- streamUuid: string
- streamType: AGRemoteVideoStreamType
Returns number

videoSubscribeThread

videoSubscribeThread(streamUuid: string): undefined | AgoraRteSubscribeThread

Parameters
- streamUuid: string
Returns undefined | AgoraRteSubscribeThread