Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RtcAdapterElectron

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

cameraThread

cameraThread: AgoraRteElectronCameraThread

logger

logger: "agora-rte-sdk/src/core/logger/type".Logger

Optional screenShareId

screenShareId?: string

Optional screenShareType

screenShareType?: AGScreenShareType

Optional screenShareWithAudio

screenShareWithAudio?: boolean

Static rtcEngine

rtcEngine: AgoraRtcEngine

Accessors

channelProfile

configs

  • get configs(): {}

  • Returns {}

    latencyLevel

    • get latencyLevel(): AUDIENCE_LATENCY_LEVEL_TYPE

    • Returns AUDIENCE_LATENCY_LEVEL_TYPE

    rtcEngine

    • get rtcEngine(): AgoraRtcEngine

    • Returns AgoraRtcEngine

    Static addonLogPath

    • get addonLogPath(): any

    • Returns any

    Static logBasePath

    • get logBasePath(): any

    • Returns any

    Static logFolderPath

    • get logFolderPath(): any

    • Returns any

    Static logPath

    • get logPath(): any

    • Returns any

    Static remote

    • get remote(): any

    • Returns any

    Static vsAddonLogPath

    • get vsAddonLogPath(): any

    • Returns any

    Methods

    addAudioRawDataObserver

    addCameraProcessors

    • addCameraProcessors(_processors: unknown[]): number

    addMicrophoneProcessors

    • addMicrophoneProcessors(_processors: unknown[]): number

    addPreviewCameraProcessors

    • addPreviewCameraProcessors(processor: unknown[]): number

    addPreviewMicrophoneProcessors

    • addPreviewMicrophoneProcessors(processor: unknown[]): number

    adjustLoopbackSignalVolume

    createRtcChannel

    destroy

    • destroy(): number

    emit

    enableLocalAudio

    • enableLocalAudio(enable: boolean): number

    enableLocalAudioStream

    • enableLocalAudioStream(enable: boolean): number

    • Parameters

      • enable: boolean

      Returns number

    enableLocalVideo

    • enableLocalVideo(enable: boolean): number

    enableLocalVideoStream

    • enableLocalVideoStream(enable: boolean): void

    • Parameters

      • enable: boolean

      Returns void

    enableLoopbackRecording

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

    enablePreviewLocalAudio

    • enablePreviewLocalAudio(enable: boolean): number

    enablePreviewLocalVideo

    • enablePreviewLocalVideo(enable: boolean): number

    getAudioDeviceManager

    getCurrentFrameData

    • getCurrentFrameData(_channelName: string, _streamUuid: string, _isLocal: boolean): ImageData

    getDiaplayDevices

    getVideoDeviceManager

    getWindowDevices

    hasScreenSharePermission

    • hasScreenSharePermission(): boolean

    isScreenDeviceEnumerateSupported

    • isScreenDeviceEnumerateSupported(): boolean

    off

    on

    onAutoplayFailed

    • onAutoplayFailed(): number

    onLocalAudioPlaybackTestVolumeChanged

    onLocalAudioTrackStateChanged

    onLocalAudioVolume

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

    onLocalLoopbackDeviceStateChanged

    onLocalScreenShareTrackStateChanged

    onLocalVideoTrackStateChanged

    once

    removeAllEventListeners

    • removeAllEventListeners(): void

    removeAudioRawDataObserver

    removeCameraProcessors

    • removeCameraProcessors(): number

    removeMicrophoneProcessors

    • removeMicrophoneProcessors(): number

    removePreviewCameraProcessors

    • removePreviewCameraProcessors(): number

    removePreviewMicrophoneProcessors

    • removePreviewMicrophoneProcessors(): number

    restoreAVState

    • restoreAVState(): void

    • Returns void

    setAudioPlaybackDevice

    • setAudioPlaybackDevice(deviceId: string): number

    setAudioRawDataConfig

    setAudioRecordingDevice

    • setAudioRecordingDevice(deviceId: string): number

    setBeautyEffectOptions

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

    setVideoCameraDevice

    • setVideoCameraDevice(deviceId: string): number

    setupLocalVideo

    setupPreviewLocalVideo

    setupRemoteVideo

    startAudioPlaybackDeviceTest

    • startAudioPlaybackDeviceTest(url: string): number

    startAudioRecordingDeviceTest

    • startAudioRecordingDeviceTest(indicateInterval: number): number

    startScreenCapture

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

    stopAudioPlaybackDeviceTest

    • stopAudioPlaybackDeviceTest(): number

    stopAudioRecordingDeviceTest

    • stopAudioRecordingDeviceTest(): number

    stopScreenCapture

    • stopScreenCapture(): number

    takeSnapshot

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

    Static getLogLevel

    • getLogLevel(): 0 | 1 | 2 | 4

    • Returns 0 | 1 | 2 | 4

    Static getRtcVersion

    • getRtcVersion(): string