nimeet Docs
中文

C# (.NET) SDK API Reference

Complete C# (.NET) public surface generated from the public SDK interface definition: classes, interfaces, enums, events, error identifiers and capability scope.

Generated from the public SDK interface definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Interface overview

This page lists the public API of C#(.NET): classes, methods, overloads, properties, events and error codes. The interface definition matches the SDK package version.

Checklist itemCount
Interface / class121
Method519
Method overloads525
Property591
Enums144
error-code constants46

Availability

This platform's SDK: Generally available. The interface definition matches the SDK package version; runtime capability follows the published SDK package.

Join channel flow

Arranged in the typical call order of join / leave / publish / subscribe; the parameter table is expanded under “Parameters of the minimal runnable flow”.

StepInterfaceMethodOverload count
Join a channel__unattributed__JoinChannel1
Leave a channel__unattributed__LeaveChannel1
subscribe to remote media__unattributed__MuteRemoteAudioStream1
role switching__unattributed__SetClientRole1
local video__unattributed__SetupLocalVideo1
enable video and preview__unattributed__StartPreview1
Create / initializeILocalSpatialAudioEngineInitialize1
Renew the TokenIRtcEngineRenewToken1
Channel scenariosIRtcEngineSetChannelProfile1

parameters for the minimal runnable flow

ParametersTypeOptionalVariadic parameters
tokenstringNoNo
channelIdstringNoNo
infostringisNo
uiduintisNo
uiduintNoNo
muteboolNoNo
roleCLIENT_ROLE_TYPENoNo
canvasVideoCanvasNoNo
tokenstringNoNo
profileCHANNEL_PROFILE_TYPENoNo

Endpoint index

InterfaceMethodPropertyEvents
__unattributed__13300
AdvancedAudioOptions010
AdvancedConfigInfo010
AdvanceOptions030
AgoraRhythmPlayerConfig020
AudioEncodedFrameObserverConfig020
AudioFileRecordingConfig060
AudioFrame080
AudioParams040
AudioPcmFrame060
AudioSpectrumData020
AudioTrackConfig020
AudioVolumeInfo040
BeautyOptions050
CacheStatistics030
CameraCapturerConfiguration040
ChannelMediaInfo030
ChannelMediaOptions0310
ChannelMediaRelayConfiguration030
ClientRoleOptions010
ClimaxSegment020
CodecCapInfo030
CodecCapLevels020
ColorEnhanceOptions020
ContentInspectConfig030
ContentInspectModule020
DataStreamConfig020
DeviceInfo020
DeviceInfoMobile010
DirectCdnStreamingMediaOptions050
DirectCdnStreamingStats050
EchoTestConfiguration060
EncodedAudioFrameInfo060
EncodedVideoFrameInfo0100
EncryptionConfig040
ExtensionContext040
ExternalVideoFrame0200
FaceShapeAreaOptions020
FaceShapeBeautyOptions020
FilterEffectOptions110
FocalLengthInfo020
IAudioEncodedFrameObserver300
IAudioPcmFrameSink100
IAudioSpectrumObserver200
ILocalSpatialAudioEngine400
ImageTrackOptions020
IMediaPlayer3800
IMediaPlayerCacheManager1100
IMediaPlayerSourceObserver902
IMediaRecorder300
IMediaRecorderObserver200
IMetadataObserver100
IRtcEngine19900
IRtcEngineEventHandler6804
IRtcEngineEx4000
IVideoEncodedFrameObserver100
IVideoFrameObserver300
LastmileProbeConfig040
LastmileProbeOneWayResult030
LastmileProbeResult040
LeaveChannelOptions030
LiveStreamAdvancedFeature020
LiveTranscoding0230
LocalAccessPointConfiguration070
LocalAudioMixerConfiguration030
LocalAudioStats080
LocalSpatialAudioConfig010
LocalTranscoderConfiguration030
LocalVideoStats0220
LogConfig030
LogUploadServerInfo040
LowlightEnhanceOptions020
MediaRecorderConfiguration0110
MediaSource090
Metadata050
MixedAudioStream040
Music0120
PlayerPlaybackStats040
PlayerStreamInfo0130
PlayerUpdatedInfo060
RecorderInfo030
RecorderStreamInfo030
Rectangle040
RemoteAudioStats0160
RemoteVideoStats0160
RemoteVoicePositionInfo020
RtcConnection020
RtcEngineContext070
RtcImage070
RtcStats0240
ScreenAudioParameters030
ScreenCaptureConfiguration060
ScreenCaptureParameters0100
ScreenCaptureParameters2040
ScreenCaptureSourceInfo0100
ScreenVideoParameters040
SegmentationProperty020
SimulcastStreamConfig030
SnapshotConfig020
SpatialAudioParams080
SpatialAudioZone090
SrcInfo020
ThumbImageBuffer040
TranscodingUser080
TranscodingVideoStream0110
UplinkNetworkInfo010
UserAudioSpectrumInfo020
UserInfo020
VideoCanvas0120
VideoDenoiserOptions020
VideoDimensions020
VideoEncoderConfiguration090
VideoFormat030
VideoFrame0210
VideoFrameBufferConfig030
VideoLayout080
VideoRenderingTracingInfo070
VideoSubscriptionOptions020
VirtualBackgroundSource040
WatermarkOptions050
WatermarkRatio030

all endpoints

__unattributed__ 133 method / 0 Property
typescript
AddVideoWatermark(watermark: RtcImage): int
AdjustLoopbackSignalVolume(volume: int): int
CreateAgoraRtcEngineEx(): IRtcEngineEx
CreateCustomAudioTrack(trackType: AUDIO_TRACK_TYPE, config: AudioTrackConfig): uint
CreateDataStream(streamId: int, reliable: bool, ordered: bool): int
CreateDataStreamEx(streamId: int, reliable: bool, ordered: bool, connection: RtcConnection): int
DestroyCustomAudioTrack(trackId: uint): int
DestroyMediaRecorder(mediaRecorder: IMediaRecorder): int
DestroyMusicPlayer(music_player: IMusicPlayer): int
Dispose(): void
EnableDualStreamMode(enabled: bool): int
EnableLoopbackRecording(enabled: bool, deviceName?: string): int
EnableLoopbackRecordingEx(connection: RtcConnection, enabled: bool, deviceName: string): int
EnumeratePlaybackDevices(): DeviceInfo[]
EnumerateRecordingDevices(): DeviceInfo[]
EnumerateVideoDevices(): DeviceInfo[]
FollowSystemLoopbackDevice(enable: bool): int
FollowSystemPlaybackDevice(enable: bool): int
FollowSystemRecordingDevice(enable: bool): int
GetAudioDeviceManager(): IAudioDeviceManager
GetCapability(deviceIdUTF8: string, deviceCapabilityNumber: uint, capability: VideoFormat): int
GetDevice(deviceIdUTF8: string): int
GetFaceShapeAreaOptions(shapeArea: FACE_SHAPE_AREA, options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPE): int
GetFaceShapeBeautyOptions(options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPE): int
GetLocalSpatialAudioEngine(): ILocalSpatialAudioEngine
GetLoopbackDevice(deviceId: string): int
GetNativeHandler(nativeHandler: IntPtr): 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
GetPlaybackDeviceMute(): bool
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
GetScreenCaptureSources(thumbSize: SIZE, iconSize: SIZE, includeScreen: bool): ScreenCaptureSourceInfo[]
GetVideoDeviceManager(): IVideoDeviceManager
InitEventHandler(engineEventHandler: IRtcEngineEventHandler): int
IsCameraExposureSupported(): bool
IsFeatureAvailableOnDevice(type: FeatureType): bool
JoinChannel(token: string, channelId: string, info?: string, uid?: uint): int
JoinChannelWithUserAccount(token: string, channelId: string, userAccount: string): int
LeaveChannel(): int
LeaveChannelEx(connection: RtcConnection): int
MuteAllRemoteAudioStreams(mute: bool): int
MuteLocalAudioStream(mute: bool): int
MuteRemoteAudioStream(uid: uint, mute: bool): int
NumberOfCapabilities(deviceIdUTF8: string): int
OnAudioDeviceStateChanged(deviceId: string, deviceType: MEDIA_DEVICE_TYPE, deviceState: MEDIA_DEVICE_STATE_TYPE): void
OnAudioDeviceVolumeChanged(deviceType: MEDIA_DEVICE_TYPE, volume: int, muted: bool): void
OnDirectCdnStreamingStateChanged(state: DIRECT_CDN_STREAMING_STATE, reason: DIRECT_CDN_STREAMING_REASON, message: string): void
OnDirectCdnStreamingStats(stats: DirectCdnStreamingStats): void
OnEarMonitoringAudioFrame(audioFrame: AudioFrame): bool
OnFirstLocalVideoFrame(source: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int): void
OnMixedAudioFrame(channelId: string, audio_frame: AudioFrame): bool
OnPlaybackAudioFrame(channelId: string, audio_frame: AudioFrame): bool
OnPlaybackAudioFrameBeforeMixing(channel_id: string, uid: uint, audio_frame: AudioFrame): bool
OnReadData(bufferPtr: IntPtr, bufferSize: int): int
OnRecordAudioFrame(channelId: string, audioFrame: AudioFrame): bool
OnSeek(offset: Int64, whence: int): Int64
OnVideoDeviceStateChanged(deviceId: string, deviceType: int, deviceState: int): void
PullAudioFrame(frame: AudioFrame): int
PushAudioFrame(frame: AudioFrame, trackId?: uint): int
PushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: uint): int
QueryCameraFocalLengthCapability(focalLengthInfos: FocalLengthInfo[], size: int): int
QueryCodecCapability(codecInfo: CodecCapInfo[], size: int): int
QueryScreenCaptureCapability(): int
RegisterAudioFrameObserver(audioFrameObserver: IAudioFrameObserver, position: AUDIO_FRAME_POSITION, mode?: OBSERVER_MODE): int
RegisterVideoEncodedFrameObserver(videoEncodedImageReceiver: IVideoEncodedFrameObserver, mode?: OBSERVER_MODE): int
RegisterVideoFrameObserver(videoFrameObserver: IVideoFrameObserver, formatPreference: VIDEO_OBSERVER_FRAME_TYPE, position: VIDEO_OBSERVER_POSITION, mode?: OBSERVER_MODE): int
SendMetadata(metadata: Metadata, source_type: VIDEO_SOURCE_TYPE): int
SetAudioProfile(profile: AUDIO_PROFILE_TYPE): int
SetAudioRecvRange(range: float): int
SetCameraStabilizationMode(mode: CAMERA_STABILIZATION_MODE): int
SetClientRole(role: CLIENT_ROLE_TYPE): int
SetDevice(deviceIdUTF8: string): int
SetDistanceUnit(unit: float): int
SetDualStreamMode(mode: SIMULCAST_STREAM_MODE): int
SetExternalAudioSource(enabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: bool): int
SetExternalMediaProjection(mediaProjection: IntPtr): int
SetExternalRemoteEglContext(eglContext: IntPtr): int
SetExternalVideoSource(enabled: bool, useTexture: bool, sourceType: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption: SenderOptions): 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
SetLocalAccessPoint(config: LocalAccessPointConfiguration): int
SetLocalRenderMode(renderMode: RENDER_MODE_TYPE): int
SetLocalRenderTargetFps(sourceType: VIDEO_SOURCE_TYPE, targetFps: int): int
SetLocalVideoDataSourcePosition(position: VIDEO_MODULE_POSITION): int
SetLoopbackDevice(deviceId: string): int
SetMaxAudioRecvCount(maxCount: int): int
SetMaxMetadataSize(size: int): int
SetParameters(parameters: string): int
SetPlaybackDevice(deviceId: string): int
SetPlaybackDeviceMute(mute: bool): int
SetPlaybackDeviceVolume(volume: int): int
SetPlayerAttenuation(playerId: int, attenuation: double, forceSet: bool): int
SetRecordingDevice(deviceId: string): int
SetRecordingDeviceMute(mute: bool): int
SetRecordingDeviceVolume(volume: int): int
SetRemoteAudioAttenuation(uid: uint, attenuation: double, forceSet: bool): int
SetRemoteRenderModeEx(uid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: RtcConnection): int
SetRemoteRenderTargetFps(targetFps: int): int
SetRouteInCommunicationMode(route: int): int
SetZones(zones: SpatialAudioZone[], zoneCount: uint): int
SetupLocalVideo(canvas: VideoCanvas): int
SetupRemoteVideo(canvas: VideoCanvas): int
SetupRemoteVideoEx(canvas: VideoCanvas, connection: RtcConnection): int
StartAudioDeviceLoopbackTest(indicationInterval: int): int
StartAudioMixing(filePath: string, loopback: bool, cycle: int): int
StartAudioRecording(filePath: string, quality: AUDIO_RECORDING_QUALITY_TYPE): int
StartAudioRecording(filePath: string, sampleRate: int, quality: AUDIO_RECORDING_QUALITY_TYPE): int
StartLocalAudioMixer(config: LocalAudioMixerConfiguration): int
StartPlaybackDeviceTest(testAudioFilePath: string): int
StartPreview(): int
StartRecordingDeviceTest(indicationInterval: int): 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
StopAudioDeviceLoopbackTest(): int
StopLocalAudioMixer(): int
StopPlaybackDeviceTest(): int
StopPreview(): int
StopRecordingDeviceTest(): int
StopScreenCapture(sourceType: VIDEO_SOURCE_TYPE): int
TakeSnapshot(uid: uint, config: SnapshotConfig): int
TakeSnapshotEx(connection: RtcConnection, uid: uint, config: SnapshotConfig): int
UnregisterVideoFrameObserver(): int
UpdateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): int
UpdatePlayerPositionInfo(playerId: int, positionInfo: RemoteVoicePositionInfo): int
UpdateSelfPosition(position: float[], axisForward: float[], axisRight: float[], axisUp: float[]): int

Method detail: 133 / 133 (parameters, returns, errors)

