Electron SDK API Reference

path(): unknown

enumeratePlaybackDevices(): AudioDeviceInfo[]
enumerateRecordingDevices(): AudioDeviceInfo[]
followSystemLoopbackDevice(enable: boolean): number
followSystemPlaybackDevice(enable: boolean): number
followSystemRecordingDevice(enable: boolean): number
getLoopbackDevice(): string
getPlaybackDefaultDevice(): AudioDeviceInfo
getPlaybackDevice(): string
getPlaybackDeviceInfo(): AudioDeviceInfo
getPlaybackDeviceMute(): boolean
getPlaybackDeviceVolume(): number
getRecordingDefaultDevice(): AudioDeviceInfo
getRecordingDevice(): string
getRecordingDeviceInfo(): AudioDeviceInfo
getRecordingDeviceMute(): boolean
getRecordingDeviceVolume(): number
release(): void
setLoopbackDevice(deviceId: string): number
setPlaybackDevice(deviceId: string): number
setPlaybackDeviceMute(mute: boolean): number
setPlaybackDeviceVolume(volume: number): number
setRecordingDevice(deviceId: string): number
setRecordingDeviceMute(mute: boolean): number
setRecordingDeviceVolume(volume: number): number
startAudioDeviceLoopbackTest(indicationInterval: number): number
startPlaybackDeviceTest(testAudioFilePath: string): number
startRecordingDeviceTest(indicationInterval: number): number
stopAudioDeviceLoopbackTest(): number
stopPlaybackDeviceTest(): number
stopRecordingDeviceTest(): number

onMixedAudioEncodedFrame(frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onPlaybackAudioEncodedFrame(frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onRecordAudioEncodedFrame(frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo): void

onPlaybackAudioFrameBeforeMixing(channelId: string, uid: number, audioFrame: AudioFrame): void

onEarMonitoringAudioFrame(audioFrame: AudioFrame): void
onMixedAudioFrame(channelId: string, audioFrame: AudioFrame): void
onPlaybackAudioFrame(channelId: string, audioFrame: AudioFrame): void
onRecordAudioFrame(channelId: string, audioFrame: AudioFrame): void

onFrame(frame: AudioPcmFrame): void

onLocalAudioSpectrum(data: AudioSpectrumData): void
onRemoteAudioSpectrum(spectrums: UserAudioSpectrumInfo[], spectrumNumber: number): void

muteAllRemoteAudioStreams(mute: boolean): number
muteLocalAudioStream(mute: boolean): number
muteRemoteAudioStream(uid: number, mute: boolean): number
release(): void
setAudioRecvRange(range: number): number
setDistanceUnit(unit: number): number
setMaxAudioRecvCount(maxCount: number): number
setPlayerAttenuation(playerId: number, attenuation: number, forceSet: boolean): number
setZones(zones: SpatialAudioZone, zoneCount: number): number
updatePlayerPositionInfo(playerId: number, positionInfo: RemoteVoicePositionInfo): number
updateSelfPosition(position: number[], axisForward: number[], axisRight: number[], axisUp: number[]): number

clearRemotePositions(): number
initialize(): number
removeRemotePosition(uid: number): number
setRemoteAudioAttenuation(uid: number, attenuation: number, forceSet: boolean): number
updateRemotePosition(uid: number, posInfo: RemoteVoicePositionInfo): number

addListener(eventType: EventType, listener: IMediaEngineEvent[EventType]): void
createCustomAudioTrack(trackType: AudioTrackType, config: AudioTrackConfig): number
destroyCustomAudioTrack(trackId: number): number
pullAudioFrame(): AudioFrame
pushAudioFrame(frame: AudioFrame, trackId?: number): number
pushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: number): number
registerAudioFrameObserver(observer: IAudioFrameObserver): number
registerFaceInfoObserver(observer: IFaceInfoObserver): number
registerVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number
registerVideoFrameObserver(observer: IVideoFrameObserver): number
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IMediaEngineEvent[EventType]): void
setExternalAudioSink(enabled: boolean, sampleRate: number, channels: number): number
setExternalAudioSource(enabled: boolean, sampleRate: number, channels: number, localPlayback?: boolean, publish?: boolean): number
setExternalVideoSource(enabled: boolean, useTexture: boolean, sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions): number
unregisterAudioFrameObserver(observer: IAudioFrameObserver): number
unregisterFaceInfoObserver(observer: IFaceInfoObserver): number
unregisterVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number
unregisterVideoFrameObserver(observer: IVideoFrameObserver): number

