Class AgoraMediaControl

Hierarchy

AGEventEmitter
- AgoraMediaControl

Constructors

constructor

new AgoraMediaControl(rtc: AGRtcManager): AgoraMediaControl

Overrides AGEventEmitter.constructor
Parameters
- rtc: AGRtcManager
Returns AgoraMediaControl

Accessors

camera

get camera(): undefined | AgoraRteCameraVideoTrack

Returns undefined | AgoraRteCameraVideoTrack

microphone

get microphone(): undefined | AgoraRteMicrophoneAudioTrack

Returns undefined | AgoraRteMicrophoneAudioTrack

player

get player(): undefined | AgoraRteStreamPlayer

Returns undefined | AgoraRteStreamPlayer

screen

get screen(): undefined | AgoraRteScreenShareTrack

Returns undefined | AgoraRteScreenShareTrack

Methods

createCameraVideoTrack

createCameraVideoTrack(): AgoraRteCameraVideoTrack

Returns AgoraRteCameraVideoTrack

createLoopbackDevice

createLoopbackDevice(): AgoraRteLoopbackDevice

Returns AgoraRteLoopbackDevice

createMicrophoneAudioTrack

createMicrophoneAudioTrack(): AgoraRteMicrophoneAudioTrack

Returns AgoraRteMicrophoneAudioTrack

createScreenShareTrack

createScreenShareTrack(): AgoraRteScreenShareTrack

Returns AgoraRteScreenShareTrack

createStreamMediaTrack

createStreamMediaTrack(): AgoraRteStreamMediaTrack

Returns AgoraRteStreamMediaTrack

createStreamPlayer

createStreamPlayer(): AgoraRteStreamPlayer

Returns AgoraRteStreamPlayer

emit

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

Inherited from AGEventEmitter.emit
Parameters
- evt: string
- Rest ...args: any[]
Returns AgoraMediaControl

getAudioPlaybackList

getAudioPlaybackList(): AGRtcDeviceInfo[]

Returns AGRtcDeviceInfo[]

getAudioRecordingList

getAudioRecordingList(): AGRtcDeviceInfo[]

Returns AGRtcDeviceInfo[]

getCurrentFrameData

getCurrentFrameData(channelName: string, streamUuid: string, isLocal: boolean): ImageData

Parameters
- channelName: string
- streamUuid: string
- isLocal: boolean
Returns ImageData

getDisplayDevices

getDisplayDevices(): Promise<AGScreenShareDevice[]>

Returns Promise<AGScreenShareDevice[]>

getVideoCameraList

getVideoCameraList(): AGRtcDeviceInfo[]

Returns AGRtcDeviceInfo[]

getWindowDevices

getWindowDevices(): Promise<AGScreenShareDevice[]>

Returns Promise<AGScreenShareDevice[]>

hasScreenSharePermission

hasScreenSharePermission(): boolean

Returns boolean

isScreenDeviceEnumerateSupported

isScreenDeviceEnumerateSupported(): boolean

Returns boolean

off

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

Inherited from AGEventEmitter.off
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraMediaControl

on

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

Inherited from AGEventEmitter.on
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraMediaControl

once

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

Inherited from AGEventEmitter.once
Parameters
- evt: string
- cb: CallableFunction
Returns AgoraMediaControl

removeAllEventListeners

removeAllEventListeners(): void

Inherited from AGEventEmitter.removeAllEventListeners
Returns void

setBeautyEffectOptions

setBeautyEffectOptions(enable: boolean, options: AGBeautyEffect): number

Parameters
- enable: boolean
- options: AGBeautyEffect
Returns number

startAudioPlaybackDeviceTest

startAudioPlaybackDeviceTest(url: string): number

Parameters
- url: string
Returns number

startAudioRecordingDeviceTest

startAudioRecordingDeviceTest(indicateInterval: number): number

Parameters
- indicateInterval: number
Returns number

stopAudioPlaybackDeviceTest

stopAudioPlaybackDeviceTest(): number

Returns number

stopAudioRecordingDeviceTest

stopAudioRecordingDeviceTest(): number

Returns number

takeSnapshot

takeSnapshot(channel: string, streamUuid: number, filePath: string): Promise<void | AGSnapshotInfo>

Parameters
- channel: string
- streamUuid: number
- filePath: string
Returns Promise<void | AGSnapshotInfo>