Unity SDK API Reference

path(): unknown

SetParameters(parameters: string): int

EnumeratePlaybackDevices(): DeviceInfo[]
EnumerateRecordingDevices(): DeviceInfo[]
FollowSystemLoopbackDevice(enable: bool): int
FollowSystemPlaybackDevice(enable: bool): int
FollowSystemRecordingDevice(enable: bool): int
GetLoopbackDevice(deviceId: string): int
GetPlaybackDefaultDevice(deviceId: string, deviceName: string): int
GetPlaybackDefaultDevice(deviceId: string, deviceTypeName: string, deviceName: string): int
GetPlaybackDevice(deviceId: string): int
GetPlaybackDeviceInfo(deviceId: string, deviceName: string): int
GetPlaybackDeviceInfo(deviceId: string, deviceName: string, deviceTypeName: string): int
GetPlaybackDeviceVolume(): int
GetRecordingDefaultDevice(deviceId: string, deviceName: string): int
GetRecordingDefaultDevice(deviceId: string, deviceTypeName: string, deviceName: string): int
GetRecordingDevice(deviceId: string): int
GetRecordingDeviceInfo(deviceId: string, deviceName: string): int
GetRecordingDeviceInfo(deviceId: string, deviceName: string, deviceTypeName: string): int
GetRecordingDeviceMute(): bool
GetRecordingDeviceVolume(): int
SetLoopbackDevice(deviceId: string): int
SetPlaybackDevice(deviceId: string): int
SetPlaybackDeviceMute(mute: bool): int
SetPlaybackDeviceVolume(volume: int): int
SetRecordingDevice(deviceId: string): int
SetRecordingDeviceMute(mute: bool): int
SetRecordingDeviceVolume(volume: int): int
StartAudioDeviceLoopbackTest(indicationInterval: int): int
StartPlaybackDeviceTest(testAudioFilePath: string): int
StartRecordingDeviceTest(indicationInterval: int): int
StopAudioDeviceLoopbackTest(): int
StopPlaybackDeviceTest(): int
StopRecordingDeviceTest(): int

OnMixedAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
OnPlaybackAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
OnRecordAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void

OnPlaybackAudioFrameBeforeMixing(channel_id: string, uid: uint, audio_frame: AudioFrame): bool

OnEarMonitoringAudioFrame(audioFrame: AudioFrame): bool
OnMixedAudioFrame(channelId: string, audio_frame: AudioFrame): bool
OnPlaybackAudioFrame(channelId: string, audio_frame: AudioFrame): bool
OnRecordAudioFrame(channelId: string, audioFrame: AudioFrame): bool

OnFrame(frame: AudioPcmFrame): bool

OnLocalAudioSpectrum(data: AudioSpectrumData): bool
OnRemoteAudioSpectrum(spectrums: UserAudioSpectrumInfo[], spectrumNumber: uint): bool

MuteAllRemoteAudioStreams(mute: bool): int
MuteLocalAudioStream(mute: bool): int
MuteRemoteAudioStream(uid: uint, mute: bool): int
SetAudioRecvRange(range: float): int
SetDistanceUnit(unit: float): int
SetMaxAudioRecvCount(maxCount: int): int
SetPlayerAttenuation(playerId: int, attenuation: double, forceSet: bool): int
SetZones(zones: SpatialAudioZone[], zoneCount: uint): int
UpdatePlayerPositionInfo(playerId: int, positionInfo: RemoteVoicePositionInfo): int
UpdateSelfPosition(position: float[], axisForward: float[], axisRight: float[], axisUp: float[]): int

ClearRemotePositions(): int
Dispose(): void
Initialize(): int
RemoveRemotePosition(uid: uint): int
SetRemoteAudioAttenuation(uid: uint, attenuation: double, forceSet: bool): int
UpdateRemotePosition(uid: uint, posInfo: RemoteVoicePositionInfo): int

CreateCustomAudioTrack(trackType: AUDIO_TRACK_TYPE, config: AudioTrackConfig): uint
DestroyCustomAudioTrack(trackId: uint): int
PullAudioFrame(frame: AudioFrame): int
PushAudioFrame(frame: AudioFrame, trackId?: uint): int
PushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: uint): int
RegisterAudioFrameObserver(audioFrameObserver: IAudioFrameObserver, position: AUDIO_FRAME_POSITION, mode?: OBSERVER_MODE): int
RegisterFaceInfoObserver(observer: IFaceInfoObserver): int
RegisterVideoEncodedFrameObserver(videoEncodedImageReceiver: IVideoEncodedFrameObserver, mode?: OBSERVER_MODE): int
RegisterVideoFrameObserver(videoFrameObserver: IVideoFrameObserver, formatPreference: VIDEO_OBSERVER_FRAME_TYPE, position: VIDEO_OBSERVER_POSITION, mode?: OBSERVER_MODE): int
SetExternalAudioSink(enabled: bool, sampleRate: int, channels: int): int
SetExternalAudioSource(enabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: bool): int
SetExternalVideoSource(enabled: bool, useTexture: bool, sourceType: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption: SenderOptions): int
UnregisterFaceInfoObserver(): int
UnregisterVideoEncodedFrameObserver(): int
UnregisterVideoFrameObserver(): int