addListener(eventType: EventType, listener: IMediaPlayerEvent[EventType]): void
adjustPlayoutVolume(volume: number): number
adjustPublishSignalVolume(volume: number): number
getAudioBufferDelay(): number
getDuration(): number
getMediaPlayerId(): number
getMute(): boolean
getPlayPosition(): number
getPlaySrc(): string
getPlayoutVolume(): number
getPublishSignalVolume(): number
getState(): MediaPlayerState
getStreamCount(): number
getStreamInfo(index: number): PlayerStreamInfo
mute(muted: boolean): number
open(url: string, startPos: number): number
openWithMediaSource(source: MediaSource): number
pause(): number
play(): number
playPreloadedSrc(src: string): number
preloadSrc(src: string, startPos: number): number
registerAudioFrameObserver(observer: IAudioPcmFrameSink, mode?: RawAudioFrameOpModeType): number
registerPlayerSourceObserver(observer: IMediaPlayerSourceObserver): number
registerVideoFrameObserver(observer: IMediaPlayerVideoFrameObserver): number
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IMediaPlayerEvent[EventType]): void
resume(): number
seek(newPos: number): number
selectAudioTrack(index: number): number
selectMultiAudioTrack(playoutTrackIndex: number, publishTrackIndex: number): number
setAudioDualMonoMode(mode: AudioDualMonoMode): number
setAudioPitch(pitch: number): number
setLoopCount(loopCount: number): number
setPlaybackSpeed(speed: number): number
setPlayerOptionInInt(key: string, value: number): number
setPlayerOptionInString(key: string, value: string): number
setRenderMode(renderMode: RenderModeType): number
setSpatialAudioParams(params: SpatialAudioParams): number
setView(view: any): number
stop(): number
switchSrc(src: string, syncPts?: boolean): number
unloadSrc(src: string): number
unregisterAudioFrameObserver(observer: IAudioPcmFrameSink): number
unregisterPlayerSourceObserver(observer: IMediaPlayerSourceObserver): number
unregisterVideoFrameObserver(observer: IMediaPlayerVideoFrameObserver): number

enableAutoRemoveCache(enable: boolean): number
getCacheDir(length: number): string
getCacheFileCount(): number
getMaxCacheFileCount(): number
getMaxCacheFileSize(): number
getMediaPlayerCacheManager(): IMediaPlayerCacheManager
removeAllCaches(): number
removeCacheByUri(uri: string): number
removeOldCache(): number
setCacheDir(path: string): number
setMaxCacheFileCount(count: number): number
setMaxCacheFileSize(cacheSize: number): number

onAudioVolumeIndication(volume: number): void
onMetaData(data: Uint8Array, length: number): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: MediaPlayerEvent, elapsedTime: number, message: string): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSourceStateChanged(state: MediaPlayerState, reason: MediaPlayerReason): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPositionChanged(positionMs: number, timestampMs: number): void
onPreloadEvent(src: string, event: PlayerPreloadEvent): void

onFrame(frame: VideoFrame): void

addListener(eventType: EventType, listener: IMediaRecorderEvent[EventType]): void
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IMediaRecorderEvent[EventType]): void
setMediaRecorderObserver(callback: IMediaRecorderObserver): number
startRecording(config: MediaRecorderConfiguration): number
stopRecording(): number

onRecorderInfoUpdated(channelId: string, uid: number, info: RecorderInfo): void
onRecorderStateChanged(channelId: string, uid: number, state: RecorderState, reason: RecorderReasonCode): void

onMetadataReceived(metadata: Metadata): void

Preload(songCode: number): string
createMusicPlayer(): IMusicPlayer
destroyMusicPlayer(musicPlayer: IMusicPlayer): number
getCaches(): { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number }
getInternalSongCode(songCode: number, jsonOption: string): number
getLyric(songCode: number, lyricType?: number): string
getMusicCharts(): string
getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string
getSongSimpleInfo(songCode: number): string
initialize(configuration: MusicContentCenterConfiguration): number
isPreloaded(songCode: number): number
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number
release(): void
removeCache(songCode: number): number
renewToken(token: string): number
searchMusic(requestId: string, keyWord: string, page: number, pageSize: number, jsonOption?: string): number
unregisterEventHandler(): number

