统信 OS API 列表

本页列出 Electron for 统信 OS SDK 支持的 API 列表。
注意： 如果在本页中无法查询到你要使用的 API，则代表 Electron for 统信 OS SDK 不支持该 API，调用该 API 时会返回错误码 -2。

IRtcEngine

• addListener

• adjustAudioMixingPlayoutVolume

• adjustAudioMixingPublishVolume

• adjustAudioMixingVolume

• adjustCustomAudioPlayoutVolume

• adjustCustomAudioPublishVolume

• adjustLoopbackSignalVolume

• adjustPlaybackSignalVolume

• adjustRecordingSignalVolume

• adjustUserPlaybackSignalVolume

• complain

• configRhythmPlayer

• createAgoraRtcEngine

• createCustomAudioTrack

• createCustomVideoTrack

• createDataStream

• createMediaPlayer

• createMediaRecorder

• destroyCustomAudioTrack

• destroyCustomVideoTrack

• destroyMediaPlayer

• destroyRendererByConfig

• destroyRendererByView

• disableAudio

• disableVideo

• enableAudio

• enableAudioVolumeIndication

• enableCustomAudioLocalPlayback

• enableDualStreamMode

• enableEncryption

• enableExtension

• enableInstantMediaRendering

• enableLocalAudio

• enableLocalVideo

• enableLoopbackRecording

• enableVideo

• enableVirtualBackground

• enableWebSdkInteroperability

• getAudioMixingCurrentPosition

• getAudioMixingDuration

• getAudioMixingPlayoutVolume

• getAudioMixingPublishVolume

• getAudioTrackCount

• getCallId

• getConnectionState

• getCurrentMonotonicTimeInMs

• getEffectCurrentPosition

• getEffectDuration

• getEffectsVolume

• getErrorDescription

• getExtensionProperty

• getMediaPlayerCacheManager

• getNativeHandle

• getNetworkType

• getNtpWallTimeInMs

• getScreenCaptureSources

• getUserInfoByUid

• getUserInfoByUserAccount

• getVersion

• getVideoDeviceManager

• getVolumeOfEffect

• initialize

• isFeatureAvailableOnDevice

• joinChannel

• joinChannelWithUserAccount

• leaveChannel

• loadExtensionProvider

• muteAllRemoteAudioStreams

• muteAllRemoteVideoStreams

• muteLocalAudioStream

• muteLocalVideoStream

• muteRecordingSignal

• muteRemoteAudioStream

• muteRemoteVideoStream

• pauseAllChannelMediaRelay

• pauseAllEffects

• pauseAudioMixing

• pauseEffect

• playAllEffects

• playEffect

• preloadChannel

• preloadChannelWithUserAccount

• preloadEffect

• pullAudioFrame

• pullAudioFrame

• pushAudioFrame

• pushVideoFrame

• queryCodecCapability

• queryDeviceScore

• rate

• registerAudioEncodedFrameObserver

• registerAudioFrameObserver

• registerAudioFrameObserver

• registerExtension

• registerLocalUserAccount

• registerMediaMetadataObserver

• registerVideoEncodedFrameObserver

• registerVideoEncodedFrameObserver

• registerVideoFrameObserver

• registerVideoFrameObserver

• release

• removeListener

• removeAllListeners

• renewToken

• resumeAllChannelMediaRelay

• resumeAllEffects

• resumeAudioMixing

• resumeEffect

• selectAudioTrack

• sendCustomReportMessage

• sendMetaData

• sendStreamMessage

• setAudioMixingDualMonoMode

• setAudioMixingPitch

• setAudioMixingPlaybackSpeed

• setAudioMixingPosition

• setAudioProfile

• setAudioScenario

• setBeautyEffectOptions

• setCameraCapturerConfiguration

• setCameraDeviceOrientation

• setChannelProfile

• setCloudProxy

• setDirectCdnStreamingAudioConfiguration

• setDirectCdnStreamingVideoConfiguration

• setDualStreamMode

• setEffectPosition

• setEffectsVolume

• setExtensionProperty

• setExtensionProviderProperty

• setExternalAudioSink

• setExternalAudioSource

• setExternalVideoSource

• setLocalRenderMode

• setLocalRenderTargetFps

• setLocalVideoMirrorMode

• setLogFile

• setLogFileSize

• setLogFilter

• setLogLevel

• setMaxMetadataSize

• setMixedAudioFrameParameters

• setParameters

• setPlaybackAudioFrameBeforeMixingParameters

• setPlaybackAudioFrameParameters

• setRecordingAudioFrameParameters

• setRemoteDefaultVideoStreamType

• setRemoteRenderMode

• setRemoteRenderTargetFps

• setRemoteSubscribeFallbackOption

• setRemoteVideoStreamType

• setRemoteVideoSubscriptionOptions

• setScreenCaptureContentHint

• setScreenCaptureScenario

• setSubscribeAudioAllowlist

• setSubscribeAudioBlocklist

• setSubscribeVideoAllowlist

