Class AGRtcManager

Hierarchy

AGRtcManager

Index

Constructors

constructor

Methods

Constructors

constructor

new AGRtcManager(configs?: AGRtcConfig): AGRtcManager

Parameters
- Optional configs: AGRtcConfig
Returns AGRtcManager

Methods

addAudioRawDataObserver

addAudioRawDataObserver(observer: AgoraRteAudioRawDataObserver, position: AgoraRteAudioRawDataPosition): number

Parameters
- observer: AgoraRteAudioRawDataObserver
- position: AgoraRteAudioRawDataPosition
Returns number

addCameraProcessors

addCameraProcessors(processors: IBaseProcessor[]): number

Parameters
- processors: IBaseProcessor[]
Returns number

addMicrophoneProcessors

addMicrophoneProcessors(processors: IBaseProcessor[]): number

Parameters
- processors: IBaseProcessor[]
Returns number

addPreviewCameraProcessors

addPreviewCameraProcessors(processors: IBaseProcessor[]): number

Parameters
- processors: IBaseProcessor[]
Returns number

addPreviewMicrophoneProcessors

addPreviewMicrophoneProcessors(processors: IBaseProcessor[]): number

Parameters
- processors: IBaseProcessor[]
Returns number

adjustLoopbackSignalVolume

adjustLoopbackSignalVolume(volume: number, connType?: AGRtcConnectionType): number

Parameters
- volume: number
- Optional connType: AGRtcConnectionType
Returns number

destroy

destroy(): number

Returns number

enableLocalAudio

enableLocalAudio(enable: boolean): number

Parameters
- enable: boolean
Returns number

enableLocalVideo

enableLocalVideo(enable: boolean): number

Parameters
- enable: boolean
Returns number

enableLoopbackRecording

enableLoopbackRecording(enable: boolean, device?: string, connType?: AGRtcConnectionType): number

Parameters
- enable: boolean
- Optional device: string
- Optional connType: AGRtcConnectionType
Returns number

enablePreviewLocalAudio

enablePreviewLocalAudio(enable: boolean): number

Parameters
- enable: boolean
Returns number

enablePreviewLocalVideo

enablePreviewLocalVideo(enable: boolean): number

Parameters
- enable: boolean
Returns number

getAudioDeviceManager

getAudioDeviceManager(): RtcAudioDeviceManagerBase

Returns RtcAudioDeviceManagerBase

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[]>

getRtcChannel

getRtcChannel(channelName: string): AGRtcChannel

Parameters
- channelName: string
Returns AGRtcChannel

getVideoDeviceManager

getVideoDeviceManager(): RtcVideoDeviceManagerBase

Returns RtcVideoDeviceManagerBase

getWindowDevices

getWindowDevices(): Promise<AGScreenShareDevice[]>

Returns Promise<AGScreenShareDevice[]>

hasScreenSharePermission

hasScreenSharePermission(): boolean

Returns boolean

isScreenDeviceEnumerateSupported

isScreenDeviceEnumerateSupported(): boolean

Returns boolean

onAutoPlayFailed

onAutoPlayFailed(cb: () => void): number

Parameters
- cb: () => void
  - - (): void
    - Returns void
Returns number

onLocalAudioTrackStateChanged

onLocalAudioTrackStateChanged(cb: LocalAudioTrackStateEvent): number

Parameters
- cb: LocalAudioTrackStateEvent
Returns number

onLocalAudioVolume

onLocalAudioVolume(cb: (volume: number) => void): number

Parameters
- cb: (volume: number) => void
  - - (volume: number): void
    - Parameters
      - volume: number
      Returns void
Returns number

onLocalCameraListChanged

onLocalCameraListChanged(cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void): number

Parameters
- cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void
  - - (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]): void
    - Parameters
      - addNewDevice: boolean
      - newDevices: AGRtcDeviceInfo[]
      - allDevices: AGRtcDeviceInfo[]
      Returns void
Returns number

onLocalLoopbackDeviceStateChanged

onLocalLoopbackDeviceStateChanged(cb: LocalLoopbackDeviceStateEvent): number

Parameters
- cb: LocalLoopbackDeviceStateEvent
Returns number

