Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RtcAdapterWeb

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly cameraThread

cameraThread: AgoraRteCameraThread

logger

logger: LoggerFacade

Readonly micThread

micThread: AgoraRteMicrophoneThread

Readonly previewCameraThread

previewCameraThread: AgoraRtePreviewCameraThread

Readonly previewMicThread

previewMicThread: AgoraRtePreviewMicrophoneThread

Readonly remoteCanvas

remoteCanvas: Map<string, AgoraRtcVideoCanvas>

Readonly screenThread

screenThread: AgoraRteScreenShareThread

Static defaultConfigs

defaultConfigs: RtcAdapterWebConfig

Accessors

audioPlaybackDeviceId

  • get audioPlaybackDeviceId(): undefined | string

  • Returns undefined | string

channelProfile

configs

  • get configs(): { codec: SDK_CODEC; latencyLevel: AudienceLatencyLevelType; mode: SDK_MODE }

  • Returns { codec: SDK_CODEC; latencyLevel: AudienceLatencyLevelType; mode: SDK_MODE }

    • codec: SDK_CODEC
    • latencyLevel: AudienceLatencyLevelType
    • mode: SDK_MODE

Methods

addAudioRawDataObserver

addCameraProcessors

  • addCameraProcessors(processors: IBaseProcessor[]): number

addMicrophoneProcessors

  • addMicrophoneProcessors(processors: IBaseProcessor[]): number

addPreviewCameraProcessors

  • addPreviewCameraProcessors(processors: IBaseProcessor[]): number

addPreviewMicrophoneProcessors

  • addPreviewMicrophoneProcessors(processors: IBaseProcessor[]): number

adjustLoopbackSignalVolume

  • adjustLoopbackSignalVolume(volume: number): number

createRtcChannel

destroy

  • destroy(): number

emit

enableLocalAudio

  • enableLocalAudio(enable: boolean): number

enableLocalVideo

  • enableLocalVideo(enable: boolean): number

enableLoopbackRecording

  • enableLoopbackRecording(enable: boolean, device?: string): 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(cb: () => void): number

onLocalAudioPlaybackTestVolumeChanged

onLocalAudioTrackStateChanged

onLocalAudioVolume

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

onLocalLoopbackDeviceStateChanged

onLocalPreviewAudioTrackStateChanged

onLocalPreviewAudioVolume

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

  • Parameters

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

        • Parameters

          • volume: number

          Returns void

    Returns number

onLocalPreviewVideoTrackStateChanged

onLocalScreenShareTrackStateChanged

onLocalVideoTrackStateChanged

once

removeAllEventListeners

  • removeAllEventListeners(): void

removeAudioRawDataObserver

removeCameraProcessors

  • removeCameraProcessors(): number

removeMicrophoneProcessors

  • removeMicrophoneProcessors(): number

removePreviewCameraProcessors

  • removePreviewCameraProcessors(): number

removePreviewMicrophoneProcessors

  • removePreviewMicrophoneProcessors(): number

setAudioFrameCallback

  • setAudioFrameCallback(): number

  • Returns number

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?: { withAudio?: boolean }): number

stopAudioFrameCallback

  • stopAudioFrameCallback(): number

  • Returns number

stopAudioPlaybackDeviceTest

  • stopAudioPlaybackDeviceTest(): number

stopAudioRecordingDeviceTest

  • stopAudioRecordingDeviceTest(): number

stopScreenCapture

  • stopScreenCapture(): number

takeSnapshot

  • takeSnapshot(channelName: string, streamUuid: number, filePath: string): Promise<never>

Static getLogLevel

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

  • Returns 0 | 1 | 2 | 4 | 3

Static getRtcVersion

  • getRtcVersion(): string