MethodParametersReturnsErrors
AddVideoWatermarkwatermark: RtcImageintError code index
AdjustLoopbackSignalVolumevolume: intintError code index
CreateAgoraRtcEngineEx—IRtcEngineExError code index
CreateCustomAudioTracktrackType: AUDIO_TRACK_TYPE, config: AudioTrackConfiguintError code index
CreateDataStreamstreamId: int, reliable: bool, ordered: boolintError code index
CreateDataStreamExstreamId: int, reliable: bool, ordered: bool, connection: RtcConnectionintError code index
DestroyCustomAudioTracktrackId: uintintError code index
DestroyMediaRecordermediaRecorder: IMediaRecorderintError code index
DestroyMusicPlayermusic_player: IMusicPlayerintError code index
Dispose—voidError code index
EnableDualStreamModeenabled: boolintError code index
EnableLoopbackRecordingenabled: bool, deviceName?: stringintError code index
EnableLoopbackRecordingExconnection: RtcConnection, enabled: bool, deviceName: stringintError code index
EnumeratePlaybackDevices—DeviceInfo[]Error code index
EnumerateRecordingDevices—DeviceInfo[]Error code index
EnumerateVideoDevices—DeviceInfo[]Error code index
FollowSystemLoopbackDeviceenable: boolintError code index
FollowSystemPlaybackDeviceenable: boolintError code index
FollowSystemRecordingDeviceenable: boolintError code index
GetAudioDeviceManager—IAudioDeviceManagerError code index
GetCapabilitydeviceIdUTF8: string, deviceCapabilityNumber: uint, capability: VideoFormatintError code index
GetDevicedeviceIdUTF8: stringintError code index
GetFaceShapeAreaOptionsshapeArea: FACE_SHAPE_AREA, options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPEintError code index
GetFaceShapeBeautyOptionsoptions: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPEintError code index
GetLocalSpatialAudioEngine—ILocalSpatialAudioEngineError code index
GetLoopbackDevicedeviceId: stringintError code index
GetNativeHandlernativeHandler: IntPtrintError code index
GetPlaybackDefaultDevicedeviceId: string, deviceName: stringintError code index
GetPlaybackDevicedeviceId: stringintError code index
GetPlaybackDeviceInfodeviceId: string, deviceName: stringintError code index
GetPlaybackDeviceMute—boolError code index
GetPlaybackDeviceVolume—intError code index
GetRecordingDefaultDevicedeviceId: string, deviceName: stringintError code index
GetRecordingDevicedeviceId: stringintError code index
GetRecordingDeviceInfodeviceId: string, deviceName: stringintError code index
GetRecordingDeviceMute—boolError code index
GetRecordingDeviceVolume—intError code index
GetScreenCaptureSourcesthumbSize: SIZE, iconSize: SIZE, includeScreen: boolScreenCaptureSourceInfo[]Error code index
GetVideoDeviceManager—IVideoDeviceManagerError code index
InitEventHandlerengineEventHandler: IRtcEngineEventHandlerintError code index
IsCameraExposureSupported—boolError code index
IsFeatureAvailableOnDevicetype: FeatureTypeboolError code index
JoinChanneltoken: string, channelId: string, info?: string, uid?: uintintError code index
JoinChannelWithUserAccounttoken: string, channelId: string, userAccount: stringintError code index
LeaveChannel—intError code index
LeaveChannelExconnection: RtcConnectionintError code index
MuteAllRemoteAudioStreamsmute: boolintError code index
MuteLocalAudioStreammute: boolintError code index
MuteRemoteAudioStreamuid: uint, mute: boolintError code index
NumberOfCapabilitiesdeviceIdUTF8: stringintError code index
OnAudioDeviceStateChangeddeviceId: string, deviceType: MEDIA_DEVICE_TYPE, deviceState: MEDIA_DEVICE_STATE_TYPEvoidError code index
OnAudioDeviceVolumeChangeddeviceType: MEDIA_DEVICE_TYPE, volume: int, muted: boolvoidError code index
OnDirectCdnStreamingStateChangedstate: DIRECT_CDN_STREAMING_STATE, reason: DIRECT_CDN_STREAMING_REASON, message: stringvoidError code index
OnDirectCdnStreamingStatsstats: DirectCdnStreamingStatsvoidError code index
OnEarMonitoringAudioFrameaudioFrame: AudioFrameboolError code index
OnFirstLocalVideoFramesource: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: intvoidError code index
OnMixedAudioFramechannelId: string, audio_frame: AudioFrameboolError code index
OnPlaybackAudioFramechannelId: string, audio_frame: AudioFrameboolError code index
OnPlaybackAudioFrameBeforeMixingchannel_id: string, uid: uint, audio_frame: AudioFrameboolError code index
OnReadDatabufferPtr: IntPtr, bufferSize: intintError code index
OnRecordAudioFramechannelId: string, audioFrame: AudioFrameboolError code index
OnSeekoffset: Int64, whence: intInt64Error code index
OnVideoDeviceStateChangeddeviceId: string, deviceType: int, deviceState: intvoidError code index
PullAudioFrameframe: AudioFrameintError code index
PushAudioFrameframe: AudioFrame, trackId?: uintintError code index
PushVideoFrameframe: ExternalVideoFrame, videoTrackId?: uintintError code index
QueryCameraFocalLengthCapabilityfocalLengthInfos: FocalLengthInfo[], size: intintError code index
QueryCodecCapabilitycodecInfo: CodecCapInfo[], size: intintError code index
QueryScreenCaptureCapability—intError code index
RegisterAudioFrameObserveraudioFrameObserver: IAudioFrameObserver, position: AUDIO_FRAME_POSITION, mode?: OBSERVER_MODEintError code index
RegisterVideoEncodedFrameObservervideoEncodedImageReceiver: IVideoEncodedFrameObserver, mode?: OBSERVER_MODEintError code index
RegisterVideoFrameObservervideoFrameObserver: IVideoFrameObserver, formatPreference: VIDEO_OBSERVER_FRAME_TYPE, position: VIDEO_OBSERVER_POSITION, mode?: OBSERVER_MODEintError code index
SendMetadatametadata: Metadata, source_type: VIDEO_SOURCE_TYPEintError code index
SetAudioProfileprofile: AUDIO_PROFILE_TYPEintError code index
SetAudioRecvRangerange: floatintError code index
SetCameraStabilizationModemode: CAMERA_STABILIZATION_MODEintError code index
SetClientRolerole: CLIENT_ROLE_TYPEintError code index
SetDevicedeviceIdUTF8: stringintError code index
SetDistanceUnitunit: floatintError code index
SetDualStreamModemode: SIMULCAST_STREAM_MODEintError code index
SetExternalAudioSourceenabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: boolintError code index
SetExternalMediaProjectionmediaProjection: IntPtrintError code index
SetExternalRemoteEglContexteglContext: IntPtrintError code index
SetExternalVideoSourceenabled: bool, useTexture: bool, sourceType: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption: SenderOptionsintError code index
SetFaceShapeAreaOptionsoptions: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPEintError code index
SetFaceShapeBeautyOptionsenabled: bool, options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPEintError code index
SetFilterEffectOptionsenabled: bool, options: FilterEffectOptions, type?: MEDIA_SOURCE_TYPEintError code index
SetLocalAccessPointconfig: LocalAccessPointConfigurationintError code index
SetLocalRenderModerenderMode: RENDER_MODE_TYPEintError code index
SetLocalRenderTargetFpssourceType: VIDEO_SOURCE_TYPE, targetFps: intintError code index
SetLocalVideoDataSourcePositionposition: VIDEO_MODULE_POSITIONintError code index
SetLoopbackDevicedeviceId: stringintError code index
SetMaxAudioRecvCountmaxCount: intintError code index
SetMaxMetadataSizesize: intintError code index
SetParametersparameters: stringintError code index
SetPlaybackDevicedeviceId: stringintError code index
SetPlaybackDeviceMutemute: boolintError code index
SetPlaybackDeviceVolumevolume: intintError code index
SetPlayerAttenuationplayerId: int, attenuation: double, forceSet: boolintError code index
SetRecordingDevicedeviceId: stringintError code index
SetRecordingDeviceMutemute: boolintError code index
SetRecordingDeviceVolumevolume: intintError code index
SetRemoteAudioAttenuationuid: uint, attenuation: double, forceSet: boolintError code index
SetRemoteRenderModeExuid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: RtcConnectionintError code index
SetRemoteRenderTargetFpstargetFps: intintError code index
SetRouteInCommunicationModeroute: intintError code index
SetZoneszones: SpatialAudioZone[], zoneCount: uintintError code index
SetupLocalVideocanvas: VideoCanvasintError code index
SetupRemoteVideocanvas: VideoCanvasintError code index
SetupRemoteVideoExcanvas: VideoCanvas, connection: RtcConnectionintError code index
StartAudioDeviceLoopbackTestindicationInterval: intintError code index
StartAudioMixingfilePath: string, loopback: bool, cycle: intintError code index
StartAudioRecordingfilePath: string, quality: AUDIO_RECORDING_QUALITY_TYPEintError code index
StartLocalAudioMixerconfig: LocalAudioMixerConfigurationintError code index
StartPlaybackDeviceTesttestAudioFilePath: stringintError code index
StartPreview—intError code index
StartRecordingDeviceTestindicationInterval: intintError code index
StartScreenCapturesourceType: VIDEO_SOURCE_TYPE, config: ScreenCaptureConfigurationintError code index
StartScreenCaptureByDisplayIddisplayId: uint, regionRect: Rectangle, captureParams: ScreenCaptureParametersintError code index
StartScreenCaptureByScreenRectscreenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParametersintError code index
StartScreenCaptureByWindowIdwindowId: long, regionRect: Rectangle, captureParams: ScreenCaptureParametersintError code index
StopAudioDeviceLoopbackTest—intError code index
StopLocalAudioMixer—intError code index
StopPlaybackDeviceTest—intError code index
StopPreview—intError code index
StopRecordingDeviceTest—intError code index
StopScreenCapturesourceType: VIDEO_SOURCE_TYPEintError code index
TakeSnapshotuid: uint, config: SnapshotConfigintError code index
TakeSnapshotExconnection: RtcConnection, uid: uint, config: SnapshotConfigintError code index
UnregisterVideoFrameObserver—intError code index
UpdateLocalAudioMixerConfigurationconfig: LocalAudioMixerConfigurationintError code index
UpdatePlayerPositionInfoplayerId: int, positionInfo: RemoteVoicePositionInfointError code index
UpdateSelfPositionposition: float[], axisForward: float[], axisRight: float[], axisUp: float[]intError code index
AdvancedAudioOptions 0 method / 1 Property
PropertyTyperead-only
audioProcessingChannelsOptionalNo
AdvancedConfigInfo 0 method / 1 Property
PropertyTyperead-only
logUploadServerunknownNo
AdvanceOptions 0 method / 3 Property
PropertyTyperead-only
encodingPreferenceENCODING_PREFERENCENo
compressionPreferenceCOMPRESSION_PREFERENCENo
encodeAlphaboolNo
AgoraRhythmPlayerConfig 0 method / 2 Property
PropertyTyperead-only
beatsPerMeasureintNo
beatsPerMinuteintNo
AudioEncodedFrameObserverConfig 0 method / 2 Property
PropertyTyperead-only
postionTypeAUDIO_ENCODED_FRAME_OBSERVER_POSITIONNo
encodingTypeAUDIO_ENCODING_TYPENo
AudioFileRecordingConfig 0 method / 6 Property
PropertyTyperead-only
filePathstringNo
encodeboolNo
sampleRateintNo
fileRecordingTypeAUDIO_FILE_RECORDING_TYPENo
qualityAUDIO_RECORDING_QUALITY_TYPENo
recordingChannelintNo
AudioFrame 0 method / 8 Property
PropertyTyperead-only
typeAUDIO_FRAME_TYPENo
samplesPerChannelintNo
bytesPerSampleBYTES_PER_SAMPLENo
channelsintNo
samplesPerSecintNo
RawBufferbyte[]No
renderTimeMslongNo
avsync_typeintNo
AudioParams 0 method / 4 Property
PropertyTyperead-only
sample_rateintNo
channelsintNo
modeRAW_AUDIO_FRAME_OP_MODE_TYPENo
samples_per_callintNo
AudioPcmFrame 0 method / 6 Property
PropertyTyperead-only
capture_timestampUInt32No
samples_per_channel_UInt64No
sample_rate_hz_intNo
num_channels_UInt64No
bytes_per_sampleBYTES_PER_SAMPLENo
data_Int16[]No
AudioSpectrumData 0 method / 2 Property
PropertyTyperead-only
audioSpectrumDatafloat[]No
dataLengthintNo
AudioTrackConfig 0 method / 2 Property
PropertyTyperead-only
enableLocalPlaybackboolNo
enableAudioProcessingboolNo
AudioVolumeInfo 0 method / 4 Property
PropertyTyperead-only
uiduintNo
volumeuintNo
vaduintNo
voicePitchdoubleNo
BeautyOptions 0 method / 5 Property
PropertyTyperead-only
lighteningContrastLevelLIGHTENING_CONTRAST_LEVELNo
lighteningLevelfloatNo
smoothnessLevelfloatNo
rednessLevelfloatNo
sharpnessLevelfloatNo
CacheStatistics 0 method / 3 Property
PropertyTyperead-only
fileSizeInt64No
cacheSizeInt64No
downloadSizeInt64No
CameraCapturerConfiguration 0 method / 4 Property
PropertyTyperead-only
cameraDirectionOptionalNo
formatVideoFormatNo
deviceIdOptionalNo
followEncodeDimensionRatioOptionalNo
ChannelMediaInfo 0 method / 3 Property
PropertyTyperead-only
channelNamestringNo
tokenstringNo
uiduintNo
ChannelMediaOptions 0 method / 31 Property
PropertyTyperead-only
publishCameraTrackOptionalNo
publishSecondaryCameraTrackOptionalNo
publishMicrophoneTrackOptionalNo
publishThirdCameraTrackOptionalNo
publishFourthCameraTrackOptionalNo
publishScreenTrackOptionalNo
publishSecondaryScreenTrackOptionalNo
publishThirdScreenTrackOptionalNo
publishFourthScreenTrackOptionalNo
publishTranscodedVideoTrackOptionalNo
publishMixedAudioTrackunknownNo
publishCustomAudioTrackOptionalNo
publishCustomAudioTrackIdOptionalNo
publishCustomVideoTrackOptionalNo
publishEncodedVideoTrackOptionalNo
publishMediaPlayerAudioTrackOptionalNo
publishMediaPlayerVideoTrackOptionalNo
autoSubscribeAudioOptionalNo
autoSubscribeVideoOptionalNo
enableAudioRecordingOrPlayoutOptionalNo
publishMediaPlayerIdOptionalNo
clientRoleTypeOptionalNo
audienceLatencyLevelOptionalNo
defaultVideoStreamTypeOptionalNo
channelProfileOptionalNo
audioDelayMsunknownNo
tokenOptionalNo
publishRhythmPlayerTrackOptionalNo
isInteractiveAudienceOptionalNo
customVideoTrackIdOptionalNo
isAudioFilterableOptionalNo
ChannelMediaRelayConfiguration 0 method / 3 Property
PropertyTyperead-only
srcInfoChannelMediaInfoNo
destInfosChannelMediaInfo[]No
destCountintNo
ClientRoleOptions 0 method / 1 Property
PropertyTyperead-only
audienceLatencyLevelAUDIENCE_LATENCY_LEVEL_TYPENo
ClimaxSegment 0 method / 2 Property
PropertyTyperead-only
startTimeMsintNo
endTimeMsintNo
CodecCapInfo 0 method / 3 Property
PropertyTyperead-only
codecTypeVIDEO_CODEC_TYPENo
codecCapMaskintNo
codecLevelsCodecCapLevelsNo
CodecCapLevels 0 method / 2 Property
PropertyTyperead-only
hwDecodingLevelVIDEO_CODEC_CAPABILITY_LEVELNo
swDecodingLevelVIDEO_CODEC_CAPABILITY_LEVELNo
ColorEnhanceOptions 0 method / 2 Property
PropertyTyperead-only
strengthLevelfloatNo
skinProtectLevelfloatNo
ContentInspectConfig 0 method / 3 Property
PropertyTyperead-only
extraInfostringNo
modulesContentInspectModule[]No
moduleCountintNo
ContentInspectModule 0 method / 2 Property
PropertyTyperead-only
typeCONTENT_INSPECT_TYPENo
intervaluintNo
DataStreamConfig 0 method / 2 Property
PropertyTyperead-only
syncWithAudioboolNo
orderedboolNo
DeviceInfo 0 method / 2 Property
PropertyTyperead-only
deviceIdstringNo
deviceNamestringNo
DeviceInfoMobile 0 method / 1 Property
PropertyTyperead-only
isLowLatencyAudioSupportedboolNo
DirectCdnStreamingMediaOptions 0 method / 5 Property
PropertyTyperead-only
publishCameraTrackOptionalNo
publishMicrophoneTrackOptionalNo
publishCustomAudioTrackOptionalNo
publishCustomVideoTrackOptionalNo
customVideoTrackIdOptionalNo
DirectCdnStreamingStats 0 method / 5 Property
PropertyTyperead-only
videoWidthintNo
videoHeightintNo
fpsintNo
videoBitrateintNo
audioBitrateintNo
EchoTestConfiguration 0 method / 6 Property
PropertyTyperead-only
viewview_tNo
enableAudioboolNo
enableVideoboolNo
tokenstringNo
channelIdstringNo
intervalInSecondsintNo
EncodedAudioFrameInfo 0 method / 6 Property
PropertyTyperead-only
codecAUDIO_CODEC_TYPENo
sampleRateHzintNo
samplesPerChannelintNo
numberOfChannelsintNo
advancedSettingsEncodedAudioFrameAdvancedSettingsNo
captureTimeMsint64_tNo
EncodedVideoFrameInfo 0 method / 10 Property
PropertyTyperead-only
codecTypeVIDEO_CODEC_TYPENo
widthintNo
heightintNo
framesPerSecondintNo
frameTypeVIDEO_FRAME_TYPE_NATIVENo
rotationVIDEO_ORIENTATIONNo
trackIdintNo
captureTimeMsint64_tNo
uiduintNo
streamTypeVIDEO_STREAM_TYPENo
EncryptionConfig 0 method / 4 Property
PropertyTyperead-only
encryptionModeENCRYPTION_MODENo
encryptionKeystringNo
encryptionKdfSaltbyte[]No
datastreamEncryptionEnabledboolNo
ExtensionContext 0 method / 4 Property
PropertyTyperead-only
isValidboolNo
uiduintNo
providerNamestringNo
extensionNamestringNo
ExternalVideoFrame 0 method / 20 Property
PropertyTyperead-only
typeVIDEO_BUFFER_TYPENo
formatVIDEO_PIXEL_FORMATNo
bufferbyte[]No
strideintNo
heightintNo
eglContextbyte[]No
eglTypeEGL_CONTEXT_TYPENo
textureIdintNo
metadataBufferbyte[]No
metadataSizeintNo
alphaBufferbyte[]No
fillAlphaBufferboolNo
alphaStitchModeALPHA_STITCH_MODENo
cropLeftintNo
cropTopintNo
cropRightintNo
cropBottomintNo
rotationintNo
timestamplongNo
colorSpaceColorSpaceNo
FaceShapeAreaOptions 0 method / 2 Property
PropertyTyperead-only
shapeAreaunknownNo
shapeIntensityunknownNo
FaceShapeBeautyOptions 0 method / 2 Property
PropertyTyperead-only
shapeStyleFACE_SHAPE_BEAUTY_STYLENo
styleIntensityintNo
FilterEffectOptions 1 method / 1 Property
typescript
path(): unknown

Method detail: 1 / 1 (parameters, returns, errors)

MethodParametersReturnsErrors
path—unknownError code index
PropertyTyperead-only
strengthunknownNo
FocalLengthInfo 0 method / 2 Property
PropertyTyperead-only
cameraDirectionintNo
focalLengthTypeCAMERA_FOCAL_LENGTH_TYPENo
IAudioEncodedFrameObserver 3 method / 0 Property
typescript
OnMixedAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
OnPlaybackAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
OnRecordAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void

Method detail: 3 / 3 (parameters, returns, errors)

MethodParametersReturnsErrors
OnMixedAudioEncodedFrameframeBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoidError code index
OnPlaybackAudioEncodedFrameframeBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoidError code index
OnRecordAudioEncodedFrameframeBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoidError code index
IAudioPcmFrameSink 1 method / 0 Property
typescript
OnFrame(frame: AudioPcmFrame): bool

Method detail: 1 / 1 (parameters, returns, errors)

MethodParametersReturnsErrors
OnFrameframe: AudioPcmFrameboolError code index
IAudioSpectrumObserver 2 method / 0 Property
typescript
OnLocalAudioSpectrum(data: AudioSpectrumData): bool
OnRemoteAudioSpectrum(spectrums: UserAudioSpectrumInfo[], spectrumNumber: uint): bool

Method detail: 2 / 2 (parameters, returns, errors)

MethodParametersReturnsErrors
OnLocalAudioSpectrumdata: AudioSpectrumDataboolError code index
OnRemoteAudioSpectrumspectrums: UserAudioSpectrumInfo[], spectrumNumber: uintboolError code index
ILocalSpatialAudioEngine 4 method / 0 Property
typescript
ClearRemotePositions(): int
Initialize(): int
RemoveRemotePosition(uid: uint): int
UpdateRemotePosition(uid: uint, posInfo: RemoteVoicePositionInfo): int

Method detail: 4 / 4 (parameters, returns, errors)

MethodParametersReturnsErrors
ClearRemotePositions—intError code index
Initialize—intError code index
RemoveRemotePositionuid: uintintError code index
UpdateRemotePositionuid: uint, posInfo: RemoteVoicePositionInfointError code index
ImageTrackOptions 0 method / 2 Property
PropertyTyperead-only
imageUrlstringNo
fpsintNo
IMediaPlayer 38 method / 0 Property
typescript
AdjustPlayoutVolume(volume: int): int
AdjustPublishSignalVolume(volume: int): int
GetDuration(duration: Int64): int
GetId(): int
GetMediaPlayerCacheManager(): IMediaPlayerCacheManager
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
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

Method detail: 38 / 38 (parameters, returns, errors)

MethodParametersReturnsErrors
AdjustPlayoutVolumevolume: intintError code index
AdjustPublishSignalVolumevolume: intintError code index
GetDurationduration: Int64intError code index
GetId—intError code index
GetMediaPlayerCacheManager—IMediaPlayerCacheManagerError code index
GetMutemuted: boolintError code index
GetPlayPositionpos: Int64intError code index
GetPlaySrc—stringError code index
GetPlayoutVolumevolume: intintError code index
GetPublishSignalVolumevolume: intintError code index
GetState—MEDIA_PLAYER_STATEError code index
GetStreamCountcount: Int64intError code index
GetStreamInfoindex: Int64, info: PlayerStreamInfointError code index
Mutemuted: boolintError code index
Openurl: string, startPos: Int64intError code index
OpenWithMediaSourcesource: MediaSourceintError code index
Pause—intError code index
Play—intError code index
PlayPreloadedSrcsrc: stringintError code index
PreloadSrcsrc: string, startPos: Int64intError code index
RegisterAudioFrameObserverobserver: IAudioPcmFrameSinkintError code index
Resume—intError code index
SeeknewPos: Int64intError code index
SelectAudioTrackindex: intintError code index
SelectMultiAudioTrackplayoutTrackIndex: int, publishTrackIndex: intintError code index
SetAudioDualMonoModemode: AUDIO_DUAL_MONO_MODEintError code index
SetAudioPitchpitch: intintError code index
SetLoopCountloopCount: intintError code index
SetPlaybackSpeedspeed: intintError code index
SetPlayerOptionkey: string, value: intintError code index
SetRenderModerenderMode: RENDER_MODE_TYPEintError code index
SetSpatialAudioParamsspatial_audio_params: SpatialAudioParamsintError code index
SetView—intError code index
Stop—intError code index
SwitchSrcsrc: string, syncPts?: boolintError code index
UnloadSrcsrc: stringintError code index
UnregisterAudioFrameObserver—intError code index
setPlayerOptionkey: string, value: stringintError code index
IMediaPlayerCacheManager 11 method / 0 Property
typescript
EnableAutoRemoveCache(enable: bool): int
GetCacheDir(path: string, length: int): int
GetCacheFileCount(): int
GetMaxCacheFileCount(): int
GetMaxCacheFileSize(): Int64
RemoveAllCaches(): int
RemoveCacheByUri(uri: string): int
RemoveOldCache(): int
SetCacheDir(path: string): int
SetMaxCacheFileCount(count: int): int
SetMaxCacheFileSize(cacheSize: Int64): int

Method detail: 11 / 11 (parameters, returns, errors)

MethodParametersReturnsErrors
EnableAutoRemoveCacheenable: boolintError code index
GetCacheDirpath: string, length: intintError code index
GetCacheFileCount—intError code index
GetMaxCacheFileCount—intError code index
GetMaxCacheFileSize—Int64Error code index
RemoveAllCaches—intError code index
RemoveCacheByUriuri: stringintError code index
RemoveOldCache—intError code index
SetCacheDirpath: stringintError code index
SetMaxCacheFileCountcount: intintError code index
SetMaxCacheFileSizecacheSize: Int64intError code index
IMediaPlayerSourceObserver 9 method / 0 Property
typescript
OnAudioVolumeIndication(volume: int): void
OnMetaData(data: byte[], length: int): void
OnPlayBufferUpdated(playCachedBuffer: Int64): void
OnPlayerEvent(eventCode: MEDIA_PLAYER_EVENT, elapsedTime: Int64, message: string): void
OnPlayerInfoUpdated(info: PlayerUpdatedInfo): void
OnPlayerSourceStateChanged(state: MEDIA_PLAYER_STATE, reason: MEDIA_PLAYER_REASON): void
OnPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
OnPositionChanged(position_ms: Int64): void
OnPreloadEvent(src: string, null: PLAYER_PRELOAD_EVENT): void

Method detail: 9 / 9 (parameters, returns, errors)

