Class AgoraRteScreenShareThread

Hierarchy

AgoraRteMediaTrackThread
- AgoraRteScreenShareThread

Index

Constructors

constructor

Properties

Accessors

playing

Methods

Constructors

constructor

new AgoraRteScreenShareThread(): AgoraRteScreenShareThread

Inherited from AgoraRteMediaTrackThread.constructor
Returns AgoraRteScreenShareThread

Properties

Optional audioTrack

audioTrack?: ILocalTrack

Optional canvas

canvas?: AgoraRtcVideoCanvas

isPipedProcessors

isPipedProcessors: boolean

loopbackDeviceState

loopbackDeviceState: AgoraRteMediaSourceState

processors

processors: IBaseProcessor[]

runnable

runnable: boolean

screenEnable

screenEnable: boolean

Optional track

track?: AGMediaBaseTrack

trackState

trackState: AgoraRteMediaSourceState

withAudio

withAudio: boolean

Accessors

playing

get playing(): undefined | boolean

Returns undefined | boolean

Methods

addProcessors

addProcessors(processors: IBaseProcessor[]): void

Inherited from AgoraRteMediaTrackThread.addProcessors
Parameters
- processors: IBaseProcessor[]
Returns void

emit

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

Inherited from AgoraRteMediaTrackThread.emit
Parameters
- evt: string
- Rest ...args: any[]
Returns AgoraRteScreenShareThread

off

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

Inherited from AgoraRteMediaTrackThread.off
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraRteScreenShareThread

on

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

Inherited from AgoraRteMediaTrackThread.on
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraRteScreenShareThread

onExecution

onExecution(): Promise<void>

Overrides AgoraRteMediaTrackThread.onExecution
Returns Promise<void>

once

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

Inherited from AgoraRteMediaTrackThread.once
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraRteScreenShareThread

removeAllEventListeners

removeAllEventListeners(): void

Inherited from AgoraRteMediaTrackThread.removeAllEventListeners
Returns void

removeProcessors

removeProcessors(): void

Inherited from AgoraRteMediaTrackThread.removeProcessors
Returns void

run

run(): void

Inherited from AgoraRteMediaTrackThread.run
Returns void

setScreenShareTrackState

setScreenShareTrackState(state: AgoraRteMediaSourceState, withAudio: boolean, reason?: number): void

Parameters
- state: AgoraRteMediaSourceState
- withAudio: boolean
- Optional reason: number
Returns void

stop

stop(): void

Inherited from AgoraRteMediaTrackThread.stop
Returns void