onLyricResult(requestId: string, songCode: number, lyricUrl: string, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: string, result: MusicChartInfo[], reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: string, result: MusicCollection, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: string, songCode: number, percent: number, lyricUrl: string, status: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: string, songCode: number, simpleInfo: string, reason: MusicContentCenterStateReason): void

openWithSongCode(songCode: number, startPos?: number): number
setPlayMode(mode: MusicPlayMode): number

addListener(eventType: EventType, listener: IRtcEngineEvent[EventType]): void
addVideoWatermark(watermarkUrl: string, options: WatermarkOptions): number
addVideoWatermarkWithConfig(configs: WatermarkConfig): number
adjustAudioMixingPlayoutVolume(volume: number): number
adjustAudioMixingPublishVolume(volume: number): number
adjustAudioMixingVolume(volume: number): number
adjustCustomAudioPlayoutVolume(trackId: number, volume: number): number
adjustCustomAudioPublishVolume(trackId: number, volume: number): number
adjustLoopbackSignalVolume(volume: number): number
adjustPlaybackSignalVolume(volume: number): number
adjustRecordingSignalVolume(volume: number): number
adjustUserPlaybackSignalVolume(uid: number, volume: number): number
clearVideoWatermarks(): number
complain(callId: string, description: string): number
configRhythmPlayer(config: AgoraRhythmPlayerConfig): number
createAgoraRtcEngine(): IRtcEngineEx
createCustomVideoTrack(): number
createDataStream(config: DataStreamConfig): number
createMediaPlayer(): IMediaPlayer
createMediaRecorder(info: RecorderStreamInfo): IMediaRecorder
createVideoEffectObject(bundlePath: string, type?: MediaSourceType): IVideoEffectObject
destroyCustomVideoTrack(videoTrackId: number): number
destroyMediaPlayer(mediaPlayer: IMediaPlayer): number
destroyMediaRecorder(mediaRecorder: IMediaRecorder): number
destroyRendererByConfig(sourceType: VideoSourceType, channelId?: string, uid?: number): void
destroyRendererByView(view: any): void
destroyVideoEffectObject(videoEffectObject: IVideoEffectObject): number
disableAudio(): number
disableAudioSpectrumMonitor(): number
disableVideo(): number
enableAudio(): number
enableAudioSpectrumMonitor(intervalInMS?: number): number
enableAudioVolumeIndication(interval: number, smooth: number, reportVad: boolean): number
enableCameraCenterStage(enabled: boolean): number
enableContentInspect(enabled: boolean, config: ContentInspectConfig): number
enableCustomAudioLocalPlayback(trackId: number, enabled: boolean): number
enableDualStreamMode(enabled: boolean, streamConfig?: SimulcastStreamConfig): number
enableEncryption(enabled: boolean, config: EncryptionConfig): number
enableExtension(provider: string, extension: string, enable?: boolean, type?: MediaSourceType): number
enableInEarMonitoring(enabled: boolean, includeAudioFilters: EarMonitoringFilterType): number
enableInstantMediaRendering(): number
enableLocalAudio(enabled: boolean): number
enableLocalVideo(enabled: boolean): number
enableLoopbackRecording(enabled: boolean, deviceName?: string): number
enableSoundPositionIndication(enabled: boolean): number
enableSpatialAudio(enabled: boolean): number
enableVideo(): number
enableVideoImageSource(enable: boolean, options: ImageTrackOptions): number
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MediaSourceType): number
enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number
enableWebSdkInteroperability(enabled: boolean): number
getAudioDeviceManager(): IAudioDeviceManager
getAudioMixingCurrentPosition(): number
getAudioMixingDuration(): number
getAudioMixingPlayoutVolume(): number
getAudioMixingPublishVolume(): number
getAudioTrackCount(): number
getCallId(): string
getConnectionState(): ConnectionStateType
getCurrentMonotonicTimeInMs(): number
getEffectCurrentPosition(soundId: number): number
getEffectDuration(filePath: string): number
getEffectsVolume(): number
getErrorDescription(code: number): string
getExtensionProperty(provider: string, extension: string, key: string, bufLen: number, type?: MediaSourceType): string
getFaceShapeAreaOptions(shapeArea: FaceShapeArea, type?: MediaSourceType): FaceShapeAreaOptions
getFaceShapeBeautyOptions(type?: MediaSourceType): FaceShapeBeautyOptions
getLocalSpatialAudioEngine(): ILocalSpatialAudioEngine
getMediaEngine(): IMediaEngine
getMusicContentCenter(): IMusicContentCenter
getNativeHandle(): number
getNetworkType(): number
getNtpWallTimeInMs(): number
getScreenCaptureSources(thumbSize: Size, iconSize: Size, includeScreen: boolean): ScreenCaptureSourceInfo[]
getUserInfoByUid(uid: number): UserInfo
getUserInfoByUserAccount(userAccount: string): UserInfo
getVersion(): SDKBuildInfo
getVideoDeviceManager(): IVideoDeviceManager
getVolumeOfEffect(soundId: number): number
initialize(context: RtcEngineContext): number
isCameraCenterStageSupported(): boolean
isFeatureAvailableOnDevice(type: FeatureType): boolean
joinChannel(token: string, channelId: string, uid: number, options: ChannelMediaOptions): number
joinChannelWithUserAccount(token: string, channelId: string, userAccount: string, options?: ChannelMediaOptions): number
joinChannelWithUserAccountEx(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions): number
leaveChannel(options?: LeaveChannelOptions): number
loadExtensionProvider(path: string, unloadAfterUse?: boolean): number
muteAllRemoteAudioStreams(mute: boolean): number
muteAllRemoteVideoStreams(mute: boolean): number
muteLocalAudioStream(mute: boolean): number
muteLocalVideoStream(mute: boolean): number
muteRecordingSignal(mute: boolean): number
muteRemoteAudioStream(uid: number, mute: boolean): number
muteRemoteVideoStream(uid: number, mute: boolean): number
pauseAllChannelMediaRelay(): number
pauseAllEffects(): number
pauseAudioMixing(): number
pauseEffect(soundId: number): number
playAllEffects(loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean): number
playEffect(soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number): number
preloadChannel(token: string, channelId: string, uid: number): number
preloadChannelWithUserAccount(token: string, channelId: string, userAccount: string): number
preloadEffect(soundId: number, filePath: string, startPos?: number): number
queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }
queryDeviceScore(): number
rate(callId: string, rating: number, description: string): number
registerAudioEncodedFrameObserver(config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver): number
registerAudioSpectrumObserver(observer: IAudioSpectrumObserver): number
registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean
registerExtension(provider: string, extension: string, type?: MediaSourceType): number
registerLocalUserAccount(appId: string, userAccount: string): number
registerMediaMetadataObserver(observer: IMetadataObserver, type: MetadataType): number
release(sync?: boolean): void
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IRtcEngineEvent[EventType]): void
removeVideoWatermark(id: string): number
renewToken(token: string): number
resumeAllChannelMediaRelay(): number
resumeAllEffects(): number
resumeAudioMixing(): number
resumeEffect(soundId: number): number
selectAudioTrack(index: number): number
sendCustomReportMessage(id: string, category: string, event: string, label: string, value: number): number
sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number
sendStreamMessage(streamId: number, data: Uint8Array, length: number): number
setAINSMode(enabled: boolean, mode: AudioAinsMode): number
setAVSyncSource(channelId: string, uid: number): number
setAdvancedAudioOptions(options: AdvancedAudioOptions): number
setAudioEffectParameters(preset: AudioEffectPreset, param1: number, param2: number): number
setAudioEffectPreset(preset: AudioEffectPreset): number
setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number
setAudioMixingPitch(pitch: number): number
setAudioMixingPlaybackSpeed(speed: number): number
setAudioMixingPosition(pos: number): number
setAudioProfile(profile: AudioProfileType, scenario?: AudioScenarioType): number
setAudioScenario(scenario: AudioScenarioType): number
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions, type?: MediaSourceType): number
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number
setCameraDeviceOrientation(type: VideoSourceType, orientation: VideoOrientation): number
setChannelProfile(profile: ChannelProfileType): number
setClientRole(role: ClientRoleType, options?: ClientRoleOptions): number
setCloudProxy(proxyType: CloudProxyType): number
setColorEnhanceOptions(enabled: boolean, options: ColorEnhanceOptions, type?: MediaSourceType): number
setDualStreamMode(mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig): number
setEarMonitoringAudioFrameParameters(sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number): number
setEffectPosition(soundId: number, pos: number): number
setEffectsVolume(volume: number): number
setExtensionProperty(provider: string, extension: string, key: string, value: string, type?: MediaSourceType): number
setExtensionProviderProperty(provider: string, key: string, value: string): number
setFaceShapeAreaOptions(options: FaceShapeAreaOptions, type?: MediaSourceType): number
setFaceShapeBeautyOptions(enabled: boolean, options: FaceShapeBeautyOptions, type?: MediaSourceType): number
setFilterEffectOptions(enabled: boolean, options: FilterEffectOptions, type?: MediaSourceType): number
setHeadphoneEQParameters(lowGain: number, highGain: number): number
setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number
setInEarMonitoringVolume(volume: number): number
setLocalAccessPoint(config: LocalAccessPointConfiguration): number
setLocalRenderMode(renderMode: RenderModeType, mirrorMode?: VideoMirrorModeType): number
setLocalRenderTargetFps(sourceType: VideoSourceType, targetFps: number): number
setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number
setLocalVoiceEqualization(bandFrequency: AudioEqualizationBandFrequency, bandGain: number): number
setLocalVoiceFormant(formantRatio: number): number
setLocalVoicePitch(pitch: number): number
setLocalVoiceReverb(reverbKey: AudioReverbType, value: number): number
setLogFile(filePath: string): number
setLogFileSize(fileSizeInKBytes: number): number
setLogFilter(filter: LogFilterType): number
setLogLevel(level: LogLevel): number
setLowlightEnhanceOptions(enabled: boolean, options: LowlightEnhanceOptions, type?: MediaSourceType): number
setMaxMetadataSize(size: number): number
setMixedAudioFrameParameters(sampleRate: number, channel: number, samplesPerCall: number): number
setParameters(parameters: string): number
setPlaybackAudioFrameBeforeMixingParameters(sampleRate: number, channel: number samplesPerCall: number): number
setPlaybackAudioFrameParameters(sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number): number
setRecordingAudioFrameParameters(sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number): number
setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number
setRemoteRenderMode(uid: number, renderMode: RenderModeType, mirrorMode: VideoMirrorModeType): number
setRemoteRenderTargetFps(targetFps: number): number
setRemoteSubscribeFallbackOption(option: StreamFallbackOptions): number
setRemoteUserSpatialAudioParams(uid: number, params: SpatialAudioParams): number
setRemoteVideoStreamType(uid: number, streamType: VideoStreamType): number
setRemoteVideoSubscriptionOptions(uid: number, options: VideoSubscriptionOptions): number
setRemoteVoicePosition(uid: number, pan: number, gain: number): number
setScreenCaptureContentHint(contentHint: VideoContentHint): number
setScreenCaptureScenario(screenScenario: ScreenScenarioType): number
setSubscribeAudioAllowlist(uidList: number[], uidNumber: number): number
setSubscribeAudioBlocklist(uidList: number[], uidNumber: number): number
setSubscribeVideoAllowlist(uidList: number[], uidNumber: number): number
setSubscribeVideoBlocklist(uidList: number[], uidNumber: number): number
setVideoDenoiserOptions(enabled: boolean, options: VideoDenoiserOptions, type?: MediaSourceType): number
setVideoEncoderConfiguration(config: VideoEncoderConfiguration): number
setVideoScenario(scenarioType: VideoApplicationScenarioType): number
setVoiceBeautifierParameters(preset: VoiceBeautifierPreset, param1: number, param2: number): number
setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): number
setVoiceConversionPreset(preset: VoiceConversionPreset): number
setVolumeOfEffect(soundId: number, volume: number): number
setupLocalVideo(canvas: VideoCanvas): number
setupRemoteVideo(canvas: VideoCanvas): number
startAudioMixing(filePath: string, loopback: boolean, cycle: number, startPos?: number): number
startAudioRecording(config: AudioRecordingConfiguration): number
startCameraCapture(sourceType: VideoSourceType, config: CameraCapturerConfiguration): number
startEchoTest(config: EchoTestConfiguration): number
startLastmileProbeTest(config: LastmileProbeConfig): number
startLocalAudioMixer(config: LocalAudioMixerConfiguration): number
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): number
startMediaRenderingTracing(): number
startOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): number
startPreview(sourceType?: VideoSourceType): number
startPreviewWithoutSourceType(): number
startRhythmPlayer(sound1: string, sound2: string, config: AgoraRhythmPlayerConfig): number
startRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): number
startRtmpStreamWithoutTranscoding(url: string): number
startScreenCaptureByDisplayId(displayId: number, regionRect: Rectangle, captureParams: ScreenCaptureParameters): number
startScreenCaptureByScreenRect(screenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParameters): number
startScreenCaptureBySourceType(sourceType: VideoSourceType, config: ScreenCaptureConfiguration): number
startScreenCaptureByWindowId(windowId: any, regionRect: Rectangle, captureParams: ScreenCaptureParameters): number
stopAllEffects(): number
stopAudioMixing(): number
stopAudioRecording(): number
stopCameraCapture(sourceType: VideoSourceType): number
stopChannelMediaRelay(): number
stopEchoTest(): number
stopEffect(soundId: number): number
stopLastmileProbeTest(): number
stopLocalAudioMixer(): number
stopLocalVideoTranscoder(): number
stopPreview(sourceType?: VideoSourceType): number
stopRhythmPlayer(): number
stopRtmpStream(url: string): number
stopScreenCapture(): number
stopScreenCaptureBySourceType(sourceType: VideoSourceType): number
takeSnapshot(uid: number, filePath: string): number
takeSnapshotWithConfig(uid: number, config: SnapshotConfig): number
unloadAllEffects(): number
unloadEffect(soundId: number): number
unregisterAudioEncodedFrameObserver(observer: IAudioEncodedFrameObserver): number
unregisterAudioSpectrumObserver(observer: IAudioSpectrumObserver): number
unregisterEventHandler(eventHandler: IRtcEngineEventHandler): boolean
unregisterMediaMetadataObserver(observer: IMetadataObserver, type: MetadataType): number
updateChannelMediaOptions(options: ChannelMediaOptions): number
updateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): number
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): number
updatePreloadChannelToken(token: string): number
updateRtmpTranscoding(transcoding: LiveTranscoding): number
updateScreenCaptureParameters(captureParams: ScreenCaptureParameters): number
updateScreenCaptureRegion(regionRect: Rectangle): number