MethodParametersReturnsErrors
OnAudioVolumeIndicationvolume: intvoidError code index
OnMetaDatadata: byte[], length: intvoidError code index
OnPlayBufferUpdatedplayCachedBuffer: Int64voidError code index
OnPlayerEventeventCode: MEDIA_PLAYER_EVENT, elapsedTime: Int64, message: stringvoidError code index
OnPlayerInfoUpdatedinfo: PlayerUpdatedInfovoidError code index
OnPlayerSourceStateChangedstate: MEDIA_PLAYER_STATE, reason: MEDIA_PLAYER_REASONvoidError code index
OnPlayerSrcInfoChangedfrom: SrcInfo, to: SrcInfovoidError code index
OnPositionChangedposition_ms: Int64voidError code index
OnPreloadEventsrc: string, null: PLAYER_PRELOAD_EVENTvoidError code index
event namecallback parameters
OnPlayerCacheStatspublic virtual void OnPlayerCacheStats(CacheStatistics stats) { }
OnPlayerPlaybackStatspublic virtual void OnPlayerPlaybackStats(PlayerPlaybackStats stats) { }
IMediaRecorder 3 method / 0 Property
typescript
SetMediaRecorderObserver(callback: IMediaRecorderObserver): int
StartRecording(config: MediaRecorderConfiguration): int
StopRecording(): int

Method detail: 3 / 3 (parameters, returns, errors)

MethodParametersReturnsErrors
SetMediaRecorderObservercallback: IMediaRecorderObserverintError code index
StartRecordingconfig: MediaRecorderConfigurationintError code index
StopRecording—intError code index
IMediaRecorderObserver 2 method / 0 Property
typescript
OnRecorderInfoUpdated(channelId: string, uid: uint, info: RecorderInfo): void
OnRecorderStateChanged(channelId: string, uid: uint, state: RecorderState, reason: RecorderReasonCode): void

Method detail: 2 / 2 (parameters, returns, errors)

MethodParametersReturnsErrors
OnRecorderInfoUpdatedchannelId: string, uid: uint, info: RecorderInfovoidError code index
OnRecorderStateChangedchannelId: string, uid: uint, state: RecorderState, reason: RecorderReasonCodevoidError code index
IMetadataObserver 1 method / 0 Property
typescript
OnMetadataReceived(metadata: Metadata): void

Method detail: 1 / 1 (parameters, returns, errors)

MethodParametersReturnsErrors
OnMetadataReceivedmetadata: MetadatavoidError code index
IRtcEngine 199 method / 0 Property
typescript
AddVideoWatermark(watermarkUrl: string, options: WatermarkOptions): 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
AdjustPlaybackSignalVolume(volume: int): int
AdjustRecordingSignalVolume(volume: int): int
AdjustUserPlaybackSignalVolume(uid: uint, volume: int): int
ClearVideoWatermarks(): int
Complain(callId: string, description: string): int
CreateAgoraRtcEngine(): IRtcEngine
CreateCustomVideoTrack(): video_track_id_t
CreateDataStream(streamId: int, config: DataStreamConfig): int
CreateMediaPlayer(): IMediaPlayer
CreateMediaRecorder(info: RecorderStreamInfo): IMediaRecorder
DestroyCustomVideoTrack(video_track_id: video_track_id_t): int
DestroyMediaPlayer(mediaPlayer: IMediaPlayer): 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, streamConfig: SimulcastStreamConfig): int
EnableEncryption(enabled: bool, config: EncryptionConfig): int
EnableExtension(provider: string, extension: string, enable?: bool, type?: MEDIA_SOURCE_TYPE): int
EnableInstantMediaRendering(): int
EnableLocalAudio(enabled: bool): int
EnableLocalVideo(enabled: bool): 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
GetAudioMixingCurrentPosition(): int
GetAudioMixingDuration(): int
GetAudioMixingPlayoutVolume(): int
GetAudioMixingPublishVolume(): int
GetAudioTrackCount(): int
GetCallId(callId: string): int
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
GetNetworkType(): int
GetNtpWallTimeInMs(): UInt64
GetUserInfoByUid(uid: uint, userInfo: UserInfo): int
GetUserInfoByUserAccount(userAccount: string, userInfo: UserInfo): int
GetVersion(build: int): string
GetVolumeOfEffect(soundId: int): int
Initialize(context: RtcEngineContext): int
IsCameraCenterStageSupported(): bool
JoinChannel(token: string, channelId: string, uid: uint, options: ChannelMediaOptions): int
JoinChannelWithUserAccount(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions): 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
QueryCodecCapability(codecInfo: CodecCapInfo[], size: int): int
QueryDeviceScore(): 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
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
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
SetAudioScenario(scenario: AUDIO_SCENARIO_TYPE): int
SetChannelProfile(profile: CHANNEL_PROFILE_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
SetDirectCdnStreamingAudioConfiguration(profile: AUDIO_PROFILE_TYPE): int
SetDirectCdnStreamingVideoConfiguration(config: VideoEncoderConfiguration): 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
SetExtensionProperty(provider: string, extension: string, key: string, value: string, type?: MEDIA_SOURCE_TYPE): int
SetExtensionProviderProperty(provider: string, key: string, value: string): int
SetExternalAudioSink(enabled: bool, sampleRate: int, channels: int): int
SetHeadphoneEQParameters(lowGain: int, highGain: int): int
SetHeadphoneEQPreset(preset: HEADPHONE_EQUALIZER_PRESET): int
SetLocalRenderMode(renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): 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
SetMixedAudioFrameParameters(sampleRate: int, channel: int, samplesPerCall: int): int
SetParameters(key: string, value: object): 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(uid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): 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
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
StartAudioMixing(filePath: string, loopback: bool, cycle: int, startPos: int): int
StartAudioRecording(config: AudioRecordingConfiguration): int
StartCameraCapture(sourceType: VIDEO_SOURCE_TYPE, config: CameraCapturerConfiguration): int
StartDirectCdnStreaming(publishUrl: string, options: DirectCdnStreamingMediaOptions): int
StartEchoTest(config: EchoTestConfiguration): int
StartLastmileProbeTest(config: LastmileProbeConfig): int
StartLocalVideoTranscoder(config: LocalTranscoderConfiguration): int
StartMediaRenderingTracing(): int
StartOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): int
StartPreview(sourceType: VIDEO_SOURCE_TYPE): int
StartRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): int
StartRtmpStreamWithoutTranscoding(url: string): 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
StopLocalVideoTranscoder(): int
StopPreview(sourceType: VIDEO_SOURCE_TYPE): int
StopRtmpStream(url: string): int
StopScreenCapture(): int
TakeSnapshot(uid: uint, filePath: string): int
UnRegisterAudioEncodedFrameObserver(): int
UnRegisterAudioFrameObserver(): int
UnloadAllEffects(): int
UnloadEffect(soundId: int): int
UnregisterAudioSpectrumObserver(): int
UnregisterMediaMetadataObserver(): int
UnregisterVideoEncodedFrameObserver(): int
UpdateChannelMediaOptions(options: ChannelMediaOptions): int
UpdateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): int
UpdatePreloadChannelToken(token: string): int
UpdateRtmpTranscoding(transcoding: LiveTranscoding): int
UpdateScreenCaptureParameters(captureParams: ScreenCaptureParameters): int
UpdateScreenCaptureRegion(regionRect: Rectangle): int

Method detail: 199 / 199 (parameters, returns, errors)

MethodParametersReturnsErrors
AddVideoWatermarkwatermarkUrl: string, options: WatermarkOptionsintError code index
AdjustAudioMixingPlayoutVolumevolume: intintError code index
AdjustAudioMixingPublishVolumevolume: intintError code index
AdjustAudioMixingVolumevolume: intintError code index
AdjustCustomAudioPlayoutVolumetrackId: uint, volume: intintError code index
AdjustCustomAudioPublishVolumetrackId: uint, volume: intintError code index
AdjustPlaybackSignalVolumevolume: intintError code index
AdjustRecordingSignalVolumevolume: intintError code index
AdjustUserPlaybackSignalVolumeuid: uint, volume: intintError code index
ClearVideoWatermarks—intError code index
ComplaincallId: string, description: stringintError code index
CreateAgoraRtcEngine—IRtcEngineError code index
CreateCustomVideoTrack—video_track_id_tError code index
CreateDataStreamstreamId: int, config: DataStreamConfigintError code index
CreateMediaPlayer—IMediaPlayerError code index
CreateMediaRecorderinfo: RecorderStreamInfoIMediaRecorderError code index
DestroyCustomVideoTrackvideo_track_id: video_track_id_tintError code index
DestroyMediaPlayermediaPlayer: IMediaPlayerintError code index
DisableAudio—intError code index
DisableAudioSpectrumMonitor—intError code index
DisableVideo—intError code index
Disposesync?: boolvoidError code index
EnableAudio—intError code index
EnableAudioSpectrumMonitorintervalInMS?: intintError code index
EnableAudioVolumeIndicationinterval: int, smooth: int, reportVad: boolintError code index
EnableCameraCenterStageenabled: boolintError code index
EnableContentInspectenabled: bool, config: ContentInspectConfigintError code index
EnableCustomAudioLocalPlaybacktrackId: uint, enabled: boolintError code index
EnableDualStreamModeenabled: bool, streamConfig: SimulcastStreamConfigintError code index
EnableEncryptionenabled: bool, config: EncryptionConfigintError code index
EnableExtensionprovider: string, extension: string, enable?: bool, type?: MEDIA_SOURCE_TYPEintError code index
EnableInstantMediaRendering—intError code index
EnableLocalAudioenabled: boolintError code index
EnableLocalVideoenabled: boolintError code index
EnableSoundPositionIndicationenabled: boolintError code index
EnableSpatialAudioenabled: boolintError code index
EnableVideo—intError code index
EnableVideoImageSourceenable: bool, options: ImageTrackOptionsintError code index
EnableVirtualBackgroundenabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MEDIA_SOURCE_TYPEintError code index
EnableVoiceAITunerenabled: bool, type: VOICE_AI_TUNER_TYPEintError code index
EnableWebSdkInteroperabilityenabled: boolintError code index
GetAudioMixingCurrentPosition—intError code index
GetAudioMixingDuration—intError code index
GetAudioMixingPlayoutVolume—intError code index
GetAudioMixingPublishVolume—intError code index
GetAudioTrackCount—intError code index
GetCallIdcallId: stringintError code index
GetConnectionState—CONNECTION_STATE_TYPEError code index
GetCurrentMonotonicTimeInMs—longError code index
GetEffectCurrentPositionsoundId: intintError code index
GetEffectDurationfilePath: stringintError code index
GetEffectsVolume—intError code index
GetErrorDescriptioncode: intstringError code index
GetExtensionPropertyprovider: string, extension: string, key: string, value: string, buf_len: int, type?: MEDIA_SOURCE_TYPEintError code index
GetNetworkType—intError code index
GetNtpWallTimeInMs—UInt64Error code index
GetUserInfoByUiduid: uint, userInfo: UserInfointError code index
GetUserInfoByUserAccountuserAccount: string, userInfo: UserInfointError code index
GetVersionbuild: intstringError code index
GetVolumeOfEffectsoundId: intintError code index
Initializecontext: RtcEngineContextintError code index
IsCameraCenterStageSupported—boolError code index
JoinChanneltoken: string, channelId: string, uid: uint, options: ChannelMediaOptionsintError code index
JoinChannelWithUserAccounttoken: string, channelId: string, userAccount: string, options: ChannelMediaOptionsintError code index
LeaveChanneloptions: LeaveChannelOptionsintError code index
LoadExtensionProviderpath: string, unload_after_use?: boolintError code index
MuteAllRemoteAudioStreamsmute: boolintError code index
MuteAllRemoteVideoStreamsmute: boolintError code index
MuteLocalAudioStreammute: boolintError code index
MuteLocalVideoStreammute: boolintError code index
MuteRecordingSignalmute: boolintError code index
MuteRemoteAudioStreamuid: uint, mute: boolintError code index
MuteRemoteVideoStreamuid: uint, mute: boolintError code index
PauseAllChannelMediaRelay—intError code index
PauseAllEffects—intError code index
PauseAudioMixing—intError code index
PauseEffectsoundId: intintError code index
PlayAllEffectsloopCount: int, pitch: double, pan: double, gain: int, publish?: boolintError code index
PlayEffectsoundId: int, filePath: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: intintError code index
PreloadChanneltoken: string, channelId: string, uid: uintintError code index
PreloadChannelWithUserAccounttoken: unknown, channelId: unknown, userAccount: unknownunknownError code index
PreloadEffectsoundId: int, filePath: string, startPos?: intintError code index
QueryCodecCapabilitycodecInfo: CodecCapInfo[], size: intintError code index
QueryDeviceScore—intError code index
RatecallId: string, rating: int, description: stringintError code index
RegisterAudioEncodedFrameObserverconfig: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserverintError code index
RegisterAudioSpectrumObserverobserver: IAudioSpectrumObserverintError code index
RegisterExtensionprovider: string, extension: string, type?: MEDIA_SOURCE_TYPEintError code index
RegisterLocalUserAccountappId: string, userAccount: stringintError code index
RegisterMediaMetadataObserverobserver: IMetadataObserver, type: METADATA_TYPEintError code index
RenewTokentoken: stringintError code index
ResumeAllChannelMediaRelay—intError code index
ResumeAllEffects—intError code index
ResumeAudioMixing—intError code index
ResumeEffectsoundId: intintError code index
SelectAudioTrackindex: intintError code index
SendCustomReportMessageid: string, category: string, null: string, label: string, value: intintError code index
SendStreamMessagestreamId: int, data: byte[], length: uintintError code index
SetAINSModeenabled: bool, mode: AUDIO_AINS_MODEintError code index
SetAVSyncSourcechannelId: string, uid: uintintError code index
SetAdvancedAudioOptionsoptions: AdvancedAudioOptionsintError code index
SetAudioEffectParameterspreset: AUDIO_EFFECT_PRESET, param1: int, param2: intintError code index
SetAudioEffectPresetpreset: AUDIO_EFFECT_PRESETintError code index
SetAudioMixingDualMonoModemode: AUDIO_MIXING_DUAL_MONO_MODEintError code index
SetAudioMixingPitchpitch: intintError code index
SetAudioMixingPlaybackSpeedspeed: intintError code index
SetAudioMixingPositionpos: intintError code index
SetAudioProfileprofile: AUDIO_PROFILE_TYPE, scenario: AUDIO_SCENARIO_TYPEintError code index
SetAudioScenarioscenario: AUDIO_SCENARIO_TYPEintError code index
SetChannelProfileprofile: CHANNEL_PROFILE_TYPEintError code index
SetClientRolerole: CLIENT_ROLE_TYPE, options: ClientRoleOptionsintError code index
SetCloudProxyproxyType: CLOUD_PROXY_TYPEintError code index
SetColorEnhanceOptionsenabled: bool, options: ColorEnhanceOptions, type?: MEDIA_SOURCE_TYPEintError code index
SetDirectCdnStreamingAudioConfigurationprofile: AUDIO_PROFILE_TYPEintError code index
SetDirectCdnStreamingVideoConfigurationconfig: VideoEncoderConfigurationintError code index
SetDualStreamModemode: SIMULCAST_STREAM_MODE, streamConfig: SimulcastStreamConfigintError code index
SetEarMonitoringAudioFrameParameterssampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: intintError code index
SetEffectPositionsoundId: int, pos: intintError code index
SetEffectsVolumevolume: intintError code index
SetExtensionPropertyprovider: string, extension: string, key: string, value: string, type?: MEDIA_SOURCE_TYPEintError code index
SetExtensionProviderPropertyprovider: string, key: string, value: stringintError code index
SetExternalAudioSinkenabled: bool, sampleRate: int, channels: intintError code index
SetHeadphoneEQParameterslowGain: int, highGain: intintError code index
SetHeadphoneEQPresetpreset: HEADPHONE_EQUALIZER_PRESETintError code index
SetLocalRenderModerenderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPEintError code index
SetLocalVideoMirrorModemirrorMode: VIDEO_MIRROR_MODE_TYPEintError code index
SetLocalVoiceEqualizationbandFrequency: AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: intintError code index
SetLocalVoiceFormantformantRatio: doubleintError code index
SetLocalVoicePitchpitch: doubleintError code index
SetLocalVoiceReverbreverbKey: AUDIO_REVERB_TYPE, value: intintError code index
SetLogFilefilePath: stringintError code index
SetLogFileSizefileSizeInKBytes: uintintError code index
SetLogFilterfilter: uintintError code index
SetLogLevellevel: LOG_LEVELintError code index
SetLowlightEnhanceOptionsenabled: bool, options: LowlightEnhanceOptions, type?: MEDIA_SOURCE_TYPEintError code index
SetMixedAudioFrameParameterssampleRate: int, channel: int, samplesPerCall: intintError code index
SetParameterskey: string, value: objectintError code index
SetPlaybackAudioFrameBeforeMixingParameterssampleRate: int, channel: intintError code index
SetPlaybackAudioFrameParameterssampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: intintError code index
SetRecordingAudioFrameParameterssampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: intintError code index
SetRemoteDefaultVideoStreamTypestreamType: VIDEO_STREAM_TYPEintError code index
SetRemoteRenderModeuid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPEintError code index
SetRemoteSubscribeFallbackOptionoption: STREAM_FALLBACK_OPTIONSintError code index
SetRemoteUserSpatialAudioParamsuid: uint, param: SpatialAudioParamsintError code index
SetRemoteVideoStreamTypeuid: uint, streamType: VIDEO_STREAM_TYPEintError code index
SetRemoteVideoSubscriptionOptionsuid: uint, options: VideoSubscriptionOptionsintError code index
SetRemoteVoicePositionuid: uint, pan: double, gain: doubleintError code index
SetScreenCaptureContentHintcontentHint: VIDEO_CONTENT_HINTintError code index
SetScreenCaptureScenarioscreenScenario: SCREEN_SCENARIO_TYPEintError code index
SetSubscribeAudioAllowlistuidList: uint[], uidNumber: intintError code index
SetSubscribeAudioBlocklistuidList: uint[], uidNumber: intintError code index
SetSubscribeVideoAllowlistuidList: uint[], uidNumber: intintError code index
SetSubscribeVideoBlocklistuidList: uint[], uidNumber: intintError code index
SetVideoDenoiserOptionsenabled: bool, options: VideoDenoiserOptions, type?: MEDIA_SOURCE_TYPEintError code index
SetVideoEncoderConfigurationconfig: VideoEncoderConfigurationintError code index
SetVideoScenarioscenarioType: VIDEO_APPLICATION_SCENARIO_TYPEintError code index
SetVoiceBeautifierParameterspreset: VOICE_BEAUTIFIER_PRESET, param1: int, param2: intintError code index
SetVoiceBeautifierPresetpreset: VOICE_BEAUTIFIER_PRESETintError code index
SetVoiceConversionPresetpreset: VOICE_CONVERSION_PRESETintError code index
SetVolumeOfEffectsoundId: int, volume: intintError code index
StartAudioMixingfilePath: string, loopback: bool, cycle: int, startPos: intintError code index
StartAudioRecordingconfig: AudioRecordingConfigurationintError code index
StartCameraCapturesourceType: VIDEO_SOURCE_TYPE, config: CameraCapturerConfigurationintError code index
StartDirectCdnStreamingpublishUrl: string, options: DirectCdnStreamingMediaOptionsintError code index
StartEchoTestconfig: EchoTestConfigurationintError code index
StartLastmileProbeTestconfig: LastmileProbeConfigintError code index
StartLocalVideoTranscoderconfig: LocalTranscoderConfigurationintError code index
StartMediaRenderingTracing—intError code index
StartOrUpdateChannelMediaRelayconfiguration: ChannelMediaRelayConfigurationintError code index
StartPreviewsourceType: VIDEO_SOURCE_TYPEintError code index
StartRtmpStreamWithTranscodingurl: string, transcoding: LiveTranscodingintError code index
StartRtmpStreamWithoutTranscodingurl: stringintError code index
StopAllEffects—intError code index
StopAudioMixing—intError code index
StopAudioRecording—intError code index
StopCameraCapturesourceType: VIDEO_SOURCE_TYPEintError code index
StopChannelMediaRelay—intError code index
StopDirectCdnStreaming—intError code index
StopEchoTest—intError code index
StopEffectsoundId: intintError code index
StopLastmileProbeTest—intError code index
StopLocalVideoTranscoder—intError code index
StopPreviewsourceType: VIDEO_SOURCE_TYPEintError code index
StopRtmpStreamurl: stringintError code index
StopScreenCapture—intError code index
TakeSnapshotuid: uint, filePath: stringintError code index
UnRegisterAudioEncodedFrameObserver—intError code index
UnRegisterAudioFrameObserver—intError code index
UnloadAllEffects—intError code index
UnloadEffectsoundId: intintError code index
UnregisterAudioSpectrumObserver—intError code index
UnregisterMediaMetadataObserver—intError code index
UnregisterVideoEncodedFrameObserver—intError code index
UpdateChannelMediaOptionsoptions: ChannelMediaOptionsintError code index
UpdateLocalTranscoderConfigurationconfig: LocalTranscoderConfigurationintError code index
UpdatePreloadChannelTokentoken: stringintError code index
UpdateRtmpTranscodingtranscoding: LiveTranscodingintError code index
UpdateScreenCaptureParameterscaptureParams: ScreenCaptureParametersintError code index
UpdateScreenCaptureRegionregionRect: RectangleintError code index
IRtcEngineEventHandler 68 method / 0 Property
typescript
OnActiveSpeaker(connection: RtcConnection, uid: uint): 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
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
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
OnFirstLocalAudioFramePublished(connection: RtcConnection, 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
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
OnNetworkQuality(connection: RtcConnection, remoteUid: uint, txQuality: int, rxQuality: int): void
OnNetworkTypeChanged(connection: RtcConnection, type: NETWORK_TYPE): void
OnPermissionError(permissionType: PERMISSION_TYPE): 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
OnRequestToken(connection: RtcConnection): 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
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
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

Method detail: 68 / 68 (parameters, returns, errors)

MethodParametersReturnsErrors
OnActiveSpeakerconnection: RtcConnection, uid: uintvoidError code index
OnAudioEffectFinishedsoundId: intvoidError code index
OnAudioMixingFinished—voidError code index
OnAudioMixingPositionChangedposition: longvoidError code index
OnAudioMixingStateChangedstate: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPEvoidError code index
OnAudioPublishStateChangedchannel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: intvoidError code index
OnAudioQualityconnection: RtcConnection, remoteUid: uint, quality: int, delay: UInt16, lost: UInt16voidError code index
OnAudioSubscribeStateChangedchannel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoidError code index
OnAudioVolumeIndicationconnection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: uint, totalVolume: intvoidError code index
OnChannelMediaRelayStateChangedstate: int, code: intvoidError code index
OnClientRoleChangeFailedconnection: RtcConnection, reason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPEvoidError code index
OnClientRoleChangedconnection: RtcConnection, oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: ClientRoleOptionsvoidError code index
OnConnectionBannedconnection: RtcConnectionvoidError code index
OnConnectionInterruptedconnection: RtcConnectionvoidError code index
OnConnectionLostconnection: RtcConnectionvoidError code index
OnConnectionStateChangedconnection: RtcConnection, state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPEvoidError code index
OnEncryptionErrorconnection: RtcConnection, errorType: ENCRYPTION_ERROR_TYPEvoidError code index
OnErrorerr: int, msg: stringvoidError code index
OnFirstLocalAudioFramePublishedconnection: RtcConnection, elapsed: intvoidError code index
OnFirstLocalVideoFramePublishedconnection: RtcConnection, elapsed: intvoidError code index
OnFirstRemoteAudioDecodedconnection: RtcConnection, uid: uint, elapsed: intvoidError code index
OnFirstRemoteAudioFrameconnection: RtcConnection, userId: uint, elapsed: intvoidError code index
OnFirstRemoteVideoDecodedconnection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: intvoidError code index
OnFirstRemoteVideoFrameconnection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: intvoidError code index
OnJoinChannelSuccessconnection: RtcConnection, elapsed: intvoidError code index
OnLastmileProbeResultresult: LastmileProbeResultvoidError code index
OnLastmileQualityquality: intvoidError code index
OnLeaveChannelconnection: RtcConnection, stats: RtcStatsvoidError code index
OnLocalAudioStateChangedconnection: RtcConnection, state: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASONvoidError code index
OnLocalAudioStatsconnection: RtcConnection, stats: LocalAudioStatsvoidError code index
OnLocalUserRegistereduid: uint, userAccount: stringvoidError code index
OnLocalVideoStateChangedsource: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASONvoidError code index
OnLocalVideoStatsconnection: RtcConnection, stats: LocalVideoStatsvoidError code index
OnLocalVideoTranscoderErrorstream: TranscodingVideoStream, error: VIDEO_TRANSCODER_ERRORvoidError code index
OnNetworkQualityconnection: RtcConnection, remoteUid: uint, txQuality: int, rxQuality: intvoidError code index
OnNetworkTypeChangedconnection: RtcConnection, type: NETWORK_TYPEvoidError code index
OnPermissionErrorpermissionType: PERMISSION_TYPEvoidError code index
OnProxyConnectedchannel: string, uid: uint, proxyType: PROXY_TYPE, localProxyIp: string, elapsed: intvoidError code index
OnRejoinChannelSuccessconnection: RtcConnection, elapsed: intvoidError code index
OnRemoteAudioStateChangedconnection: RtcConnection, remoteUid: uint, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: intvoidError code index
OnRemoteAudioStatsconnection: RtcConnection, stats: RemoteAudioStatsvoidError code index
OnRemoteAudioTransportStatsconnection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16voidError code index
OnRemoteSubscribeFallbackToAudioOnlyuid: uint, isFallbackOrRecover: boolvoidError code index
OnRemoteVideoStateChangedconnection: RtcConnection, remoteUid: uint, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: intvoidError code index
OnRemoteVideoStatsconnection: RtcConnection, stats: RemoteVideoStatsvoidError code index
OnRemoteVideoTransportStatsconnection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16voidError code index
OnRequestTokenconnection: RtcConnectionvoidError code index
OnRtcStatsconnection: RtcConnection, stats: RtcStatsvoidError code index
OnRtmpStreamingEventurl: string, eventCode: RTMP_STREAMING_EVENTvoidError code index
OnRtmpStreamingStateChangedurl: string, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASONvoidError code index
OnSnapshotTakenconnection: RtcConnection, uid: uint, filePath: string, width: int, height: int, errCode: intvoidError code index
OnStreamMessageconnection: RtcConnection, remoteUid: uint, streamId: int, data: byte[], length: ulong, sentTs: ulongvoidError code index
OnStreamMessageErrorconnection: RtcConnection, remoteUid: uint, streamId: int, code: int, missed: int, cached: intvoidError code index
OnTokenPrivilegeWillExpireconnection: RtcConnection, token: stringvoidError code index
OnTranscodingUpdated—voidError code index
OnUplinkNetworkInfoUpdatedinfo: UplinkNetworkInfovoidError code index
OnUserEnableLocalVideoconnection: RtcConnection, remoteUid: uint, enabled: boolvoidError code index
OnUserEnableVideoconnection: RtcConnection, remoteUid: uint, enabled: boolvoidError code index
OnUserInfoUpdateduid: uint, info: UserInfovoidError code index
OnUserJoinedconnection: RtcConnection, remoteUid: uint, elapsed: intvoidError code index
OnUserMuteAudioconnection: RtcConnection, remoteUid: uint, muted: boolvoidError code index
OnUserMuteVideoconnection: RtcConnection, remoteUid: uint, muted: boolvoidError code index
OnUserOfflineconnection: RtcConnection, remoteUid: uint, reason: USER_OFFLINE_REASON_TYPEvoidError code index
OnVideoPublishStateChangedsource: VIDEO_SOURCE_TYPE, channel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: intvoidError code index
OnVideoRenderingTracingResultconnection: RtcConnection, uid: uint, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfovoidError code index
OnVideoSizeChangedconnection: RtcConnection, sourceType: VIDEO_SOURCE_TYPE, uid: uint, width: int, height: int, rotation: intvoidError code index
OnVideoStopped—voidError code index
OnVideoSubscribeStateChangedchannel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoidError code index
event namecallback parameters
OnExtensionErrorWithContextpublic virtual void OnExtensionErrorWithContext(ExtensionContext context, int error, string message){}
OnExtensionEventWithContextpublic virtual void OnExtensionEventWithContext(ExtensionContext context, string key, string value){}
OnExtensionStartedWithContextpublic virtual void OnExtensionEventWithContext(ExtensionContext context, string key, string value){ }
OnExtensionStoppedWithContextpublic virtual void OnExtensionStoppedWithContext(ExtensionContext context){ }
IRtcEngineEx 40 method / 0 Property
typescript
AddVideoWatermarkEx(watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection): int
AdjustUserPlaybackSignalVolumeEx(uid: uint, volume: int, connection: RtcConnection): int
ClearVideoWatermarkEx(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
GetCallIdEx(callId: string, connection: RtcConnection): int
GetConnectionStateEx(connection: RtcConnection): CONNECTION_STATE_TYPE
JoinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions): 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
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
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
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
UpdateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): int
UpdateRtmpTranscodingEx(transcoding: LiveTranscoding, connection: RtcConnection): int

