HarmonyOS SDK API Reference

addBackgroundImage(backgroundImage: unknown): unknown
create(config: RtcEngineConfig): RtcEngine
createCustomAudioTrack(trackType: Constants.AudioTrackType, config: AudioTrackConfig): number
createEngine(context: Context, appID: string, handler: IRtcEngineEventHandler): RtcEngine
destroy(): number
destroyCustomAudioTrack(trackId: number): number
destroyMediaRecorder(recorder: AgoraMediaRecorder): void
enableAutoRemoveCache(enable: unknown): unknown
enableEncryptionEx(enabled: boolean, config: EncryptionConfig, connection: RtcConnection): number
enableFaceDetection(enabled: boolean): number
enableVideoImageSource(enabled: boolean, options: ImageTrackOptions): number
getCacheDir(): unknown
getCacheFileCount(): unknown
getDestChannelMediaInfos(): Map
getEffectsVolume(): number
getMaxCacheFileCount(): unknown
getMaxCacheFileSize(): unknown
getNtpWallTimeInMs(): bigint
getSrcChannelMediaInfo(): ChannelMediaInfo
getUserInfoByUid(uid: number, userInfo: UserInfo): number
getUserInfoByUserAccount(userAccount: string, userInfo: UserInfo): number
getVolumeOfEffect(soundId: number): number
getWatermarkList(): unknown
joinChannelWithUserAccount(token: string, channelName: string, userAccount: string, options?: ChannelMediaOptions): number
joinChannelWithUserAccountEx(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): number
muteRecordingSignal(muted: boolean): number
onAudioRouteChanged(route: Constants.AudioRouteTypes): void
onFacePositionChanged(imageWidth: number, imageHeight: number, faceRectArr: Array): void
onLyricResult(requestId: string, songCode: bigint, lyricUrl: string, reason: Constants.MusicContentCenterStateReason): void
onMusicChartsResult(requestId: string, list: MusicChartInfo[], reason: Constants.MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: string, page: number, pageSize: number, total: number, list: Music[], reason: Constants.MusicContentCenterStateReason): void
onPreLoadEvent(requestId: string, songCode: bigint, percent: number, lyricUrl: string, state: number, reason: Constants.MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: string, songCode: bigint, simpleInfo: string, reason: Constants.MusicContentCenterStateReason): void
onUserInfoUpdated(uid: unknown): unknown
pauseAllEffects(): 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): Promise
preloadChannelWithUserAccount(token: string, channelName: string, userAccount: string): number
preloadEffect(soundId: number, filePath: string, startPos?: number): Promise
registerLocalUserAccount(appId: string, userAccount: string): number
registerPlayerObserver(playerObserver: IMediaPlayerObserver): unknown
removeAllCaches(): unknown
removeBackgroundImage(backgroundImage: unknown): unknown
removeCacheByUri(uri: unknown): unknown
removeDestChannelInfo(channelName: string): unknown
removeOldCache(): unknown
resumeAllEffects(): number
resumeEffect(soundId: number): number
setAudioEffectPreset(preset: Constants.AudioEffectPreset): number
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions, sourceType?: Constants.MediaSourceType): number
setCacheDir(): unknown
setCameraExposurePosition(positionXinView: number, positionYinView: number): number
setCameraFocusPositionInPreview(positionX: number, positionY: number): number
setCameraZoomFactor(factor: number): number
setDestChannelInfo(channelName: string, destInfo: ChannelMediaInfo): unknown
setDualStreamMode(mode: Constants.SimulcastStreamMode, streamConfig?: SimulcastStreamConfig): number
setEffectsVolume(volume: number): number
setLocalVoiceEqualization(bandFrequency: Constants.AudioEqualizationBandFrequency, bandGain: number): number
setLocalVoicePitch(pitch: number): number
setLocalVoiceReverb(reverbKey: Constants.AudioReverbType, value: number): number
setMaxCacheFileCount(count: unknown): unknown
setMaxCacheFileSize(cacheSize: unknown): unknown
setRemoteRenderModeEx(uid: number, renderMode: number, mirrorMode: number, connection: RtcConnection): number
setRemoteSubscribeFallbackOption(option: Constants.StreamFallbackOptions): number
setSrcChannelInfo(srcInfo: ChannelMediaInfo): unknown
setVolumeOfEffect(soundId: number, volume: number): number
startAudioRecording(filePath: string, quality: Constants.AudioRecordingQualityType): number
startRecordingDeviceTest(indicationInterval: number): number
stopAllEffects(): number
stopEffect(soundId: number): number
stopLocalVideoTranscoder(): number
stopRecordingDeviceTest(): number
takeSnapshotEx(connection: RtcConnection, uid: number, filePath: string): number
unRegisterPlayerObserver(): unknown
unloadAllEffects(): number
unloadEffect(soundId: number): number
updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): number