• setSubscribeVideoBlocklist

• setVideoEncoderConfiguration

• setVideoScenario

• setVolumeOfEffect

• setupLocalVideo

• setupRemoteVideo

• startAudioMixing

• startAudioRecording

• startCameraCapture

• startDirectCdnStreaming

• startEchoTest

• startLastmileProbeTest

• startLocalAudioMixer

• startMediaRenderingTracing

• startOrUpdateChannelMediaRelay

• startPreviewWithoutSourceType

• startRhythmPlayer

• startRtmpStreamWithTranscoding

• startRtmpStreamWithoutTranscoding

• startScreenCaptureByDisplayId

• startScreenCaptureByWindowId

• stopAllEffects

• stopAudioMixing

• stopAudioRecording

• stopCameraCapture

• stopChannelMediaRelay

• stopDirectCdnStreaming

• stopEchoTest

• stopEffect

• stopLastmileProbeTest

• stopLocalAudioMixer

• stopPreview

• stopRhythmPlayer

• stopRtmpStream

• stopScreenCapture

• unloadAllEffects

• unloadEffect

• unregisterAudioEncodedFrameObserver

• unregisterAudioFrameObserver

• unregisterMediaMetadataObserver

• unregisterVideoEncodedFrameObserver

• updateChannelMediaOptions

• updateLocalAudioMixerConfiguration

• updatePreloadChannelToken

• updateRtmpTranscoding

• updateScreenCaptureParameters

IRtcEngineEx

• adjustUserPlaybackSignalVolumeEx

• createDataStreamEx

• enableAudioVolumeIndicationEx

• enableDualStreamModeEx

• enableEncryptionEx

• enableLoopbackRecordingEx

• getCallIdEx

• getConnectionStateEx

• joinChannelEx

• joinChannelWithUserAccountEx

• leaveChannelEx

• muteAllRemoteAudioStreamsEx

• muteAllRemoteVideoStreamsEx

• muteLocalAudioStreamEx

• muteLocalVideoStreamEx

• muteRemoteAudioStreamEx

• muteRemoteVideoStreamEx

• pauseAllChannelMediaRelayEx

• resumeAllChannelMediaRelayEx

• sendCustomReportMessageEx

• sendStreamMessageEx

• setDualStreamModeEx

• setRemoteRenderModeEx

• setRemoteVideoStreamTypeEx

• setRemoteVideoSubscriptionOptionsEx

• setRemoteVideoSubscriptionOptionsEx

• setSubscribeAudioAllowlistEx

• setSubscribeAudioBlocklistEx

• setSubscribeVideoAllowlistEx

• setSubscribeVideoBlocklistEx

• setVideoEncoderConfigurationEx

• setupRemoteVideoEx

• startMediaRenderingTracingEx

• startOrUpdateChannelMediaRelayEx

• startRtmpStreamWithTranscodingEx

• startRtmpStreamWithoutTranscodingEx

• stopChannelMediaRelayEx

• stopRtmpStreamEx

• updateChannelMediaOptionsEx

• updateRtmpTranscodingEx

IRtcEngineEventHandler

• onActiveSpeaker

• onAudioDeviceStateChanged

• onAudioDeviceVolumeChanged

• onAudioEffectFinished

• onAudioMixingFinished

• onAudioMixingPositionChanged

• onAudioMixingStateChanged

• onAudioPublishStateChanged

• onAudioQuality

• onAudioSubscribeStateChanged

• onAudioVolumeIndication

• onChannelMediaRelayStateChanged

• onClientRoleChangeFailed

• onClientRoleChanged

• onConnectionBanned

• onConnectionInterrupted

• onConnectionLost

• onConnectionStateChanged

• onEncryptionError

• onError

• onExtensionErrorWithContext

• onExtensionEventWithContext

• onExtensionStartedWithContext

• onExtensionStoppedWithContext

• onFirstLocalAudioFramePublished

• onFirstLocalVideoFrame

• onFirstLocalVideoFramePublished

• onFirstRemoteAudioDecoded

• onFirstRemoteAudioFrame

• onFirstRemoteVideoDecoded

• onFirstRemoteVideoFrame

• onJoinChannelSuccess

• onLastmileProbeResult

• onLastmileQuality

• onLeaveChannel

• onLocalAudioStateChanged

• onLocalAudioStats

• onLocalUserRegistered

• onLocalVideoStateChanged

• onLocalVideoStats

• onNetworkQuality

• onNetworkTypeChanged

• onPermissionError

• onProxyConnected

• onRejoinChannelSuccess

• onRemoteAudioStateChanged

• onRemoteAudioStats

• onRemoteAudioTransportStats

• onRemoteSubscribeFallbackToAudioOnly

• onRemoteVideoStateChanged

• onRemoteVideoStats

• onRemoteVideoTransportStats

• onRequestToken

• onRhythmPlayerStateChanged

• onRtcStats

• onRtmpStreamingEvent

• onRtmpStreamingStateChanged

• onStreamMessage

