Unreal C++ SDK API Reference

destroyMediaRecorder(mediaRecorder: agora_refptr): int
get(index: int): MusicChartInfo*
getCount(): int
getCount(): int
getMusic(index: int32_t): Music*
getPage(): int
getPageSize(): int
getPlaybackDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDeviceVolume(volume: int*): int
getRecordingDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH]): int
getTotal(): int
onPlaybackAudioFrameBeforeMixing(channelId: const char*, uid: rtc::uid_t, audioFrame: AudioFrame&): bool
setExternalMediaProjection(mediaProjection: void*): int
setLocalAccessPoint(config: const LocalAccessPointConfiguration&): int
startAudioRecording(filePath: const char*, quality: AUDIO_RECORDING_QUALITY_TYPE): int
startAudioRecording(filePath: const char*, sampleRate: int, quality: AUDIO_RECORDING_QUALITY_TYPE): int

path(): unknown

setParameters(parameters: const char*): int

getApplicationVolume(volume: int&): int
getCount(): int
getDefaultDevice(null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getDefaultDevice(null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getDevice(index: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getDevice(index: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
isApplicationMute(mute: bool&): int
release(): void
setApplicationMute(mute: bool): int
setApplicationVolume(volume: int): int
setDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int

enumeratePlaybackDevices(): IAudioDeviceCollection*
enumerateRecordingDevices(): IAudioDeviceCollection*
followSystemLoopbackDevice(enable: bool): int
followSystemPlaybackDevice(enable: bool): int
followSystemRecordingDevice(enable: bool): int
getLoopbackDevice(null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDevice(null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDeviceMute(mute: bool*): int
getRecordingDevice(null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getRecordingDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH]): int
getRecordingDeviceMute(mute: bool*): int
getRecordingDeviceVolume(volume: int*): int
release(): void
setLoopbackDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int
setPlaybackDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int
setPlaybackDeviceMute(mute: bool): int
setPlaybackDeviceVolume(volume: int): int
setRecordingDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int
setRecordingDeviceMute(mute: bool): int
setRecordingDeviceVolume(volume: int): int
startAudioDeviceLoopbackTest(indicationInterval: int): int
startPlaybackDeviceTest(testAudioFilePath: const char*): int
startRecordingDeviceTest(indicationInterval: int): int
stopAudioDeviceLoopbackTest(): int
stopPlaybackDeviceTest(): int
stopRecordingDeviceTest(): int

onMixedAudioEncodedFrame(frameBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&): void
onPlaybackAudioEncodedFrame(frameBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&): void
onRecordAudioEncodedFrame(frameBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&): void

getEarMonitoringAudioParams(): AudioParams
getMixedAudioParams(): AudioParams
getObservedAudioFramePosition(): int
getPlaybackAudioParams(): AudioParams
getRecordAudioParams(): AudioParams
onEarMonitoringAudioFrame(audioFrame: AudioFrame&): bool
onMixedAudioFrame(channelId: const char*, audioFrame: AudioFrame&): bool
onPlaybackAudioFrame(channelId: const char*, audioFrame: AudioFrame&): bool
onRecordAudioFrame(channelId: const char*, audioFrame: AudioFrame&): bool

onFrame(frame: agora::media::base::AudioPcmFrame*): void

onLocalAudioSpectrum(data: const AudioSpectrumData&): bool
onRemoteAudioSpectrum(spectrums: const UserAudioSpectrumInfo*, spectrumNumber: unsigned int): bool

muteAllRemoteAudioStreams(mute: bool): int
muteLocalAudioStream(mute: bool): int
muteRemoteAudioStream(uid: uid_t, mute: bool): int
release(): void
setAudioRecvRange(range: float): int
setDistanceUnit(unit: float): int
setMaxAudioRecvCount(maxCount: int): int
setPlayerAttenuation(playerId: int, attenuation: double, forceSet: bool): int
setRemoteAudioAttenuation(uid: uid_t, attenuation: double, forceSet: bool): int
setZones(zones: const SpatialAudioZone*, zoneCount: unsigned int): int
updatePlayerPositionInfo(playerId: int, positionInfo: const RemoteVoicePositionInfo&): int
updateSelfPosition(null: float position[3], null: float axisForward[3], null: float axisRight[3], null: float axisUp[3]): int

onDirectCdnStreamingStateChanged(state: DIRECT_CDN_STREAMING_STATE, reason: DIRECT_CDN_STREAMING_REASON, message: const char*): void
onDirectCdnStreamingStats(stats: const DirectCdnStreamStats&): void

clearRemotePositions(): int
initialize(config: const LocalSpatialAudioConfig&): int
removeRemotePosition(uid: uid_t): int
updateRemotePosition(uid: uid_t, posInfo: const RemoteVoicePositionInfo&): int

createCustomAudioTrack(trackType: rtc::AUDIO_TRACK_TYPE, config: const rtc::AudioTrackConfig&): rtc::track_id_t
destroyCustomAudioTrack(trackId: rtc::track_id_t): int
pullAudioFrame(frame: IAudioFrameObserver::AudioFrame*): int
pushAudioFrame(frame: IAudioFrameObserver::AudioFrame*, trackId?: rtc::track_id_t): int
pushVideoFrame(frame: base::ExternalVideoFrame*, videoTrackId?: unsigned int): int
registerAudioFrameObserver(observer: IAudioFrameObserver*): int
registerVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver*): int
registerVideoFrameObserver(observer: IVideoFrameObserver*): int
setExternalAudioSource(enabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: bool): int
setExternalVideoSource(enabled: bool, useTexture: bool, sourceType?: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption?: rtc::SenderOptions): int

adjustPlayoutVolume(volume: int): int
adjustPublishSignalVolume(volume: int): int
getDuration(duration: int64_t&): int
getMediaPlayerCacheManager(): AGORA_API agora::rtc::IMediaPlayerCacheManager*AGORA_CALL
getMediaPlayerId(): int
getMute(mute: bool&): int
getPlayPosition(pos: int64_t&): int
getPlaySrc(): char*
getPlayoutVolume(volume: int&): int
getPublishSignalVolume(volume: int&): int
getState(): media::base::MEDIA_PLAYER_STATE
getStreamCount(count: int64_t&): int
getStreamInfo(index: int64_t, info: media::base::PlayerStreamInfo*): int
mute(muted: bool): int
open(url: const char*, startPos: int64_t): int
openWithMediaSource(source: const media::base::MediaSource&): int
pause(): int
play(): int
playPreloadedSrc(src: const char*): int
preloadSrc(src: const char*, startPos: int64_t): int
registerAudioFrameObserver(observer: media::IAudioPcmFrameSink*): int
registerAudioFrameObserver(observer: media::IAudioPcmFrameSink*, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE): int
registerPlayerSourceObserver(observer: IMediaPlayerSourceObserver*): int
registerVideoFrameObserver(observer: media::base::IVideoFrameObserver*): int
resume(): int
seek(newPos: int64_t): int
selectAudioTrack(index: int): int
selectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
setAudioDualMonoMode(mode: agora::media::base::AUDIO_DUAL_MONO_MODE): int
setAudioPitch(pitch: int): int
setLoopCount(loopCount: int): int
setPlaybackSpeed(speed: int): int
setPlayerOption(key: const char*, value: int64_t): int
setPlayerOption(key: const char*, value: const char*): int
setRenderMode(renderMode: media::base::RENDER_MODE_TYPE): int
setSpatialAudioParams(params: const SpatialAudioParams&): int
setView(view: media::base::view_t): int
stop(): int
switchSrc(src: const char*, syncPts: bool): int
unloadSrc(src: const char*): int
unregisterAudioFrameObserver(observer: media::IAudioPcmFrameSink*): int
unregisterPlayerSourceObserver(observer: IMediaPlayerSourceObserver*): int
unregisterVideoFrameObserver(observer: agora::media::base::IVideoFrameObserver*): int

enableAutoRemoveCache(enable: bool): int
getCacheDir(path: char*, length: int): int
getCacheFileCount(): int
getMaxCacheFileCount(): int
getMaxCacheFileSize(): int64_t
removeAllCaches(): int
removeCacheByUri(uri: const char*): int
removeOldCache(): int
setCacheDir(path: const char*): int
setMaxCacheFileCount(count: int): int
setMaxCacheFileSize(cacheSize: int64_t): int

onReadData(buffer: unsigned char*, bufferSize: int): int
onSeek(offset: int64_t, whence: int): int64_t

onAudioVolumeIndication(volume: int): void
onMetaData(data: const void*, length: int): void
onPlayBufferUpdated(playCachedBuffer: int64_t): void
onPlayerCacheStats(stats: const media::base::CacheStatistics&): void
onPlayerEvent(eventCode: media::base::MEDIA_PLAYER_EVENT, elapsedTime: int64_t, message: const char*): void
onPlayerInfoUpdated(info: const media::base::PlayerUpdatedInfo&): void
onPlayerPlaybackStats(stats: const media::base::PlayerPlaybackStats&): void
onPlayerSourceStateChanged(state: media::base::MEDIA_PLAYER_STATE, reason: media::base::MEDIA_PLAYER_REASON): void
onPlayerSrcInfoChanged(from: const media::base::SrcInfo&, to: const media::base::SrcInfo&): void
onPositionChanged(positionMs: int64_t, timestampMs: int64_t): void
onPreloadEvent(src: const char*, event: media::base::PLAYER_PRELOAD_EVENT): void

setMediaRecorderObserver(callback: media::IMediaRecorderObserver*): int
startRecording(config: const media::MediaRecorderConfiguration&): int
stopRecording(): int

onRecorderInfoUpdated(channelId: const char*, uid: rtc::uid_t, info: const RecorderInfo&): void
onRecorderStateChanged(channelId: const char*, uid: rtc::uid_t, state: RecorderState, reason: RecorderReasonCode): void

getMaxMetadataSize(): int
onMetadataReceived(metadata: const Metadata&): void
onReadyToSendMetadata(metadata: Metadata&, source_type: VIDEO_SOURCE_TYPE): bool

createMusicPlayer(): agora_refptr
destroyMusicPlayer(music_player: agora_refptr): int
getCaches(cacheInfo: MusicCacheInfo*, cacheInfoSize: int32_t*): int
getInternalSongCode(songCode: int64_t, jsonOption: const char*, internalSongCode: int64_t&): int
getLyric(requestId: agora::util::AString&, songCode: int64_t, LyricType?: int32_t): int
getMusicCharts(requestId: agora::util::AString&): int
getMusicCollectionWithMusicChartId(requestId: unknown, musicChartId: unknown, page: unknown, pageSize: unknown, jsonOption: unknown, Key: unknown, pitchType: unknown, needHighPart: unknown): unknown
getSongSimpleInfo(requestId: agora::util::AString&, songCode: int64_t): int
initialize(configuration: const MusicContentCenterConfiguration&): int
isPreloaded(songCode: int64_t): int
preload(songCode: int64_t, jsonOption?: const char*): int
preload(requestId: agora::util::AString&, songCode: int64_t): int
registerEventHandler(eventHandler: IMusicContentCenterEventHandler*): int
release(): void
removeCache(songCode: int64_t): int
renewToken(token: const char*): int
searchMusic(requestId: agora::util::AString&, keyWord: const char*, page: int32_t, pageSize: int32_t, jsonOption?: const char*): int
unregisterEventHandler(): int

onLyricResult(requestId: const char*, songCode: int64_t, lyricUrl: const char*, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: const char*, result: agora_refptr, reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: const char*, result: agora_refptr, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: const char*, songCode: int64_t, percent: int, lyricUrl: const char*, state: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: const char*, songCode: int64_t, simpleInfo: const char*, reason: MusicContentCenterStateReason): void

open(songCode: int64_t, startPos?: int64_t): int
setPlayMode(mode: MusicPlayMode): int

onReceiveAudioPacket(packet: Packet&): bool
onReceiveVideoPacket(packet: Packet&): bool
onSendAudioPacket(packet: Packet&): bool
onSendVideoPacket(packet: Packet&): bool

Get(): AgoraUERtcEngine*
Release(sync?: bool): void
addVideoWatermark(watermark: const RtcImage&): int
addVideoWatermark(watermarkUrl: const char*, options: const WatermarkOptions&): int
adjustAudioMixingPlayoutVolume(volume: int): int
adjustAudioMixingPublishVolume(volume: int): int
adjustAudioMixingVolume(volume: int): int
adjustCustomAudioPlayoutVolume(trackId: track_id_t, volume: int): int
adjustCustomAudioPublishVolume(trackId: track_id_t, volume: int): int
adjustLoopbackSignalVolume(volume: int): int
adjustPlaybackSignalVolume(volume: int): int
adjustRecordingSignalVolume(volume: int): int
adjustUserPlaybackSignalVolume(uid: unsigned int, volume: int): int
clearVideoWatermarks(): int
complain(callId: const char*, description: const char*): int
configRhythmPlayer(config: const AgoraRhythmPlayerConfig&): int
createCustomVideoTrack(): video_track_id_t
createDataStream(streamId: int*, reliable: bool, ordered: bool): int
createDataStream(streamId: int*, config: DataStreamConfig&): int
createMediaPlayer(): agora_refptr
createMediaRecorder(info: const RecorderStreamInfo&): agora_refptr
destroyCustomVideoTrack(video_track_id: video_track_id_t): int
destroyMediaPlayer(media_player: agora_refptr): int
disableAudio(): int
disableAudioSpectrumMonitor(): int
disableVideo(): int
enableAudio(): int
enableAudioSpectrumMonitor(intervalInMS?: int): int
enableAudioVolumeIndication(interval: int, smooth: int, reportVad: bool): int
enableCameraCenterStage(enabled: bool): int
enableContentInspect(enabled: bool, config: const media::ContentInspectConfig&): int
enableCustomAudioLocalPlayback(trackId: track_id_t, enabled: bool): int
enableDualStreamMode(enabled: bool): int
enableDualStreamMode(enabled: bool, streamConfig: const SimulcastStreamConfig&): int
enableEncryption(enabled: bool, config: const EncryptionConfig&): int
enableExtension(provider: const char*, extension: const char*, enable?: bool, type?: agora::media::MEDIA_SOURCE_TYPE): int
enableFaceDetection(enabled: bool): int
enableInEarMonitoring(enabled: bool, includeAudioFilters: int): int
enableInstantMediaRendering(): int
enableLocalAudio(enabled: bool): int
enableLocalVideo(enabled: bool): int
enableLoopbackRecording(enabled: bool, deviceName?: const char*): int
enableMultiCamera(enabled: unknown, config: unknown): unknown
enableSoundPositionIndication(enabled: bool): int
enableSpatialAudio(enabled: bool): int
enableVideo(): int
enableVideoImageSource(enable: bool, options: const ImageTrackOptions&): int
enableVirtualBackground(enabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: agora::media::MEDIA_SOURCE_TYPE): int
enableVoiceAITuner(enabled: bool, type: VOICE_AI_TUNER_TYPE): int
enableWebSdkInteroperability(enabled: bool): int
getAudioDeviceInfo(deviceInfo: DeviceInfo&): int
getAudioMixingCurrentPosition(): int
getAudioMixingDuration(): int
getAudioMixingPlayoutVolume(): int
getAudioMixingPublishVolume(): int
getAudioTrackCount(): int
getCallId(callId: agora::util::AString&): int
getCameraMaxZoomFactor(): float
getConnectionState(): CONNECTION_STATE_TYPE
getCurrentMonotonicTimeInMs(): int64_t
getEffectCurrentPosition(soundId: int): int
getEffectDuration(filePath: const char*): int
getEffectsVolume(): int
getErrorDescription(code: int): char*
getExtensionProperty(provider: const char*, extension: const char*, key: const char*, value: char*, buf_len: int, type?: agora::media::MEDIA_SOURCE_TYPE): int
getFaceShapeAreaOptions(shapeArea: agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA, options: FaceShapeAreaOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
getFaceShapeBeautyOptions(options: FaceShapeBeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
getNetworkType(): int
getNtpWallTimeInMs(): uint64_t
getScreenCaptureSources(thumbSize: const SIZE&, iconSize: const SIZE&, includeScreen: const bool): IScreenCaptureSourceList*
getUserInfoByUid(uid: uid_t, userInfo: rtc::UserInfo*, channelId?: const char*, localUserAccount?: const char*): int
getUserInfoByUserAccount(userAccount: const char*, userInfo: rtc::UserInfo*, channelId?: const char*, localUserAccount?: const char*): int
getVersion(build: int*): char*
getVolumeOfEffect(soundId: int): int
initialize(context: const RtcEngineContext&): int
isCameraAutoExposureFaceModeSupported(): bool
isCameraAutoFocusFaceModeSupported(): bool
isCameraCenterStageSupported(): bool
isCameraExposurePositionSupported(): bool
isCameraExposureSupported(): bool
isCameraFaceDetectSupported(): bool
isCameraFocusSupported(): bool
isCameraTorchSupported(): bool
isCameraZoomSupported(): bool
isFeatureAvailableOnDevice(type: FeatureType): bool
isSpeakerphoneEnabled(): bool
joinChannel(token: const char*, channelId: const char*, info: const char*, uid: uid_t): int
joinChannel(token: const char*, channelId: const char*, uid: uid_t, options: const ChannelMediaOptions&): int
joinChannelWithUserAccount(token: const char*, channelId: const char*, userAccount: const char*): int
joinChannelWithUserAccount(token: const char*, channelId: const char*, userAccount: const char*, options: const ChannelMediaOptions&): int
leaveChannel(): int
leaveChannel(options: const LeaveChannelOptions&): int
loadExtensionProvider(path: const char*, unload_after_use?: bool): int
muteAllRemoteAudioStreams(mute: bool): int
muteAllRemoteVideoStreams(mute: bool): int
muteLocalAudioStream(mute: bool): int
muteLocalVideoStream(mute: bool): int
muteRecordingSignal(mute: bool): int
muteRemoteAudioStream(uid: uid_t, mute: bool): int
muteRemoteVideoStream(userId: uid_t, mute: bool): int
pauseAllChannelMediaRelay(): int
pauseAllEffects(): int
pauseAudioMixing(): int
pauseEffect(soundId: int): int
playAllEffects(loopCount: int, pitch: double, pan: double, gain: int, publish?: bool): int
playEffect(soundId: int, filePath: const char*, loopCount: int, pitch: double, pan: double, gain: int, publish: bool, startPos: int): int
preloadChannel(token: const char*, channelId: const char*, uid: uid_t): int
preloadChannelWithUserAccount(token: const char*, channelId: const char*, userAccount: const char*): int
preloadEffect(soundId: int, filePath: const char*, startPos?: int): int
queryCameraFocalLengthCapability(focalLengthInfos: agora::rtc::FocalLengthInfo*, size: int&): int
queryCodecCapability(codecInfo: CodecCapInfo*, size: int&): int
queryDeviceScore(): int
queryInterface(iid: INTERFACE_ID_TYPE, inter: void**): int
queryScreenCaptureCapability(): unknown
rate(callId: const char*, rating: int, description: const char*): int
registerAudioEncodedFrameObserver(config: const AudioEncodedFrameObserverConfig&, observer: IAudioEncodedFrameObserver*): int
registerAudioSpectrumObserver(observer: agora::media::IAudioSpectrumObserver*): int
registerExtension(provider: const char*, extension: const char*, type?: agora::media::MEDIA_SOURCE_TYPE): int
registerLocalUserAccount(appId: const char*, userAccount: const char*): int
registerMediaMetadataObserver(observer: IMetadataObserver*, type: IMetadataObserver::METADATA_TYPE): int
registerPacketObserver(observer: IPacketObserver*): int
renewToken(token: const char*): int
resumeAllChannelMediaRelay(): int
resumeAllEffects(): int
resumeAudioMixing(): int
resumeEffect(soundId: int): int
selectAudioTrack(index: int): int
sendCustomReportMessage(id: const char*, category: const char*, event: const char*, label: const char*, value: int): int
sendStreamMessage(streamId: int, data: const char*, length: size_t): int
setAINSMode(enabled: bool, mode: AUDIO_AINS_MODE): int
setAVSyncSource(channelId: const char*, uid: uid_t): int
setAdvancedAudioOptions(options: media::base::AdvancedAudioOptions&): int
setAudioEffectParameters(preset: AUDIO_EFFECT_PRESET, param1: int, param2: int): int
setAudioEffectPreset(preset: AUDIO_EFFECT_PRESET): int
setAudioMixingDualMonoMode(mode: media::AUDIO_MIXING_DUAL_MONO_MODE): int
setAudioMixingPitch(pitch: int): int
setAudioMixingPlaybackSpeed(speed: int): int
setAudioMixingPosition(null: int pos /*in ms*/): int
setAudioProfile(profile: AUDIO_PROFILE_TYPE, scenario: AUDIO_SCENARIO_TYPE): int
setAudioProfile(profile: AUDIO_PROFILE_TYPE): int
setAudioScenario(scenario: AUDIO_SCENARIO_TYPE): int
setAudioSessionOperationRestriction(restriction: AUDIO_SESSION_OPERATION_RESTRICTION): int
setBeautyEffectOptions(enabled: bool, options: const BeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setCameraAutoExposureFaceModeEnabled(enabled: bool): int
setCameraAutoFocusFaceModeEnabled(enabled: bool): int
setCameraCapturerConfiguration(config: const CameraCapturerConfiguration&): int
setCameraDeviceOrientation(type: VIDEO_SOURCE_TYPE, orientation: VIDEO_ORIENTATION): int
setCameraExposureFactor(factor: float): int
setCameraExposurePosition(positionXinView: float, positionYinView: float): int
setCameraFocusPositionInPreview(positionX: float, positionY: float): int
setCameraStabilizationMode(mode: CAMERA_STABILIZATION_MODE): int
setCameraTorchOn(isOn: bool): int
setCameraZoomFactor(factor: float): int
setChannelProfile(profile: CHANNEL_PROFILE_TYPE): int
setClientRole(role: CLIENT_ROLE_TYPE): int
setClientRole(role: CLIENT_ROLE_TYPE, options: const ClientRoleOptions&): int
setCloudProxy(proxyType: CLOUD_PROXY_TYPE): int
setColorEnhanceOptions(enabled: bool, options: const ColorEnhanceOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): int
setDirectCdnStreamingAudioConfiguration(profile: AUDIO_PROFILE_TYPE): int
setDirectCdnStreamingVideoConfiguration(config: const VideoEncoderConfiguration&): int
setDualStreamMode(mode: SIMULCAST_STREAM_MODE): int
setDualStreamMode(mode: SIMULCAST_STREAM_MODE, streamConfig: const SimulcastStreamConfig&): int
setEarMonitoringAudioFrameParameters(sampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: int): int
setEffectPosition(soundId: int, pos: int): int
setEffectsVolume(volume: int): int
setEnableSpeakerphone(speakerOn: bool): int
setExtensionProperty(provider: const char*, extension: const char*, key: const char*, value: const char*, type?: agora::media::MEDIA_SOURCE_TYPE): int
setExtensionProviderProperty(provider: const char*, key: const char*, value: const char*): int
setExternalAudioSink(enabled: bool, sampleRate: int, channels: int): int
setExternalRemoteEglContext(eglContext: void*): int
setFaceShapeAreaOptions(options: const FaceShapeAreaOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setFaceShapeBeautyOptions(enabled: bool, options: const FaceShapeBeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setFilterEffectOptions(enabled: bool, options: const FilterEffectOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setHeadphoneEQParameters(lowGain: int, highGain: int): int
setHeadphoneEQPreset(preset: HEADPHONE_EQUALIZER_PRESET): int
setInEarMonitoringVolume(volume: int): int
setLocalRenderMode(renderMode: media::base::RENDER_MODE_TYPE): int
setLocalRenderMode(renderMode: media::base::RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
setLocalRenderTargetFps(sourceType: VIDEO_SOURCE_TYPE, targetFps: int): int
setLocalVideoMirrorMode(mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
setLocalVoiceEqualization(bandFrequency: AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: int): int
setLocalVoiceFormant(formantRatio: double): int
setLocalVoicePitch(pitch: double): int
setLocalVoiceReverb(reverbKey: AUDIO_REVERB_TYPE, value: int): int
setLogFile(filePath: const char*): int
setLogFileSize(fileSizeInKBytes: unsigned int): int
setLogFilter(filter: unsigned int): int
setLogLevel(level: commons::LOG_LEVEL): int
setLowlightEnhanceOptions(enabled: bool, options: const LowlightEnhanceOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setMixedAudioFrameParameters(sampleRate: int, channel: int, samplesPerCall: int): int
setParameters(parameters: const char*): int
setPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int): int
setPlaybackAudioFrameParameters(sampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: int): int
setRecordingAudioFrameParameters(sampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: int): int
setRemoteDefaultVideoStreamType(streamType: VIDEO_STREAM_TYPE): int
setRemoteRenderMode(userId: uid_t, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
setRemoteRenderTargetFps(targetFps: int): int
setRemoteSubscribeFallbackOption(option: STREAM_FALLBACK_OPTIONS): int
setRemoteUserSpatialAudioParams(uid: uid_t, params: const agora::SpatialAudioParams&): int
setRemoteVideoStreamType(uid: uid_t, streamType: VIDEO_STREAM_TYPE): int
setRemoteVideoSubscriptionOptions(uid: uid_t, options: const VideoSubscriptionOptions&): int
setRemoteVoicePosition(uid: uid_t, pan: double, gain: double): int
setRouteInCommunicationMode(route: int): int
setScreenCaptureContentHint(contentHint: VIDEO_CONTENT_HINT): int
setScreenCaptureScenario(screenScenario: SCREEN_SCENARIO_TYPE): int
setSubscribeAudioAllowlist(uidList: uid_t*, uidNumber: int): int
setSubscribeAudioBlocklist(uidList: uid_t*, uidNumber: int): int
setSubscribeVideoAllowlist(uidList: uid_t*, uidNumber: int): int
setSubscribeVideoBlocklist(uidList: uid_t*, uidNumber: int): int
setVideoDenoiserOptions(enabled: bool, options: const VideoDenoiserOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setVideoEncoderConfiguration(config: const VideoEncoderConfiguration&): int
setVideoScenario(scenarioType: VIDEO_APPLICATION_SCENARIO_TYPE): int
setVoiceBeautifierParameters(preset: VOICE_BEAUTIFIER_PRESET, param1: int, param2: int): int
setVoiceBeautifierPreset(preset: VOICE_BEAUTIFIER_PRESET): int
setVoiceConversionPreset(preset: VOICE_CONVERSION_PRESET): int
setVolumeOfEffect(soundId: int, volume: int): int
setupLocalVideo(canvas: const VideoCanvas&): int
setupRemoteVideo(canvas: const VideoCanvas&): int
startAudioMixing(filePath: const char*, loopback: bool, cycle: int): int
startAudioMixing(filePath: const char*, loopback: bool, cycle: int, startPos: int): int
startAudioRecording(config: const AudioFileRecordingConfig&): int
startCameraCapture(sourceType: VIDEO_SOURCE_TYPE, config: const CameraCapturerConfiguration&): int
startDirectCdnStreaming(eventHandler: IDirectCdnStreamingEventHandler*, publishUrl: const char*, options: const DirectCdnStreamingMediaOptions&): int
startEchoTest(config: const EchoTestConfiguration&): int
startLastmileProbeTest(config: const LastmileProbeConfig&): int
startLocalAudioMixer(config: const LocalAudioMixerConfiguration&): int
startLocalVideoTranscoder(config: const LocalTranscoderConfiguration&): int
startMediaRenderingTracing(): int
startOrUpdateChannelMediaRelay(configuration: const ChannelMediaRelayConfiguration&): int
startPreview(): int
startPreview(sourceType: VIDEO_SOURCE_TYPE): int
startRhythmPlayer(sound1: const char*, sound2: const char*, config: const AgoraRhythmPlayerConfig&): int
startRtmpStreamWithTranscoding(url: const char*, transcoding: const LiveTranscoding&): int
startRtmpStreamWithoutTranscoding(url: const char*): int
startScreenCapture(captureParams: unknown): unknown
startScreenCapture(sourceType: VIDEO_SOURCE_TYPE, config: const ScreenCaptureConfiguration&): int
startScreenCaptureByDisplayId(displayId: int64_t, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&): int
startScreenCaptureByScreenRect(screenRect: const Rectangle&, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&): int
startScreenCaptureByWindowId(windowId: int64_t, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&): int
stopAllEffects(): int
stopAudioMixing(): int
stopAudioRecording(): int
stopCameraCapture(sourceType: VIDEO_SOURCE_TYPE): int
stopChannelMediaRelay(): int
stopDirectCdnStreaming(): int
stopEchoTest(): int
stopEffect(soundId: int): int
stopLastmileProbeTest(): int
stopLocalAudioMixer(): int
stopLocalVideoTranscoder(): int
stopPreview(): int
stopPreview(sourceType: VIDEO_SOURCE_TYPE): int
stopRhythmPlayer(): int
stopRtmpStream(url: const char*): int
stopScreenCapture(): unknown
stopScreenCapture(sourceType: VIDEO_SOURCE_TYPE): int
switchCamera(): int
takeSnapshot(uid: uid_t, filePath: const char*): int
takeSnapshot(uid: uid_t, config: const media::SnapshotConfig&): int
unloadAllEffects(): int
unloadEffect(soundId: int): int
unregisterAudioSpectrumObserver(observer: agora::media::IAudioSpectrumObserver*): int
unregisterMediaMetadataObserver(observer: IMetadataObserver*, type: IMetadataObserver::METADATA_TYPE): int
updateChannelMediaOptions(options: const ChannelMediaOptions&): int
updateLocalAudioMixerConfiguration(config: const LocalAudioMixerConfiguration&): int
updateLocalTranscoderConfiguration(config: const LocalTranscoderConfiguration&): int
updatePreloadChannelToken(token: const char*): int
updateRtmpTranscoding(transcoding: const LiveTranscoding&): int
updateScreenCapture(captureParams: const ScreenCaptureParameters2&): int
updateScreenCaptureParameters(captureParams: const ScreenCaptureParameters&): int
updateScreenCaptureRegion(regionRect: const Rectangle&): int

onActiveSpeaker(userId: uid_t): void
onAudioDeviceStateChanged(deviceId: const char*, deviceType: int, deviceState: int): void
onAudioDeviceVolumeChanged(deviceType: MEDIA_DEVICE_TYPE, volume: int, muted: bool): void
onAudioEffectFinished(soundId: int): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: int64_t): void
onAudioMixingStateChanged(state: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPE): void
onAudioPublishStateChanged(channel: const char*, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
onAudioQuality(uid: uid_t, quality: int, delay: unsigned short, lost: unsigned short): void
onAudioRoutingChanged(routing: int): void
onAudioSubscribeStateChanged(channel: const char*, uid: uid_t, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void
onAudioVolumeIndication(speakers: const AudioVolumeInfo*, speakerNumber: unsigned int, totalVolume: int): void
onCameraExposureAreaChanged(x: int, y: int, width: int, height: int): void
onCameraFocusAreaChanged(x: int, y: int, width: int, height: int): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: CHANNEL_MEDIA_RELAY_STATE, code: CHANNEL_MEDIA_RELAY_ERROR): void
onClientRoleChangeFailed(reason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPE): void
onClientRoleChanged(oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: const ClientRoleOptions&): void
onConnectionBanned(): void
onConnectionInterrupted(): void
onConnectionLost(): void
onConnectionStateChanged(state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPE): void
onEncryptionError(errorType: ENCRYPTION_ERROR_TYPE): void
onError(err: int, msg: const char*): void
onExtensionErrorWithContext(context: const ExtensionContext&, error: int, message: const char*): void
onExtensionEventWithContext(context: const ExtensionContext&, key: const char*, value: const char*): void
onExtensionStartedWithContext(context: const ExtensionContext&): void
onExtensionStoppedWithContext(context: const ExtensionContext&): void
onFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: const Rectangle*, vecDistance: const int*, numFaces: int): void
onFirstLocalAudioFramePublished(elapsed: int): void
onFirstLocalVideoFrame(source: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int): void
onFirstLocalVideoFramePublished(source: VIDEO_SOURCE_TYPE, elapsed: int): void
onFirstRemoteAudioDecoded(uid: uid_t, elapsed: int): void
onFirstRemoteAudioFrame(uid: uid_t, elapsed: int): void
onFirstRemoteVideoDecoded(uid: uid_t, width: int, height: int, elapsed: int): void
onFirstRemoteVideoFrame(userId: uid_t, width: int, height: int, elapsed: int): void
onJoinChannelSuccess(channel: const char*, uid: uid_t, elapsed: int): void
onLastmileProbeResult(result: const LastmileProbeResult&): void
onLastmileQuality(quality: int): void
onLeaveChannel(stats: const RtcStats&): void
onLocalAudioStateChanged(state: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASON): void
onLocalAudioStats(stats: const LocalAudioStats&): void
onLocalUserRegistered(uid: uid_t, userAccount: const char*): void
onLocalVideoStateChanged(source: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASON): void
onLocalVideoStats(source: VIDEO_SOURCE_TYPE, stats: const LocalVideoStats&): void
onLocalVideoTranscoderError(stream: const TranscodingVideoStream&, error: VIDEO_TRANSCODER_ERROR): void
onNetworkQuality(uid: uid_t, txQuality: int, rxQuality: int): void
onNetworkTypeChanged(type: NETWORK_TYPE): void
onPermissionError(permissionType: PERMISSION_TYPE): void
onProxyConnected(channel: const char*, uid: uid_t, proxyType: PROXY_TYPE, localProxyIp: const char*, elapsed: int): void
onRejoinChannelSuccess(channel: const char*, uid: uid_t, elapsed: int): void
onRemoteAudioStateChanged(uid: uid_t, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: int): void
onRemoteAudioStats(stats: const RemoteAudioStats&): void
onRemoteAudioTransportStats(uid: uid_t, delay: unsigned short, lost: unsigned short, rxKBitRate: unsigned short): void
onRemoteSubscribeFallbackToAudioOnly(uid: uid_t, isFallbackOrRecover: bool): void
onRemoteVideoStateChanged(uid: uid_t, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: int): void
onRemoteVideoStats(stats: const RemoteVideoStats&): void
onRemoteVideoTransportStats(uid: uid_t, delay: unsigned short, lost: unsigned short, rxKBitRate: unsigned short): void
onRequestToken(): void
onRhythmPlayerStateChanged(state: RHYTHM_PLAYER_STATE_TYPE, reason: RHYTHM_PLAYER_REASON): void
onRtcStats(stats: const RtcStats&): void
onRtmpStreamingEvent(url: const char*, eventCode: RTMP_STREAMING_EVENT): void
onRtmpStreamingStateChanged(url: const char*, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASON): void
onSnapshotTaken(uid: uid_t, filePath: const char*, width: int, height: int, errCode: int): void
onStreamMessage(userId: uid_t, streamId: int, data: const char*, length: size_t, sentTs: uint64_t): void
onStreamMessageError(userId: uid_t, streamId: int, code: int, missed: int, cached: int): void
onTokenPrivilegeWillExpire(token: const char*): void
onTranscodedStreamLayoutInfo(uid: uid_t, width: int, height: int, layoutCount: int, layoutlist: const VideoLayout*): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: const UplinkNetworkInfo&): void
onUserEnableLocalVideo(uid: uid_t, enabled: bool): void
onUserEnableVideo(uid: uid_t, enabled: bool): void
onUserInfoUpdated(uid: uid_t, info: const UserInfo&): void
onUserJoined(uid: uid_t, elapsed: int): void
onUserMuteAudio(uid: uid_t, muted: bool): void
onUserMuteVideo(uid: uid_t, muted: bool): void
onUserOffline(uid: uid_t, reason: USER_OFFLINE_REASON_TYPE): void
onVideoDeviceStateChanged(deviceId: const char*, deviceType: int, deviceState: int): void
onVideoPublishStateChanged(source: VIDEO_SOURCE_TYPE, channel: const char*, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
onVideoRenderingTracingResult(uid: uid_t, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(sourceType: VIDEO_SOURCE_TYPE, uid: uid_t, width: int, height: int, rotation: int): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: const char*, uid: uid_t, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void