Method detail: 40 / 40 (parameters, returns, errors)

MethodParametersReturnsErrors
AddVideoWatermarkExwatermarkUrl: string, options: WatermarkOptions, connection: RtcConnectionintError code index
AdjustUserPlaybackSignalVolumeExuid: uint, volume: int, connection: RtcConnectionintError code index
ClearVideoWatermarkExconnection: RtcConnectionintError code index
CreateDataStreamExstreamId: int, config: DataStreamConfig, connection: RtcConnectionintError code index
EnableAudioVolumeIndicationExinterval: int, smooth: int, reportVad: bool, connection: RtcConnectionintError code index
EnableContentInspectExenabled: bool, config: ContentInspectConfig, connection: RtcConnectionintError code index
EnableDualStreamModeExenabled: bool, streamConfig: SimulcastStreamConfig, connection: RtcConnectionintError code index
EnableEncryptionExconnection: RtcConnection, enabled: bool, config: EncryptionConfigintError code index
GetCallIdExcallId: string, connection: RtcConnectionintError code index
GetConnectionStateExconnection: RtcConnectionCONNECTION_STATE_TYPEError code index
JoinChannelExtoken: string, connection: RtcConnection, options: ChannelMediaOptionsintError code index
LeaveChannelExconnection: RtcConnection, options: LeaveChannelOptionsintError code index
MuteAllRemoteAudioStreamsExmute: bool, connection: RtcConnectionintError code index
MuteAllRemoteVideoStreamsExmute: bool, connection: RtcConnectionintError code index
MuteLocalAudioStreamExmute: bool, connection: RtcConnectionintError code index
MuteLocalVideoStreamExmute: bool, connection: RtcConnectionintError code index
MuteRemoteAudioStreamExuid: uint, mute: bool, connection: RtcConnectionintError code index
MuteRemoteVideoStreamExuid: uint, mute: bool, connection: RtcConnectionintError code index
PauseAllChannelMediaRelayExconnection: RtcConnectionintError code index
ResumeAllChannelMediaRelayExconnection: RtcConnectionintError code index
SendCustomReportMessageExid: string, category: string, null: string, label: string, value: int, connection: RtcConnectionintError code index
SendStreamMessageExstreamId: int, data: byte[], length: uint, connection: RtcConnectionintError code index
SetDualStreamModeExmode: SIMULCAST_STREAM_MODE, streamConfig: SimulcastStreamConfig, connection: RtcConnectionintError code index
SetRemoteVideoStreamTypeExuid: uint, streamType: VIDEO_STREAM_TYPE, connection: RtcConnectionintError code index
SetRemoteVideoSubscriptionOptionsExuid: uint, options: VideoSubscriptionOptions, connection: RtcConnectionintError code index
SetRemoteVoicePositionExuid: uint, pan: double, gain: double, connection: RtcConnectionintError code index
SetSubscribeAudioAllowlistExuidList: unknown, uidNumber: unknown, connection: unknownunknownError code index
SetSubscribeAudioBlocklistExuidList: uint[], uidNumber: int, connection: RtcConnectionintError code index
SetSubscribeVideoAllowlistExuidList: uint[], uidNumber: int, connection: RtcConnectionintError code index
SetSubscribeVideoBlocklistExuidList: uint[], uidNumber: int, connection: RtcConnectionintError code index
SetVideoEncoderConfigurationExconfig: VideoEncoderConfiguration, connection: RtcConnectionintError code index
StartMediaRenderingTracingExconnection: RtcConnectionintError code index
StartOrUpdateChannelMediaRelayExconfiguration: ChannelMediaRelayConfiguration, connection: RtcConnectionintError code index
StartRtmpStreamWithTranscodingExurl: string, transcoding: LiveTranscoding, connection: RtcConnectionintError code index
StartRtmpStreamWithoutTranscodingExurl: string, connection: RtcConnectionintError code index
StopChannelMediaRelayExconnection: RtcConnectionintError code index
StopRtmpStreamExurl: string, connection: RtcConnectionintError code index
TakeSnapshotExconnection: RtcConnection, uid: uint, filePath: stringintError code index
UpdateChannelMediaOptionsExoptions: ChannelMediaOptions, connection: RtcConnectionintError code index
UpdateRtmpTranscodingExtranscoding: LiveTranscoding, connection: RtcConnectionintError code index
IVideoEncodedFrameObserver 1 method / 0 Property
typescript
OnEncodedVideoFrameReceived(uid: uint, imageBufferPtr: IntPtr, length: UInt64, videoEncodedFrameInfo: EncodedVideoFrameInfo): bool

Method detail: 1 / 1 (parameters, returns, errors)

MethodParametersReturnsErrors
OnEncodedVideoFrameReceiveduid: uint, imageBufferPtr: IntPtr, length: UInt64, videoEncodedFrameInfo: EncodedVideoFrameInfoboolError code index
IVideoFrameObserver 3 method / 0 Property
typescript
OnCaptureVideoFrame(sourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFrame): bool
OnPreEncodeVideoFrame(sourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFrame): bool
OnRenderVideoFrame(channelId: string, remoteUid: uint, videoFrame: VideoFrame): bool

Method detail: 3 / 3 (parameters, returns, errors)

