Class AgoraRteScene

Hierarchy

EventEmitter
- AgoraRteScene

Constructors

constructor

new AgoraRteScene(sceneId: string, options: SceneObjects): AgoraRteScene

Overrides EventEmitter.constructor
Parameters
- sceneId: string
- options: SceneObjects
Returns AgoraRteScene

Properties

Optional createTs

createTs?: number

Readonly dataStore

dataStore: AgoraRteSyncDataStore

logger

logger: LoggerFacade

Readonly sceneId

sceneId: string

Accessors

engine

get engine(): AgoraRteEngine

Returns AgoraRteEngine

localUser

get localUser(): undefined | AgoraRteLocalUser

Returns undefined | AgoraRteLocalUser

rtcChannel

get rtcChannel(): AGRtcChannel

Returns AGRtcChannel

rtcSid

get rtcSid(): string

Returns string

rtmSid

get rtmSid(): string

Returns string

timestampServerLocalGap

get timestampServerLocalGap(): number

Returns number

Methods

addCloudProxyObserver

addCloudProxyObserver(observer: AgoraCloudProxyObserver): void

Parameters
- observer: AgoraCloudProxyObserver
Returns void

addCustomMessageObserver

addCustomMessageObserver(observer: AgoraRteCustomMessageObserver): void

Parameters
- observer: AgoraRteCustomMessageObserver
Returns void

enableDualStream

enableDualStream(enable: boolean, connectionType?: AGRtcConnectionType): Promise<void>

Parameters
- enable: boolean
- Optional connectionType: AGRtcConnectionType
Returns Promise<void>

getApiService

getApiService(): AgoraRteService

Returns AgoraRteService

joinRTC

joinRTC(options?: AgoraRteSceneJoinRTCOptions): Promise<void>

Parameters
- Optional options: AgoraRteSceneJoinRTCOptions
Returns Promise<void>

joinScene

joinScene(options: AgoraRteSceneJoinOptions): Promise<void>

Parameters
- options: AgoraRteSceneJoinOptions
Returns Promise<void>

leaveRTC

leaveRTC(connectionType?: AGRtcConnectionType): Promise<void>

Parameters
- Optional connectionType: AGRtcConnectionType
Returns Promise<void>

leaveScene

leaveScene(): Promise<void>

Returns Promise<void>

muteRemoteAudioStream

muteRemoteAudioStream(streamUuid: string, muted: boolean): number

Parameters
- streamUuid: string
- muted: boolean
Returns number

muteRemoteVideoStream

muteRemoteVideoStream(streamUuid: string, muted: boolean): number

Parameters
- streamUuid: string
- muted: boolean
Returns number

muteRemoteVideoStreamMass

muteRemoteVideoStreamMass(streamUuids: string[], muted: boolean): Promise<string[]>

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

removeCloudProxyObserver

removeCloudProxyObserver(observer: AgoraCloudProxyObserver): void

Parameters
- observer: AgoraCloudProxyObserver
Returns void

removeCustomMessageObserver

removeCustomMessageObserver(observer: AgoraRteCustomMessageObserver): void

Parameters
- observer: AgoraRteCustomMessageObserver
Returns void

setAllRemoteTracksVolume

setAllRemoteTracksVolume(volume: number): void

Parameters
- volume: number
Returns void

setLowStreamParameter

setLowStreamParameter(streamParameter: AGLowStreamParameter, connectionType?: AGRtcConnectionType): number

Parameters
- streamParameter: AGLowStreamParameter
- Optional connectionType: AGRtcConnectionType
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

updateRemoteMediaStreamBatch

updateRemoteMediaStreamBatch(streams: { audioSourceType?: AgoraRteAudioSourceType; audioState?: AgoraRteMediaPublishState; streamUuid: string; userUuid: string; videoSourceType?: AgoraRteVideoSourceType; videoState?: AgoraRteMediaPublishState }[]): Promise<any>

Parameters
- streams: { audioSourceType?: AgoraRteAudioSourceType; audioState?: AgoraRteMediaPublishState; streamUuid: string; userUuid: string; videoSourceType?: AgoraRteVideoSourceType; videoState?: AgoraRteMediaPublishState }[]
Returns Promise<any>