setMediaRecorderObserver(callback: IMediaRecorderCallback | null): number
startRecording(config: MediaRecorderConfiguration): number
stopRecording(): number

createMusicPlayer(): IAgoraMusicPlayer
destroy(): void
destroyMusicPlayer(): unknown
getCaches(): MusicCacheInfo[]
getInternalSongCode(songCode: bigint, jsonOption: string): bigint
getLyric(songCode: bigint, lyricType: number): string
getMusicCharts(): string
getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string
getSongSimpleInfo(songCode: bigint): string
initialize(configuration: MusicContentCenterConfiguration): number
isPreloaded(songCode: bigint): number
preload(songCode: bigint): string
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number
release(): void
removeCache(songCode: bigint): number
renewToken(token: string): number
searchMusic(keyword: string, page: number, pageSize: number, jsonOption?: string): string
unregisterEventHandler(): number

setPlayMode(mode: Constants.MusicPlayMode): number

adjustPlayoutVolume(vol: number): number
adjustPublishSignalVolume(volume: number): number
getDuration(): number
getMediaPlayerId(): number
getMute(): boolean
getPlayPosition(): number
getPlaySrc(): string
getPlayoutVolume(): number
getPublishSignalVolume(): number
getState(): Constants.MediaPlayerState
getStreamCount(): number
getStreamInfo(index: number): MediaStreamInfo|undefined
mute(muted: boolean): number
open(url: string, startPos: number): number
openWithMediaSource(source: MediaPlayerSource): number
pause(): number
play(): number
playPreloadedSrc(src: string): number
preloadSrc(src: string, startPos: number): number
resume(): number
seek(newPos: number): number
selectAudioTrack(index: number): number
selectMultiAudioTrack(playoutTrackIndex: number, publishTrackIndex: number): number
setAudioDualMonoMode(mode: Constants.AudioDualMonoMode): number
setAudioPitch(pitch: number): number
setLoopCount(loopCount: number): number
setPlaybackSpeed(speed: number): number
setPlayerOption(key: string, value: number): unknown
setPlayerOptionString(key: string, value: string): number
setRenderMode(mode: number): number
setView(view: string): number
stop(): number
switchSrc(src: string, syncPts: boolean): number
unloadSrc(src: string): number

onAudioVolumeIndication(volume: number): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: ArrayBuffer): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: number, message: string): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPlayerStateChanged(state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason): void
onPositionChanged(positionMs: number, timestampMs: number): void
onPreloadEvent(src: string, event: Constants.MediaPlayerPreloadEvent): void

onAudioVolumeIndication(volume: number): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: ArrayBuffer): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: number, message: string): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPlayerStateChanged(state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason): void
onPositionChanged(positionMs: number, timestampMs: number): void
onPreloadEvent(src: string, event: Constants.MediaPlayerPreloadEvent): void

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

