Class AgoraRteLocalUser

Constructors

constructor

new AgoraRteLocalUser(scene: AgoraRteScene, __namedParameters: { rtc: AGRtcManager; rtcToken: string; sceneId: string; streamUuid: string; userName: string; userProperties: any; userRole: string; userUuid: string }): AgoraRteLocalUser

参数

参数名	描述
scene: AgoraRteScene
__namedParameters: { rtc: AGRtcManager; rtcToken: string; sceneId: string; streamUuid: string; userName: string; userProperties: any; userRole: string; userUuid: string }	rtc: AGRtcManager rtcToken: string sceneId: string streamUuid: string userName: string userProperties: any userRole: string userUuid: string

返回值

AgoraRteLocalUser

Properties

logger

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

Readonly

rtcToken

rtcToken: string

Readonly

sceneId

sceneId: string

Readonly

streamUuid

streamUuid: string

Optional

subStream

subStream?: { streamUuid: string }

Readonly

userName

userName: string

Readonly

userProperties

userProperties: any

Readonly

userRole

userRole: string

Readonly

userUuid

userUuid: string

Methods

deleteLocalMediaStream

deleteLocalMediaStream(): Promise<any>

返回值

Promise<any>

deleteLocalScreenStream

deleteLocalScreenStream(): Promise<any>

返回值

Promise<any>

deleteSceneProperties

deleteSceneProperties(properties: string[], cause: any): Promise<any>

参数

参数名	描述
properties: string[]
cause: any

返回值

Promise<any>

deleteUserProperties

deleteUserProperties(properties: string[], cause: any): Promise<any>

参数

参数名	描述
properties: string[]
cause: any

返回值

Promise<any>

destroy

destroy(): void

返回值

void

publishStreamToCdn

publishStreamToCdn(videoEncoderConfg?: AGVideoEncoderConfigurations): Promise<any>

参数

参数名	描述
videoEncoderConfg: AGVideoEncoderConfigurations

返回值

Promise<any>

sendCustomChannelMessage

sendCustomChannelMessage(cmd: string, data: Record<string, any>, sync?: boolean): Promise<any>

参数

参数名	描述
cmd: string
data: Record<string, any>
sync: boolean

返回值

Promise<any>

sendCustomPeerMessage

sendCustomPeerMessage(cmd: string, data: Record<string, any>, toUserUuid: string, ack?: boolean): Promise<any>

参数

参数名	描述
cmd: string
data: Record<string, any>
toUserUuid: string
ack: boolean

返回值

Promise<any>

sendRoomMessage

sendRoomMessage(message: string): Promise<any>

参数

参数名	描述
message: string

返回值

Promise<any>

setSceneProperties

setSceneProperties(properties: any, cause: any): Promise<any>

参数

参数名	描述
properties: any
cause: any

返回值

Promise<any>

setUserProperties

setUserProperties(properties: any, cause: any): Promise<any>

参数

参数名	描述
properties: any
cause: any

返回值

Promise<any>

setupRemoteVideo

setupRemoteVideo(canvas: AgoraRtcVideoCanvas): void

参数

参数名	描述
canvas: AgoraRtcVideoCanvas

返回值

void

toData

toData(): AgoraUser

返回值

AgoraUser

updateLocalMediaState

updateLocalMediaState(__namedParameters: { audioSourceState?: AgoraRteMediaSourceState; videoSourceState?: AgoraRteMediaSourceState }, connectionType?: AGRtcConnectionType): Promise<any>

参数

参数名	描述
__namedParameters: { audioSourceState?: AgoraRteMediaSourceState; videoSourceState?: AgoraRteMediaSourceState }	Optional audioSourceState?: AgoraRteMediaSourceState Optional videoSourceState?: AgoraRteMediaSourceState
connectionType: AGRtcConnectionType

返回值

Promise<any>

updateLocalMediaStream

updateLocalMediaStream(__namedParameters: { audioSourceType?: AgoraRteAudioSourceType; publishAudio?: AgoraRteMediaPublishState; publishVideo?: AgoraRteMediaPublishState; videoSourceType?: AgoraRteVideoSourceType }, connectionType?: AGRtcConnectionType): Promise<any>

参数

参数名	描述
__namedParameters: { audioSourceType?: AgoraRteAudioSourceType; publishAudio?: AgoraRteMediaPublishState; publishVideo?: AgoraRteMediaPublishState; videoSourceType?: AgoraRteVideoSourceType }	Optional audioSourceType?: AgoraRteAudioSourceType Optional publishAudio?: AgoraRteMediaPublishState Optional publishVideo?: AgoraRteMediaPublishState Optional videoSourceType?: AgoraRteVideoSourceType
connectionType: AGRtcConnectionType

返回值

Promise<any>

updateRemoteMediaStream

updateRemoteMediaStream(userUuid: string, streamUuid: string, __namedParameters: { publishAudio?: AgoraRteMediaPublishState; publishVideo?: AgoraRteMediaPublishState }, connectionType?: AGRtcConnectionType): Promise<any>

参数

参数名	描述
userUuid: string
streamUuid: string
__namedParameters: { publishAudio?: AgoraRteMediaPublishState; publishVideo?: AgoraRteMediaPublishState }	Optional publishAudio?: AgoraRteMediaPublishState Optional publishVideo?: AgoraRteMediaPublishState
connectionType: AGRtcConnectionType

返回值

Promise<any>