MethodParametersReturnsErrors
OnCaptureVideoFramesourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFrameboolError code index
OnPreEncodeVideoFramesourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFrameboolError code index
OnRenderVideoFramechannelId: string, remoteUid: uint, videoFrame: VideoFrameboolError code index
LastmileProbeConfig 0 method / 4 Property
PropertyTyperead-only
probeUplinkboolNo
probeDownlinkboolNo
expectedUplinkBitrateuintNo
expectedDownlinkBitrateuintNo
LastmileProbeOneWayResult 0 method / 3 Property
PropertyTyperead-only
packetLossRateuintNo
jitteruintNo
availableBandwidthuintNo
LastmileProbeResult 0 method / 4 Property
PropertyTyperead-only
stateLASTMILE_PROBE_RESULT_STATENo
uplinkReportLastmileProbeOneWayResultNo
downlinkReportLastmileProbeOneWayResultNo
rttuintNo
LeaveChannelOptions 0 method / 3 Property
PropertyTyperead-only
stopAudioMixingboolNo
stopAllEffectboolNo
stopMicrophoneRecordingboolNo
LiveStreamAdvancedFeature 0 method / 2 Property
PropertyTyperead-only
featureNamestringNo
openedboolNo
LiveTranscoding 0 method / 23 Property
PropertyTyperead-only
widthintNo
heightintNo
videoBitrateintNo
videoFrameRateunknownNo
lowLatencyboolNo
videoGopintNo
videoCodecProfileVIDEO_CODEC_PROFILE_TYPENo
videoCodecTypeVIDEO_CODEC_TYPE_FOR_STREAMNo
transcodingUsersTranscodingUser[]No
transcodingExtraInfostringNo
backgroundColoruintNo
userCountuintNo
metadatastringNo
watermarkRtcImage[]No
backgroundImageRtcImage[]No
audioSampleRateAUDIO_SAMPLE_RATE_TYPENo
audioBitrateintNo
audioChannelsintNo
audioCodecProfileAUDIO_CODEC_PROFILE_TYPENo
watermarkCountuintNo
backgroundImageCountuintNo
advancedFeaturesLiveStreamAdvancedFeature[]No
advancedFeatureCountuintNo
LocalAccessPointConfiguration 0 method / 7 Property
PropertyTyperead-only
ipListstring[]No
ipListSizeintNo
domainListstring[]No
domainListSizeintNo
verifyDomainNamestringNo
modeLOCAL_PROXY_MODENo
advancedConfigAdvancedConfigInfoNo
LocalAudioMixerConfiguration 0 method / 3 Property
PropertyTyperead-only
streamCountuintNo
audioInputStreamsMixedAudioStream[]No
syncWithLocalMicunknownNo
LocalAudioStats 0 method / 8 Property
PropertyTyperead-only
numChannelsintNo
sentSampleRateintNo
sentBitrateunknownNo
txPacketLossRateushortNo
internalCodecint sentBitrate intNo
audioDeviceDelayintNo
earMonitorDelayunknownNo
aecEstimatedDelayint audioPlayoutDelay int earMonitorDelay intNo
LocalSpatialAudioConfig 0 method / 1 Property
PropertyTyperead-only
rtcEngineIRtcEngineNo
LocalTranscoderConfiguration 0 method / 3 Property
PropertyTyperead-only
streamCountuintNo
videoInputStreamsTranscodingVideoStream[]No
videoOutputConfigurationVideoEncoderConfigurationNo
LocalVideoStats 0 method / 22 Property
PropertyTyperead-only
uiduintNo
sentBitrateintNo
sentFrameRateintNo
captureFrameRateintNo
captureFrameWidthintNo
captureFrameHeightintNo
regulatedCaptureFrameRateintNo
regulatedCaptureFrameWidthintNo
regulatedCaptureFrameHeightintNo
encoderOutputFrameRateintNo
rendererOutputFrameRateintNo
targetBitrateintNo
targetFrameRateintNo
qualityAdaptIndicationQUALITY_ADAPT_INDICATIONNo
encodedBitrateintNo
encodedFrameHeightintNo
encodedFrameWidthintNo
encodedFrameCountintNo
codecTypeVIDEO_CODEC_TYPENo
txPacketLossRateushortNo
captureBrightnessLevelCAPTURE_BRIGHTNESS_LEVEL_TYPENo
hwEncoderAcceleratingintNo
LogConfig 0 method / 3 Property
PropertyTyperead-only
filePathstringNo
fileSizeInKBuintNo
levelLOG_LEVELNo
LogUploadServerInfo 0 method / 4 Property
PropertyTyperead-only
serverDomainunknownNo
serverPathunknownNo
serverPortunknownNo
serverHttpsunknownNo
LowlightEnhanceOptions 0 method / 2 Property
PropertyTyperead-only
levelLOW_LIGHT_ENHANCE_LEVELNo
modeLOW_LIGHT_ENHANCE_MODENo
MediaRecorderConfiguration 0 method / 11 Property
PropertyTyperead-only
storagePathstringNo
containerFormatMediaRecorderContainerFormatNo
streamTypeMediaRecorderStreamTypeNo
maxDurationMsintNo
recorderInfoUpdateIntervalintNo
widthintNo
heightintNo
fpsintNo
sample_rateintNo
channel_numintNo
videoSourceTypeVIDEO_SOURCE_TYPENo
MediaSource 0 method / 9 Property
PropertyTyperead-only
urlstringNo
uristringNo
startPosint64_tNo
autoPlayboolNo
enableCacheboolNo
enableMultiAudioTrackunknownNo
isAgoraSourceOptionalNo
isLiveSourceOptionalNo
providerIMediaPlayerCustomDataProviderNo
Metadata 0 method / 5 Property
PropertyTyperead-only
channelIdstringNo
uiduintNo
sizeuintNo
bufferIntPtrNo
timeStampMslongNo
MixedAudioStream 0 method / 4 Property
PropertyTyperead-only
sourceTypeAUDIO_SOURCE_TYPENo
remoteUserUiduintNo
channelIdstringNo
trackIduintNo
Music 0 method / 12 Property
PropertyTyperead-only
songCodeInt64No
namestringNo
singerstringNo
posterstringNo
releaseTimestringNo
typeintNo
pitchTypeintNo
durationSintNo
lyricListint[]No
climaxSegmentListClimaxSegment[]No
lyricCountintNo
climaxSegmentCountintNo
PlayerPlaybackStats 0 method / 4 Property
PropertyTyperead-only
videoFpsintNo
videoBitrateInKbpsintNo
audioBitrateInKbpsintNo
totalBitrateInKbpsintNo
PlayerStreamInfo 0 method / 13 Property
PropertyTyperead-only
streamIndexintNo
streamTypeMEDIA_STREAM_TYPENo
codecNamestringNo
languagestringNo
videoFrameRateintNo
videoBitRateintNo
videoWidthintNo
videoHeightintNo
videoRotationintNo
audioSampleRateintNo
audioChannelsintNo
audioBitsPerSampleintNo
durationint64_tNo
PlayerUpdatedInfo 0 method / 6 Property
PropertyTyperead-only
deviceIdOptionalNo
videoHeightunknownNo
videoWidthunknownNo
audioSampleRateunknownNo
audioChannelsunknownNo
audioBitsPerSampleunknownNo
RecorderInfo 0 method / 3 Property
PropertyTyperead-only
fileNamestringNo
durationMsuintNo
fileSizeuintNo
RecorderStreamInfo 0 method / 3 Property
PropertyTyperead-only
channelIdstringNo
uiduintNo
typeRecorderStreamTypeNo
Rectangle 0 method / 4 Property
PropertyTyperead-only
xintNo
yintNo
widthintNo
heightintNo
RemoteAudioStats 0 method / 16 Property
PropertyTyperead-only
uiduintNo
qualityintNo
networkTransportDelayintNo
jitterBufferDelayintNo
audioLossRateintNo
numChannelsintNo
receivedSampleRateintNo
receivedBitrateintNo
totalFrozenTimeintNo
frozenRateintNo
totalActiveTimeintNo
publishDurationintNo
qoeQualityintNo
qualityChangedReasonintNo
mosValueintNo
e2eDelayintNo
RemoteVideoStats 0 method / 16 Property
PropertyTyperead-only
uiduintNo
delayintNo
e2eDelayintNo
widthintNo
heightintNo
receivedBitrateintNo
decoderOutputFrameRateintNo
rendererOutputFrameRateintNo
frameLossRateintNo
packetLossRateintNo
rxStreamTypeVIDEO_STREAM_TYPENo
totalFrozenTimeintNo
frozenRateintNo
totalActiveTimeintNo
publishDurationintNo
avSyncTimeMsintNo
RemoteVoicePositionInfo 0 method / 2 Property
PropertyTyperead-only
positionfloat[]No
forwardfloat[]No
RtcConnection 0 method / 2 Property
PropertyTyperead-only
channelIdstringNo
localUiduintNo
RtcEngineContext 0 method / 7 Property
PropertyTyperead-only
contextUInt64No
channelProfileCHANNEL_PROFILE_TYPENo
audioScenarioAUDIO_SCENARIO_TYPENo
areaCodeAREA_CODENo
logConfigLogConfigNo
domainLimitboolNo
autoRegisterAgoraExtensionsboolNo
RtcImage 0 method / 7 Property
PropertyTyperead-only
urlstringNo
xintNo
yintNo
widthintNo
heightintNo
zOrderintNo
alphadoubleNo
RtcStats 0 method / 24 Property
PropertyTyperead-only
durationuintNo
txBytesuintNo
rxBytesuintNo
txAudioBytesuintNo
txVideoBytesuintNo
rxAudioBytesuintNo
rxVideoBytesuintNo
txKBitRateushortNo
rxKBitRateushortNo
rxAudioKBitRateushortNo
txAudioKBitRateushortNo
rxVideoKBitRateushortNo
txVideoKBitRateushortNo
lastmileDelayushortNo
txPacketLossRateintNo
rxPacketLossRateintNo
userCountuintNo
cpuAppUsagedoubleNo
cpuTotalUsagedoubleNo
connectTimeMsintNo
gatewayRttintNo
memoryAppUsageRatiodoubleNo
memoryTotalUsageRatiodoubleNo
memoryAppUsageInKbytesintNo
ScreenAudioParameters 0 method / 3 Property
PropertyTyperead-only
sampleRateintNo
channelsintNo
captureSignalVolumeintNo
ScreenCaptureConfiguration 0 method / 6 Property
PropertyTyperead-only
isCaptureWindowboolNo
displayIdlongNo
screenRectRectangleNo
windowIdlongNo
parametersunknownNo
regionRectRectangleNo
ScreenCaptureParameters 0 method / 10 Property
PropertyTyperead-only
dimensionsVideoDimensionsNo
frameRateintNo
bitrateintNo
captureMouseCursorboolNo
windowFocusboolNo
excludeWindowListview_t[]No
enableHighLightboolNo
highLightColoruintNo
highLightWidthintNo
excludeWindowCountintNo
ScreenCaptureParameters2 0 method / 4 Property
PropertyTyperead-only
captureAudioboolNo
audioParamsScreenAudioParametersNo
captureVideoboolNo
videoParamsScreenVideoParametersNo
ScreenCaptureSourceInfo 0 method / 10 Property
PropertyTyperead-only
typeScreenCaptureSourceTypeNo
sourceIdlongNo
sourceNamestringNo
thumbImageThumbImageBufferNo
iconImageThumbImageBufferNo
processPathstringNo
sourceTitlestringNo
primaryMonitorboolNo
positionRectangleNo
sourceDisplayIdlongNo
ScreenVideoParameters 0 method / 4 Property
PropertyTyperead-only
dimensionsVideoDimensionsNo
frameRateintNo
bitrateintNo
contentHintVIDEO_CONTENT_HINTNo
SegmentationProperty 0 method / 2 Property
PropertyTyperead-only
modelTypeSEG_MODEL_TYPENo
greenCapacityfloatNo
SimulcastStreamConfig 0 method / 3 Property
PropertyTyperead-only
dimensionsVideoDimensionsNo
kBitrateintNo
framerateintNo
SnapshotConfig 0 method / 2 Property
PropertyTyperead-only
filePathstringNo
positionVIDEO_MODULE_POSITIONNo
SpatialAudioParams 0 method / 8 Property
PropertyTyperead-only
speaker_azimuthOptionalNo
speaker_elevationOptionalNo
speaker_distanceOptionalNo
speaker_orientationOptionalNo
enable_blurOptionalNo
enable_air_absorbOptionalNo
speaker_attenuationOptionalNo
enable_dopplerOptionalNo
SpatialAudioZone 0 method / 9 Property
PropertyTyperead-only
zoneSetIdintNo
positionfloat[]No
forwardfloat[]No
rightfloat[]No
upfloat[]No
forwardLengthfloatNo
rightLengthfloatNo
upLengthfloatNo
audioAttenuationfloatNo
SrcInfo 0 method / 2 Property
PropertyTyperead-only
bitrateInKbpsintNo
namestringNo
ThumbImageBuffer 0 method / 4 Property
PropertyTyperead-only
bufferInt64No
lengthuintNo
widthuintNo
heightuintNo
TranscodingUser 0 method / 8 Property
PropertyTyperead-only
uiduintNo
xintNo
yintNo
widthintNo
heightintNo
zOrderintNo
alphadoubleNo
audioChannelintNo
TranscodingVideoStream 0 method / 11 Property
PropertyTyperead-only
sourceTypeVIDEO_SOURCE_TYPENo
remoteUserUiduintNo
imageUrlstringNo
mediaPlayerIdintNo
xintNo
yintNo
widthintNo
heightintNo
zOrderintNo
alphadoubleNo
mirrorboolNo
UplinkNetworkInfo 0 method / 1 Property
PropertyTyperead-only
video_encoder_target_bitrate_bpsintNo
UserAudioSpectrumInfo 0 method / 2 Property
PropertyTyperead-only
uiduintNo
spectrumDataAudioSpectrumDataNo
UserInfo 0 method / 2 Property
PropertyTyperead-only
uiduintNo
userAccountstringNo
VideoCanvas 0 method / 12 Property
PropertyTyperead-only
uiduintNo
subviewUiduintNo
viewview_tNo
renderModeRENDER_MODE_TYPENo
mirrorModeVIDEO_MIRROR_MODE_TYPENo
sourceTypeVIDEO_SOURCE_TYPENo
setupModeVIDEO_VIEW_SETUP_MODENo
mediaPlayerIdintNo
cropAreaRectangleNo
backgroundColoruintNo
enableAlphaMaskboolNo
positionVIDEO_MODULE_POSITIONNo
VideoDenoiserOptions 0 method / 2 Property
PropertyTyperead-only
levelVIDEO_DENOISER_LEVELNo
modeVIDEO_DENOISER_MODENo
VideoDimensions 0 method / 2 Property
PropertyTyperead-only
widthintNo
heightintNo
VideoEncoderConfiguration 0 method / 9 Property
PropertyTyperead-only
dimensionsVideoDimensionsNo
codecTypeVIDEO_CODEC_TYPENo
frameRateintNo
bitrateintNo
minBitrateintNo
orientationModeORIENTATION_MODENo
degradationPreferenceDEGRADATION_PREFERENCENo
mirrorModeVIDEO_MIRROR_MODE_TYPENo
advanceOptionsAdvanceOptionsNo
VideoFormat 0 method / 3 Property
PropertyTyperead-only
widthunknownNo
heightunknownNo
fpsunknownNo
VideoFrame 0 method / 21 Property
PropertyTyperead-only
typeVIDEO_PIXEL_FORMATNo
widthintNo
heightintNo
yStrideintNo
uStrideintNo
vStrideintNo
yBufferbyte[]No
uBufferbyte[]No
vBufferbyte[]No
rotationintNo
renderTimeMslongNo
avsync_typeintNo
metadata_bufferIntPtrNo
metadata_sizeintNo
sharedContextIntPtrNo
textureIdintNo
matrixfloat[]No
colorSpaceColorSpaceNo
alphaBufferbyte[]No
alphaStitchModeALPHA_STITCH_MODENo
metaInfoIVideoFrameMetaInfoNo
VideoFrameBufferConfig 0 method / 3 Property
PropertyTyperead-only
typeVIDEO_SOURCE_TYPENo
iduintNo
keystringNo
VideoLayout 0 method / 8 Property
PropertyTyperead-only
channelIdstringNo
uiduintNo
strUidstringNo
xuintNo
yunknownNo
widthuint y uintNo
heightuintNo
videoStateuintNo
VideoRenderingTracingInfo 0 method / 7 Property
PropertyTyperead-only
elapsedTimeintNo
start2JoinChannelintNo
join2JoinSuccessintNo
joinSuccess2RemoteJoinedintNo
remoteJoined2SetViewintNo
remoteJoined2UnmuteVideointNo
remoteJoined2PacketReceivedintNo
VideoSubscriptionOptions 0 method / 2 Property
PropertyTyperead-only
typeOptionalNo
encodedFrameOnlyOptionalNo
VirtualBackgroundSource 0 method / 4 Property
PropertyTyperead-only
background_source_typeBACKGROUND_SOURCE_TYPENo
coloruintNo
sourcestringNo
blur_degreeBACKGROUND_BLUR_DEGREENo
WatermarkOptions 0 method / 5 Property
PropertyTyperead-only
visibleInPreviewboolNo
positionInLandscapeModeRectangleNo
positionInPortraitModeRectangleNo
watermarkRatioWatermarkRatioNo
modeWATERMARK_FIT_MODENo
WatermarkRatio 0 method / 3 Property
PropertyTyperead-only
xRatiofloatNo
yRatiofloatNo
widthRatiofloatNo

Enums