onAudioEffectFinished(soundId: number): void
onAudioMixingPositionChanged(position: bigint): void
onAudioMixingStateChanged(state: Constants.AudioMixingState, reason: Constants.AudioMixingReason): void
onAudioPublishStateChanged(channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number): void
onAudioSubscribeStateChanged(channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number): void
onAudioVolumeIndication(speakers: Array, totalVolume: number): void
onCameraExposureAreaChanged(rect: camera.Rect): void
onCameraFocusPointChanged(point: camera.Point): void
onChannelMediaRelayStateChanged(state: Constants.ChannelMediaRelayState, code: Constants.ChannelMediaRelayError): void
onClientRoleChangeFailed(reason: number, currentRole: Constants.ClientRole): void
onClientRoleChanged(oldRole: Constants.ClientRole, newRole: Constants.ClientRole, newRoleOptions: ClientRoleOptions): void
onConnectionLost(): void
onConnectionStateChanged(state: Constants.ConnectionState, reason: Constants.ConnectionChangedReason): void
onEncryptionError(errorType: Constants.EncryptionError): void
onError(err: Constants.ErrorCode, message: string): void
onFirstLocalVideoFrame(source: Constants.VideoSourceType, width: number, height: number, elapsed: number): void
onFirstRemoteVideoFrame(uid: number, width: number, height: number, elapsed: number): void
onJoinChannelSuccess(channel: string, uid: number, elapsed: number): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: Constants.QualityType): void
onLeaveChannel(stats: RtcStats): void
onLocalAudioStateChanged(state: Constants.LocalAudioStreamState, error: Constants.LocalAudioStreamReason): void
onLocalAudioStats(stats: LocalAudioStats): void
onLocalUserRegistered(uid: unknown, userAccount: unknown): unknown
onLocalVideoStateChanged(source: Constants.VideoSourceType, state: Constants.LocalVideoStreamState, reason: Constants.LocalVideoStreamReason): void
onLocalVideoStats(source: Constants.VideoSourceType, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: Constants.VideoTranscoderError): void
onNetworkQuality(uid: number, txQuality: Constants.NetworkQuality, rxQuality: Constants.NetworkQuality): void
onPermissionError(permission: Constants.PermissionType): void
onRejoinChannelSuccess(channel: string, uid: number, elapsed: number): void
onRemoteAudioStateChanged(uid: number, state: Constants.RemoteAudioStreamState, reason: Constants.RemoteAudioStreamReason, elapsed: number): void
onRemoteAudioStats(stats: RemoteAudioStats): void
onRemoteVideoStateChanged(uid: number, state: Constants.RemoteVideoStreamState, reason: Constants.RemoteVideoStreamReason, elapsed: number): void
onRemoteVideoStats(stats: RemoteVideoStats): void
onRequestToken(): void
onRtcStats(stats: RtcStats): void
onRtmpStreamingEvent(url: string, event: Constants.RtmpStreamingEvent): void
onRtmpStreamingStateChanged(url: string, state: Constants.RtmpStreamPublishState, reason: Constants.RtmpStreamPublishReason): void
onSnapshotTaken(uid: number, filePath: string, width: number, height: number, errCode: number): void
onStreamMessage(uid: number, streamId: number, data: Uint8Array): void
onStreamMessageError(uid: number, streamId: number, error: number, missed: number, cached: number): void
onTokenPrivilegeWillExpire(token: string): void
onTranscodingUpdated(): void
onUserEnableVideo(uid: number, enabled: boolean): void
onUserJoined(uid: number, elapse: number): void
onUserMuteAudio(uid: number, muted: boolean): void
onUserMuteVideo(uid: number, muted: boolean): void
onUserOffline(uid: number, reason: number): void
onVideoPublishStateChanged(source: Constants.VideoSourceType, channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number): void
onVideoSizeChanged(source: Constants.VideoSourceType, uid: number, width: number, height: number, rotation: number): void
onVideoSubscribeStateChanged(channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number): void