onActiveSpeaker(connection: RtcConnection, uid: number): void
onAudioDeviceStateChanged(deviceId: string, deviceType: MediaDeviceType, deviceState: number): void
onAudioDeviceVolumeChanged(deviceType: MediaDeviceType, volume: number, muted: boolean): void
onAudioEffectFinished(soundId: number): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: number): void
onAudioMixingStateChanged(state: AudioMixingStateType, reason: AudioMixingReasonType): void
onAudioPublishStateChanged(channel: string, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: number): void
onAudioQuality(connection: RtcConnection, remoteUid: number, quality: QualityType, delay: number, lost: number): void
onAudioRoutingChanged(routing: number): void
onAudioSubscribeStateChanged(channel: string, uid: number, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: number): void
onAudioVolumeIndication(connection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: number, totalVolume: number): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: ChannelMediaRelayState, code: ChannelMediaRelayError): void
onClientRoleChangeFailed(connection: RtcConnection, reason: ClientRoleChangeFailedReason, currentRole: ClientRoleType): void
onClientRoleChanged(connection: RtcConnection, oldRole: ClientRoleType, newRole: ClientRoleType newRoleOptions: ClientRoleOptions): void
onConnectionBanned(connection: RtcConnection): void
onConnectionInterrupted(connection: RtcConnection): void
onConnectionLost(connection: RtcConnection): void
onConnectionStateChanged(connection: RtcConnection, state: ConnectionStateType, reason: ConnectionChangedReasonType): void
onEncryptionError(connection: RtcConnection, errorType: EncryptionErrorType): void
onError(err: ErrorCodeType, msg: string): void
onExtensionErrorWithContext(context: ExtensionContext, error: number, message: string): void
onExtensionEventWithContext(context: ExtensionContext, key: string, value: string): void
onExtensionStartedWithContext(context: ExtensionContext): void
onExtensionStoppedWithContext(context: ExtensionContext): void
onFirstLocalAudioFramePublished(connection: RtcConnection, elapsed: number): void
onFirstLocalVideoFrame(source: VideoSourceType, width: number, height: number, elapsed: number): void
onFirstLocalVideoFramePublished(connection: RtcConnection, elapsed: number): void
onFirstRemoteAudioDecoded(connection: RtcConnection, uid: number, elapsed: number): void
onFirstRemoteAudioFrame(connection: RtcConnection, userId: number, elapsed: number): void
onFirstRemoteVideoDecoded(connection: RtcConnection, remoteUid: number, width: number, height: number, elapsed: number): void
onFirstRemoteVideoFrame(connection: RtcConnection, remoteUid: number, width: number, height: number, elapsed: number): void
onJoinChannelSuccess(connection: RtcConnection, elapsed: number): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: QualityType): void
onLeaveChannel(connection: RtcConnection, stats: RtcStats): void
onLocalAudioStateChanged(connection: RtcConnection, state: LocalAudioStreamState, reason: LocalAudioStreamReason): void
onLocalAudioStats(connection: RtcConnection, stats: LocalAudioStats): void
onLocalUserRegistered(uid: number, userAccount: string): void
onLocalVideoStateChanged(source: VideoSourceType, state: LocalVideoStreamState, reason: LocalVideoStreamReason): void
onLocalVideoStats(connection: RtcConnection, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: VideoTranscoderError): void
onMultipathStats(connection: RtcConnection, stats: MultipathStats): void
onNetworkQuality(connection: RtcConnection, remoteUid: number, txQuality: QualityType, rxQuality: QualityType): void
onNetworkTypeChanged(connection: RtcConnection, type: NetworkType): void
onPermissionError(permissionType: PermissionType): void
onProxyConnected(channel: string, uid: number, proxyType: ProxyType, localProxyIp: string, elapsed: number): void
onRejoinChannelSuccess(connection: RtcConnection, elapsed: number): void
onRemoteAudioStateChanged(connection: RtcConnection, remoteUid: number, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: number): void
onRemoteAudioStats(connection: RtcConnection, stats: RemoteAudioStats): void
onRemoteAudioTransportStats(connection: RtcConnection, remoteUid: number, delay: number, lost: number, rxKBitRate: number): void
onRemoteSubscribeFallbackToAudioOnly(uid: number, isFallbackOrRecover: boolean): void
onRemoteVideoStateChanged(connection: RtcConnection, remoteUid: number, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: number): void
onRemoteVideoStats(connection: RtcConnection, stats: RemoteVideoStats): void
onRemoteVideoTransportStats(connection: RtcConnection, remoteUid: number, delay: number, lost: number, rxKBitRate: number): void
onRenewTokenResult(connection: RtcConnection, token: string, code: RenewTokenErrorCode): void
onRequestToken(connection: RtcConnection): void
onRhythmPlayerStateChanged(state: RhythmPlayerStateType, reason: RhythmPlayerReason): void
onRtcStats(connection: RtcConnection, stats: RtcStats): void
onRtmpStreamingEvent(url: string, eventCode: RtmpStreamingEvent): void
onRtmpStreamingStateChanged(url: string, state: RtmpStreamPublishState, reason: RtmpStreamPublishReason): void
onSnapshotTaken(connection: RtcConnection, uid: number, filePath: string, width: number, height: number, errCode: number): void
onStreamMessage(connection: RtcConnection, remoteUid: number, streamId: number, data: Uint8Array, length: number, sentTs: number): void
onStreamMessageError(connection: RtcConnection, remoteUid: number, streamId: number, code: ErrorCodeType, missed: number, cached: number): void
onTokenPrivilegeWillExpire(connection: RtcConnection, token: string): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
onUserEnableLocalVideo(connection: RtcConnection, remoteUid: number, enabled: boolean): void
onUserEnableVideo(connection: RtcConnection, remoteUid: number, enabled: boolean): void
onUserInfoUpdated(uid: number, info: UserInfo): void
onUserJoined(connection: RtcConnection, remoteUid: number, elapsed: number): void
onUserMuteAudio(connection: RtcConnection, remoteUid: number, muted: boolean): void
onUserMuteVideo(connection: RtcConnection, remoteUid: number, muted: boolean): void
onUserOffline(connection: RtcConnection, remoteUid: number, reason: UserOfflineReasonType): void
onVideoDeviceStateChanged(deviceId: string, deviceType: MediaDeviceType, deviceState: number): void
onVideoPublishStateChanged(source: VideoSourceType, channel: string, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: number): void
onVideoRenderingTracingResult(connection: RtcConnection, uid: number, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(connection: RtcConnection, sourceType: VideoSourceType, uid: number, width: number, height: number, rotation: number): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: string, uid: number, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: number): void