EnumsMember countExample value
ALPHA_STITCH_MODE5NO_ALPHA_STITCH = 0
AREA_CODE7AREA_CODE_CN = null
AUDIENCE_LATENCY_LEVEL_TYPE2AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1
AUDIO_AINS_MODE3AINS_MODE_BALANCED = 0
AUDIO_CODEC_PROFILE_TYPE3AUDIO_CODEC_PROFILE_LC_AAC = 0
AUDIO_CODEC_TYPE8AUDIO_CODEC_OPUS = 1
AUDIO_DUAL_MONO_MODE4AUDIO_DUAL_MONO_STEREO = 0
AUDIO_EFFECT_PRESET21AUDIO_EFFECT_OFF = null
AUDIO_ENCODED_FRAME_OBSERVER_POSITION3AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1
AUDIO_ENCODING_TYPE11AUDIO_ENCODING_TYPE_AAC_16000_LOW = null
AUDIO_EQUALIZATION_BAND_FREQUENCY10AUDIO_EQUALIZATION_BAND_31 = 0
AUDIO_FILE_RECORDING_TYPE3AUDIO_FILE_RECORDING_MIC = 1
AUDIO_FRAME_TYPE1FRAME_TYPE_PCM16 = 0
AUDIO_MIXING_DUAL_MONO_MODE4AUDIO_MIXING_DUAL_MONO_AUTO = 0
AUDIO_MIXING_REASON_TYPE7AUDIO_MIXING_REASON_OK = 0
AUDIO_MIXING_STATE_TYPE4AUDIO_MIXING_STATE_PLAYING = 710
AUDIO_PROCESSING_CHANNELS2AUDIO_PROCESSING_MONO = 1
AUDIO_PROFILE_TYPE6AUDIO_PROFILE_DEFAULT = 0
AUDIO_RECORDING_QUALITY_TYPE4AUDIO_RECORDING_QUALITY_LOW = 0
AUDIO_REVERB_PRESET9AUDIO_REVERB_OFF = null
AUDIO_REVERB_TYPE5AUDIO_REVERB_DRY_LEVEL = 0
AUDIO_SAMPLE_RATE_TYPE3AUDIO_SAMPLE_RATE_32000 = 32000
AUDIO_SCENARIO_TYPE7AUDIO_SCENARIO_DEFAULT = 0
AUDIO_SESSION_OPERATION_RESTRICTION5AUDIO_SESSION_OPERATION_RESTRICTION_NONE = null
AUDIO_SOURCE_TYPE7AUDIO_SOURCE_MICROPHONE = 0
AUDIO_TRACK_TYPE2AUDIO_TRACK_MIXABLE = 0
AudioRoute12ROUTE_DEFAULT = -1
BACKGROUND_BLUR_DEGREE3BLUR_DEGREE_LOW = 1
BACKGROUND_SOURCE_TYPE4BACKGROUND_COLOR = 1
BITRATE1STANDARD_BITRATE = 0
CAMERA_DIRECTION2CAMERA_REAR = 0
CAMERA_FOCAL_LENGTH_TYPE3CAMERA_FOCAL_LENGTH_DEFAULT = 0
CAMERA_STABILIZATION_MODE5CAMERA_STABILIZATION_MODE_OFF = -1
CAPTURE_BRIGHTNESS_LEVEL_TYPE4CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1
CHANNEL_MEDIA_RELAY_ERROR12RELAY_OK = 0
CHANNEL_MEDIA_RELAY_STATE4RELAY_STATE_IDLE = 0
CHANNEL_PROFILE_TYPE4CHANNEL_PROFILE_COMMUNICATION = 0
CLIENT_ROLE_CHANGE_FAILED_REASON4CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1
CLIENT_ROLE_TYPE2CLIENT_ROLE_BROADCASTER = 1
CLOUD_PROXY_TYPE3NONE_PROXY = 0
CODEC_CAP_MASK5CODEC_CAP_MASK_NONE = 0
COMPRESSION_PREFERENCE3PREFER_COMPRESSION_AUTO = -1
CONNECTION_CHANGED_REASON_TYPE21CONNECTION_CHANGED_CONNECTING = 0
CONNECTION_STATE_TYPE5CONNECTION_STATE_DISCONNECTED = 1
CONTENT_INSPECT_TYPE2CONTENT_INSPECT_INVALID = 0
DEGRADATION_PREFERENCE5MAINTAIN_AUTO = -1
DIRECT_CDN_STREAMING_REASON6DIRECT_CDN_STREAMING_REASON_OK = 0
DIRECT_CDN_STREAMING_STATE5DIRECT_CDN_STREAMING_STATE_IDLE = 0
EAR_MONITORING_FILTER_TYPE4EAR_MONITORING_FILTER_NONE = null
ENCODING_PREFERENCE3PREFER_AUTO = -1
ENCRYPTION_ERROR_TYPE5ENCRYPTION_ERROR_INTERNAL_FAILURE = 0
ENCRYPTION_MODE9AES_128_XTS = 1
ERROR_CODE_TYPE46ERR_OK = 0
EXPERIENCE_POOR_REASON5EXPERIENCE_REASON_NONE = 0
EXPERIENCE_QUALITY_TYPE2EXPERIENCE_QUALITY_GOOD = 0
EXTERNAL_VIDEO_SOURCE_TYPE2VIDEO_FRAME = 0
FACE_SHAPE_AREA1FACE_SHAPE_AREA_NONE = -1
FACE_SHAPE_BEAUTY_STYLE2FACE_SHAPE_BEAUTY_STYLE_FEMALE = 0
FeatureType2VIDEO_VIRTUAL_BACKGROUND = 1
FRAME_RATE7FRAME_RATE_FPS_1 = 1
HEADPHONE_EQUALIZER_PRESET3HEADPHONE_EQUALIZER_OFF = null
LASTMILE_PROBE_RESULT_STATE3LASTMILE_PROBE_RESULT_COMPLETE = 1
LIGHTENING_CONTRAST_LEVEL3LIGHTENING_CONTRAST_LOW = 0
LOCAL_AUDIO_STREAM_REASON11LOCAL_AUDIO_STREAM_REASON_OK = 0
LOCAL_AUDIO_STREAM_STATE4LOCAL_AUDIO_STREAM_STATE_STOPPED = 0
LOCAL_PROXY_MODE2kConnectivityFirst = 0
LOCAL_VIDEO_STREAM_REASON15LOCAL_VIDEO_STREAM_REASON_OK = 0
LOCAL_VIDEO_STREAM_STATE4LOCAL_VIDEO_STREAM_STATE_STOPPED = 0
LOG_LEVEL5LOG_LEVEL_NONE = 0
LOW_LIGHT_ENHANCE_LEVEL2LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY = 0
LOW_LIGHT_ENHANCE_MODE2LOW_LIGHT_ENHANCE_AUTO = 0
MAX_USER_ACCOUNT_LENGTH_TYPE1MAX_USER_ACCOUNT_LENGTH = null
MEDIA_DEVICE_STATE_TYPE6MEDIA_DEVICE_STATE_IDLE = 0
MEDIA_DEVICE_TYPE7UNKNOWN_AUDIO_DEVICE = -1
MEDIA_PLAYER_EVENT14PLAYER_EVENT_SEEK_BEGIN = 0
MEDIA_PLAYER_METADATA_TYPE2PLAYER_METADATA_TYPE_UNKNOWN = 0
MEDIA_PLAYER_REASON16PLAYER_REASON_NONE = 0
MEDIA_PLAYER_STATE9PLAYER_STATE_IDLE = 0
MEDIA_SOURCE_TYPE6AUDIO_PLAYOUT_SOURCE = 0
MEDIA_STREAM_TYPE4STREAM_TYPE_UNKNOWN = 0
MEDIA_TRACE_EVENT2MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0
MediaRecorderContainerFormat1FORMAT_MP4 = 1
MediaRecorderStreamType3STREAM_TYPE_AUDIO = null
METADATA_TYPE2UNKNOWN_METADATA = null
MUSIC_CACHE_STATUS_TYPE2MUSIC_CACHE_STATUS_TYPE_CACHED = 0
MusicContentCenterStateReason8kMusicContentCenterReasonOk = 0
MusicPlayMode3kMusicPlayModeOriginal = 0
NETWORK_TYPE8NETWORK_TYPE_UNKNOWN = -1
OBSERVER_MODE2RAW_DATA = null
ORIENTATION_MODE3ORIENTATION_MODE_ADAPTIVE = 0
PERMISSION_TYPE3RECORD_AUDIO = 0
PLAYER_PRELOAD_EVENT3PLAYER_PRELOAD_EVENT_BEGIN = 0
PreloadState4kPreloadStateCompleted = 0
PROXY_TYPE5NONE_PROXY_TYPE = 0
QUALITY_ADAPT_INDICATION3ADAPT_NONE = 0
QUALITY_TYPE8QUALITY_UNKNOWN = 0
RAW_AUDIO_FRAME_OP_MODE_TYPE2RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
RecorderReasonCode5RECORDER_REASON_NONE = 0
RecorderState3RECORDER_STATE_ERROR = -1
RecorderStreamType2RTC = 0
REMOTE_AUDIO_STATE5REMOTE_AUDIO_STATE_STOPPED = 0
REMOTE_AUDIO_STATE_REASON8REMOTE_AUDIO_REASON_INTERNAL = 0
REMOTE_VIDEO_STATE5REMOTE_VIDEO_STATE_STOPPED = 0
REMOTE_VIDEO_STATE_REASON11REMOTE_VIDEO_STATE_REASON_INTERNAL = 0
RENDER_MODE_TYPE3RENDER_MODE_HIDDEN = 1
RHYTHM_PLAYER_REASON5RHYTHM_PLAYER_REASON_OK = 0
RHYTHM_PLAYER_STATE_TYPE5RHYTHM_PLAYER_STATE_IDLE = 810
RTMP_STREAM_LIFE_CYCLE_TYPE2RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = null
RTMP_STREAM_PUBLISH_REASON15RTMP_STREAM_PUBLISH_REASON_OK = 0
RTMP_STREAM_PUBLISH_STATE6RTMP_STREAM_PUBLISH_STATE_IDLE = 0
RTMP_STREAMING_EVENT4RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1
SCREEN_CAPTURE_FRAMERATE_CAPABILITY3SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS = 0
SCREEN_SCENARIO_TYPE4SCREEN_SCENARIO_DOCUMENT = 1
ScreenCaptureSourceType4ScreenCaptureSourceType_Unknown = -1
SEG_MODEL_TYPE2SEG_MODEL_AI = 1
SIMULCAST_STREAM_MODE3AUTO_SIMULCAST_STREAM = -1
STREAM_FALLBACK_OPTIONS3STREAM_FALLBACK_OPTION_DISABLED = 0
STREAM_PUBLISH_STATE4PUB_STATE_IDLE = 0
STREAM_SUBSCRIBE_STATE4SUB_STATE_IDLE = 0
USER_OFFLINE_REASON_TYPE3USER_OFFLINE_QUIT = 0
VIDEO_APPLICATION_SCENARIO_TYPE4APPLICATION_SCENARIO_GENERAL = 0
VIDEO_BUFFER_TYPE3VIDEO_BUFFER_RAW_DATA = 1
VIDEO_CODEC_CAPABILITY_LEVEL5CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1
VIDEO_CODEC_PROFILE_TYPE3VIDEO_CODEC_PROFILE_BASELINE = 66
VIDEO_CODEC_TYPE6VIDEO_CODEC_NONE = 0
VIDEO_CODEC_TYPE_FOR_STREAM2VIDEO_CODEC_H264_FOR_STREAM = 1
VIDEO_CONTENT_HINT3CONTENT_HINT_NONE = null
VIDEO_DENOISER_LEVEL2VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0
VIDEO_DENOISER_MODE2VIDEO_DENOISER_AUTO = 0
VIDEO_FRAME_TYPE6VIDEO_FRAME_TYPE_BLANK_FRAME = 0
VIDEO_MIRROR_MODE_TYPE3VIDEO_MIRROR_MODE_AUTO = 0
VIDEO_MODULE_POSITION4POSITION_POST_CAPTURER = 1
VIDEO_OBSERVER_FRAME_TYPE4FRAME_TYPE_DEFAULT = null
VIDEO_ORIENTATION4VIDEO_ORIENTATION_0 = 0
VIDEO_PIXEL_FORMAT4VIDEO_PIXEL_DEFAULT = 0
VIDEO_SOURCE_TYPE18VIDEO_SOURCE_CAMERA_PRIMARY = 0
VIDEO_STREAM_TYPE2VIDEO_STREAM_HIGH = 0
VIDEO_TRANSCODER_ERROR6VT_ERR_VIDEO_SOURCE_NOT_READY = 1
VIDEO_VIEW_SETUP_MODE3VIDEO_VIEW_SETUP_REPLACE = 0
VOICE_AI_TUNER_TYPE10VOICE_AI_TUNER_MATURE_MALE = 0
VOICE_BEAUTIFIER_PRESET14VOICE_BEAUTIFIER_OFF = null
VOICE_CHANGER_PRESET19VOICE_CHANGER_OFF = null
VOICE_CONVERSION_PRESET5VOICE_CONVERSION_OFF = null
WATERMARK_FIT_MODE2FIT_MODE_COVER_POSITION = null
ALPHA_STITCH_MODE 5 members
Membervalue
NO_ALPHA_STITCH0
ALPHA_STITCH_UP1
ALPHA_STITCH_BELOW2
ALPHA_STITCH_LEFT3
ALPHA_STITCH_RIGHT4
AREA_CODE 7 members
Membervalue
AREA_CODE_CNnull
AREA_CODE_NAnull
AREA_CODE_EUnull
AREA_CODE_ASnull
AREA_CODE_JPnull
AREA_CODE_INnull
AREA_CODE_GLOBnull
AUDIENCE_LATENCY_LEVEL_TYPE 2 members
Membervalue
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY1
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY2
AUDIO_AINS_MODE 3 members
Membervalue
AINS_MODE_BALANCED0
AINS_MODE_AGGRESSIVE1
AINS_MODE_ULTRALOWLATENCY2
AUDIO_CODEC_PROFILE_TYPE 3 members
Membervalue
AUDIO_CODEC_PROFILE_LC_AAC0
AUDIO_CODEC_PROFILE_HE_AAC1
AUDIO_CODEC_PROFILE_HE_AAC_V22
AUDIO_CODEC_TYPE 8 members
Membervalue
AUDIO_CODEC_OPUS1
AUDIO_CODEC_PCMA3
AUDIO_CODEC_PCMU4
AUDIO_CODEC_G7225
AUDIO_CODEC_AACLC8
AUDIO_CODEC_HEAAC9
AUDIO_CODEC_JC110
AUDIO_CODEC_HEAAC211
AUDIO_DUAL_MONO_MODE 4 members
Membervalue
AUDIO_DUAL_MONO_STEREO0
AUDIO_DUAL_MONO_L1
AUDIO_DUAL_MONO_R2
AUDIO_DUAL_MONO_MIX3
AUDIO_EFFECT_PRESET 21 members
Membervalue
AUDIO_EFFECT_OFFnull
ROOM_ACOUSTICS_KTVnull
ROOM_ACOUSTICS_VOCAL_CONCERTnull
ROOM_ACOUSTICS_STUDIOnull
ROOM_ACOUSTICS_PHONOGRAPHnull
ROOM_ACOUSTICS_VIRTUAL_STEREOnull
ROOM_ACOUSTICS_SPACIALnull
ROOM_ACOUSTICS_ETHEREALnull
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUNDnull
ROOM_ACOUSTICS_CHORUSnull
ROOM_ACOUSTICS_3D_VOICEnull
VOICE_CHANGER_EFFECT_UNCLEnull
VOICE_CHANGER_EFFECT_OLDMANnull
VOICE_CHANGER_EFFECT_BOYnull
VOICE_CHANGER_EFFECT_SISTERnull
VOICE_CHANGER_EFFECT_GIRLnull
VOICE_CHANGER_EFFECT_PIGKINGnull
VOICE_CHANGER_EFFECT_HULKnull
STYLE_TRANSFORMATION_RNBnull
STYLE_TRANSFORMATION_POPULARnull
PITCH_CORRECTIONnull
AUDIO_ENCODED_FRAME_OBSERVER_POSITION 3 members
Membervalue
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD1
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK2
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED3
AUDIO_ENCODING_TYPE 11 members
Membervalue
AUDIO_ENCODING_TYPE_AAC_16000_LOWnull
AUDIO_ENCODING_TYPE_AAC_16000_MEDIUMnull
AUDIO_ENCODING_TYPE_AAC_32000_LOWnull
AUDIO_ENCODING_TYPE_AAC_32000_MEDIUMnull
AUDIO_ENCODING_TYPE_AAC_32000_HIGHnull
AUDIO_ENCODING_TYPE_AAC_48000_MEDIUMnull
AUDIO_ENCODING_TYPE_AAC_48000_HIGHnull
AUDIO_ENCODING_TYPE_OPUS_16000_LOWnull
AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUMnull
AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUMnull
AUDIO_ENCODING_TYPE_OPUS_48000_HIGHnull
AUDIO_EQUALIZATION_BAND_FREQUENCY 10 members
Membervalue
AUDIO_EQUALIZATION_BAND_310
AUDIO_EQUALIZATION_BAND_621
AUDIO_EQUALIZATION_BAND_1252
AUDIO_EQUALIZATION_BAND_2503
AUDIO_EQUALIZATION_BAND_5004
AUDIO_EQUALIZATION_BAND_1K5
AUDIO_EQUALIZATION_BAND_2K6
AUDIO_EQUALIZATION_BAND_4K7
AUDIO_EQUALIZATION_BAND_8K8
AUDIO_EQUALIZATION_BAND_16K9
AUDIO_FILE_RECORDING_TYPE 3 members
Membervalue
AUDIO_FILE_RECORDING_MIC1
AUDIO_FILE_RECORDING_PLAYBACK2
AUDIO_FILE_RECORDING_MIXED3
AUDIO_FRAME_TYPE 1 members
Membervalue
FRAME_TYPE_PCM160
AUDIO_MIXING_DUAL_MONO_MODE 4 members
Membervalue
AUDIO_MIXING_DUAL_MONO_AUTO0
AUDIO_MIXING_DUAL_MONO_L1
AUDIO_MIXING_DUAL_MONO_R2
AUDIO_MIXING_DUAL_MONO_MIX3
AUDIO_MIXING_REASON_TYPE 7 members
Membervalue
AUDIO_MIXING_REASON_OK0
AUDIO_MIXING_REASON_CAN_NOT_OPEN701
AUDIO_MIXING_REASON_TOO_FREQUENT_CALL702
AUDIO_MIXING_REASON_INTERRUPTED_EOF703
AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED721
AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED723
AUDIO_MIXING_REASON_STOPPED_BY_USER724
AUDIO_MIXING_STATE_TYPE 4 members
Membervalue
AUDIO_MIXING_STATE_PLAYING710
AUDIO_MIXING_STATE_PAUSED711
AUDIO_MIXING_STATE_STOPPED713
AUDIO_MIXING_STATE_FAILED714
AUDIO_PROCESSING_CHANNELS 2 members
Membervalue
AUDIO_PROCESSING_MONO1
AUDIO_PROCESSING_STEREO2
AUDIO_PROFILE_TYPE 6 members
Membervalue
AUDIO_PROFILE_DEFAULT0
AUDIO_PROFILE_SPEECH_STANDARD1
AUDIO_PROFILE_MUSIC_STANDARD2
AUDIO_PROFILE_MUSIC_STANDARD_STEREO3
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO5
AUDIO_PROFILE_NUMnull
AUDIO_RECORDING_QUALITY_TYPE 4 members
Membervalue
AUDIO_RECORDING_QUALITY_LOW0
AUDIO_RECORDING_QUALITY_MEDIUM1
AUDIO_RECORDING_QUALITY_HIGH2
AUDIO_RECORDING_QUALITY_ULTRA_HIGH3
AUDIO_REVERB_PRESET 9 members
Membervalue
AUDIO_REVERB_OFFnull
AUDIO_REVERB_FX_KTVnull
AUDIO_REVERB_FX_VOCAL_CONCERTnull
AUDIO_REVERB_FX_UNCLEnull
AUDIO_REVERB_FX_SISTERnull
AUDIO_REVERB_FX_STUDIOnull
AUDIO_REVERB_FX_POPULARnull
AUDIO_REVERB_FX_RNBnull
AUDIO_REVERB_FX_PHONOGRAPHnull
AUDIO_REVERB_TYPE 5 members
Membervalue
AUDIO_REVERB_DRY_LEVEL0
AUDIO_REVERB_WET_LEVEL1
AUDIO_REVERB_ROOM_SIZE2
AUDIO_REVERB_WET_DELAY3
AUDIO_REVERB_STRENGTH4
AUDIO_SAMPLE_RATE_TYPE 3 members
Membervalue
AUDIO_SAMPLE_RATE_3200032000
AUDIO_SAMPLE_RATE_4410044100
AUDIO_SAMPLE_RATE_4800048000
AUDIO_SCENARIO_TYPE 7 members
Membervalue
AUDIO_SCENARIO_DEFAULT0
AUDIO_SCENARIO_GAME_STREAMING3
AUDIO_SCENARIO_CHATROOM5
AUDIO_SCENARIO_CHORUS7
AUDIO_SCENARIO_MEETING8
AUDIO_SCENARIO_AI_CLIENT10
AUDIO_SCENARIO_NUMnull
AUDIO_SESSION_OPERATION_RESTRICTION 5 members
Membervalue
AUDIO_SESSION_OPERATION_RESTRICTION_NONEnull
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORYnull
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSIONnull
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSIONnull
AUDIO_SESSION_OPERATION_RESTRICTION_ALLnull
AUDIO_SOURCE_TYPE 7 members
Membervalue
AUDIO_SOURCE_MICROPHONE0
AUDIO_SOURCE_CUSTOM1
AUDIO_SOURCE_MEDIA_PLAYER2
AUDIO_SOURCE_LOOPBACK_RECORDING3
AUDIO_SOURCE_REMOTE_USER5
AUDIO_SOURCE_REMOTE_CHANNEL6
AUDIO_SOURCE_UNKNOWN100
AUDIO_TRACK_TYPE 2 members
Membervalue
AUDIO_TRACK_MIXABLE0
AUDIO_TRACK_DIRECT1
AudioRoute 12 members
Membervalue
ROUTE_DEFAULT-1
ROUTE_HEADSET0
ROUTE_EARPIECE1
ROUTE_HEADSETNOMIC2
ROUTE_SPEAKERPHONE3
ROUTE_LOUDSPEAKER4
ROUTE_BLUETOOTH_DEVICE_HFP5
ROUTE_USB6
ROUTE_HDMI7
ROUTE_DISPLAYPORT8
ROUTE_AIRPLAY9
ROUTE_BLUETOOTH_DEVICE_A2DP10
BACKGROUND_BLUR_DEGREE 3 members
Membervalue
BLUR_DEGREE_LOW1
BLUR_DEGREE_MEDIUM2
BLUR_DEGREE_HIGH3
BACKGROUND_SOURCE_TYPE 4 members
Membervalue
BACKGROUND_COLOR1
BACKGROUND_IMG2
BACKGROUND_BLUR3
BACKGROUND_VIDEO4
BITRATE 1 members
Membervalue
STANDARD_BITRATE0
CAMERA_DIRECTION 2 members
Membervalue
CAMERA_REAR0
CAMERA_FRONT1
CAMERA_FOCAL_LENGTH_TYPE 3 members
Membervalue
CAMERA_FOCAL_LENGTH_DEFAULT0
CAMERA_FOCAL_LENGTH_WIDE_ANGLE1
CAMERA_FOCAL_LENGTH_ULTRA_WIDE2
CAMERA_STABILIZATION_MODE 5 members
Membervalue
CAMERA_STABILIZATION_MODE_OFF-1
CAMERA_STABILIZATION_MODE_AUTO0
CAMERA_STABILIZATION_MODE_LEVEL_11
CAMERA_STABILIZATION_MODE_LEVEL_22
CAMERA_STABILIZATION_MODE_LEVEL_33
CAPTURE_BRIGHTNESS_LEVEL_TYPE 4 members
Membervalue
CAPTURE_BRIGHTNESS_LEVEL_INVALID-1
CAPTURE_BRIGHTNESS_LEVEL_NORMAL0
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT1
CAPTURE_BRIGHTNESS_LEVEL_DARK2
CHANNEL_MEDIA_RELAY_ERROR 12 members
Membervalue
RELAY_OK0
RELAY_ERROR_SERVER_ERROR_RESPONSE1
RELAY_ERROR_SERVER_NO_RESPONSE2
RELAY_ERROR_NO_RESOURCE_AVAILABLE3
RELAY_ERROR_FAILED_JOIN_SRC4
RELAY_ERROR_FAILED_JOIN_DEST5
RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC6
RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST7
RELAY_ERROR_SERVER_CONNECTION_LOST8
RELAY_ERROR_INTERNAL_ERROR9
RELAY_ERROR_SRC_TOKEN_EXPIRED10
RELAY_ERROR_DEST_TOKEN_EXPIRED11
CHANNEL_MEDIA_RELAY_STATE 4 members
Membervalue
RELAY_STATE_IDLE0
RELAY_STATE_CONNECTING1
RELAY_STATE_RUNNING2
RELAY_STATE_FAILURE3
CHANNEL_PROFILE_TYPE 4 members
Membervalue
CHANNEL_PROFILE_COMMUNICATION0
CHANNEL_PROFILE_LIVE_BROADCASTING1
CHANNEL_PROFILE_GAME2
CHANNEL_PROFILE_CLOUD_GAMING3
CLIENT_ROLE_CHANGE_FAILED_REASON 4 members
Membervalue
CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS1
CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED2
CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT3
CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED4
CLIENT_ROLE_TYPE 2 members
Membervalue
CLIENT_ROLE_BROADCASTER1
CLIENT_ROLE_AUDIENCE2
CLOUD_PROXY_TYPE 3 members
Membervalue
NONE_PROXY0
UDP_PROXY1
TCP_PROXY2
CODEC_CAP_MASK 5 members
Membervalue
CODEC_CAP_MASK_NONE0
CODEC_CAP_MASK_HW_DECnull
CODEC_CAP_MASK_HW_ENCnull
CODEC_CAP_MASK_SW_DECnull
CODEC_CAP_MASK_SW_ENCnull
COMPRESSION_PREFERENCE 3 members
Membervalue
PREFER_COMPRESSION_AUTO-1
PREFER_LOW_LATENCY0
PREFER_QUALITY1
CONNECTION_CHANGED_REASON_TYPE 21 members
Membervalue
CONNECTION_CHANGED_CONNECTING0
CONNECTION_CHANGED_JOIN_SUCCESS1
CONNECTION_CHANGED_INTERRUPTED2
CONNECTION_CHANGED_BANNED_BY_SERVER3
CONNECTION_CHANGED_JOIN_FAILED4
CONNECTION_CHANGED_LEAVE_CHANNEL5
CONNECTION_CHANGED_INVALID_APP_ID6
CONNECTION_CHANGED_INVALID_CHANNEL_NAME7
CONNECTION_CHANGED_INVALID_TOKEN8
CONNECTION_CHANGED_TOKEN_EXPIRED9
CONNECTION_CHANGED_REJECTED_BY_SERVER10
CONNECTION_CHANGED_SETTING_PROXY_SERVER11
CONNECTION_CHANGED_RENEW_TOKEN12
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED13
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT14
CONNECTION_CHANGED_REJOIN_SUCCESS15
CONNECTION_CHANGED_LOST16
CONNECTION_CHANGED_ECHO_TEST17
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER18
CONNECTION_CHANGED_SAME_UID_LOGIN19
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS20
CONNECTION_STATE_TYPE 5 members
Membervalue
CONNECTION_STATE_DISCONNECTED1
CONNECTION_STATE_CONNECTING2
CONNECTION_STATE_CONNECTED3
CONNECTION_STATE_RECONNECTING4
CONNECTION_STATE_FAILED5
CONTENT_INSPECT_TYPE 2 members
Membervalue
CONTENT_INSPECT_INVALID0
CONTENT_INSPECT_SUPERVISION2
DEGRADATION_PREFERENCE 5 members
Membervalue
MAINTAIN_AUTO-1
MAINTAIN_QUALITY0
MAINTAIN_FRAMERATE1
MAINTAIN_BALANCED2
MAINTAIN_RESOLUTION3
DIRECT_CDN_STREAMING_REASON 6 members
Membervalue
DIRECT_CDN_STREAMING_REASON_OK0
DIRECT_CDN_STREAMING_REASON_FAILED1
DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION2
DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION3
DIRECT_CDN_STREAMING_REASON_NET_CONNECT4
DIRECT_CDN_STREAMING_REASON_BAD_NAME5
DIRECT_CDN_STREAMING_STATE 5 members
Membervalue
DIRECT_CDN_STREAMING_STATE_IDLE0
DIRECT_CDN_STREAMING_STATE_RUNNING1
DIRECT_CDN_STREAMING_STATE_STOPPED2
DIRECT_CDN_STREAMING_STATE_FAILED3
DIRECT_CDN_STREAMING_STATE_RECOVERING4
EAR_MONITORING_FILTER_TYPE 4 members
Membervalue
EAR_MONITORING_FILTER_NONEnull
EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERSnull
EAR_MONITORING_FILTER_NOISE_SUPPRESSIONnull
EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTERnull
ENCODING_PREFERENCE 3 members
Membervalue
PREFER_AUTO-1
PREFER_SOFTWARE0
PREFER_HARDWARE1
ENCRYPTION_ERROR_TYPE 5 members
Membervalue
ENCRYPTION_ERROR_INTERNAL_FAILURE0
ENCRYPTION_ERROR_DECRYPTION_FAILURE1
ENCRYPTION_ERROR_ENCRYPTION_FAILURE2
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE3
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE4
ENCRYPTION_MODE 9 members
Membervalue
AES_128_XTS1
AES_128_ECB2
AES_256_XTS3
SM4_128_ECB4
AES_128_GCM5
AES_256_GCM6
AES_128_GCM27
AES_256_GCM28
MODE_ENDnull
ERROR_CODE_TYPE 46 members
Membervalue
ERR_OK0
ERR_FAILED1
ERR_INVALID_ARGUMENT2
ERR_NOT_READY3
IRtcEnginenull
ERR_NOT_SUPPORTED4
ERR_REFUSED5
ERR_BUFFER_TOO_SMALL6
ERR_NOT_INITIALIZED7
ERR_INVALID_STATE8
ERR_NO_PERMISSION9
ERR_TIMEDOUT10
ERR_JOIN_CHANNEL_REJECTED17
ERR_LEAVE_CHANNEL_REJECTED18
ERR_ALREADY_IN_USE19
ERR_ABORTED20
ERR_INIT_NET_ENGINE21
ERR_RESOURCE_LIMITED22
ERR_INVALID_APP_ID101
ERR_INVALID_CHANNEL_NAME102
ERR_NO_SERVER_RESOURCES103
ERR_TOKEN_EXPIRED109
ERR_INVALID_TOKEN110
ERR_CONNECTION_INTERRUPTED111
ERR_CONNECTION_LOST112
ERR_NOT_IN_CHANNEL113
ERR_SIZE_TOO_LARGE114
ERR_BITRATE_LIMIT115
ERR_TOO_MANY_DATA_STREAMS116
ERR_STREAM_MESSAGE_TIMEOUT117
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED119
ERR_DECRYPTION_FAILED120
ERR_INVALID_USER_ID121
ERR_DATASTREAM_DECRYPTION_FAILED122
ERR_CLIENT_IS_BANNED_BY_SERVER123
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH130
ERR_INVALID_USER_ACCOUNT134
ERR_LOAD_MEDIA_ENGINE1001
ERR_ADM_GENERAL_ERROR1005
ERR_ADM_INIT_PLAYOUT1008
ERR_ADM_START_PLAYOUT1009
ERR_ADM_STOP_PLAYOUT1010
ERR_ADM_INIT_RECORDING1011
ERR_ADM_START_RECORDING1012
ERR_ADM_STOP_RECORDING1013
ERR_VDM_CAMERA_NOT_AUTHORIZED1501
EXPERIENCE_POOR_REASON 5 members
Membervalue
EXPERIENCE_REASON_NONE0
REMOTE_NETWORK_QUALITY_POOR1
LOCAL_NETWORK_QUALITY_POOR2
WIRELESS_SIGNAL_POOR4
WIFI_BLUETOOTH_COEXIST8
EXPERIENCE_QUALITY_TYPE 2 members
Membervalue
EXPERIENCE_QUALITY_GOOD0
EXPERIENCE_QUALITY_BAD1
EXTERNAL_VIDEO_SOURCE_TYPE 2 members
Membervalue
VIDEO_FRAME0
ENCODED_VIDEO_FRAME1
FACE_SHAPE_AREA 1 members
Membervalue
FACE_SHAPE_AREA_NONE-1
FACE_SHAPE_BEAUTY_STYLE 2 members
Membervalue
FACE_SHAPE_BEAUTY_STYLE_FEMALE0
FACE_SHAPE_BEAUTY_STYLE_MALE1
FeatureType 2 members
Membervalue
VIDEO_VIRTUAL_BACKGROUND1
VIDEO_BEAUTY_EFFECT2
FRAME_RATE 7 members
Membervalue
FRAME_RATE_FPS_11
FRAME_RATE_FPS_77
FRAME_RATE_FPS_1010
FRAME_RATE_FPS_1515
FRAME_RATE_FPS_2424
FRAME_RATE_FPS_3030
FRAME_RATE_FPS_6060
HEADPHONE_EQUALIZER_PRESET 3 members
Membervalue
HEADPHONE_EQUALIZER_OFFnull
HEADPHONE_EQUALIZER_OVEREARnull
HEADPHONE_EQUALIZER_INEARnull
LASTMILE_PROBE_RESULT_STATE 3 members
Membervalue
LASTMILE_PROBE_RESULT_COMPLETE1
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE2
LASTMILE_PROBE_RESULT_UNAVAILABLE3
LIGHTENING_CONTRAST_LEVEL 3 members
Membervalue
LIGHTENING_CONTRAST_LOW0
LIGHTENING_CONTRAST_NORMAL1
LIGHTENING_CONTRAST_HIGH2
LOCAL_AUDIO_STREAM_REASON 11 members
Membervalue
LOCAL_AUDIO_STREAM_REASON_OK0
LOCAL_AUDIO_STREAM_REASON_FAILURE1
LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION2
LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY3
LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE4
LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE5
LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE6
LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE7
LOCAL_AUDIO_STREAM_REASON_INTERRUPTEDnull
LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID9
LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID10
LOCAL_AUDIO_STREAM_STATE 4 members
Membervalue
LOCAL_AUDIO_STREAM_STATE_STOPPED0
LOCAL_AUDIO_STREAM_STATE_RECORDING1
LOCAL_AUDIO_STREAM_STATE_ENCODING2
LOCAL_AUDIO_STREAM_STATE_FAILED3
LOCAL_PROXY_MODE 2 members
Membervalue
kConnectivityFirst0
kLocalOnly1
LOCAL_VIDEO_STREAM_REASON 15 members
Membervalue
LOCAL_VIDEO_STREAM_REASON_OK0
LOCAL_VIDEO_STREAM_REASON_FAILURE1
LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION2
LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY3
LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE4
LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT5
LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND6
LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS7
LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND8
LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED9
LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID10
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED11
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED12
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED13
LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE101
LOCAL_VIDEO_STREAM_STATE 4 members
Membervalue
LOCAL_VIDEO_STREAM_STATE_STOPPED0
LOCAL_VIDEO_STREAM_STATE_CAPTURING1
LOCAL_VIDEO_STREAM_STATE_ENCODING2
LOCAL_VIDEO_STREAM_STATE_FAILED3
LOG_LEVEL 5 members
Membervalue
LOG_LEVEL_NONE0
LOG_LEVEL_INFO1
LOG_LEVEL_WARN2
LOG_LEVEL_ERROR4
LOG_LEVEL_FATAL8
LOW_LIGHT_ENHANCE_LEVEL 2 members
Membervalue
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY0
LOW_LIGHT_ENHANCE_LEVEL_FAST1
LOW_LIGHT_ENHANCE_MODE 2 members
Membervalue
LOW_LIGHT_ENHANCE_AUTO0
LOW_LIGHT_ENHANCE_MANUAL1
MAX_USER_ACCOUNT_LENGTH_TYPE 1 members
Membervalue
MAX_USER_ACCOUNT_LENGTHnull
MEDIA_DEVICE_STATE_TYPE 6 members
Membervalue
MEDIA_DEVICE_STATE_IDLE0
MEDIA_DEVICE_STATE_ACTIVE1
MEDIA_DEVICE_STATE_DISABLED2
MEDIA_DEVICE_STATE_PLUGGED_IN3
MEDIA_DEVICE_STATE_NOT_PRESENT4
MEDIA_DEVICE_STATE_UNPLUGGED8
MEDIA_DEVICE_TYPE 7 members
Membervalue
UNKNOWN_AUDIO_DEVICE-1
AUDIO_PLAYOUT_DEVICE0
AUDIO_RECORDING_DEVICE1
VIDEO_RENDER_DEVICE2
VIDEO_CAPTURE_DEVICE3
AUDIO_APPLICATION_PLAYOUT_DEVICE4
AUDIO_VIRTUAL_PLAYOUT_DEVICE5
MEDIA_PLAYER_EVENT 14 members
Membervalue
PLAYER_EVENT_SEEK_BEGIN0
PLAYER_EVENT_SEEK_COMPLETE1
PLAYER_EVENT_SEEK_ERROR2
PLAYER_EVENT_AUDIO_TRACK_CHANGED5
PLAYER_EVENT_BUFFER_LOW6
PLAYER_EVENT_BUFFER_RECOVER7
PLAYER_EVENT_FREEZE_START8
PLAYER_EVENT_FREEZE_STOP9
PLAYER_EVENT_SWITCH_BEGIN10
PLAYER_EVENT_SWITCH_COMPLETE11
PLAYER_EVENT_SWITCH_ERROR12
PLAYER_EVENT_FIRST_DISPLAYED13
PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT14
PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE15
MEDIA_PLAYER_METADATA_TYPE 2 members
Membervalue
PLAYER_METADATA_TYPE_UNKNOWN0
PLAYER_METADATA_TYPE_SEI1
MEDIA_PLAYER_REASON 16 members
Membervalue
PLAYER_REASON_NONE0
PLAYER_REASON_INVALID_ARGUMENTS-1
PLAYER_REASON_INTERNAL-2
PLAYER_REASON_NO_RESOURCE-3
PLAYER_REASON_INVALID_MEDIA_SOURCE-4
PLAYER_REASON_UNKNOWN_STREAM_TYPE-5
PLAYER_REASON_OBJ_NOT_INITIALIZED-6
PLAYER_REASON_CODEC_NOT_SUPPORTED-7
PLAYER_REASON_VIDEO_RENDER_FAILED-8
PLAYER_REASON_INVALID_STATE-9
PLAYER_REASON_URL_NOT_FOUND-10
PLAYER_REASON_INVALID_CONNECTION_STATE-11
PLAYER_REASON_SRC_BUFFER_UNDERFLOW-12
PLAYER_REASON_INTERRUPTED-13
PLAYER_REASON_NOT_SUPPORTED-14
PLAYER_REASON_TOKEN_EXPIRED-15
MEDIA_PLAYER_STATE 9 members
Membervalue
PLAYER_STATE_IDLE0
PLAYER_STATE_OPENING1
PLAYER_STATE_OPEN_COMPLETED2
PLAYER_STATE_PLAYING3
PLAYER_STATE_PAUSED4
PLAYER_STATE_PLAYBACK_COMPLETED5
PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED6
PLAYER_STATE_STOPPED7
PLAYER_STATE_FAILED100
MEDIA_SOURCE_TYPE 6 members
Membervalue
AUDIO_PLAYOUT_SOURCE0
AUDIO_RECORDING_SOURCE1
PRIMARY_CAMERA_SOURCE2
SECONDARY_CAMERA_SOURCE3
CUSTOM_VIDEO_SOURCE6
UNKNOWN_MEDIA_SOURCE100
MEDIA_STREAM_TYPE 4 members
Membervalue
STREAM_TYPE_UNKNOWN0
STREAM_TYPE_VIDEO1
STREAM_TYPE_AUDIO2
STREAM_TYPE_SUBTITLE3
MEDIA_TRACE_EVENT 2 members
Membervalue
MEDIA_TRACE_EVENT_VIDEO_RENDERED0
MEDIA_TRACE_EVENT_VIDEO_DECODED1
MediaRecorderContainerFormat 1 members
Membervalue
FORMAT_MP41
MediaRecorderStreamType 3 members
Membervalue
STREAM_TYPE_AUDIOnull
STREAM_TYPE_VIDEOnull
STREAM_TYPE_BOTHnull
METADATA_TYPE 2 members
Membervalue
UNKNOWN_METADATAnull
VIDEO_METADATAnull
MUSIC_CACHE_STATUS_TYPE 2 members
Membervalue
MUSIC_CACHE_STATUS_TYPE_CACHED0
MUSIC_CACHE_STATUS_TYPE_CACHING1
MusicContentCenterStateReason 8 members
Membervalue
kMusicContentCenterReasonOk0
kMusicContentCenterReasonError1
kMusicContentCenterReasonGateway2
kMusicContentCenterReasonPermissionAndResource3
kMusicContentCenterReasonInternalDataParse4
kMusicContentCenterReasonMusicLoading5
kMusicContentCenterReasonMusicDecryption6
kMusicContentCenterReasonHttpInternalError7
MusicPlayMode 3 members
Membervalue
kMusicPlayModeOriginal0
kMusicPlayModeAccompany1
kMusicPlayModeLeadSing2
NETWORK_TYPE 8 members
Membervalue
NETWORK_TYPE_UNKNOWN-1
NETWORK_TYPE_DISCONNECTED0
NETWORK_TYPE_LAN1
NETWORK_TYPE_WIFI2
NETWORK_TYPE_MOBILE_2G3
NETWORK_TYPE_MOBILE_3G4
NETWORK_TYPE_MOBILE_4G5
NETWORK_TYPE_MOBILE_5G6
OBSERVER_MODE 2 members
Membervalue
RAW_DATAnull
INTPTRnull
ORIENTATION_MODE 3 members
Membervalue
ORIENTATION_MODE_ADAPTIVE0
ORIENTATION_MODE_FIXED_LANDSCAPE1
ORIENTATION_MODE_FIXED_PORTRAIT2
PERMISSION_TYPE 3 members
Membervalue
RECORD_AUDIO0
CAMERA1
SCREEN_CAPTUREnull
PLAYER_PRELOAD_EVENT 3 members
Membervalue
PLAYER_PRELOAD_EVENT_BEGIN0
PLAYER_PRELOAD_EVENT_COMPLETE1
PLAYER_PRELOAD_EVENT_ERROR2
PreloadState 4 members
Membervalue
kPreloadStateCompleted0
kPreloadStateFailed1
kPreloadStatePreloading2
kPreloadStateRemoved3
PROXY_TYPE 5 members
Membervalue
NONE_PROXY_TYPE0
UDP_PROXY_TYPE1
TCP_PROXY_TYPE2
LOCAL_PROXY_TYPE3
TCP_PROXY_AUTO_FALLBACK_TYPE4
QUALITY_ADAPT_INDICATION 3 members
Membervalue
ADAPT_NONE0
ADAPT_UP_BANDWIDTH1
ADAPT_DOWN_BANDWIDTH2
QUALITY_TYPE 8 members
Membervalue
QUALITY_UNKNOWN0
QUALITY_EXCELLENT1
QUALITY_GOOD2
QUALITY_POOR3
QUALITY_BAD4
QUALITY_VBAD5
QUALITY_DOWN6
QUALITY_DETECTING8
RAW_AUDIO_FRAME_OP_MODE_TYPE 2 members
Membervalue
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY0
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE2
RecorderReasonCode 5 members
Membervalue
RECORDER_REASON_NONE0
RECORDER_ERROR_WRITE_FAILED1
RECORDER_ERROR_NO_STREAM2
RECORDER_ERROR_OVER_MAX_DURATION3
RECORDER_ERROR_CONFIG_CHANGED4
RecorderState 3 members
Membervalue
RECORDER_STATE_ERROR-1
RECORDER_STATE_START2
RECORDER_STATE_STOP3
RecorderStreamType 2 members
Membervalue
RTC0
PREVIEW1
REMOTE_AUDIO_STATE 5 members
Membervalue
REMOTE_AUDIO_STATE_STOPPED0
REMOTE_AUDIO_STATE_STARTING1
REMOTE_AUDIO_STATE_DECODING2
REMOTE_AUDIO_STATE_FROZEN3
REMOTE_AUDIO_STATE_FAILED4
REMOTE_AUDIO_STATE_REASON 8 members
Membervalue
REMOTE_AUDIO_REASON_INTERNAL0
REMOTE_AUDIO_REASON_NETWORK_CONGESTION1
REMOTE_AUDIO_REASON_NETWORK_RECOVERY2
REMOTE_AUDIO_REASON_LOCAL_MUTED3
REMOTE_AUDIO_REASON_LOCAL_UNMUTED4
REMOTE_AUDIO_REASON_REMOTE_MUTED5
REMOTE_AUDIO_REASON_REMOTE_UNMUTED6
REMOTE_AUDIO_REASON_REMOTE_OFFLINE7
REMOTE_VIDEO_STATE 5 members
Membervalue
REMOTE_VIDEO_STATE_STOPPED0
REMOTE_VIDEO_STATE_STARTING1
REMOTE_VIDEO_STATE_DECODING2
REMOTE_VIDEO_STATE_FROZEN3
REMOTE_VIDEO_STATE_FAILED4
REMOTE_VIDEO_STATE_REASON 11 members
Membervalue
REMOTE_VIDEO_STATE_REASON_INTERNAL0
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION1
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY2
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED3
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED4
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED5
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED6
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE7
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK8
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY9
REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT13
RENDER_MODE_TYPE 3 members
Membervalue
RENDER_MODE_HIDDEN1
RENDER_MODE_FIT2
RENDER_MODE_ADAPTIVE3
RHYTHM_PLAYER_REASON 5 members
Membervalue
RHYTHM_PLAYER_REASON_OK0
RHYTHM_PLAYER_REASON_FAILED1
RHYTHM_PLAYER_REASON_CAN_NOT_OPEN801
RHYTHM_PLAYER_REASON_CAN_NOT_PLAY802
RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT803
RHYTHM_PLAYER_STATE_TYPE 5 members
Membervalue
RHYTHM_PLAYER_STATE_IDLE810
RHYTHM_PLAYER_STATE_OPENING811
RHYTHM_PLAYER_STATE_DECODING812
RHYTHM_PLAYER_STATE_PLAYING813
RHYTHM_PLAYER_STATE_FAILED814
RTMP_STREAM_LIFE_CYCLE_TYPE 2 members
Membervalue
RTMP_STREAM_LIFE_CYCLE_BIND2CHANNELnull
RTMP_STREAM_LIFE_CYCLE_BIND2OWNERnull
RTMP_STREAM_PUBLISH_REASON 15 members
Membervalue
RTMP_STREAM_PUBLISH_REASON_OK0
RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT1
RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED2
RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT3
RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR4
RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR5
RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN6
RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT7
RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED8
RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND9
RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED10
RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER11
RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM13
RTMP_STREAM_PUBLISH_REASON_NET_DOWN14
RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE16
RTMP_STREAM_PUBLISH_STATE 6 members
Membervalue
RTMP_STREAM_PUBLISH_STATE_IDLE0
RTMP_STREAM_PUBLISH_STATE_CONNECTING1
RTMP_STREAM_PUBLISH_STATE_RUNNING2
RTMP_STREAM_PUBLISH_STATE_RECOVERING3
RTMP_STREAM_PUBLISH_STATE_FAILURE4
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING5
RTMP_STREAMING_EVENT 4 members
Membervalue
RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE1
RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE2
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT3
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN4
SCREEN_CAPTURE_FRAMERATE_CAPABILITY 3 members
Membervalue
SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS0
SCREEN_CAPTURE_FRAMERATE_CAPABILITY_30_FPS1
SCREEN_CAPTURE_FRAMERATE_CAPABILITY_60_FPS2
SCREEN_SCENARIO_TYPE 4 members
Membervalue
SCREEN_SCENARIO_DOCUMENT1
SCREEN_SCENARIO_GAMING2
SCREEN_SCENARIO_VIDEO3
SCREEN_SCENARIO_RDC4
ScreenCaptureSourceType 4 members
Membervalue
ScreenCaptureSourceType_Unknown-1
ScreenCaptureSourceType_Window0
ScreenCaptureSourceType_Screen1
ScreenCaptureSourceType_Custom2
SEG_MODEL_TYPE 2 members
Membervalue
SEG_MODEL_AI1
SEG_MODEL_GREEN2
SIMULCAST_STREAM_MODE 3 members
Membervalue
AUTO_SIMULCAST_STREAM-1
DISABLE_SIMULCAST_STREAM0
ENABLE_SIMULCAST_STREAM1
STREAM_FALLBACK_OPTIONS 3 members
Membervalue
STREAM_FALLBACK_OPTION_DISABLED0
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW1
STREAM_FALLBACK_OPTION_AUDIO_ONLY2
STREAM_PUBLISH_STATE 4 members
Membervalue
PUB_STATE_IDLE0
PUB_STATE_NO_PUBLISHED1
PUB_STATE_PUBLISHING2
PUB_STATE_PUBLISHED3
STREAM_SUBSCRIBE_STATE 4 members
Membervalue
SUB_STATE_IDLE0
SUB_STATE_NO_SUBSCRIBED1
SUB_STATE_SUBSCRIBING2
SUB_STATE_SUBSCRIBED3
USER_OFFLINE_REASON_TYPE 3 members
Membervalue
USER_OFFLINE_QUIT0
USER_OFFLINE_DROPPED1
USER_OFFLINE_BECOME_AUDIENCE2
VIDEO_APPLICATION_SCENARIO_TYPE 4 members
Membervalue
APPLICATION_SCENARIO_GENERAL0
APPLICATION_SCENARIO_MEETINGnull
APPLICATION_SCENARIO_1V1null
APPLICATION_SCENARIO_LIVESHOWnull
VIDEO_BUFFER_TYPE 3 members
Membervalue
VIDEO_BUFFER_RAW_DATA1
VIDEO_BUFFER_ARRAY2
VIDEO_BUFFER_TEXTURE3
VIDEO_CODEC_CAPABILITY_LEVEL 5 members
Membervalue
CODEC_CAPABILITY_LEVEL_UNSPECIFIED-1
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT5
CODEC_CAPABILITY_LEVEL_1080P30FPS10
CODEC_CAPABILITY_LEVEL_1080P60FPS20
CODEC_CAPABILITY_LEVEL_4K60FPS30
VIDEO_CODEC_PROFILE_TYPE 3 members
Membervalue
VIDEO_CODEC_PROFILE_BASELINE66
VIDEO_CODEC_PROFILE_MAIN77
VIDEO_CODEC_PROFILE_HIGH100
VIDEO_CODEC_TYPE 6 members
Membervalue
VIDEO_CODEC_NONE0
VIDEO_CODEC_VP81
VIDEO_CODEC_H2642
VIDEO_CODEC_H2653
VIDEO_CODEC_GENERIC6
VIDEO_CODEC_GENERIC_JPEG20
VIDEO_CODEC_TYPE_FOR_STREAM 2 members
Membervalue
VIDEO_CODEC_H264_FOR_STREAM1
VIDEO_CODEC_H265_FOR_STREAM2
VIDEO_CONTENT_HINT 3 members
Membervalue
CONTENT_HINT_NONEnull
CONTENT_HINT_MOTIONnull
CONTENT_HINT_DETAILSnull
VIDEO_DENOISER_LEVEL 2 members
Membervalue
VIDEO_DENOISER_LEVEL_HIGH_QUALITY0
VIDEO_DENOISER_LEVEL_FAST1
VIDEO_DENOISER_MODE 2 members
Membervalue
VIDEO_DENOISER_AUTO0
VIDEO_DENOISER_MANUAL1
VIDEO_FRAME_TYPE 6 members
Membervalue
VIDEO_FRAME_TYPE_BLANK_FRAME0
VIDEO_FRAME_TYPE_KEY_FRAME3
VIDEO_FRAME_TYPE_DELTA_FRAME4
VIDEO_FRAME_TYPE_B_FRAME5
VIDEO_FRAME_TYPE_DROPPABLE_FRAME6
VIDEO_FRAME_TYPE_UNKNOWnull
VIDEO_MIRROR_MODE_TYPE 3 members
Membervalue
VIDEO_MIRROR_MODE_AUTO0
VIDEO_MIRROR_MODE_ENABLED1
VIDEO_MIRROR_MODE_DISABLED2
VIDEO_MODULE_POSITION 4 members
Membervalue
POSITION_POST_CAPTURER1
POSITION_PRE_RENDERER2
POSITION_PRE_ENCODER4
POSITION_POST_CAPTURER_ORIGIN8
VIDEO_OBSERVER_FRAME_TYPE 4 members
Membervalue
FRAME_TYPE_DEFAULTnull
FRAME_TYPE_YUV420null
FRAME_TYPE_YUV422null
FRAME_TYPE_RGBAnull
VIDEO_ORIENTATION 4 members
Membervalue
VIDEO_ORIENTATION_00
VIDEO_ORIENTATION_9090
VIDEO_ORIENTATION_180180
VIDEO_ORIENTATION_270270
VIDEO_PIXEL_FORMAT 4 members
Membervalue
VIDEO_PIXEL_DEFAULT0
VIDEO_PIXEL_I4201
VIDEO_PIXEL_RGBA4
VIDEO_PIXEL_I42216
VIDEO_SOURCE_TYPE 18 members
Membervalue
VIDEO_SOURCE_CAMERA_PRIMARY0
VIDEO_SOURCE_CAMERA0
VIDEO_SOURCE_CAMERA_SECONDARY1
VIDEO_SOURCE_SCREEN_PRIMARY2
VIDEO_SOURCE_SCREEN2
VIDEO_SOURCE_SCREEN_SECONDARY3
VIDEO_SOURCE_CUSTOM4
VIDEO_SOURCE_MEDIA_PLAYER5
VIDEO_SOURCE_RTC_IMAGE_PNG6
VIDEO_SOURCE_RTC_IMAGE_JPEG7
VIDEO_SOURCE_RTC_IMAGE_GIF8
VIDEO_SOURCE_REMOTE9
VIDEO_SOURCE_TRANSCODED10
VIDEO_SOURCE_CAMERA_THIRD11
VIDEO_SOURCE_CAMERA_FOURTH12
VIDEO_SOURCE_SCREEN_THIRD13
VIDEO_SOURCE_SCREEN_FOURTH14
VIDEO_SOURCE_UNKNOWN100
VIDEO_STREAM_TYPE 2 members
Membervalue
VIDEO_STREAM_HIGH0
VIDEO_STREAM_LOW1
VIDEO_TRANSCODER_ERROR 6 members
Membervalue
VT_ERR_VIDEO_SOURCE_NOT_READY1
VT_ERR_INVALID_VIDEO_SOURCE_TYPE2
VT_ERR_INVALID_IMAGE_PATH3
VT_ERR_UNSUPPORT_IMAGE_FORMAT4
VT_ERR_INVALID_LAYOUT5
VT_ERR_INTERNAL20
VIDEO_VIEW_SETUP_MODE 3 members
Membervalue
VIDEO_VIEW_SETUP_REPLACE0
VIDEO_VIEW_SETUP_ADD1
VIDEO_VIEW_SETUP_REMOVE2
VOICE_AI_TUNER_TYPE 10 members
Membervalue
VOICE_AI_TUNER_MATURE_MALE0
VOICE_AI_TUNER_FRESH_MALE1
VOICE_AI_TUNER_ELEGANT_FEMALE2
VOICE_AI_TUNER_SWEET_FEMALE3
VOICE_AI_TUNER_WARM_MALE_SINGING4
VOICE_AI_TUNER_GENTLE_FEMALE_SINGING5
VOICE_AI_TUNER_HUSKY_MALE_SINGING6
VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING7
VOICE_AI_TUNER_POWERFUL_MALE_SINGING8
VOICE_AI_TUNER_DREAMY_FEMALE_SINGING9
VOICE_BEAUTIFIER_PRESET 14 members
Membervalue
VOICE_BEAUTIFIER_OFFnull
CHAT_BEAUTIFIER_MAGNETICnull
CHAT_BEAUTIFIER_FRESHnull
CHAT_BEAUTIFIER_VITALITYnull
SINGING_BEAUTIFIERnull
TIMBRE_TRANSFORMATION_VIGOROUSnull
TIMBRE_TRANSFORMATION_DEEPnull
TIMBRE_TRANSFORMATION_MELLOWnull
TIMBRE_TRANSFORMATION_FALSETTOnull
TIMBRE_TRANSFORMATION_FULLnull
TIMBRE_TRANSFORMATION_CLEARnull
TIMBRE_TRANSFORMATION_RESOUNDINGnull
TIMBRE_TRANSFORMATION_RINGINGnull
ULTRA_HIGH_QUALITY_VOICEnull
VOICE_CHANGER_PRESET 19 members
Membervalue
VOICE_CHANGER_OFFnull
VOICE_CHANGER_OLDMANnull
VOICE_CHANGER_BABYBOYnull
VOICE_CHANGER_BABYGIRLnull
VOICE_CHANGER_ZHUBAJIEnull
VOICE_CHANGER_ETHEREALnull
VOICE_CHANGER_HULKnull
VOICE_BEAUTY_VIGOROUSnull
VOICE_BEAUTY_DEEPnull
VOICE_BEAUTY_MELLOWnull
VOICE_BEAUTY_FALSETTOnull
VOICE_BEAUTY_FULLnull
VOICE_BEAUTY_CLEARnull
VOICE_BEAUTY_RESOUNDINGnull
VOICE_BEAUTY_RINGINGnull
VOICE_BEAUTY_SPACIALnull
GENERAL_BEAUTY_VOICE_MALEnull
GENERAL_BEAUTY_VOICE_FEMALE_FRESHnull
GENERAL_BEAUTY_VOICE_FEMALE_VITALITYnull
VOICE_CONVERSION_PRESET 5 members
Membervalue
VOICE_CONVERSION_OFFnull
VOICE_CHANGER_NEUTRALnull
VOICE_CHANGER_SWEETnull
VOICE_CHANGER_SOLIDnull
VOICE_CHANGER_BASSnull
WATERMARK_FIT_MODE 2 members
Membervalue
FIT_MODE_COVER_POSITIONnull
FIT_MODE_USE_IMAGE_RATIOnull