adjustAudioMixingPlayoutVolume(volume: number): number
adjustAudioMixingPublishVolume(volume: number): number
adjustAudioMixingVolume(volume: number): number
adjustPlaybackSignalVolume(volume: number): number
adjustRecordingSignalVolume(volume: number): number
adjustUserPlaybackSignalVolume(uid: number, volume: number): number
createCustomVideoTrack(): number
createDataStream(config: DataStreamConfig): number
createMediaPlayer(): IMediaPlayer|undefined
createMediaRecorder(info: RecorderStreamInfo): AgoraMediaRecorder
destroy(): Promise
destroyCustomVideoTrack(videoTrackId: number): number
disableAudio(): number
disableVideo(): number
enableAudio(): number
enableAudioVolumeIndication(interval: number, smooth: number, reportVad: boolean): number
enableContentInspect(enabled: boolean, config: ContentInspectConfig): number
enableEncryption(enabled: boolean, config: EncryptionConfig): number
enableInEarMonitoring(enabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterType): number
enableLocalAudio(enabled: boolean): number
enableLocalVideo(enabled: boolean): number
enableVideo(): number
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, sourceType?: Constants.MediaSourceType): number
getAudioMixingCurrentPosition(): number
getAudioMixingDuration(): number
getAudioMixingPlayoutVolume(): number
getAudioMixingPublishVolume(): number
getCallId(): string
getCameraMaxZoomFactor(): number
getCurrentMonotonicTimeInMs(): number
getErrorDescription(error: number): string
getNativeHandle(): bigint
getSdkVersion(): string
isCameraAutoFocusFaceModeSupported(): boolean
isCameraExposurePositionSupported(): boolean
isCameraExposureSupported(): boolean
isCameraFaceDetectSupported(): boolean
isCameraFocusSupported(): boolean
isCameraZoomSupported(): boolean
isSpeakerphoneEnabled(): boolean
joinChannel(key: string, channel: string, optionalInfo: string, uid: number): number
joinChannelWithOptions(token: string, channelId: string, uid: number, options: ChannelMediaOptions): number
leaveChannel(options?: LeaveChannelOptions): number
muteAllRemoteAudioStreams(muted: boolean): number
muteAllRemoteVideoStreams(muted: boolean): number
muteLocalAudioStream(muted: boolean): number
muteLocalVideoStream(muted: boolean): number
muteRemoteAudioStream(uid: number, muted: boolean): number
muteRemoteVideoStream(uid: number, muted: boolean): number
pauseAllChannelMediaRelay(): number
pauseAudioMixing(): number
pushExternalVideoFrame(frame: VideoFrame): boolean
pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: number): number
renewToken(token: string): number
resumeAllChannelMediaRelay(): number
resumeAudioMixing(): number
sendStreamMessage(streamId: number, message: ArrayBuffer): number
setAudioMixingPlaybackSpeed(speed: number): number
setAudioMixingPosition(pos: number): number
setAudioProfile(profile: Constants.AudioProfileType): number
setAudioScenario(scenario: Constants.AudioScenarioType): number
setCameraAutoFocusFaceModeEnabled(enabled: boolean): number
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number
setChannelProfile(profile: number): number
setClientRole(role: number, options?: ClientRoleOptions): number
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: boolean): number
setEnableSpeakerphone(enabled: unknown): unknown
setExternalVideoSource(enable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceType): number
setInEarMonitoringVolume(volume: number): number
setLocalRenderMode(renderMode: number, mirrorMode: number): number
setParameters(parameters: string): number
setRemoteDefaultVideoStreamType(streamType: Constants.VideoStreamType): number
setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number
setRemoteVideoStreamType(uid: number, streamType: Constants.VideoStreamType): number
setVideoEncoderConfiguration(configuration: VideoEncoderConfiguration): number
setVoiceBeautifierPreset(preset: Constants.VoiceBeautifierPreset): number
setupLocalVideo(canvas: VideoCanvas): number
setupRemoteVideo(canvas: VideoCanvas): number
startAudioMixing(filepath: string, loopback: boolean, cycle: number, startpos?: number): number
startAudioRecordingWithConfiguration(config: AudioRecordingConfiguration): number
startCameraCapture(sourceType: Constants.VideoSourceType, config: CameraCapturerConfiguration): number
startLastmileProbeTest(config: LastmileProbeConfig): number
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): number
startOrUpdateChannelMediaRelay(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration): number
startPreview(sourceType?: Constants.VideoSourceType): number
startRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): number
startRtmpStreamWithoutTranscoding(url: string): number
startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): number
stopAudioMixing(): number
stopAudioRecording(): number
stopCameraCapture(sourceType: Constants.VideoSourceType): number
stopChannelMediaRelay(): number
stopLastmileProbeTest(): number
stopPreview(sourceType?: Constants.VideoSourceType): number
stopRtmpStream(url: string): number
stopScreenCapture(): number
switchCamera(): number
takeSnapshot(uid: number, filePath: string): number
updateChannelMediaOptions(options: ChannelMediaOptions): number
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): number
updateRtmpTranscoding(transcoding: LiveTranscoding): number

adjustUserPlaybackSignalVolumeEx(uid: number, volume: number, connection: RtcConnection): number
createDataStreamEx(config: DataStreamConfig, connection: RtcConnection): number
enableAudioVolumeIndicationEx(interval: number, smooth: number, reportVad: boolean, connection: RtcConnection): number
getCallIdEx(connection: RtcConnection): string
joinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): number
leaveChannelEx(connection: RtcConnection, options?: LeaveChannelOptions): number
muteAllRemoteAudioStreamsEx(muted: boolean, connection: RtcConnection): number
muteAllRemoteVideoStreamsEx(muted: boolean, connection: RtcConnection): number
muteLocalAudioStreamEx(muted: boolean, connection: RtcConnection): number
muteLocalVideoStreamEx(muted: boolean, connection: RtcConnection): number
muteRemoteAudioStreamEx(uid: number, muted: boolean, connection: RtcConnection): number
muteRemoteVideoStreamEx(uid: number, muted: boolean, connection: RtcConnection): number
setDualStreamModeEx(mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
setRemoteVideoStreamTypeEx(uid: number, streamType: number, connection: RtcConnection): number
setRemoteVoicePositionEx(uid: unknown, pan: unknown, gain: unknown, connection: unknown): unknown
setVideoEncoderConfigurationEx(configuration: VideoEncoderConfiguration, connection: RtcConnection): number
setupRemoteVideoEx(remote: VideoCanvas, connection: RtcConnection): number
startOrUpdateChannelMediaRelayEx(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnection): number
updateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): number