• onStreamMessageError

• onTokenPrivilegeWillExpire

• onTranscodingUpdated

• onUplinkNetworkInfoUpdated

• onUserEnableLocalVideo

• onUserEnableVideo

• onUserInfoUpdated

• onUserJoined

• onUserMuteAudio

• onUserMuteVideo

• onUserOffline

• onVideoDeviceStateChanged

• onVideoPublishStateChanged

• onVideoRenderingTracingResult

• onVideoSizeChanged

• onVideoStopped

• onVideoSubscribeStateChanged

IMediaPlayer

• addListener

• adjustPlayoutVolume

• adjustPublishSignalVolume

• getDuration

• getMediaPlayerCacheManager

• getMediaPlayerId

• getMute

• getPlayPosition

• getPlaySrc

• getPlayoutVolume

• getPublishSignalVolume

• getState

• getStreamCount

• getStreamInfo

• mute

• open

• openWithMediaSource

• pause

• play

• playPreloadedSrc

• preloadSrc

• registerAudioFrameObserver

• registerPlayerSourceObserver

• registerVideoFrameObserver

• removeListener

• removeAllListeners

• resume

• seek

• selectAudioTrack

• selectMultiAudioTrack

• setAudioDualMonoMode

• setAudioPitch

• setLoopCount

• setPlaybackSpeed

• setPlayerOptionInInt

• setPlayerOptionInString

• setRenderMode

• setView

• stop

• switchSrc

• unloadSrc

• unregisterAudioFrameObserver

• unregisterPlayerSourceObserver

• unregisterVideoFrameObserver

IVideoEncodedFrameObserver

• onEncodedVideoFrameReceived

IVideoFrameObserver

• onCaptureVideoFrame

• onPreEncodeVideoFrame

• onRenderVideoFrame

IMusicPlayer

• openWithSongCode

• setPlayMode

IAudioDeviceManager

• getPlaybackDeviceInfo

• getPlaybackDeviceMute

• getPlaybackDeviceVolume

• getRecordingDefaultDevice

• getRecordingDevice

• getRecordingDeviceInfo

• getRecordingDeviceMute

• getRecordingDeviceVolume

• setPlaybackDevice

• setPlaybackDeviceMute

• setPlaybackDeviceVolume

• setRecordingDevice

• setRecordingDeviceMute

• setRecordingDeviceVolume

• startPlaybackDeviceTest

• startRecordingDeviceTest

• stopPlaybackDeviceTest

• stopRecordingDeviceTest

IAudioEncodedFrameObserver

• onMixedAudioEncodedFrame

• onPlaybackAudioEncodedFrame

• onRecordAudioEncodedFrame

IAudioFrameObserverBase

• onMixedAudioFrame

• onPlaybackAudioFrame

• onRecordAudioFrame

IDirectCdnStreamingEventHandler

• onDirectCdnStreamingStateChanged

• onDirectCdnStreamingStats

IMediaEngine

• createCustomAudioTrack

• destroyCustomAudioTrack

• pullAudioFrame

• pushAudioFrame

• pushVideoFrame

• registerAudioFrameObserver

• registerVideoEncodedFrameObserver

• registerVideoFrameObserver

• setExternalAudioSink

• setExternalVideoSource

IMediaPlayerAudioFrameObserver

• onFrame

IMediaPlayerCacheManager

• enableAutoRemoveCache

• getCacheDir

• getCacheFileCount

• getMaxCacheFileCount

• getMaxCacheFileSize

• removeAllCaches

• removeCacheByUri

• removeOldCache

• setCacheDir

• setMaxCacheFileCount

• setMaxCacheFileSize

IMediaPlayerSourceObserver

• onAudioVolumeIndication

• onMetaData

• onPlayBufferUpdated

• onPlayerCacheStats

• onPlayerEvent

• onPlayerInfoUpdated

• onPlayerPlaybackStats

• onPlayerSourceStateChanged

• onPlayerSrcInfoChanged

• onPositionChanged

• onPreloadEvent

IMediaRecorder

• addListener

• destroyMediaRecorder

• removeListener

• removeAllListeners

• setMediaRecorderObserver

• startRecording

• stopRecording

IMediaRecorderObserver

• onRecorderInfoUpdated

• onRecorderStateChanged

IMetadataObserver

• onMetadataReceived

IMusicContentCenter

• createMusicPlayer

• destroyMusicPlayer

• getCaches

• getInternalSongCode

• getLyric

• getMusicCharts

• getMusicCollectionByMusicChartId

• getSongSimpleInfo

• initialize

• initialize

• isPreloaded

• Preload

• registerEventHandler

• release

• removeCache

• renewToken

• searchMusic

• unregisterEventHandler

IMusicContentCenterEventHandler

• onLyricResult

• onMusicChartsResult

• onMusicCollectionResult

• onPreLoadEvent

• onSongSimpleInfoResult

IVideoDeviceManager

• enumerateVideoDevices

• getCapability

• numberOfCapabilities