Class AgoraRteLocalUser

Hierarchy

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

Parameters
- 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
Returns 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 }

Type declaration

streamUuid: string

Readonly userName

userName: string

Readonly userProperties

userProperties: any

Readonly userRole

userRole: string

Readonly userUuid

userUuid: string

Methods

deleteLocalMediaStream

deleteLocalMediaStream(): Promise<any>

Returns Promise<any>

deleteLocalScreenStream

deleteLocalScreenStream(): Promise<any>

Returns Promise<any>

deleteSceneProperties

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

Parameters
- properties: string[]
- cause: any
Returns Promise<any>

deleteUserProperties

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

Parameters
- properties: string[]
- cause: any
Returns Promise<any>

destroy

destroy(): void

Returns void

publishStreamToCdn

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

Parameters
- Optional videoEncoderConfg: AGVideoEncoderConfigurations
Returns Promise<any>

sendCustomChannelMessage

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

Parameters
- cmd: string
- data: Record<string, any>
- Optional sync: boolean
Returns Promise<any>

sendCustomPeerMessage

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

Parameters
- cmd: string
- data: Record<string, any>
- toUserUuid: string
- Optional ack: boolean
Returns Promise<any>

sendRoomMessage

sendRoomMessage(message: string): Promise<any>

Parameters
- message: string
Returns Promise<any>

setSceneProperties

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

Parameters
- properties: any
- cause: any
Returns Promise<any>

setUserProperties

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

Parameters
- properties: any
- cause: any
Returns Promise<any>

setupRemoteVideo

setupRemoteVideo(canvas: AgoraRtcVideoCanvas): void

Parameters
- canvas: AgoraRtcVideoCanvas
Returns void

toData

toData(): AgoraUser

Returns AgoraUser

updateLocalMediaState

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

Parameters
- __namedParameters: { audioSourceState?: AgoraRteMediaSourceState; videoSourceState?: AgoraRteMediaSourceState }
  - Optional audioSourceState?: AgoraRteMediaSourceState
  - Optional videoSourceState?: AgoraRteMediaSourceState
- Optional connectionType: AGRtcConnectionType
Returns Promise<any>

updateLocalMediaStream

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

Parameters
- __namedParameters: { audioSourceType?: AgoraRteAudioSourceType; publishAudio?: AgoraRteMediaPublishState; publishVideo?: AgoraRteMediaPublishState; videoSourceType?: AgoraRteVideoSourceType }
  - Optional audioSourceType?: AgoraRteAudioSourceType
  - Optional publishAudio?: AgoraRteMediaPublishState
  - Optional publishVideo?: AgoraRteMediaPublishState
  - Optional videoSourceType?: AgoraRteVideoSourceType
- Optional connectionType: AGRtcConnectionType
Returns Promise<any>

updateRemoteMediaStream

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

Parameters
- userUuid: string
- streamUuid: string
- __namedParameters: { publishAudio?: AgoraRteMediaPublishState; publishVideo?: AgoraRteMediaPublishState }
  - Optional publishAudio?: AgoraRteMediaPublishState
  - Optional publishVideo?: AgoraRteMediaPublishState
- Optional connectionType: AGRtcConnectionType
Returns Promise<any>