API 列表
- HarmonyOS
更新时间不可用
本页列出 HarmonyOS 所有的接口类以及其中包含的 API。
RtcEngine
RTC SDK 的基础接口类，实现实时音视频的主要功能。
详情
RtcEngine 提供了 App 调用的主要方法。
相关参考
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- adjustUserPlaybackSignalVolume
- createCustomVideoTrack
- createDataStream
- createMediaPlayer
- createMediaRecorder
- destroyCustomVideoTrack
- disableAudio
- disableVideo
- enableAudio
- enableAudioVolumeIndication
- enableContentInspect
- enableEncryption
- enableInEarMonitoring
- enableLocalAudio
- enableLocalVideo
- enableVideo
- enableVirtualBackground
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getCallId
- getCameraMaxZoomFactor
- getCurrentMonotonicTimeInMs
- getErrorDescription
- getNativeHandle
- getSdkVersion
- isCameraAutoFocusFaceModeSupported
- isCameraExposurePositionSupported
- isCameraExposureSupported
- isCameraFaceDetectSupported
- isCameraFocusSupported
- isCameraZoomSupported
- isSpeakerphoneEnabled
- joinChannel
- joinChannelWithOptions
- leaveChannel
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRemoteAudioStream
- muteRemoteVideoStream
- pauseAllChannelMediaRelay
- pauseAudioMixing
- pushExternalVideoFrameById
- pushExternalVideoFrame
- destroy
- renewToken
- resumeAllChannelMediaRelay
- resumeAudioMixing
- sendStreamMessage
- setAudioMixingPosition
- setAudioMixingPlaybackSpeed
- setAudioProfile
- setAudioScenario
- setCameraAutoFocusFaceModeEnabled
- setCameraCapturerConfiguration
- setChannelProfile
- setClientRole
- setDefaultAudioRouteToSpeakerphone
- setEnableSpeakerphone
- setExternalVideoSource
- setInEarMonitoringVolume
- setLocalRenderMode
- setParameters
- setRemoteDefaultVideoStreamType
- setRemoteRenderMode
- setRemoteVideoStreamType
- setupLocalVideo
- setupRemoteVideo
- setVideoEncoderConfiguration
- setVoiceBeautifierPreset
- startAudioMixing
- startAudioRecordingWithConfiguration
- startLastmileProbeTest
- startLocalVideoTranscoder
- startOrUpdateChannelMediaRelay
- startPreview
- startCameraCapture
- startRtmpStreamWithoutTranscoding
- startRtmpStreamWithTranscoding
- startScreenCapture
- stopAudioMixing
- stopAudioRecording
- stopChannelMediaRelay
- stopLastmileProbeTest
- stopPreview
- stopCameraCapture
- stopRtmpStream
- stopScreenCapture
- switchCamera
- takeSnapshot
- updateChannelMediaOptions
- updateLocalTranscoderConfiguration
- updateRtmpTranscoding
RtcEngineEx
提供多频道方法的接口类。
详情
继承自 RtcEngine。
相关参考
- createDataStreamEx
- enableAudioVolumeIndicationEx
- getCallIdEx
- joinChannelEx
- leaveChannelEx
- muteAllRemoteAudioStreamsEx
- muteAllRemoteVideoStreamsEx
- muteLocalAudioStreamEx
- muteLocalVideoStreamEx
- muteRemoteAudioStreamEx
- muteRemoteVideoStreamEx
- setDualStreamModeEx
- setRemoteVideoStreamTypeEx
- setRemoteVoicePositionEx
- setupRemoteVideoEx
- setVideoEncoderConfigurationEx
- startOrUpdateChannelMediaRelayEx
- updateChannelMediaOptionsEx
- adjustUserPlaybackSignalVolumeEx
IRtcEngineEventHandler
接口类 IRtcEngineEventHandler 用于 SDK 向 App 发送事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。
详情
该接口类的所有方法都有缺省（空）实现， App 可以根据需要只继承关心的事件。
注意：
- 在回调方法中，App 不应该做耗时或者调用可能会引起阻塞的 API（如
sendMessage），否则可能影响 SDK 的运行。 - SDK 不再捕获开发者在 IRtcEngineEventHandler 类回调中自行实现的代码逻辑中的异常。你需要自行处理该异常，否则异常出现时可能引起 App 崩溃。
相关参考
- onAudioEffectFinished
- onAudioMixingPositionChanged
- onAudioMixingStateChanged
- onAudioPublishStateChanged
- onAudioSubscribeStateChanged
- onAudioVolumeIndication
- onCameraExposureAreaChanged
- onCameraFocusPointChanged
- onChannelMediaRelayStateChanged
- onClientRoleChanged
- onClientRoleChangeFailed
- onConnectionLost
- onConnectionStateChanged
- onEncryptionError
- onError
- onFirstLocalVideoFrame
- onFirstRemoteVideoFrame
- onJoinChannelSuccess
- onLastmileProbeResult
- onLastmileQuality
- onLeaveChannel
- onLocalAudioStateChanged
- onLocalAudioStats
- onLocalUserRegistered
- onLocalVideoStateChanged
- onLocalVideoStats
- onLocalVideoTranscoderError
- onNetworkQuality
- onPermissionError
- onRejoinChannelSuccess
- onRemoteAudioStateChanged
- onRemoteAudioStats
- onRemoteVideoStateChanged
- onRemoteVideoStats
- onRequestToken
- onRtcStats
- onRtmpStreamingEvent
- onRtmpStreamingStateChanged
- onSnapshotTaken
- onStreamMessage
- onStreamMessageError
- onTokenPrivilegeWillExpire
- onTranscodingUpdated
- onUserEnableVideo
- onUserJoined
- onUserMuteAudio
- onUserMuteVideo
- onUserOffline
- onVideoPublishStateChanged
- onVideoSizeChanged
- onVideoSubscribeStateChanged
IMediaPlayer
提供媒体播放器功能的类，支持多实例。
相关参考
- adjustPlayoutVolume
- adjustPublishSignalVolume
- getDuration
- getMediaPlayerId
- getMute
- getPlayoutVolume
- getPlayPosition
- getPlaySrc
- getPublishSignalVolume
- getState
- getStreamCount
- getStreamInfo
- mute
- open
- openWithMediaSource
- pause
- play
- playPreloadedSrc
- preloadSrc
- resume
- seek
- selectAudioTrack
- selectMultiAudioTrack
- setAudioPitch
- setAudioDualMonoMode
- setLoopCount
- setPlaybackSpeed
- setPlayerOption
- setPlayerOptionString
- setRenderMode
- setView
- stop
- switchSrc
- unloadSrc
IMediaPlayerObserver
提供媒体播放器的回调。
相关参考
- onAudioVolumeIndication
- onMetaData
- onPlayBufferUpdated
- onPlayerCacheStats
- onPlayerEvent
- onPlayerInfoUpdated
- onPlayerPlaybackStats
- onPlayerStateChanged
- onPlayerSrcInfoChanged
- onPositionChanged
- onPreloadEvent
AgoraMediaRecorder
提供本地及远端音视频录制功能的类。
相关参考
IMediaRecorderCallback
包含音视频录制的事件。
相关参考
IMusicContentCenterEventHandler
IMusicContentCenterEventHandler 接口类，用于 SDK 向客户端发送音乐内容中心事件通知。
IAgoraMusicPlayer
继承自 IMediaPlayer 类，提供音乐播放器的相关方法。
相关参考
IAgoraMusicContentCenter
IAgoraMusicContentCenter 接口类提供音乐内容中心的相关方法。