Class AgoraRteScene

Constructors

constructor

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

参数

参数名	描述
sceneId: string
options: SceneObjects

返回值

AgoraRteScene

Properties

Optional

createTs

createTs?: number

Readonly

dataStore

dataStore: AgoraRteSyncDataStore

logger

logger: LoggerFacade

Readonly

sceneId

sceneId: string

Accessors

engine

get engine(): AgoraRteEngine

localUser

get localUser(): undefined | AgoraRteLocalUser

rtcChannel

get rtcChannel(): AGRtcChannel

rtcSid

get rtcSid(): string

rtmSid

get rtmSid(): string

timestampServerLocalGap

get timestampServerLocalGap(): number

Methods

addCloudProxyObserver

addCloudProxyObserver(observer: AgoraCloudProxyObserver): void

参数

参数名	描述
observer: AgoraCloudProxyObserver

返回值

void

addCustomMessageObserver

addCustomMessageObserver(observer: AgoraRteCustomMessageObserver): void

参数

参数名	描述
observer: AgoraRteCustomMessageObserver

返回值

void

enableDualStream

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

参数

参数名	描述
enable: boolean
connectionType: AGRtcConnectionType

返回值

Promise<void>

getApiService

getApiService(): AgoraRteService

返回值

AgoraRteService

joinRTC

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

参数

参数名	描述
options: AgoraRteSceneJoinRTCOptions

返回值

Promise<void>

joinScene

joinScene(options: AgoraRteSceneJoinOptions): Promise<void>

参数

参数名	描述
options: AgoraRteSceneJoinOptions

返回值

Promise<void>

leaveRTC

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

参数

参数名	描述
connectionType: AGRtcConnectionType

返回值

Promise<void>

leaveScene

leaveScene(): Promise<void>

返回值

Promise<void>

muteRemoteAudioStream

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

参数

参数名	描述
streamUuid: string
muted: boolean

返回值

number

muteRemoteVideoStream

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

参数

参数名	描述
streamUuid: string
muted: boolean

返回值

number

muteRemoteVideoStreamMass

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

参数

参数名	描述
streamUuids: string[]
muted: boolean

返回值

Promise<string[]>

removeCloudProxyObserver

removeCloudProxyObserver(observer: AgoraCloudProxyObserver): void

参数

参数名	描述
observer: AgoraCloudProxyObserver

返回值

void

removeCustomMessageObserver

removeCustomMessageObserver(observer: AgoraRteCustomMessageObserver): void

参数

参数名	描述
observer: AgoraRteCustomMessageObserver

返回值

void

setAllRemoteTracksVolume

setAllRemoteTracksVolume(volume: number): void

参数

参数名	描述
volume: number

返回值

void

setLowStreamParameter

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

参数

参数名	描述
streamParameter: AGLowStreamParameter
connectionType: AGRtcConnectionType

返回值

number

setRemoteTrackVolume

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

参数

参数名	描述
streamUuid: string
volume: number

返回值

void

setRemoteVideoStreamType

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

参数

参数名	描述
streamUuid: string
streamType: AGRemoteVideoStreamType

返回值

number

updateRemoteMediaStreamBatch

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

参数

参数名	描述
streams: { audioSourceType?: AgoraRteAudioSourceType; audioState?: AgoraRteMediaPublishState; streamUuid: string; userUuid: string; videoSourceType?: AgoraRteVideoSourceType; videoState?: AgoraRteMediaPublishState }[]

返回值

Promise<any>