addVideoWatermarkEx(watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection): number
addVideoWatermarkWithConfigEx(config: WatermarkConfig, connection: RtcConnection): number
adjustUserPlaybackSignalVolumeEx(uid: number, volume: number, connection: RtcConnection): number
clearVideoWatermarkEx(connection: RtcConnection): number
createDataStreamEx(config: DataStreamConfig, connection: RtcConnection): number
enableAudioVolumeIndicationEx(interval: number, smooth: number, reportVad: boolean, connection: RtcConnection): number
enableContentInspectEx(enabled: boolean, config: ContentInspectConfig, connection: RtcConnection): number
enableDualStreamModeEx(enabled: boolean, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
enableEncryptionEx(connection: RtcConnection, enabled: boolean, config: EncryptionConfig): number
enableLoopbackRecordingEx(connection: RtcConnection, enabled: boolean, deviceName?: string): number
getCallIdEx(connection: RtcConnection): string
getConnectionStateEx(connection: RtcConnection): ConnectionStateType
joinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions): number
leaveChannelEx(connection: RtcConnection, options?: LeaveChannelOptions): number
muteAllRemoteAudioStreamsEx(mute: boolean, connection: RtcConnection): number
muteAllRemoteVideoStreamsEx(mute: boolean, connection: RtcConnection): number
muteLocalAudioStreamEx(mute: boolean, connection: RtcConnection): number
muteLocalVideoStreamEx(mute: boolean, connection: RtcConnection): number
muteRemoteAudioStreamEx(uid: number, mute: boolean, connection: RtcConnection): number
muteRemoteVideoStreamEx(uid: number, mute: boolean, connection: RtcConnection): number
pauseAllChannelMediaRelayEx(connection: RtcConnection): number
playEffectEx(connection: RtcConnection, soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number): number
preloadEffectEx(connection: RtcConnection, soundId: number, filePath: string, startPos?: number): number
removeVideoWatermarkEx(id: string, connection: RtcConnection): number
resumeAllChannelMediaRelayEx(connection: RtcConnection): number
sendCustomReportMessageEx(id: string, category: string, event: string, label: string, value: number, connection: RtcConnection): number
sendStreamMessageEx(streamId: number, data: Uint8Array, length: number, connection: RtcConnection): number
setDualStreamModeEx(mode: SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
setRemoteRenderModeEx(uid: number, renderMode: RenderModeType, mirrorMode: VideoMirrorModeType, connection: RtcConnection): number
setRemoteVideoStreamTypeEx(uid: number, streamType: VideoStreamType, connection: RtcConnection): number
setRemoteVideoSubscriptionOptionsEx(uid: number, options: VideoSubscriptionOptions, connection: RtcConnection): number
setRemoteVoicePositionEx(uid: number, pan: number, gain: number, connection: RtcConnection): number
setSubscribeAudioAllowlistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setSubscribeAudioBlocklistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setSubscribeVideoAllowlistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setSubscribeVideoBlocklistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setVideoEncoderConfigurationEx(config: VideoEncoderConfiguration, connection: RtcConnection): number
setupRemoteVideoEx(canvas: VideoCanvas, connection: RtcConnection): number
startMediaRenderingTracingEx(connection: RtcConnection): number
startOrUpdateChannelMediaRelayEx(configuration: ChannelMediaRelayConfiguration, connection: RtcConnection): number
startRtmpStreamWithTranscodingEx(url: string, transcoding: LiveTranscoding, connection: RtcConnection): number
startRtmpStreamWithoutTranscodingEx(url: string, connection: RtcConnection): number
stopChannelMediaRelayEx(connection: RtcConnection): number
stopRtmpStreamEx(url: string, connection: RtcConnection): number
takeSnapshotEx(connection: RtcConnection, uid: number, filePath: string): number
takeSnapshotWithConfigEx(connection: RtcConnection, uid: number, config: SnapshotConfig): number
updateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): number
updateRtmpTranscodingEx(transcoding: LiveTranscoding, connection: RtcConnection): number