error-code constants

Constantvalue
ERR_ABORTED20
ERR_ADM_GENERAL_ERROR1005
ERR_ADM_INIT_PLAYOUT1008
ERR_ADM_INIT_RECORDING1011
ERR_ADM_START_PLAYOUT1009
ERR_ADM_START_RECORDING1012
ERR_ADM_STOP_PLAYOUT1010
ERR_ADM_STOP_RECORDING1013
ERR_ALREADY_IN_USE19
ERR_BITRATE_LIMIT115
ERR_BUFFER_TOO_SMALL6
ERR_CLIENT_IS_BANNED_BY_SERVER123
ERR_CONNECTION_INTERRUPTED111
ERR_CONNECTION_LOST112
ERR_DATASTREAM_DECRYPTION_FAILED122
ERR_DECRYPTION_FAILED120
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH130
ERR_FAILED1
ERR_INIT_NET_ENGINE21
ERR_INVALID_APP_ID101
ERR_INVALID_ARGUMENT2
ERR_INVALID_CHANNEL_NAME102
ERR_INVALID_STATE8
ERR_INVALID_TOKEN110
ERR_INVALID_USER_ACCOUNT134
ERR_INVALID_USER_ID121
ERR_JOIN_CHANNEL_REJECTED17
ERR_LEAVE_CHANNEL_REJECTED18
ERR_LOAD_MEDIA_ENGINE1001
ERR_NOT_INITIALIZED7
ERR_NOT_IN_CHANNEL113
ERR_NOT_READY3
ERR_NOT_SUPPORTED4
ERR_NO_PERMISSION9
ERR_NO_SERVER_RESOURCES103
ERR_OK0
ERR_REFUSED5
ERR_RESOURCE_LIMITED22
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED119
ERR_SIZE_TOO_LARGE114
ERR_STREAM_MESSAGE_TIMEOUT117
ERR_TIMEDOUT10
ERR_TOKEN_EXPIRED109
ERR_TOO_MANY_DATA_STREAMS116
ERR_VDM_CAMERA_NOT_AUTHORIZED1501
IRtcEnginenull