AdjustPlayoutVolume(volume: int): int
AdjustPublishSignalVolume(volume: int): int
Dispose(): void
GetAudioBufferDelay(): int
GetDuration(duration: Int64): int
GetId(): int
GetMute(muted: bool): int
GetPlayPosition(pos: Int64): int
GetPlaySrc(): string
GetPlayoutVolume(volume: int): int
GetPublishSignalVolume(volume: int): int
GetState(): MEDIA_PLAYER_STATE
GetStreamCount(count: Int64): int
GetStreamInfo(index: Int64, info: PlayerStreamInfo): int
InitEventHandler(engineEventHandler: IMediaPlayerSourceObserver): int
Mute(muted: bool): int
Open(url: string, startPos: Int64): int
OpenWithMediaSource(source: MediaSource): int
Pause(): int
Play(): int
PlayPreloadedSrc(src: string): int
PreloadSrc(src: string, startPos: Int64): int
RegisterAudioFrameObserver(observer: IAudioPcmFrameSink): int
RegisterAudioFrameObserver(observer: IAudioPcmFrameSink, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE): int
Resume(): int
Seek(newPos: Int64): int
SelectAudioTrack(index: int): int
SelectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
SetAudioDualMonoMode(mode: AUDIO_DUAL_MONO_MODE): int
SetAudioPitch(pitch: int): int
SetLoopCount(loopCount: int): int
SetPlaybackSpeed(speed: int): int
SetPlayerOption(key: string, value: int): int
SetRenderMode(renderMode: RENDER_MODE_TYPE): int
SetSpatialAudioParams(spatial_audio_params: SpatialAudioParams): int
SetView(): int
Stop(): int
SwitchSrc(src: string, syncPts?: bool): int
UnloadSrc(src: string): int
UnregisterAudioFrameObserver(): int
setPlayerOption(key: string, value: string): int

EnableAutoRemoveCache(enable: bool): int
GetCacheDir(path: string, length: int): int
GetCacheFileCount(): int
GetMaxCacheFileCount(): int
GetMaxCacheFileSize(): Int64
GetMediaPlayerCacheManager(): IMediaPlayerCacheManager
RemoveAllCaches(): int
RemoveCacheByUri(uri: string): int
RemoveOldCache(): int
SetCacheDir(path: string): int
SetMaxCacheFileCount(count: int): int
SetMaxCacheFileSize(cacheSize: Int64): int

OnReadData(bufferPtr: IntPtr, bufferSize: int): int
OnSeek(offset: Int64, whence: int): Int64

OnMetaData(data: byte[], length: int): void
OnPlayBufferUpdated(playCachedBuffer: Int64): void
OnPlayerCacheStats(stats: CacheStatistics): void
OnPlayerEvent(eventCode: MEDIA_PLAYER_EVENT, elapsedTime: Int64, message: string): void
OnPlayerInfoUpdated(info: PlayerUpdatedInfo): void
OnPlayerPlaybackStats(stats: PlayerPlaybackStats): void
OnPlayerSourceStateChanged(state: MEDIA_PLAYER_STATE, reason: MEDIA_PLAYER_REASON): void
OnPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
OnPositionChanged(positionMs: long, timestampMs: long): void
OnPreloadEvent(src: string, null: PLAYER_PRELOAD_EVENT): void
onAudioVolumeIndication(volume: int): void

SetMediaRecorderObserver(callback: IMediaRecorderObserver): int
StartRecording(config: MediaRecorderConfiguration): int
StopRecording(): int

OnRecorderInfoUpdated(channelId: string, uid: uint, info: RecorderInfo): void
OnRecorderStateChanged(channelId: string, uid: uint, state: RecorderState, reason: RecorderReasonCode): void

OnMetadataReceived(metadata: Metadata): void
OnReadyToSendMetadata(metadata: Metadata, source_type: VIDEO_SOURCE_TYPE): bool

