Jump to index list
Voice SDK v4.5.0 for Electron
  • A
    • addListener[1][2][3][4]
    • addVideoWatermark[1]
    • addVideoWatermarkEx[1]
    • adjustAudioMixingPlayoutVolume[1]
    • adjustAudioMixingPublishVolume[1]
    • adjustAudioMixingVolume[1]
    • adjustCustomAudioPlayoutVolume[1]
    • adjustCustomAudioPublishVolume[1]
    • adjustLoopbackSignalVolume[1]
    • adjustPlaybackSignalVolume[1]
    • adjustPlayoutVolume[1]
    • adjustPublishSignalVolume[1]
    • adjustRecordingSignalVolume[1]
    • adjustUserPlaybackSignalVolume[1]
    • adjustUserPlaybackSignalVolumeEx[1]
  • C
    • clearRemotePositions[1]
    • clearVideoWatermarkEx[1]
    • clearVideoWatermarks[1]
    • complain[1]
    • configRhythmPlayer[1]
    • createAgoraRtcEngine[1]
    • createCustomAudioTrack[1]
    • createCustomVideoTrack[1]
    • createDataStream[1]
    • createDataStreamEx[1]
    • createMediaPlayer[1]
  • D
    • destroyCustomAudioTrack[1]
    • destroyCustomVideoTrack[1]
    • destroyMediaPlayer[1]
    • destroyMusicPlayer[1]
    • destroyRendererByConfig[1]
    • destroyRendererByView[1]
    • disableAudio[1]
    • disableAudioSpectrumMonitor[1]
    • disableVideo[1]
  • E
    • enableAudio[1]
    • enableAudioSpectrumMonitor[1]
    • enableAudioVolumeIndication[1]
    • enableAudioVolumeIndicationEx[1]
    • enableAutoRemoveCache[1]
    • enableCameraCenterStage[1]
    • enableContentInspect[1]
    • enableContentInspectEx[1]
    • enableCustomAudioLocalPlayback[1]
    • enableDualStreamMode[1]
    • enableDualStreamModeEx[1]
    • enableEncryption[1]
    • enableEncryptionEx[1]
    • enableExtension[1]
    • enableInEarMonitoring[1]
    • enableInstantMediaRendering[1]
    • enableLocalAudio[1]
    • enableLocalVideo[1]
    • enableLoopbackRecording[1]
    • enableLoopbackRecordingEx[1]
    • enableSoundPositionIndication[1]
    • enableSpatialAudio[1]
    • enableVideo[1]
    • enableVideoImageSource[1]
    • enableVirtualBackground[1]
    • enableVoiceAITuner[1]
    • enableWebSdkInteroperability[1]
    • enumeratePlaybackDevices[1]
    • enumerateRecordingDevices[1]
    • enumerateVideoDevices[1]
  • F
    • followSystemLoopbackDevice[1]
    • followSystemPlaybackDevice[1]
    • followSystemRecordingDevice[1]
  • G
    • getAudioDeviceManager[1]
    • getAudioMixingCurrentPosition[1]
    • getAudioMixingDuration[1]
    • getAudioMixingPlayoutVolume[1]
    • getAudioMixingPublishVolume[1]
    • getAudioTrackCount[1]
    • getCacheDir[1]
    • getCacheFileCount[1]
    • getCallId[1]
    • getCallIdEx[1]
    • getCapability[1]
    • getConnectionState[1]
    • getConnectionStateEx[1]
    • getCurrentMonotonicTimeInMs[1]
    • getDevice[1]
    • getDuration[1]
    • getEffectCurrentPosition[1]
    • getEffectDuration[1]
    • getEffectsVolume[1]
    • getErrorDescription[1]
    • getExtensionProperty[1]
    • getLocalSpatialAudioEngine[1]
    • getLoopbackDevice[1]
    • getMaxCacheFileCount[1]
    • getMaxCacheFileSize[1]
    • getMediaEngine[1]
    • getMediaPlayerCacheManager[1]
    • getMediaPlayerId[1]
    • getMute[1]
    • getNativeHandle[1]
    • getNetworkType[1]
    • getNtpWallTimeInMs[1]
    • getPlaybackDefaultDevice[1]
    • getPlaybackDevice[1]
    • getPlaybackDeviceInfo[1]
    • getPlaybackDeviceMute[1]
    • getPlaybackDeviceVolume[1]
    • getPlayoutVolume[1]
    • getPlayPosition[1]
    • getPlaySrc[1]
    • getPublishSignalVolume[1]
    • getRecordingDefaultDevice[1]
    • getRecordingDevice[1]
    • getRecordingDeviceInfo[1]
    • getRecordingDeviceMute[1]
    • getRecordingDeviceVolume[1]
    • getScreenCaptureSources[1]
    • getState[1]
    • getStreamCount[1]
    • getStreamInfo[1]
    • getUserInfoByUid[1]
    • getUserInfoByUserAccount[1]
    • getVersion[1]
    • getVideoDeviceManager[1]
    • getVolumeOfEffect[1]
  • I
    • initialize[1][2]
    • isCameraCenterStageSupported[1]
    • isFeatureAvailableOnDevice[1]
  • J
    • joinChannel[1]
    • joinChannelEx[1]
    • joinChannelWithUserAccount[1]
    • joinChannelWithUserAccountEx[1]
  • L
    • leaveChannel[1]
    • leaveChannelEx[1]
    • loadExtensionProvider[1]
  • M
    • mute[1]
    • muteAllRemoteAudioStreams[1][2]
    • muteAllRemoteAudioStreamsEx[1]
    • muteAllRemoteVideoStreams[1]
    • muteAllRemoteVideoStreamsEx[1]
    • muteLocalAudioStream[1][2]
    • muteLocalAudioStreamEx[1]
    • muteLocalVideoStream[1]
    • muteLocalVideoStreamEx[1]
    • muteRecordingSignal[1]
    • muteRemoteAudioStream[1][2]
    • muteRemoteAudioStreamEx[1]
    • muteRemoteVideoStream[1]
    • muteRemoteVideoStreamEx[1]
  • N
    • numberOfCapabilities[1]
  • O
    • onActiveSpeaker[1]
    • onAudioDeviceStateChanged[1]
    • onAudioDeviceVolumeChanged[1]
    • onAudioEffectFinished[1]
    • onAudioMixingFinished[1]
    • onAudioMixingPositionChanged[1]
    • onAudioMixingStateChanged[1]
    • onAudioPublishStateChanged[1]
    • onAudioQuality[1]
    • onAudioRoutingChanged[1]
    • onAudioSubscribeStateChanged[1]
    • onAudioVolumeIndication[1][2]
    • onCameraReady[1]
    • onCaptureVideoFrame[1]
    • onChannelMediaRelayStateChanged[1]
    • onClientRoleChangeFailed[1]
    • onConnectionBanned[1]
    • onConnectionInterrupted[1]
    • onConnectionLost[1]
    • onConnectionStateChanged[1]
    • onDirectCdnStreamingStateChanged[1]
    • onDirectCdnStreamingStats[1]
    • onEarMonitoringAudioFrame[1]
    • onEncodedVideoFrameReceived[1]
    • onEncryptionError[1]
    • onError[1]
    • onExtensionErrorWithContext[1]
    • onExtensionEventWithContext[1]
    • onExtensionStartedWithContext[1]
    • onExtensionStoppedWithContext[1]
    • onFaceInfo[1]
    • onFirstLocalAudioFramePublished[1]
    • onFirstLocalVideoFrame[1]
    • onFirstLocalVideoFramePublished[1]
    • onFirstRemoteAudioDecoded[1]
    • onFirstRemoteAudioFrame[1]
    • onFirstRemoteVideoDecoded[1]
    • onFirstRemoteVideoFrame[1]
    • onFrame[1][2]
    • onJoinChannelSuccess[1]
    • onLastmileProbeResult[1]
    • onLastmileQuality[1]
    • onLeaveChannel[1]
    • onLocalAudioSpectrum[1]
    • onLocalAudioStateChanged[1]
    • onLocalAudioStats[1]
    • onLocalUserRegistered[1]
    • onLocalVideoStateChanged[1]
    • onLocalVideoStats[1]
    • onLocalVideoTranscoderError[1]
    • onMetaData[1]
    • onMetadataReceived[1]
    • onMixedAudioEncodedFrame[1]
    • onMixedAudioFrame[1]
    • onNetworkQuality[1]
    • onNetworkTypeChanged[1]
    • onPermissionError[1]
    • onPlaybackAudioEncodedFrame[1]
    • onPlaybackAudioFrame[1]
    • onPlaybackAudioFrameBeforeMixing[1]
    • onPlayBufferUpdated[1]
    • onPlayerCacheStats[1]
    • onPlayerEvent[1]
    • onPlayerInfoUpdated[1]
    • onPlayerPlaybackStats[1]
    • onPlayerSourceStateChanged[1]
    • onPlayerSrcInfoChanged[1]
    • onPositionChanged[1]
    • onPreEncodeVideoFrame[1]
    • onPreloadEvent[1]
    • onProxyConnected[1]
    • onRecordAudioEncodedFrame[1]
    • onRecordAudioFrame[1]
    • onRejoinChannelSuccess[1]
    • onRemoteAudioSpectrum[1]
    • onRemoteAudioStateChanged[1]
    • onRemoteAudioStats[1]
    • onRemoteAudioTransportStats[1]
    • onRemoteSubscribeFallbackToAudioOnly[1]
    • onRemoteVideoStateChanged[1]
    • onRemoteVideoStats[1]
    • onRemoteVideoTransportStats[1]
    • onRenderVideoFrame[1]
    • onRequestToken[1]
    • onRhythmPlayerStateChanged[1]
    • onRtcStats[1]
    • onRtmpStreamingEvent[1]
    • onRtmpStreamingStateChanged[1]
    • onSnapshotTaken[1]
    • onStreamMessage[1]
    • onStreamMessageError[1]
    • onTokenPrivilegeWillExpire[1]
    • onTranscodingUpdated[1]
    • onUplinkNetworkInfoUpdated[1]
    • onUserEnableLocalVideo[1]
    • onUserEnableVideo[1]
    • onUserInfoUpdated[1]
    • onUserMuteAudio[1]
    • onUserMuteVideo[1]
    • onUserOffline[1]
    • onVideoDeviceStateChanged[1]
    • onVideoPublishStateChanged[1]
    • onVideoRenderingTracingResult[1]
    • onVideoSizeChanged[1]
    • onVideoStopped[1]
    • onVideoSubscribeStateChanged[1]
    • open[1]
    • openWithMediaSource[1]
  • P
    • pause[1]
    • pauseAllChannelMediaRelay[1]
    • pauseAllChannelMediaRelayEx[1]
    • pauseAllEffects[1]
    • pauseAudioMixing[1]
    • pauseEffect[1]
    • play[1]
    • playAllEffects[1]
    • playEffect[1]
    • playPreloadedSrc[1]
    • preloadChannel[1]
    • preloadChannelWithUserAccount[1]
    • preloadEffect[1]
    • preloadSrc[1]
    • pullAudioFrame[1]
    • pushAudioFrame[1]
    • pushVideoFrame[1]
  • Q
    • queryCodecCapability[1]
    • queryDeviceScore[1]
  • R
    • rate[1]
    • registerAudioEncodedFrameObserver[1]
    • registerAudioFrameObserver[1][2]
    • registerAudioSpectrumObserver[1]
    • registerEventHandler[1]
    • registerExtension[1]
    • registerFaceInfoObserver[1]
    • registerLocalUserAccount[1]
    • registerMediaMetadataObserver[1]
    • registerPlayerSourceObserver[1]
    • registerVideoEncodedFrameObserver[1]
    • registerVideoFrameObserver[1][2]
    • release[1][2][3]
    • removeAllCaches[1]
    • removeAllListeners[1][2][3][4]
    • removeCacheByUri[1]
    • removeListener[1][2][3][4]
    • removeOldCache[1]
    • removeRemotePosition[1]
    • renewToken[1]
    • resume[1]
    • resumeAllChannelMediaRelay[1]
    • resumeAllChannelMediaRelayEx[1]
    • resumeAllEffects[1]
    • resumeAudioMixing[1]
    • resumeEffect[1]
  • S
    • seek[1]
    • selectAudioTrack[1][2]
    • selectMultiAudioTrack[1]
    • sendCustomReportMessage[1]
    • sendCustomReportMessageEx[1]
    • sendMetaData[1]
    • sendStreamMessage[1]
    • sendStreamMessageEx[1]
    • setAdvancedAudioOptions[1]
    • setAINSMode[1]
    • setAudioDualMonoMode[1]
    • setAudioEffectParameters[1]
    • setAudioEffectPreset[1]
    • setAudioMixingDualMonoMode[1]
    • setAudioMixingPitch[1]
    • setAudioMixingPlaybackSpeed[1]
    • setAudioMixingPosition[1]
    • setAudioPitch[1]
    • setAudioProfile[1]
    • setAudioRecvRange[1]
    • setAudioScenario[1]
    • setBeautyEffectOptions[1]
    • setCacheDir[1]
    • setCameraCapturerConfiguration[1]
    • setCameraDeviceOrientation[1]
    • setChannelProfile[1]
    • setClientRole[1]
    • setCloudProxy[1]
    • setColorEnhanceOptions[1]
    • setDevice[1]
    • setDirectCdnStreamingAudioConfiguration[1]
    • setDirectCdnStreamingVideoConfiguration[1]
    • setDistanceUnit[1]
    • setDualStreamMode[1]
    • setDualStreamModeEx[1]
    • setEarMonitoringAudioFrameParameters[1]
    • setEffectPosition[1]
    • setEffectsVolume[1]
    • setExtensionProperty[1]
    • setExtensionProviderProperty[1]
    • setExternalAudioSink[1]
    • setExternalAudioSource[1]
    • setExternalVideoSource[1]
    • setFilterEffectOptions[1]
    • setHeadphoneEQParameters[1]
    • setHeadphoneEQPreset[1]
    • setInEarMonitoringVolume[1]
    • setLocalRenderMode[1]
    • setLocalRenderTargetFps[1]
    • setLocalVideoMirrorMode[1]
    • setLocalVoiceEqualization[1]
    • setLocalVoiceFormant[1]
    • setLocalVoicePitch[1]
    • setLocalVoiceReverb[1]
    • setLogFile[1]
    • setLogFileSize[1]
    • setLogFilter[1]
    • setLogLevel[1]
    • setLoopbackDevice[1]
    • setLoopCount[1]
    • setLowlightEnhanceOptions[1]
    • setMaxAudioRecvCount[1]
    • setMaxCacheFileCount[1]
    • setMaxCacheFileSize[1]
    • setMaxMetadataSize[1]
    • setMixedAudioFrameParameters[1]
    • setParameters[1]
    • setPlaybackAudioFrameBeforeMixingParameters[1]
    • setPlaybackAudioFrameParameters[1]
    • setPlaybackDevice[1]
    • setPlaybackDeviceMute[1]
    • setPlaybackDeviceVolume[1]
    • setPlaybackSpeed[1]
    • setPlayerAttenuation[1]
    • setPlayerOptionInInt[1]
    • setPlayerOptionInString[1]
    • setRecordingAudioFrameParameters[1]
    • setRecordingDevice[1]
    • setRecordingDeviceMute[1]
    • setRecordingDeviceVolume[1]
    • setRemoteAudioAttenuation[1]
    • setRemoteDefaultVideoStreamType[1]
    • setRemoteRenderMode[1]
    • setRemoteRenderModeEx[1]
    • setRemoteRenderTargetFps[1]
    • setRemoteSubscribeFallbackOption[1]
    • setRemoteUserSpatialAudioParams[1]
    • setRemoteVideoStreamType[1]
    • setRemoteVideoStreamTypeEx[1]
    • setRemoteVideoSubscriptionOptions[1]
    • setRemoteVideoSubscriptionOptionsEx[1]
    • setRemoteVoicePosition[1]
    • setRemoteVoicePositionEx[1]
    • setRenderMode[1]
    • setScreenCaptureContentHint[1]
    • setScreenCaptureScenario[1]
    • setSpatialAudioParams[1]
    • setSubscribeAudioAllowlist[1]
    • setSubscribeAudioAllowlistEx[1]
    • setSubscribeAudioBlocklist[1]
    • setSubscribeAudioBlocklistEx[1]
    • setSubscribeVideoAllowlist[1]
    • setSubscribeVideoAllowlistEx[1]
    • setSubscribeVideoBlocklist[1]
    • setSubscribeVideoBlocklistEx[1]
    • setupLocalVideo[1]
    • setupRemoteVideo[1]
    • setupRemoteVideoEx[1]
    • setVideoDenoiserOptions[1]
    • setVideoEncoderConfiguration[1]
    • setVideoEncoderConfigurationEx[1]
    • setVideoScenario[1]
    • setView[1]
    • setVoiceBeautifierParameters[1]
    • setVoiceBeautifierPreset[1]
    • setVoiceConversionPreset[1]
    • setVolumeOfEffect[1]
    • setZones[1]
    • startAudioDeviceLoopbackTest[1]
    • startAudioMixing[1]
    • startAudioRecording[1]
    • startCameraCapture[1]
    • startDirectCdnStreaming[1]
    • startEchoTest[1]
    • startLastmileProbeTest[1]
    • startLocalAudioMixer[1]
    • startLocalVideoTranscoder[1]
    • startMediaRenderingTracing[1]
    • startMediaRenderingTracingEx[1]
    • startOrUpdateChannelMediaRelay[1]
    • startOrUpdateChannelMediaRelayEx[1]
    • startPlaybackDeviceTest[1]
    • startPreview[1]
    • startPreviewWithoutSourceType[1]
    • startRecordingDeviceTest[1]
    • startRhythmPlayer[1]
    • startRtmpStreamWithoutTranscoding[1]
    • startRtmpStreamWithoutTranscodingEx[1]
    • startRtmpStreamWithTranscoding[1]
    • startRtmpStreamWithTranscodingEx[1]
    • startScreenCaptureByDisplayId[1]
    • startScreenCaptureByScreenRect[1]
    • startScreenCaptureBySourceType[1]
    • startScreenCaptureByWindowId[1]
    • stop[1]
    • stopAllEffects[1]
    • stopAudioDeviceLoopbackTest[1]
    • stopAudioMixing[1]
    • stopAudioRecording[1]
    • stopCameraCapture[1]
    • stopChannelMediaRelay[1]
    • stopChannelMediaRelayEx[1]
    • stopDirectCdnStreaming[1]
    • stopEchoTest[1]
    • stopEffect[1]
    • stopLastmileProbeTest[1]
    • stopLocalAudioMixer[1]
    • stopLocalVideoTranscoder[1]
    • stopPlaybackDeviceTest[1]
    • stopPreview[1]
    • stopRecordingDeviceTest[1]
    • stopRhythmPlayer[1]
    • stopRtmpStream[1]
    • stopRtmpStreamEx[1]
    • stopScreenCapture[1]
    • stopScreenCaptureBySourceType[1]
    • switchSrc[1]
  • T
    • takeSnapshot[1]
    • takeSnapshotEx[1]
    • takeSnapshotWithConfig[1]
    • takeSnapshotWithConfigEx[1]
  • U
    • unloadAllEffects[1]
    • unloadEffect[1]
    • unloadSrc[1]
    • unregisterAudioEncodedFrameObserver[1]
    • unregisterAudioFrameObserver[1][2]
    • unregisterAudioSpectrumObserver[1]
    • unregisterEventHandler[1]
    • unregisterFaceInfoObserver[1]
    • unregisterMediaMetadataObserver[1]
    • unregisterPlayerSourceObserver[1]
    • unregisterVideoEncodedFrameObserver[1]
    • unregisterVideoFrameObserver[1][2]
    • updateChannelMediaOptions[1]
    • updateChannelMediaOptionsEx[1]
    • updateLocalAudioMixerConfiguration[1]
    • updateLocalTranscoderConfiguration[1]
    • updatePlayerPositionInfo[1]
    • updatePreloadChannelToken[1]
    • updateRemotePosition[1]
    • updateRtmpTranscoding[1]
    • updateRtmpTranscodingEx[1]
    • updateScreenCaptureParameters[1]
    • updateScreenCaptureRegion[1]
    • updateSelfPosition[1]