Known limitations

The following members are not available in the current version and return -4 (ERR_NOT_SUPPORTED). They remain in the interface definition so cross-platform code stays consistent.

InterfaceMember
FilterEffectOptionspath
IAudioPcmFrameSinkOnFrame
IAudioSpectrumObserverOnLocalAudioSpectrum
IAudioSpectrumObserverOnRemoteAudioSpectrum
IMediaRecorderSetMediaRecorderObserver
IMediaRecorderStartRecording
IMediaRecorderStopRecording
IRtcEngineCreateAgoraRtcEngine
IRtcEngineCreateMediaRecorder
IRtcEngineEnableContentInspect
IRtcEngineEnableEncryption
IRtcEngineEnableExtension
IRtcEngineGetCallId
IRtcEngineGetExtensionProperty
IRtcEngineLoadExtensionProvider
IRtcEnginePauseAllChannelMediaRelay
IRtcEngineRegisterExtension
IRtcEngineResumeAllChannelMediaRelay
IRtcEngineSetAdvancedAudioOptions
IRtcEngineSetDirectCdnStreamingAudioConfiguration
IRtcEngineSetDirectCdnStreamingVideoConfiguration
IRtcEngineSetExtensionProperty
IRtcEngineSetExtensionProviderProperty
IRtcEngineSetExternalAudioSink
IRtcEngineSetRemoteSubscribeFallbackOption
IRtcEngineSetRemoteUserSpatialAudioParams
IRtcEngineSetRemoteVideoSubscriptionOptions
IRtcEngineStartAudioRecording
IRtcEngineStartDirectCdnStreaming
IRtcEngineStartLocalVideoTranscoder
IRtcEngineStartOrUpdateChannelMediaRelay
IRtcEngineStartRtmpStreamWithTranscoding
IRtcEngineStartRtmpStreamWithoutTranscoding
IRtcEngineStopAudioRecording
IRtcEngineStopChannelMediaRelay
IRtcEngineStopDirectCdnStreaming
IRtcEngineStopLocalVideoTranscoder
IRtcEngineStopRtmpStream
IRtcEngineUnRegisterAudioFrameObserver
IRtcEngineUnregisterVideoEncodedFrameObserver
IRtcEngineUpdateChannelMediaOptions
IRtcEngineUpdateLocalTranscoderConfiguration
IRtcEngineUpdateRtmpTranscoding
IRtcEngineExEnableContentInspectEx
IRtcEngineExEnableEncryptionEx
IRtcEngineExGetCallIdEx
IRtcEngineExPauseAllChannelMediaRelayEx
IRtcEngineExResumeAllChannelMediaRelayEx
IRtcEngineExSetRemoteVideoSubscriptionOptionsEx
IRtcEngineExStartOrUpdateChannelMediaRelayEx
IRtcEngineExStartRtmpStreamWithTranscodingEx
IRtcEngineExStartRtmpStreamWithoutTranscodingEx
IRtcEngineExStopChannelMediaRelayEx
IRtcEngineExStopRtmpStreamEx
IRtcEngineExUpdateChannelMediaOptionsEx
IRtcEngineExUpdateRtmpTranscodingEx
IVideoEncodedFrameObserverOnEncodedVideoFrameReceived
IVideoFrameObserverOnCaptureVideoFrame
IVideoFrameObserverOnPreEncodeVideoFrame
IVideoFrameObserverOnRenderVideoFrame
__unattributed__AddVideoWatermark
__unattributed__CreateAgoraRtcEngineEx
__unattributed__CreateDataStream
__unattributed__CreateDataStreamEx
__unattributed__DestroyMediaRecorder
__unattributed__DestroyMusicPlayer
__unattributed__Dispose
__unattributed__EnableDualStreamMode
__unattributed__EnableLoopbackRecording
__unattributed__EnableLoopbackRecordingEx
__unattributed__GetAudioDeviceManager
__unattributed__GetCapability
__unattributed__GetFaceShapeAreaOptions
__unattributed__GetFaceShapeBeautyOptions
__unattributed__GetLoopbackDevice
__unattributed__GetNativeHandler
__unattributed__GetScreenCaptureSources
__unattributed__GetVideoDeviceManager
__unattributed__InitEventHandler
__unattributed__IsFeatureAvailableOnDevice
__unattributed__JoinChannel
__unattributed__JoinChannelWithUserAccount
__unattributed__LeaveChannel
__unattributed__LeaveChannelEx
__unattributed__MuteAllRemoteAudioStreams
__unattributed__MuteLocalAudioStream
__unattributed__MuteRemoteAudioStream
__unattributed__OnAudioDeviceStateChanged
__unattributed__OnAudioDeviceVolumeChanged
__unattributed__OnDirectCdnStreamingStateChanged
__unattributed__OnDirectCdnStreamingStats
__unattributed__OnEarMonitoringAudioFrame
__unattributed__OnFirstLocalVideoFrame
__unattributed__OnMixedAudioFrame
__unattributed__OnPlaybackAudioFrame
__unattributed__OnPlaybackAudioFrameBeforeMixing
__unattributed__OnReadData
__unattributed__OnRecordAudioFrame
__unattributed__OnSeek
__unattributed__OnVideoDeviceStateChanged
__unattributed__PullAudioFrame
__unattributed__PushAudioFrame
__unattributed__PushVideoFrame
__unattributed__QueryCameraFocalLengthCapability
__unattributed__QueryCodecCapability
__unattributed__RegisterAudioFrameObserver
__unattributed__RegisterVideoEncodedFrameObserver
__unattributed__RegisterVideoFrameObserver
__unattributed__SendMetadata
__unattributed__SetAudioProfile
__unattributed__SetCameraStabilizationMode
__unattributed__SetClientRole
__unattributed__SetDualStreamMode
__unattributed__SetExternalAudioSource
__unattributed__SetExternalMediaProjection
__unattributed__SetExternalRemoteEglContext
__unattributed__SetExternalVideoSource
__unattributed__SetFaceShapeAreaOptions
__unattributed__SetFaceShapeBeautyOptions
__unattributed__SetFilterEffectOptions
__unattributed__SetLocalAccessPoint
__unattributed__SetLocalRenderMode
__unattributed__SetLocalRenderTargetFps
__unattributed__SetLocalVideoDataSourcePosition
__unattributed__SetMaxMetadataSize
__unattributed__SetParameters
__unattributed__SetRemoteRenderModeEx
__unattributed__SetRemoteRenderTargetFps
__unattributed__SetRouteInCommunicationMode
__unattributed__SetupLocalVideo
__unattributed__SetupRemoteVideo
__unattributed__SetupRemoteVideoEx
__unattributed__StartAudioMixing
__unattributed__StartAudioRecording
__unattributed__StartLocalAudioMixer
__unattributed__StartPreview
__unattributed__StartScreenCapture
__unattributed__StartScreenCaptureByDisplayId
__unattributed__StartScreenCaptureByScreenRect
__unattributed__StartScreenCaptureByWindowId
__unattributed__StopLocalAudioMixer
__unattributed__StopPreview
__unattributed__StopScreenCapture
__unattributed__TakeSnapshot
__unattributed__TakeSnapshotEx
__unattributed__UnregisterVideoFrameObserver
__unattributed__UpdateLocalAudioMixerConfiguration

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.