CreateMusicPlayer(): IMusicPlayer
DestroyMusicPlayer(music_player: IMusicPlayer): int
GetCaches(cacheInfo: MusicCacheInfo[], cacheInfoSize: Int32): int
GetInternalSongCode(songCode: Int64, jsonOption: string, internalSongCode: Int64): int
GetLyric(requestId: string, songCode: Int64, LyricType?: int): int
GetMusicCharts(requestId: string): int
GetMusicCollectionByMusicChartId(requestId: string, musicChartType: int, page: int, pageSize: int, jsonOption?: string): int
GetSongSimpleInfo(requestId: string, songCode: Int64): int
Initialize(configuration: MusicContentCenterConfiguration): int
IsPreloaded(songCode: Int64): int
Preload(songCode: Int64, jsonOption?: string): int
Preload(requestId: string, songCode: Int64): int
RegisterEventHandler(eventHandler: IMusicContentCenterEventHandler): int
RemoveCache(songCode: Int64): int
RenewToken(token: string): int
SearchMusic(requestId: string, keyWord: string, page: int, pageSize: int, jsonOption?: string): int
UnregisterEventHandler(): int

OnLyricResult(requestId: string, songCode: long, lyricUrl: string, reason: MusicContentCenterStateReason): void
OnMusicChartsResult(requestId: string, result: MusicChartInfo[], reason: MusicContentCenterStateReason): void
OnMusicCollectionResult(requestId: string, result: MusicCollection, reason: MusicContentCenterStateReason): void
OnPreLoadEvent(requestId: string, songCode: long, percent: int, lyricUrl: string, state: PreloadState, reason: MusicContentCenterStateReason): void
OnSongSimpleInfoResult(requestId: string, songCode: long, simpleInfo: string, reason: MusicContentCenterStateReason): void

Open(songCode: Int64, startPos: Int64): int
SetPlayMode(mode: MusicPlayMode): int