onLocalPlaybackListChanged

onLocalPlaybackListChanged(cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void): number

Parameters
- cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void
  - - (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]): void
    - Parameters
      - addNewDevice: boolean
      - newDevices: AGRtcDeviceInfo[]
      - allDevices: AGRtcDeviceInfo[]
      Returns void
Returns number

onLocalRecordingDeviceListChanged

onLocalRecordingDeviceListChanged(cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void): number

Parameters
- cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void
  - - (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]): void
    - Parameters
      - addNewDevice: boolean
      - newDevices: AGRtcDeviceInfo[]
      - allDevices: AGRtcDeviceInfo[]
      Returns void
Returns number

onLocalScreenShareTrackStateChanged

onLocalScreenShareTrackStateChanged(cb: LocalVideoTrackStateEvent): number

Parameters
- cb: LocalVideoTrackStateEvent
Returns number

onLocalVideoTrackStateChanged

onLocalVideoTrackStateChanged(cb: LocalVideoTrackStateEvent): number

Parameters
- cb: LocalVideoTrackStateEvent
Returns number

removeAudioRawDataObserver

removeAudioRawDataObserver(observer: AgoraRteAudioRawDataObserver, position: AgoraRteAudioRawDataPosition): number

Parameters
- observer: AgoraRteAudioRawDataObserver
- position: AgoraRteAudioRawDataPosition
Returns number

removeCameraProcessors

removeCameraProcessors(): number

Returns number

removeMicrophoneProcessors

removeMicrophoneProcessors(): number

Returns number

removePreviewCameraProcessors

removePreviewCameraProcessors(): number

Returns number

removePreviewMicrophoneProcessors

removePreviewMicrophoneProcessors(): number

Returns number

setAudioPlaybackDevice

setAudioPlaybackDevice(deviceId: string): number

Parameters
- deviceId: string
Returns number

setAudioRawDataConfig

setAudioRawDataConfig(config: AgoraRteAudioRawDataConfig, position: AgoraRteAudioRawDataPosition): number

Parameters
- config: AgoraRteAudioRawDataConfig
- position: AgoraRteAudioRawDataPosition
Returns number

setAudioRecordingDevice

setAudioRecordingDevice(deviceId: string): number

Parameters
- deviceId: string
Returns number

setBeautyEffectOptions

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

Parameters
- enable: boolean
- options: AGBeautyEffect
Returns number

setVideoCameraDevice

setVideoCameraDevice(deviceId: string): number

Parameters
- deviceId: string
Returns number

setupLocalVideo

setupLocalVideo(canvas: AgoraRtcVideoCanvas, videoSourceType: AgoraRteVideoSourceType): number

Parameters
- canvas: AgoraRtcVideoCanvas
- videoSourceType: AgoraRteVideoSourceType
Returns number

setupPreviewLocalVideo

setupPreviewLocalVideo(canvas: AgoraRtcVideoCanvas): number

Parameters
- canvas: AgoraRtcVideoCanvas
Returns number

setupRemoteVideo

setupRemoteVideo(canvas: AgoraRtcVideoCanvas): number

Parameters
- canvas: AgoraRtcVideoCanvas
Returns number

startAudioPlaybackDeviceTest

startAudioPlaybackDeviceTest(url: string): number

Parameters
- url: string
Returns number

startAudioRecordingDeviceTest

startAudioRecordingDeviceTest(indicateInterval: number): number

Parameters
- indicateInterval: number
Returns number

startScreenCapture

startScreenCapture(params?: { audioDeviceName?: string; id?: string; type?: AGScreenShareType; withAudio?: boolean }): number

Parameters
- Optional params: { audioDeviceName?: string; id?: string; type?: AGScreenShareType; withAudio?: boolean }
  - Optional audioDeviceName?: string
  - Optional id?: string
  - Optional type?: AGScreenShareType
  - Optional withAudio?: boolean
Returns number

stopAudioPlaybackDeviceTest

stopAudioPlaybackDeviceTest(): number

Returns number

stopAudioRecordingDeviceTest

stopAudioRecordingDeviceTest(): number

Returns number

stopScreenCapture

stopScreenCapture(): 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>