Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Methods

Abstract addAudioRawDataObserver

Abstract addCameraProcessors

  • addCameraProcessors(processor: IBaseProcessor[]): number
  • Parameters

    • processor: IBaseProcessor[]

    Returns number

Abstract addMicrophoneProcessors

  • addMicrophoneProcessors(processor: IBaseProcessor[]): number
  • Parameters

    • processor: IBaseProcessor[]

    Returns number

Abstract addPreviewCameraProcessors

  • addPreviewCameraProcessors(processor: IBaseProcessor[]): number
  • Parameters

    • processor: IBaseProcessor[]

    Returns number

Abstract addPreviewMicrophoneProcessors

  • addPreviewMicrophoneProcessors(processor: IBaseProcessor[]): number
  • Parameters

    • processor: IBaseProcessor[]

    Returns number

Abstract adjustLoopbackSignalVolume

Abstract createRtcChannel

Abstract destroy

  • destroy(): number
  • Returns number

emit

Abstract enableLocalAudio

  • enableLocalAudio(enable: boolean): number
  • Parameters

    • enable: boolean

    Returns number

Abstract enableLocalVideo

  • enableLocalVideo(enable: boolean): number
  • Parameters

    • enable: boolean

    Returns number

Abstract enableLoopbackRecording

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

    Returns number

Abstract enablePreviewLocalAudio

  • enablePreviewLocalAudio(enable: boolean): number
  • Parameters

    • enable: boolean

    Returns number

Abstract enablePreviewLocalVideo

  • enablePreviewLocalVideo(enable: boolean): number
  • Parameters

    • enable: boolean

    Returns number

Abstract getAudioDeviceManager

Abstract getCurrentFrameData

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

    • channelName: string
    • streamUuid: string
    • isLocal: boolean

    Returns ImageData

Abstract getDiaplayDevices

Abstract getVideoDeviceManager

Abstract getWindowDevices

Abstract hasScreenSharePermission

  • hasScreenSharePermission(): boolean
  • Returns boolean

Abstract isScreenDeviceEnumerateSupported

  • isScreenDeviceEnumerateSupported(): boolean
  • Returns boolean

off

on

Abstract onAutoplayFailed

  • onAutoplayFailed(cb: () => void): number
  • Parameters

    • cb: () => void
        • (): void
        • Returns void

    Returns number

Abstract onLocalAudioPlaybackTestVolumeChanged

Abstract onLocalAudioTrackStateChanged

Abstract onLocalAudioVolume

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

    • cb: (volume: number) => void
        • (volume: number): void
        • Parameters

          • volume: number

          Returns void

    Returns number

Abstract onLocalLoopbackDeviceStateChanged

Abstract onLocalScreenShareTrackStateChanged

Abstract onLocalVideoTrackStateChanged

once

removeAllEventListeners

  • removeAllEventListeners(): void

Abstract removeAudioRawDataObserver

Abstract removeCameraProcessors

  • removeCameraProcessors(): number
  • Returns number

Abstract removeMicrophoneProcessors

  • removeMicrophoneProcessors(): number
  • Returns number

Abstract removePreviewCameraProcessors

  • removePreviewCameraProcessors(): number
  • Returns number

Abstract removePreviewMicrophoneProcessors

  • removePreviewMicrophoneProcessors(): number
  • Returns number

Abstract setAudioPlaybackDevice

  • setAudioPlaybackDevice(deviceId: string): number
  • Parameters

    • deviceId: string

    Returns number

Abstract setAudioRawDataConfig

Abstract setAudioRecordingDevice

  • setAudioRecordingDevice(deviceId: string): number
  • Parameters

    • deviceId: string

    Returns number

Abstract setBeautyEffectOptions

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

Abstract setVideoCameraDevice

  • setVideoCameraDevice(deviceId: string): number
  • Parameters

    • deviceId: string

    Returns number

Abstract setupLocalVideo

Abstract setupPreviewLocalVideo

Abstract setupRemoteVideo

Abstract startAudioPlaybackDeviceTest

  • startAudioPlaybackDeviceTest(url: string): number
  • Parameters

    • url: string

    Returns number

Abstract startAudioRecordingDeviceTest

  • startAudioRecordingDeviceTest(indicateInterval: number): number
  • Parameters

    • indicateInterval: number

    Returns number

Abstract 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

Abstract stopAudioPlaybackDeviceTest

  • stopAudioPlaybackDeviceTest(): number
  • Returns number

Abstract stopAudioRecordingDeviceTest

  • stopAudioRecordingDeviceTest(): number
  • Returns number

Abstract stopScreenCapture

  • stopScreenCapture(): number
  • Returns number

Abstract takeSnapshot

  • takeSnapshot(channelName: string, streamUuid: number, filePath: string): Promise<void | AGSnapshotInfo>
  • Parameters

    • channelName: string
    • streamUuid: number
    • filePath: string

    Returns Promise<void | AGSnapshotInfo>

Static getRtcVersion

  • getRtcVersion(): string
  • Returns string