AddVideoWatermark(watermark: RtcImage): int
AddVideoWatermark(watermarkUrl: string, options: WatermarkOptions): int
AddVideoWatermark(configs: WatermarkConfig): int
AdjustAudioMixingPlayoutVolume(volume: int): int
AdjustAudioMixingPublishVolume(volume: int): int
AdjustAudioMixingVolume(volume: int): int
AdjustCustomAudioPlayoutVolume(trackId: uint, volume: int): int
AdjustCustomAudioPublishVolume(trackId: uint, volume: int): int
AdjustLoopbackSignalVolume(volume: int): int
AdjustPlaybackSignalVolume(volume: int): int
AdjustRecordingSignalVolume(volume: int): int
AdjustUserPlaybackSignalVolume(uid: uint, volume: int): int
ClearVideoWatermarks(): int
Complain(callId: string, description: string): int
ConfigRhythmPlayer(config: AgoraRhythmPlayerConfig): int
CreateAgoraRtcEngine(): IRtcEngine
CreateCustomVideoTrack(): video_track_id_t
CreateDataStream(streamId: int, reliable: bool, ordered: bool): int
CreateDataStream(streamId: int, config: DataStreamConfig): int
CreateMediaPlayer(): IMediaPlayer
CreateMediaRecorder(info: RecorderStreamInfo): IMediaRecorder
CreateVideoEffectObject(bundlePath: string, type?: MEDIA_SOURCE_TYPE): IVideoEffectObject
DestroyCustomVideoTrack(video_track_id: video_track_id_t): int
DestroyMediaPlayer(mediaPlayer: IMediaPlayer): int
DestroyMediaRecorder(mediaRecorder: IMediaRecorder): int
DestroyVideoEffectObject(videoEffectObject: IVideoEffectObject): int
DisableAudio(): int
DisableAudioSpectrumMonitor(): int
DisableVideo(): int
Dispose(sync?: bool): void
EnableAudio(): int
EnableAudioSpectrumMonitor(intervalInMS?: int): int
EnableAudioVolumeIndication(interval: int, smooth: int, reportVad: bool): int
EnableCameraCenterStage(enabled: bool): int
EnableContentInspect(enabled: bool, config: ContentInspectConfig): int
EnableCustomAudioLocalPlayback(trackId: uint, enabled: bool): int
EnableDualStreamMode(enabled: bool): int
EnableDualStreamMode(enabled: bool, streamConfig: SimulcastStreamConfig): int
EnableEncryption(enabled: bool, config: EncryptionConfig): int
EnableExtension(provider: string, extension: string, enable?: bool, type?: 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?: string): int
EnableMultiCamera(enabled: bool, config: CameraCapturerConfiguration): int
EnableSoundPositionIndication(enabled: bool): int
EnableSpatialAudio(enabled: bool): int
EnableVideo(): int
EnableVideoImageSource(enable: bool, options: ImageTrackOptions): int
EnableVirtualBackground(enabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MEDIA_SOURCE_TYPE): int
EnableVoiceAITuner(enabled: bool, type: VOICE_AI_TUNER_TYPE): int
EnableWebSdkInteroperability(enabled: bool): int
GetAudioDeviceInfo(deviceInfo: DeviceInfoMobile): int
GetAudioDeviceManager(): IAudioDeviceManager
GetAudioMixingCurrentPosition(): int
GetAudioMixingDuration(): int
GetAudioMixingPlayoutVolume(): int
GetAudioMixingPublishVolume(): int
GetAudioTrackCount(): int
GetCallId(callId: string): int
GetCameraMaxZoomFactor(): float
GetConnectionState(): CONNECTION_STATE_TYPE
GetCurrentMonotonicTimeInMs(): long
GetEffectCurrentPosition(soundId: int): int
GetEffectDuration(filePath: string): int
GetEffectsVolume(): int
GetErrorDescription(code: int): string
GetExtensionProperty(provider: string, extension: string, key: string, value: string, buf_len: int, type?: MEDIA_SOURCE_TYPE): int
GetFaceShapeAreaOptions(shapeArea: FACE_SHAPE_AREA, options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPE): int
GetFaceShapeBeautyOptions(options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPE): int
GetLocalSpatialAudioEngine(): ILocalSpatialAudioEngine
GetMusicContentCenter(): IMusicContentCenter
GetNativeHandler(nativeHandler: IntPtr): int
GetNetworkType(): int
GetNtpWallTimeInMs(): UInt64
GetScreenCaptureSources(thumbSize: SIZE, iconSize: SIZE, includeScreen: bool): ScreenCaptureSourceInfo[]
GetUserInfoByUid(uid: uint, userInfo: UserInfo): int
GetUserInfoByUserAccount(userAccount: string, userInfo: UserInfo): int
GetVersion(build: int): string
GetVideoDeviceManager(): IVideoDeviceManager
GetVolumeOfEffect(soundId: int): int
InitEventHandler(engineEventHandler: IRtcEngineEventHandler): int
Initialize(context: 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: string, channelId: string, info?: string, uid?: uint): int
JoinChannel(token: string, channelId: string, uid: uint, options: ChannelMediaOptions): int
JoinChannelWithUserAccount(token: string, channelId: string, userAccount: string): int
JoinChannelWithUserAccount(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions): int
LeaveChannel(): int
LeaveChannel(options: LeaveChannelOptions): int
LoadExtensionProvider(path: string, 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: uint, mute: bool): int
MuteRemoteVideoStream(uid: uint, 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: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: int): int
PreloadChannel(token: string, channelId: string, uid: uint): int
PreloadChannelWithUserAccount(token: unknown, channelId: unknown, userAccount: unknown): unknown
PreloadEffect(soundId: int, filePath: string, startPos?: int): int
QueryCameraFocalLengthCapability(focalLengthInfos: FocalLengthInfo[], size: int): int
QueryCodecCapability(codecInfo: CodecCapInfo[], size: int): int
QueryDeviceScore(): int
QueryScreenCaptureCapability(): int
Rate(callId: string, rating: int, description: string): int
RegisterAudioEncodedFrameObserver(config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver): int
RegisterAudioSpectrumObserver(observer: IAudioSpectrumObserver): int
RegisterExtension(provider: string, extension: string, type?: MEDIA_SOURCE_TYPE): int
RegisterLocalUserAccount(appId: string, userAccount: string): int
RegisterMediaMetadataObserver(observer: IMetadataObserver, type: METADATA_TYPE): int
RemoveVideoWatermark(id: string): int
RenewToken(token: string): int
ResumeAllChannelMediaRelay(): int
ResumeAllEffects(): int
ResumeAudioMixing(): int
ResumeEffect(soundId: int): int
SelectAudioTrack(index: int): int
SendCustomReportMessage(id: string, category: string, null: string, label: string, value: int): int
SendMetadata(metadata: Metadata, source_type: VIDEO_SOURCE_TYPE): int
SendStreamMessage(streamId: int, data: byte[], length: uint): int
SetAINSMode(enabled: bool, mode: AUDIO_AINS_MODE): int
SetAVSyncSource(channelId: string, uid: uint): int
SetAdvancedAudioOptions(options: AdvancedAudioOptions): int
SetAudioEffectParameters(preset: AUDIO_EFFECT_PRESET, param1: int, param2: int): int
SetAudioEffectPreset(preset: AUDIO_EFFECT_PRESET): int
SetAudioMixingDualMonoMode(mode: AUDIO_MIXING_DUAL_MONO_MODE): int
SetAudioMixingPitch(pitch: int): int
SetAudioMixingPlaybackSpeed(speed: int): int
SetAudioMixingPosition(pos: int): 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: BeautyOptions, type?: MEDIA_SOURCE_TYPE): int
SetCameraAutoExposureFaceModeEnabled(enabled: bool): int
SetCameraAutoFocusFaceModeEnabled(enabled: bool): int
SetCameraCapturerConfiguration(config: 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: ClientRoleOptions): int
SetCloudProxy(proxyType: CLOUD_PROXY_TYPE): int
SetColorEnhanceOptions(enabled: bool, options: ColorEnhanceOptions, type?: MEDIA_SOURCE_TYPE): int
SetDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): int
SetDualStreamMode(mode: SIMULCAST_STREAM_MODE): int
SetDualStreamMode(mode: SIMULCAST_STREAM_MODE, streamConfig: 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: string, extension: string, key: string, value: string, type?: MEDIA_SOURCE_TYPE): int
SetExtensionProviderProperty(provider: string, key: string, value: string): int
SetExternalMediaProjection(mediaProjection: IntPtr): int
SetExternalRemoteEglContext(eglContext: IntPtr): int
SetFaceShapeAreaOptions(options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPE): int
SetFaceShapeBeautyOptions(enabled: bool, options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPE): int
SetFilterEffectOptions(enabled: bool, options: FilterEffectOptions, type?: MEDIA_SOURCE_TYPE): int
SetHeadphoneEQParameters(lowGain: int, highGain: int): int
SetHeadphoneEQPreset(preset: HEADPHONE_EQUALIZER_PRESET): int
SetInEarMonitoringVolume(volume: int): int
SetLocalAccessPoint(config: LocalAccessPointConfiguration): int
SetLocalRenderMode(renderMode: RENDER_MODE_TYPE): int
SetLocalRenderMode(renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
SetLocalRenderTargetFps(sourceType: VIDEO_SOURCE_TYPE, targetFps: int): int
SetLocalVideoDataSourcePosition(position: VIDEO_MODULE_POSITION): 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: string): int
SetLogFileSize(fileSizeInKBytes: uint): int
SetLogFilter(filter: uint): int
SetLogLevel(level: LOG_LEVEL): int
SetLowlightEnhanceOptions(enabled: bool, options: LowlightEnhanceOptions, type?: MEDIA_SOURCE_TYPE): int
SetMaxMetadataSize(size: int): int
SetMixedAudioFrameParameters(sampleRate: int, channel: int, samplesPerCall: int): int
SetParameters(key: string, value: object): int
SetPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int): int
SetPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int, samplesPerCall: 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(uid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
SetRemoteRenderTargetFps(targetFps: int): int
SetRemoteSubscribeFallbackOption(option: STREAM_FALLBACK_OPTIONS): int
SetRemoteUserSpatialAudioParams(uid: uint, param: SpatialAudioParams): int
SetRemoteVideoStreamType(uid: uint, streamType: VIDEO_STREAM_TYPE): int
SetRemoteVideoSubscriptionOptions(uid: uint, options: VideoSubscriptionOptions): int
SetRemoteVoicePosition(uid: uint, pan: double, gain: double): int
SetRouteInCommunicationMode(route: int): int
SetScreenCaptureContentHint(contentHint: VIDEO_CONTENT_HINT): int
SetScreenCaptureScenario(screenScenario: SCREEN_SCENARIO_TYPE): int
SetSubscribeAudioAllowlist(uidList: uint[], uidNumber: int): int
SetSubscribeAudioBlocklist(uidList: uint[], uidNumber: int): int
SetSubscribeVideoAllowlist(uidList: uint[], uidNumber: int): int
SetSubscribeVideoBlocklist(uidList: uint[], uidNumber: int): int
SetVideoDenoiserOptions(enabled: bool, options: VideoDenoiserOptions, type?: MEDIA_SOURCE_TYPE): int
SetVideoEncoderConfiguration(config: 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: VideoCanvas): int
SetupRemoteVideo(canvas: VideoCanvas): int
StartAudioMixing(filePath: string, loopback: bool, cycle: int): int
StartAudioMixing(filePath: string, loopback: bool, cycle: int, startPos: int): int
StartAudioRecording(filePath: string, quality: AUDIO_RECORDING_QUALITY_TYPE): int
StartAudioRecording(filePath: string, sampleRate: int, quality: AUDIO_RECORDING_QUALITY_TYPE): int
StartAudioRecording(config: AudioRecordingConfiguration): int
StartCameraCapture(sourceType: VIDEO_SOURCE_TYPE, config: CameraCapturerConfiguration): int
StartEchoTest(config: EchoTestConfiguration): int
StartLastmileProbeTest(config: LastmileProbeConfig): int
StartLocalAudioMixer(config: LocalAudioMixerConfiguration): int
StartLocalVideoTranscoder(config: LocalTranscoderConfiguration): int
StartMediaRenderingTracing(): int
StartOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): int
StartPreview(): int
StartPreview(sourceType: VIDEO_SOURCE_TYPE): int
StartRhythmPlayer(sound1: string, sound2: string, config: AgoraRhythmPlayerConfig): int
StartRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): int
StartRtmpStreamWithoutTranscoding(url: string): int
StartScreenCapture(captureParams: ScreenCaptureParameters2): int
StartScreenCapture(sourceType: VIDEO_SOURCE_TYPE, config: ScreenCaptureConfiguration): int
StartScreenCaptureByDisplayId(displayId: uint, regionRect: Rectangle, captureParams: ScreenCaptureParameters): int
StartScreenCaptureByScreenRect(screenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParameters): int
StartScreenCaptureByWindowId(windowId: long, regionRect: Rectangle, captureParams: ScreenCaptureParameters): int
StopAllEffects(): int
StopAudioMixing(): int
StopAudioRecording(): int
StopCameraCapture(sourceType: VIDEO_SOURCE_TYPE): int
StopChannelMediaRelay(): 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: string): int
StopScreenCapture(): int
StopScreenCapture(sourceType: VIDEO_SOURCE_TYPE): int
SwitchCamera(): int
TakeSnapshot(uid: uint, filePath: string): int
TakeSnapshot(uid: uint, config: SnapshotConfig): int
UnRegisterAudioEncodedFrameObserver(): int
UnRegisterAudioFrameObserver(): int
UnloadAllEffects(): int
UnloadEffect(soundId: int): int
UnregisterAudioSpectrumObserver(): int
UnregisterMediaMetadataObserver(): int
UpdateChannelMediaOptions(options: ChannelMediaOptions): int
UpdateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): int
UpdateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): int
UpdatePreloadChannelToken(token: string): int
UpdateRtmpTranscoding(transcoding: LiveTranscoding): int
UpdateScreenCapture(captureParams: ScreenCaptureParameters2): int
UpdateScreenCaptureParameters(captureParams: ScreenCaptureParameters): int
UpdateScreenCaptureRegion(regionRect: Rectangle): int

