API 列表
- C++
更新时间不可用
本页列出 C++ 所有的接口类以及其中包含的 API。
Canvas
Canvas 类用于渲染视频流。
自从
自 v4.4.0 版本新增。
相关参考
CanvasConfig
用于配置播放器的视频渲染参数。
自从
自 v4.4.0 版本新增。
相关参考
Error
用于获取错误码和错误信息。
自从
自 v4.4.0 版本新增。
相关参考
IAudioDeviceCollection
用于管理音频设备的集合。
相关参考
- getApplicationVolume
- getCount
- getDefaultDevice [2/2]
- getDefaultDevice [1/2]
- getDevice [2/2]
- getDevice [1/2]
- isApplicationMute
- release
- setApplicationMute
- setApplicationVolume
- setDevice
IAudioDeviceManager
用于音频设备的管理。
相关参考
- enumeratePlaybackDevices
- enumerateRecordingDevices
- followSystemLoopbackDevice
- followSystemPlaybackDevice
- followSystemRecordingDevice
- getLoopbackDevice
- getPlaybackDevice
- getPlaybackDeviceInfo [1/2]
- getPlaybackDeviceInfo [2/2]
- getPlaybackDeviceMute
- getPlaybackDeviceVolume
- getRecordingDevice
- getRecordingDeviceInfo [1/2]
- getRecordingDeviceInfo [2/2]
- getRecordingDeviceMute
- getRecordingDeviceVolume
- release
- setLoopbackDevice
- setPlaybackDevice
- setPlaybackDeviceMute
- setPlaybackDeviceVolume
- setRecordingDevice
- setRecordingDeviceMute
- setRecordingDeviceVolume
- startAudioDeviceLoopbackTest
- startPlaybackDeviceTest
- startRecordingDeviceTest
- stopAudioDeviceLoopbackTest
- stopPlaybackDeviceTest
- stopRecordingDeviceTest
IAudioEncodedFrameObserver
用于监听编码后音频帧的回调接口。
相关参考
IAudioFrameObserver
用于实现音频帧观察功能。
IAudioFrameObserverBase
用于音频帧观察的基类。
相关参考
- getEarMonitoringAudioParams
- getMixedAudioParams
- getObservedAudioFramePosition
- getPlaybackAudioParams
- getRecordAudioParams
- onEarMonitoringAudioFrame
- onMixedAudioFrame
- onPlaybackAudioFrame
- onPlaybackAudioFrameBeforeMixing
- onRecordAudioFrame
IAudioPcmFrameSink
用于监听音频 PCM 帧。
相关参考
IAudioSpectrumObserver
用于观察和处理音频频谱数据。
相关参考
ILocalSpatialAudioEngine
用于实现基础空间音效引擎接口功能。
相关参考
- clearRemotePositions
- initialize
- muteAllRemoteAudioStreams
- muteLocalAudioStream
- muteRemoteAudioStream
- release
- removeRemotePosition
- setAudioRecvRange
- setDistanceUnit
- setMaxAudioRecvCount
- setPlayerAttenuation
- setRemoteAudioAttenuation
- setZones
- updatePlayerPositionInfo
- updateRemotePosition
- updateSelfPosition
IMediaEngine
IMediaEngine 用于实现媒体引擎相关功能。
相关参考
- createCustomAudioTrack
- destroyCustomAudioTrack
- pullAudioFrame
- pushAudioFrame
- pushVideoFrame
- registerAudioFrameObserver
- registerVideoEncodedFrameObserver
- registerVideoFrameObserver
- setExternalAudioSink
- setExternalAudioSource
- setExternalRemoteEglContext
- setExternalVideoSource
IMediaPlayer
用于访问媒体播放器实体。
如果你想同时播放多个媒体源，可以创建多个媒体播放器源对象。
相关参考
- adjustPlayoutVolume
- adjustPublishSignalVolume
- getAudioBufferDelay
- getDuration
- getMediaPlayerId
- getMute
- getPlayoutVolume
- getPlayPosition
- getPlaySrc
- getPublishSignalVolume
- getState
- getStreamCount
- getStreamInfo
- mute
- open
- openWithMediaSource
- pause
- play
- playPreloadedSrc
- preloadSrc
- registerAudioFrameObserver [1/2]
- registerAudioFrameObserver [2/2]
- registerPlayerSourceObserver
- registerVideoFrameObserver
- resume
- seek
- selectAudioTrack [2/2]
- selectMultiAudioTrack
- setAudioDualMonoMode
- setAudioPitch
- setLoopCount
- setPlaybackSpeed
- setPlayerOption [1/2]
- setPlayerOption [2/2]
- setRenderMode
- setSpatialAudioParams
- setView
- stop
- switchSrc
- unloadSrc
- unregisterAudioFrameObserver
- unregisterPlayerSourceObserver
- unregisterVideoFrameObserver
IMediaPlayerCacheManager
用于管理和设置播放器缓存。
相关参考
- enableAutoRemoveCache
- getCacheDir
- getCacheFileCount
- getMaxCacheFileCount
- getMaxCacheFileSize
- getMediaPlayerCacheManager
- removeAllCaches
- removeCacheByUri
- removeOldCache
- setCacheDir
- setMaxCacheFileCount
- setMaxCacheFileSize
IMediaPlayerCustomDataProvider
用于提供自定义数据源的接口回调接口。
播放器会持续调用该接口，请求你填充需要播放的数据流。
相关参考
IMediaPlayerSourceObserver
用于向应用报告媒体播放器的运行时事件。
相关参考
- onAudioVolumeIndication
- onMetaData [1/2]
- onPlayBufferUpdated
- onPlayerCacheStats
- onPlayerEvent
- onPlayerInfoUpdated [1/2]
- onPlayerPlaybackStats
- onPlayerSourceStateChanged
- onPlayerSrcInfoChanged
- onPositionChanged
- onPreloadEvent
IMediaRecorder
用于实现媒体录制功能的接口。
相关参考
IMediaRecorderObserver
用于实现媒体录制的观察器接口。
相关参考
IMetadataObserver
IMetadataObserver 接口，用于处理与元数据相关的回调。
相关参考
IMusicContentCenter
IMusicContentCenter 用于管理音乐内容中心。
相关参考
- createMusicPlayer
- destroyMusicPlayer
- getCaches
- getInternalSongCode
- getLyric
- getMusicCharts
- getMusicCollectionByMusicChartId
- getSongSimpleInfo
- initialize
- isPreloaded
- preload [1/2]
- preload [2/2]
- registerEventHandler
- release
- removeCache
- renewToken
- searchMusic
- unregisterEventHandler
IMusicContentCenterEventHandler
用于处理音乐内容中心相关事件。
相关参考
IMusicPlayer
用于播放音乐的接口。
相关参考
IPacketObserver
IPacketObserver 类用于实现自定义数据包的观察和处理。
相关参考
IRtcEngine
实现声网实时通信核心功能的基础接口类。
相关参考
- addVideoWatermark [1/3]
- addVideoWatermark [2/3]
- addVideoWatermark [3/3]
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustCustomAudioPlayoutVolume
- adjustCustomAudioPublishVolume
- adjustLoopbackSignalVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- adjustUserPlaybackSignalVolume
- clearVideoWatermarks
- complain
- configRhythmPlayer
- createAgoraRtcEngine
- createCustomVideoTrack
- createDataStream [1/2]
- createDataStream [2/2]
- createMediaPlayer
- createMediaRecorder
- createVideoEffectObject
- destroyCustomVideoTrack
- destroyMediaPlayer
- destroyMediaRecorder
- destroyVideoEffectObject
- disableAudio
- disableAudioSpectrumMonitor
- disableVideo
- enableAudio
- enableAudioSpectrumMonitor
- enableAudioVolumeIndication
- enableCameraCenterStage
- enableContentInspect
- enableCustomAudioLocalPlayback
- enableDualStreamMode [1/2]
- enableDualStreamMode [2/2]
- enableEncryption
- enableExtension
- enableFaceDetection
- enableInEarMonitoring
- enableInstantMediaRendering
- enableLocalAudio
- enableLocalVideo
- enableLoopbackRecording
- enableMultiCamera
- enableSoundPositionIndication
- enableSpatialAudio
- enableVideo
- enableVideoImageSource
- enableVirtualBackground
- enableVoiceAITuner
- enableWebSdkInteroperability
- getAudioDeviceInfo
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getAudioTrackCount
- getCallId
- getCameraMaxZoomFactor
- getConnectionState
- getCurrentMonotonicTimeInMs
- getEffectCurrentPosition
- getEffectDuration
- getEffectsVolume
- getErrorDescription
- getExtensionProperty
- getFaceShapeAreaOptions
- getFaceShapeBeautyOptions
- getNetworkType
- getNtpWallTimeInMs
- getScreenCaptureSources
- getUserInfoByUid
- getUserInfoByUserAccount
- getVersion
- getVolumeOfEffect
- initialize
- isCameraAutoExposureFaceModeSupported
- isCameraAutoFocusFaceModeSupported
- isCameraCenterStageSupported
- isCameraExposurePositionSupported
- isCameraExposureSupported
- isCameraFaceDetectSupported
- isCameraFocusSupported
- isCameraTorchSupported
- isCameraZoomSupported
- isFeatureAvailableOnDevice
- isSpeakerphoneEnabled
- joinChannel [1/2]
- joinChannel [2/2]
- joinChannelWithUserAccount [1/2]
- joinChannelWithUserAccount [2/2]
- joinChannelWithUserAccountEx
- leaveChannel [1/2]
- leaveChannel [2/2]
- loadExtensionProvider
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRecordingSignal
- muteRemoteAudioStream
- muteRemoteVideoStream
- pauseAllChannelMediaRelay
- pauseAllEffects
- pauseAudioMixing
- pauseEffect
- playAllEffects
- playEffect
- preloadChannel
- preloadChannelWithUserAccount
- preloadEffect
- queryCameraFocalLengthCapability
- queryCodecCapability
- queryDeviceScore
- queryInterface
- queryScreenCaptureCapability
- rate
- registerAudioEncodedFrameObserver
- registerAudioSpectrumObserver
- registerExtension
- registerLocalUserAccount
- registerMediaMetadataObserver
- registerPacketObserver
- release
- removeVideoWatermark
- renewToken
- resumeAllChannelMediaRelay
- resumeAllEffects
- resumeAudioMixing
- resumeEffect
- selectAudioTrack [1/2]
- sendCustomReportMessage
- sendStreamMessage
- setAdvancedAudioOptions
- setAINSMode
- setAudioEffectParameters
- setAudioEffectPreset
- setAudioMixingDualMonoMode
- setAudioMixingPitch
- setAudioMixingPlaybackSpeed
- setAudioMixingPosition
- setAudioProfile [1/2]
- setAudioProfile [2/2]
- setAudioScenario
- setAudioSessionOperationRestriction
- setAVSyncSource
- setBeautyEffectOptions
- setCameraAutoExposureFaceModeEnabled
- setCameraAutoFocusFaceModeEnabled
- setCameraCapturerConfiguration
- setCameraDeviceOrientation
- setCameraExposureFactor
- setCameraExposurePosition
- setCameraFocusPositionInPreview
- setCameraStabilizationMode
- setCameraTorchOn
- setCameraZoomFactor
- setChannelProfile
- setClientRole [1/2]
- setClientRole [2/2]
- setCloudProxy
- setColorEnhanceOptions
- setDefaultAudioRouteToSpeakerphone
- setDualStreamMode [1/2]
- setDualStreamMode [2/2]
- setEarMonitoringAudioFrameParameters
- setEffectPosition
- setEffectsVolume
- setEnableSpeakerphone
- setExtensionProperty
- setExtensionProviderProperty
- setExternalMediaProjection
- setFaceShapeAreaOptions
- setFaceShapeBeautyOptions
- setFilterEffectOptions
- setHeadphoneEQParameters
- setHeadphoneEQPreset
- setInEarMonitoringVolume
- setLocalAccessPoint
- setLocalRenderMode [1/2]
- setLocalRenderMode [2/2]
- setLocalRenderTargetFps
- setLocalVideoMirrorMode
- setLocalVoiceEqualization
- setLocalVoiceFormant
- setLocalVoicePitch
- setLocalVoiceReverb
- setLogFile
- setLogFileSize
- setLogFilter
- setLogLevel
- setLowlightEnhanceOptions
- setMixedAudioFrameParameters
- setParameters
- setPlaybackAudioFrameBeforeMixingParameters [1/2]
- setPlaybackAudioFrameBeforeMixingParameters [2/2]
- setPlaybackAudioFrameParameters
- setRecordingAudioFrameParameters
- setRemoteDefaultVideoStreamType
- setRemoteRenderMode
- setRemoteRenderTargetFps
- setRemoteSubscribeFallbackOption
- setRemoteUserSpatialAudioParams
- setRemoteVideoStreamType
- setRemoteVideoSubscriptionOptions
- setRemoteVoicePosition
- setRouteInCommunicationMode
- setScreenCaptureContentHint
- setScreenCaptureScenario
- setSubscribeAudioAllowlist
- setSubscribeAudioBlocklist
- setSubscribeVideoAllowlist
- setSubscribeVideoBlocklist
- setupLocalVideo
- setupRemoteVideo
- setVideoDenoiserOptions
- setVideoEncoderConfiguration
- setVideoScenario
- setVoiceBeautifierParameters
- setVoiceBeautifierPreset
- setVoiceConversionPreset
- setVolumeOfEffect
- startAudioMixing [1/2]
- startAudioMixing [2/2]
- startAudioRecording [1/3]
- startAudioRecording [2/3]
- startAudioRecording [3/3]
- startCameraCapture
- startEchoTest
- startLastmileProbeTest
- startLocalAudioMixer
- startLocalVideoTranscoder
- startMediaRenderingTracing
- startOrUpdateChannelMediaRelay
- startPreview [1/2]
- startPreview [2/2]
- startRhythmPlayer
- startRtmpStreamWithoutTranscoding
- startRtmpStreamWithTranscoding
- startScreenCapture [1/2]
- startScreenCapture [2/2]
- startScreenCaptureByDisplayId
- startScreenCaptureByScreenRect
- startScreenCaptureByWindowId
- stopAllEffects
- stopAudioMixing
- stopAudioRecording
- stopCameraCapture
- stopChannelMediaRelay
- stopEchoTest
- stopEffect
- stopLastmileProbeTest
- stopLocalAudioMixer
- stopLocalVideoTranscoder
- stopPreview [1/2]
- stopPreview [2/2]
- stopRhythmPlayer
- stopRtmpStream
- stopScreenCapture [1/2]
- stopScreenCapture [2/2]
- switchCamera
- takeSnapshot [1/2]
- takeSnapshot [2/2]
- unloadAllEffects
- unloadEffect
- unregisterAudioSpectrumObserver
- unregisterMediaMetadataObserver
- updateChannelMediaOptions
- updateLocalAudioMixerConfiguration
- updateLocalTranscoderConfiguration
- updatePreloadChannelToken
- updateRtmpTranscoding
- updateScreenCapture
- updateScreenCaptureParameters
- updateScreenCaptureRegion
IRtcEngineEventHandler
用于接收 SDK 回调事件通知。
SDK 通过该类向 App 发送回调事件通知。你可以继承该类中的方法来获取所需的事件通知。该类中的所有方法均提供默认（空）实现，你可以按需选择性地继承部分方法。在回调方法中，应避免执行耗时操作或调用阻塞 API，否则可能影响 SDK 的正常运行。
相关参考
- onActiveSpeaker
- onAudioDeviceStateChanged
- onAudioDeviceVolumeChanged
- onAudioEffectFinished
- onAudioMixingFinished
- onAudioMixingPositionChanged
- onAudioMixingStateChanged
- onAudioPublishStateChanged
- onAudioQuality
- onAudioRoutingChanged
- onAudioSubscribeStateChanged
- onAudioVolumeIndication
- onCameraExposureAreaChanged
- onCameraFocusAreaChanged
- onCameraReady
- onChannelMediaRelayStateChanged
- onClientRoleChanged
- onClientRoleChangeFailed
- onConnectionBanned
- onConnectionInterrupted
- onConnectionLost
- onConnectionStateChanged
- onEncryptionError
- onError
- onExtensionErrorWithContext
- onExtensionEventWithContext
- onExtensionStartedWithContext
- onExtensionStoppedWithContext
- onFacePositionChanged
- onFirstLocalAudioFramePublished
- onFirstLocalVideoFrame
- onFirstLocalVideoFramePublished
- onFirstRemoteAudioDecoded
- onFirstRemoteAudioFrame
- onFirstRemoteVideoDecoded
- onFirstRemoteVideoFrame
- onJoinChannelSuccess
- onLastmileProbeResult
- onLastmileQuality
- onLeaveChannel
- onLocalAudioStateChanged
- onLocalAudioStats
- onLocalUserRegistered
- onLocalVideoEvent
- onLocalVideoStateChanged
- onLocalVideoStats
- onLocalVideoTranscoderError
- onMultipathStats
- onNetworkQuality
- onNetworkTypeChanged
- onPermissionError
- onPermissionGranted
- onProxyConnected
- onRejoinChannelSuccess
- onRemoteAudioStateChanged
- onRemoteAudioStats
- onRemoteAudioTransportStats
- onRemoteSubscribeFallbackToAudioOnly
- onRemoteVideoStateChanged
- onRemoteVideoStats
- onRemoteVideoTransportStats
- onRenewTokenResult
- onRequestToken
- onRhythmPlayerStateChanged
- onRtcStats
- onRtmpStreamingEvent
- onRtmpStreamingStateChanged
- onSnapshotTaken
- onStreamMessage
- onStreamMessageError
- onTokenPrivilegeWillExpire
- onTranscodedStreamLayoutInfo
- onTranscodingUpdated
- onUplinkNetworkInfoUpdated
- onUserEnableLocalVideo
- onUserEnableVideo
- onUserInfoUpdated
- onUserJoined
- onUserMuteAudio
- onUserMuteVideo
- onUserOffline
- onVideoDeviceStateChanged
- onVideoPublishStateChanged
- onVideoRenderingTracingResult
- onVideoSizeChanged
- onVideoStopped
- onVideoSubscribeStateChanged
- RtcEngineReleaseCallback
IRtcEngineEventHandlerEx
扩展 IRtcEngineEventHandler 功能的类。
IRtcEngineEx
扩展 IRtcEngine 的功能。
相关参考
- addVideoWatermarkEx [1/2]
- addVideoWatermarkEx [2/2]
- adjustUserPlaybackSignalVolumeEx
- clearVideoWatermarkEx
- createDataStreamEx [1/2]
- createDataStreamEx [2/2]
- enableAudioVolumeIndicationEx
- enableContentInspectEx
- enableDualStreamModeEx
- enableEncryptionEx
- enableLoopbackRecordingEx
- getCallIdEx
- getConnectionStateEx
- getUserInfoByUidEx
- getUserInfoByUserAccountEx
- joinChannelEx
- leaveChannelEx [1/2]
- leaveChannelEx [2/2]
- muteAllRemoteAudioStreamsEx
- muteAllRemoteVideoStreamsEx
- muteLocalAudioStreamEx
- muteLocalVideoStreamEx
- muteRemoteAudioStreamEx
- muteRemoteVideoStreamEx
- pauseAllChannelMediaRelayEx
- playEffectEx
- preloadEffectEx
- removeVideoWatermarkEx
- resumeAllChannelMediaRelayEx
- sendCustomReportMessageEx
- sendStreamMessageEx
- setDualStreamModeEx
- setRemoteRenderModeEx
- setRemoteVideoStreamTypeEx
- setRemoteVideoSubscriptionOptionsEx
- setRemoteVoicePositionEx
- setSubscribeAudioAllowlistEx
- setSubscribeAudioBlocklistEx
- setSubscribeVideoAllowlistEx
- setSubscribeVideoBlocklistEx
- setupRemoteVideoEx
- setVideoEncoderConfigurationEx
- startMediaRenderingTracingEx
- startOrUpdateChannelMediaRelayEx
- startRtmpStreamWithoutTranscodingEx
- startRtmpStreamWithTranscodingEx
- stopChannelMediaRelayEx
- stopRtmpStreamEx
- takeSnapshotEx [1/2]
- takeSnapshotEx [2/2]
- updateChannelMediaOptionsEx
- updateRtmpTranscodingEx
IScreenCaptureSourceList
用于获取屏幕共享源的列表。
相关参考
IVideoDeviceCollection
用于获取视频设备信息。
相关参考
IVideoDeviceManager
用于管理视频设备。
相关参考
IVideoEncodedFrameObserver
用于处理编码后的视频帧。
相关参考
IVideoFrameObserver
用于观察和处理视频帧。
相关参考
- getMirrorApplied
- getObservedFramePosition
- getRotationApplied
- getVideoFormatPreference
- getVideoFrameProcessMode
- onCaptureVideoFrame
- onFrame
- onPreEncodeVideoFrame
- onRenderVideoFrame
MusicChartCollection
用于获取音乐排行榜的详细信息。
相关参考
Player
Player 类用于播放 URL 资源。
自从
自 v4.4.0 版本新增。
相关参考
- GetConfigs [2/3]
- GetInfo
- GetPosition
- GetStats
- MuteAudio
- MuteVideo
- OpenWithUrl
- Pause
- Play
- Player
- PreloadWithUrl
- RegisterObserver
- Seek
- SetCanvas
- SetConfigs [2/3]
- Stop
- SwitchWithUrl
- UnregisterObserver
PlayerConfig
用于设置播放器配置。
自从
自 v4.4.0 版本新增。
相关参考
- GetAbrFallbackLayer
- GetAbrSubscriptionLayer
- GetAutoPlay
- GetLoopCount
- GetPlaybackSpeed
- GetPlayoutVolume
- SetAbrFallbackLayer
- SetAbrSubscriptionLayer
- SetAutoPlay
- SetLoopCount
- SetPlaybackSpeed
- SetPlayoutVolume
PlayerObserver
用于监听 Player 对象的事件。
自从
自 v4.4.0 版本新增。
相关参考
- onAudioVolumeIndication
- onEvent
- onMetadata [2/2]
- onPlayerInfoUpdated [2/2]
- onPositionChanged
- onResolutionChanged
- onStateChanged
Rte
Rte 类是声网实时互动 SDK 的基础接口。
自从
自 v4.4.0 版本新增。
相关参考
PlayerInfo
用于获取播放器和媒体流的相关信息。
自从
自 v4.5.1 版本新增。