OnActiveSpeaker(connection: RtcConnection, uid: uint): void
OnAudioDeviceStateChanged(deviceId: string, deviceType: MEDIA_DEVICE_TYPE, deviceState: MEDIA_DEVICE_STATE_TYPE): void
OnAudioDeviceVolumeChanged(deviceType: MEDIA_DEVICE_TYPE, volume: int, muted: bool): void
OnAudioEffectFinished(soundId: int): void
OnAudioMixingFinished(): void
OnAudioMixingPositionChanged(position: long): void
OnAudioMixingStateChanged(state: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPE): void
OnAudioPublishStateChanged(channel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
OnAudioQuality(connection: RtcConnection, remoteUid: uint, quality: int, delay: UInt16, lost: UInt16): void
OnAudioRoutingChanged(routing: int): void
OnAudioSubscribeStateChanged(channel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void
OnAudioVolumeIndication(connection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: uint, 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: int, code: int): void
OnClientRoleChangeFailed(connection: RtcConnection, reason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPE): void
OnClientRoleChanged(connection: RtcConnection, oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: ClientRoleOptions): void
OnConnectionBanned(connection: RtcConnection): void
OnConnectionInterrupted(connection: RtcConnection): void
OnConnectionLost(connection: RtcConnection): void
OnConnectionStateChanged(connection: RtcConnection, state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPE): void
OnEncryptionError(connection: RtcConnection, errorType: ENCRYPTION_ERROR_TYPE): void
OnError(err: int, msg: string): void
OnExtensionErrorWithContext(context: ExtensionContext, error: int, message: string): void
OnExtensionEventWithContext(context: ExtensionContext, key: string, value: string): void
OnExtensionStartedWithContext(context: unknown): unknown
OnExtensionStoppedWithContext(context: ExtensionContext): void
OnFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int[], numFaces: int): void
OnFirstLocalAudioFramePublished(connection: RtcConnection, elapsed: int): void
OnFirstLocalVideoFrame(source: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int): void
OnFirstLocalVideoFramePublished(connection: RtcConnection, elapsed: int): void
OnFirstRemoteAudioDecoded(connection: RtcConnection, uid: uint, elapsed: int): void
OnFirstRemoteAudioFrame(connection: RtcConnection, userId: uint, elapsed: int): void
OnFirstRemoteVideoDecoded(connection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: int): void
OnFirstRemoteVideoFrame(connection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: int): void
OnJoinChannelSuccess(connection: RtcConnection, elapsed: int): void
OnLastmileProbeResult(result: LastmileProbeResult): void
OnLastmileQuality(quality: int): void
OnLeaveChannel(connection: RtcConnection, stats: RtcStats): void
OnLocalAudioStateChanged(connection: RtcConnection, state: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASON): void
OnLocalAudioStats(connection: RtcConnection, stats: LocalAudioStats): void
OnLocalUserRegistered(uid: uint, userAccount: string): void
OnLocalVideoEvent(source: VideoSourceType, event: LocalVideoEventType): void
OnLocalVideoStateChanged(source: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASON): void
OnLocalVideoStats(connection: RtcConnection, stats: LocalVideoStats): void
OnLocalVideoTranscoderError(stream: TranscodingVideoStream, error: VIDEO_TRANSCODER_ERROR): void
OnMultipathStats(connection: RtcConnection, stats: MultipathStats): void
OnNetworkQuality(connection: RtcConnection, remoteUid: uint, txQuality: int, rxQuality: int): void
OnNetworkTypeChanged(connection: RtcConnection, type: NETWORK_TYPE): void
OnPermissionError(permissionType: PERMISSION_TYPE): void
OnPermissionGranted(permissionType: PermissionType): void
OnProxyConnected(channel: string, uid: uint, proxyType: PROXY_TYPE, localProxyIp: string, elapsed: int): void
OnRejoinChannelSuccess(connection: RtcConnection, elapsed: int): void
OnRemoteAudioStateChanged(connection: RtcConnection, remoteUid: uint, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: int): void
OnRemoteAudioStats(connection: RtcConnection, stats: RemoteAudioStats): void
OnRemoteAudioTransportStats(connection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16): void
OnRemoteSubscribeFallbackToAudioOnly(uid: uint, isFallbackOrRecover: bool): void
OnRemoteVideoStateChanged(connection: RtcConnection, remoteUid: uint, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: int): void
OnRemoteVideoStats(connection: RtcConnection, stats: RemoteVideoStats): void
OnRemoteVideoTransportStats(connection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16): void
OnRenewTokenResult(connection: RtcConnection, token: string, code: RENEW_TOKEN_ERROR_CODE): void
OnRequestToken(connection: RtcConnection): void
OnRhythmPlayerStateChanged(state: RHYTHM_PLAYER_STATE_TYPE, reason: RHYTHM_PLAYER_REASON): void
OnRtcStats(connection: RtcConnection, stats: RtcStats): void
OnRtmpStreamingEvent(url: string, eventCode: RTMP_STREAMING_EVENT): void
OnRtmpStreamingStateChanged(url: string, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASON): void
OnSnapshotTaken(connection: RtcConnection, uid: uint, filePath: string, width: int, height: int, errCode: int): void
OnStreamMessage(connection: RtcConnection, remoteUid: uint, streamId: int, data: byte[], length: ulong, sentTs: ulong): void
OnStreamMessageError(connection: RtcConnection, remoteUid: uint, streamId: int, code: int, missed: int, cached: int): void
OnTokenPrivilegeWillExpire(connection: RtcConnection, token: string): void
OnTranscodedStreamLayoutInfo(connection: RtcConnection, uid: uint, width: int, height: int, layoutCount: int, layoutlist: VideoLayout[]): void
OnTranscodingUpdated(): void
OnUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
OnUserEnableLocalVideo(connection: RtcConnection, remoteUid: uint, enabled: bool): void
OnUserEnableVideo(connection: RtcConnection, remoteUid: uint, enabled: bool): void
OnUserInfoUpdated(uid: uint, info: UserInfo): void
OnUserJoined(connection: RtcConnection, remoteUid: uint, elapsed: int): void
OnUserMuteAudio(connection: RtcConnection, remoteUid: uint, muted: bool): void
OnUserMuteVideo(connection: RtcConnection, remoteUid: uint, muted: bool): void
OnUserOffline(connection: RtcConnection, remoteUid: uint, reason: USER_OFFLINE_REASON_TYPE): void
OnVideoDeviceStateChanged(deviceId: string, deviceType: int, deviceState: int): void
OnVideoPublishStateChanged(source: VIDEO_SOURCE_TYPE, channel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
OnVideoRenderingTracingResult(connection: RtcConnection, uid: uint, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo): void
OnVideoSizeChanged(connection: RtcConnection, sourceType: VIDEO_SOURCE_TYPE, uid: uint, width: int, height: int, rotation: int): void
OnVideoStopped(): void
OnVideoSubscribeStateChanged(channel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void

AddVideoWatermarkEx(watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection): int
AdjustUserPlaybackSignalVolumeEx(uid: uint, volume: int, connection: RtcConnection): int
ClearVideoWatermarkEx(connection: RtcConnection): int
CreateAgoraRtcEngineEx(): IRtcEngineEx
CreateDataStreamEx(streamId: int, reliable: bool, ordered: bool, connection: RtcConnection): int
CreateDataStreamEx(streamId: int, config: DataStreamConfig, connection: RtcConnection): int
EnableAudioVolumeIndicationEx(interval: int, smooth: int, reportVad: bool, connection: RtcConnection): int
EnableContentInspectEx(enabled: bool, config: ContentInspectConfig, connection: RtcConnection): int
EnableDualStreamModeEx(enabled: bool, streamConfig: SimulcastStreamConfig, connection: RtcConnection): int
EnableEncryptionEx(connection: RtcConnection, enabled: bool, config: EncryptionConfig): int
EnableLoopbackRecordingEx(connection: RtcConnection, enabled: bool, deviceName: string): int
GetCallIdEx(callId: string, connection: RtcConnection): int
GetConnectionStateEx(connection: RtcConnection): CONNECTION_STATE_TYPE
JoinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions): int
LeaveChannelEx(connection: RtcConnection): int
LeaveChannelEx(connection: RtcConnection, options: LeaveChannelOptions): int
MuteAllRemoteAudioStreamsEx(mute: bool, connection: RtcConnection): int
MuteAllRemoteVideoStreamsEx(mute: bool, connection: RtcConnection): int
MuteLocalAudioStreamEx(mute: bool, connection: RtcConnection): int
MuteLocalVideoStreamEx(mute: bool, connection: RtcConnection): int
MuteRemoteAudioStreamEx(uid: uint, mute: bool, connection: RtcConnection): int
MuteRemoteVideoStreamEx(uid: uint, mute: bool, connection: RtcConnection): int
PauseAllChannelMediaRelayEx(connection: RtcConnection): int
PlayEffectEx(connection: RtcConnection, soundId: int, filePath: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: int): int
PreloadEffectEx(connection: RtcConnection, soundId: int, filePath: string, startPos?: int): int
RemoveVideoWatermarkEx(id: string, connection: RtcConnection): int
ResumeAllChannelMediaRelayEx(connection: RtcConnection): int
SendCustomReportMessageEx(id: string, category: string, null: string, label: string, value: int, connection: RtcConnection): int
SendStreamMessageEx(streamId: int, data: byte[], length: uint, connection: RtcConnection): int
SetDualStreamModeEx(mode: SIMULCAST_STREAM_MODE, streamConfig: SimulcastStreamConfig, connection: RtcConnection): int
SetRemoteRenderModeEx(uid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: RtcConnection): int
SetRemoteVideoStreamTypeEx(uid: uint, streamType: VIDEO_STREAM_TYPE, connection: RtcConnection): int
SetRemoteVideoSubscriptionOptionsEx(uid: uint, options: VideoSubscriptionOptions, connection: RtcConnection): int
SetRemoteVoicePositionEx(uid: uint, pan: double, gain: double, connection: RtcConnection): int
SetSubscribeAudioAllowlistEx(uidList: unknown, uidNumber: unknown, connection: unknown): unknown
SetSubscribeAudioBlocklistEx(uidList: uint[], uidNumber: int, connection: RtcConnection): int
SetSubscribeVideoAllowlistEx(uidList: uint[], uidNumber: int, connection: RtcConnection): int
SetSubscribeVideoBlocklistEx(uidList: uint[], uidNumber: int, connection: RtcConnection): int
SetVideoEncoderConfigurationEx(config: VideoEncoderConfiguration, connection: RtcConnection): int
SetupRemoteVideoEx(canvas: VideoCanvas, connection: RtcConnection): int
StartMediaRenderingTracingEx(connection: RtcConnection): int
StartOrUpdateChannelMediaRelayEx(configuration: ChannelMediaRelayConfiguration, connection: RtcConnection): int
StartRtmpStreamWithTranscodingEx(url: string, transcoding: LiveTranscoding, connection: RtcConnection): int
StartRtmpStreamWithoutTranscodingEx(url: string, connection: RtcConnection): int
StopChannelMediaRelayEx(connection: RtcConnection): int
StopRtmpStreamEx(url: string, connection: RtcConnection): int
TakeSnapshotEx(connection: RtcConnection, uid: uint, filePath: string): int
TakeSnapshotEx(connection: RtcConnection, uid: uint, config: SnapshotConfig): int
UpdateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): int
UpdateRtmpTranscodingEx(transcoding: LiveTranscoding, connection: RtcConnection): int