macOS SDK API Reference

Complete macOS 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 macOS: classes, methods, overloads, properties, events and error codes. The interface definition matches the SDK package version.

Checklist item	Count
Interface / class	121
Method	612
Method overloads	612
Property	539
Enums	144
error-code constants	70

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”.

Step	Interface	Method	Overload count
enable video and preview	`AgoraRtcEngineKit`	`enableVideo`	1
Join a channel	`AgoraRtcEngineKit`	`joinChannelByToken:channelId:info:uid:joinSuccess:`	1
Leave a channel	`AgoraRtcEngineKit`	`leaveChannel:`	1
Create / initialize	`AgoraRtcEngineKit`	`sharedEngineWithAppId:delegate:`	1

parameters for the minimal runnable flow

Parameters	Type	Optional	Variadic parameters
`token`	`NSString*`	is	No
`channelId`	`NSString*`	No	No
`info`	`NSString*`	is	No
`uid`	`NSUInteger`	No	No
`joinSuccessBlock`	`void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)`	is	No
`leaveChannelBlock`	`void(^ )(AgoraChannelStats*stat)`	is	No
`appId`	`NSString*`	No	No
`delegate`	`id`	is	No

Endpoint index

Interface	Method	Property
`__unattributed__`	56	0
`AdvancedConfigInfo`	0	1
`AgoraAdvancedAudioOptions`	0	1
`AgoraAdvancedVideoOptions`	0	3
`AgoraAudioEncodedFrameDelegate`	3	0
`AgoraAudioEncodedFrameDelegateConfig`	0	2
`AgoraAudioFrame`	0	8
`AgoraAudioFrameDelegate`	10	0
`AgoraAudioParams`	0	4
`AgoraAudioRecordingConfiguration`	0	5
`AgoraAudioSpectrumDelegate`	2	0
`AgoraAudioSpectrumInfo`	0	2
`AgoraAudioTrackConfig`	0	2
`AgoraBeautyOptions`	0	5
`AgoraCameraCapturerConfiguration`	0	6
`AgoraChannelMediaRelayConfiguration`	2	2
`AgoraChannelMediaRelayInfo`	0	3
`AgoraChannelStats`	0	28
`AgoraClientRoleOptions`	0	1
`AgoraColorEnhanceOptions`	0	2
`AgoraContentInspectConfig`	0	3
`AgoraContentInspectModule`	0	3
`AgoraDataStreamConfig`	0	2
`AgoraEchoTestConfiguration`	0	6
`AgoraEncodedAudioFrameInfo`	0	4
`AgoraEncodedVideoFrameDelegate`	1	0
`AgoraEncodedVideoFrameInfo`	0	10
`AgoraEncryptionConfig`	0	4
`AgoraExtensionContext`	0	4
`AgoraFaceShapeAreaOptions`	0	2
`AgoraFaceShapeBeautyOptions`	0	2
`AgoraFilterEffectOptions`	0	2
`AgoraImage`	0	4
`AgoraImageTrackOptions`	0	3
`AgoraLastmileProbeConfig`	0	4
`AgoraLastmileProbeOneWayResult`	0	3
`AgoraLastmileProbeResult`	0	4
`AgoraLeaveChannelOptions`	0	3
`AgoraLiveStreamAdvancedFeature`	0	2
`AgoraLiveTranscoding`	5	16
`AgoraLiveTranscodingUser`	0	5
`AgoraLocalAccessPointConfiguration`	0	6
`AgoraLocalAudioMixerConfiguration`	0	2
`AgoraLocalSpatialAudioConfig`	0	1
`AgoraLocalSpatialAudioKit`	5	0
`AgoraLocalTranscoderConfiguration`	0	3
`AgoraLogConfig`	0	3
`AgoraLowlightEnhanceOptions`	0	2
`AgoraMediaMetadataDataSource`	2	0
`AgoraMediaMetadataDelegate`	1	0
`AgoraMediaPlayerCacheStatistics`	0	3
`AgoraMediaPlayerPlaybackStats`	0	4
`AgoraMediaPlayerSrcInfo`	0	2
`AgoraMediaPlayerUpdatedInfo`	0	6
`AgoraMediaRecorder`	4	0
`AgoraMediaRecorderConfiguration`	0	11
`AgoraMediaRecorderDelegate`	2	0
`AgoraMediaRecorderInfo`	0	3
`AgoraMediaSource`	0	10
`AgoraMetadata`	0	4
`AgoraMixedAudioStream`	0	4
`AgoraMultipathStats`	0	8
`AgoraOutputVideoFrame`	0	17
`AgoraPathStats`	0	3
`AgoraRecorderStreamInfo`	0	3
`AgoraRemoteVoicePositionInfo`	0	2
`AgoraRhythmPlayerConfig`	0	2
`AgoraRtcAudioVolumeInfo`	0	4
`AgoraRtcChannelMediaOptions`	0	38
`AgoraRtcConnection`	0	2
`AgoraRtcDeviceInfo`	0	4
`AgoraRtcEngineConfig`	0	10
`AgoraRtcEngineDelegate`	77	0
`AgoraRtcEngineKit`	289	0
`AgoraRtcLocalAudioStats`	0	9
`AgoraRtcLocalVideoStats`	0	23
`AgoraRtcMediaPlayerAudioFrameDelegate`	1	0
`AgoraRtcMediaPlayerCacheManagerProtocol`	13	0
`AgoraRtcMediaPlayerDelegate`	11	0
`AgoraRtcMediaPlayerProtocol`	36	0
`AgoraRtcMediaPlayerVideoFrameDelegate`	3	0
`AgoraRtcMediaStreamInfo`	0	12
`AgoraRtcRemoteAudioStats`	0	19
`AgoraRtcRemoteVideoStats`	0	18
`AgoraRtcVideoCanvas`	0	12
`AgoraRte`	6	0
`AgoraRteCanvas`	5	0
`AgoraRteCanvasConfig`	4	0
`AgoraRteConfig`	4	0
`AgoraRteError`	2	0
`AgoraRtePlayer`	18	0
`AgoraRtePlayerConfig`	12	0
`AgoraRtePlayerObserver`	7	0
`AgoraRtePlayerStats`	0	0
`AgoraScreenCaptureConfiguration`	0	5
`AgoraScreenCaptureParameters`	0	9
`AgoraScreenCaptureSourceInfo`	0	9
`AgoraSegmentationProperty`	0	3
`AgoraSimulcastStreamConfig`	0	0
`AgoraSnapshotConfig`	0	2
`AgoraSpatialAudioKitBase`	11	0
`AgoraSpatialAudioParams`	0	8
`AgoraSpatialAudioZone`	0	9
`AgoraTranscodingVideoStream`	0	8
`AgoraUplinkNetworkInfo`	0	1
`AgoraUserInfo`	0	2
`AgoraVideoCodecCapInfo`	0	3
`AgoraVideoCodecCapLevels`	0	2
`AgoraVideoDenoiserOptions`	0	2
`AgoraVideoEffectObject`	10	1
`AgoraVideoEncoderConfiguration`	2	9
`AgoraVideoFrame`	0	16
`AgoraVideoFrameDelegate`	8	0
`AgoraVideoLayout`	0	8
`AgoraVideoRenderingTracingInfo`	0	7
`AgoraVideoSubscriptionOptions`	0	2
`AgoraVirtualBackgroundSource`	0	4
`LogUploadServerInfo`	0	4
`WatermarkBuffer`	0	5
`WatermarkConfig`	0	5
`WatermarkOptions`	0	4

all endpoints

__unattributed__ 56 method / 0 Property

typescript

addVideoWatermarkEx:connection:(configs: WatermarkConfig*, connection: AgoraRtcConnection*): int
addVideoWatermarkEx:options:connection:(url: NSURL*, options: WatermarkOptions*, connection: AgoraRtcConnection*): int
adjustUserPlaybackSignalVolumeEx:volume:connection:(uid: NSUInteger, volume: NSInteger, connection: AgoraRtcConnection*): int
clearVideoWatermarkEx:(connection: AgoraRtcConnection*): int
createDataStreamEx:config:connection:(streamId: NSInteger*, config: AgoraDataStreamConfig*, connection: AgoraRtcConnection*): int
createDataStreamEx:reliable:ordered:connection:(streamId: NSInteger*, reliable: BOOL, ordered: BOOL, connection: AgoraRtcConnection*): int
enableAudioVolumeIndicationEx:smooth:reportVad:connection:(interval: NSInteger, smooth: NSInteger, reportVad: BOOL, connection: AgoraRtcConnection*): int
enableContentInspectEx:config:connection:(enabled: BOOL, config: AgoraContentInspectConfig*, connection: AgoraRtcConnection*): int
enableDualStreamModeEx:streamConfig:connection:(enabled: BOOL, streamConfig: AgoraSimulcastStreamConfig*, connection: AgoraRtcConnection*): int
enableEncryptionEx:encryptionConfig:connection:(enabled: BOOL, config: AgoraEncryptionConfig*, connection: AgoraRtcConnection*): int
enableLoopbackRecordingEx:deviceName:connection:(enabled: BOOL, deviceName?: NSString*, connection: AgoraRtcConnection*): int
getCallIdEx:(connection: AgoraRtcConnection*): NSString*
getConnectionStateEx:(connection: AgoraRtcConnection*): AgoraConnectionState
getUserInfoByUidEx:connection:withError:(uid: NSUInteger, connection: AgoraRtcConnection*, error?: AgoraErrorCode*): AgoraUserInfo*
getUserInfoByUserAccountEx:connection:withError:(userAccount: NSString*, connection: AgoraRtcConnection*, error?: AgoraErrorCode*): AgoraUserInfo*
joinChannelExByToken:channelId:userAccount:delegate:mediaOptions:joinSuccess:(token?: NSString*, channelId: NSString*, userAccount: NSString*, delegate?: id, mediaOptions: AgoraRtcChannelMediaOptions*, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:(token?: NSString*, connection: AgoraRtcConnection*, delegate?: id, mediaOptions: AgoraRtcChannelMediaOptions*, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
leaveChannelEx:leaveChannelBlock:(connection: AgoraRtcConnection*, leaveChannelBlock?: void(^ )(AgoraChannelStats*stat)): int
leaveChannelEx:options:leaveChannelBlock:(connection: AgoraRtcConnection*, options: AgoraLeaveChannelOptions*, leaveChannelBlock?: void(^ )(AgoraChannelStats*stat)): int
muteAllRemoteAudioStreamsEx:connection:(mute: BOOL, connection: AgoraRtcConnection*): int
muteAllRemoteVideoStreamsEx:connection:(mute: BOOL, connection: AgoraRtcConnection*): int
muteLocalAudioStreamEx:connection:(mute: BOOL, connection: AgoraRtcConnection*): int
muteLocalVideoStreamEx:connection:(mute: BOOL, connection: AgoraRtcConnection*): int
muteRemoteAudioStreamEx:mute:connection:(uid: NSUInteger, mute: BOOL, connection: AgoraRtcConnection*): int
muteRemoteVideoStreamEx:mute:connection:(uid: NSUInteger, mute: BOOL, connection: AgoraRtcConnection*): int
pauseAllChannelMediaRelayEx:(connection: AgoraRtcConnection*): int
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:(connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger): int
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:(connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL): int
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:startPos:(connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL, startPos: int): int
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:startPos:(connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, startPos: int): int
preloadEffectEx:soundId:filePath:(connection: AgoraRtcConnection*, soundId: int, filePath: NSString*): int
preloadEffectEx:soundId:filePath:startPos:(connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, startPos: int): int
removeVideoWatermarkEx:connection:(id: NSString*, connection: AgoraRtcConnection*): int
resumeAllChannelMediaRelayEx:(connection: AgoraRtcConnection*): int
sendCustomReportMessageEx:category:event:label:value:connection:(messageId?: NSString*, category?: NSString*, event?: NSString*, label?: NSString*, value: NSInteger, connection: AgoraRtcConnection*): int
setDualStreamModeEx:streamConfig:connection:(mode: AgoraSimulcastStreamMode, streamConfig: AgoraSimulcastStreamConfig*, connection: AgoraRtcConnection*): int
setRemoteRenderModeEx:mode:mirror:connection:(uid: NSUInteger, mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorMode, connection: AgoraRtcConnection*): int
setRemoteVideoStreamEx:type:connection:(uid: NSUInteger, streamType: AgoraVideoStreamType, connection: AgoraRtcConnection*): int
setRemoteVideoSubscriptionOptionsEx:options:connection:(uid: NSUInteger, options: AgoraVideoSubscriptionOptions*, connection: AgoraRtcConnection*): int
setRemoteVoicePositionEx:pan:gain:connection:(uid: NSUInteger, pan: double, gain: double, connection: AgoraRtcConnection*): int
setSubscribeAudioAllowlistEx:connection:(allowlist: NSArray*, connection: AgoraRtcConnection*): int
setSubscribeAudioBlocklistEx:connection:(blocklist: NSArray*, connection: AgoraRtcConnection*): int
setSubscribeVideoAllowlistEx:connection:(allowlist: NSArray*, connection: AgoraRtcConnection*): int
setSubscribeVideoBlocklistEx:connection:(blocklist: NSArray*, connection: AgoraRtcConnection*): int
setVideoEncoderConfigurationEx:connection:(config: AgoraVideoEncoderConfiguration*, connection: AgoraRtcConnection*): int
setupRemoteVideoEx:connection:(remote: AgoraRtcVideoCanvas*, connection: AgoraRtcConnection*): int
startMediaRenderingTracingEx:(connection: AgoraRtcConnection*): int
startOrUpdateChannelMediaRelayEx:connection:(config: AgoraChannelMediaRelayConfiguration*, connection: AgoraRtcConnection*): int
startRtmpStreamWithTranscodingEx:transcoding:connection:(url: NSString*, transcoding?: AgoraLiveTranscoding*, connection: AgoraRtcConnection*): int
startRtmpStreamWithoutTranscodingEx:connection:(url: NSString*, connection: AgoraRtcConnection*): int
stopChannelMediaRelayEx:(connection: AgoraRtcConnection*): int
stopRtmpStreamEx:connection:(url: NSString*, connection: AgoraRtcConnection*): int
takeSnapshotEx:uid:filePath:(connection: AgoraRtcConnection*, uid: NSInteger, filePath: NSString*): NSInteger
takeSnapshotExWithConfig:uid:config:(connection: AgoraRtcConnection*, uid: NSInteger, config: AgoraSnapshotConfig*): NSInteger
updateChannelExWithMediaOptions:connection:(mediaOptions: AgoraRtcChannelMediaOptions*, connection: AgoraRtcConnection*): int
updateRtmpTranscodingEx:connection:(transcoding?: AgoraLiveTranscoding*, connection: AgoraRtcConnection*): int

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

Method	Parameters	Returns	Errors
`addVideoWatermarkEx:connection:`	`configs: WatermarkConfig, connection: AgoraRtcConnection`	`int`	Error code index
`addVideoWatermarkEx:options:connection:`	`url: NSURL, options: WatermarkOptions, connection: AgoraRtcConnection*`	`int`	Error code index
`adjustUserPlaybackSignalVolumeEx:volume:connection:`	`uid: NSUInteger, volume: NSInteger, connection: AgoraRtcConnection*`	`int`	Error code index
`clearVideoWatermarkEx:`	`connection: AgoraRtcConnection*`	`int`	Error code index
`createDataStreamEx:config:connection:`	`streamId: NSInteger, config: AgoraDataStreamConfig, connection: AgoraRtcConnection*`	`int`	Error code index
`createDataStreamEx:reliable:ordered:connection:`	`streamId: NSInteger, reliable: BOOL, ordered: BOOL, connection: AgoraRtcConnection`	`int`	Error code index
`enableAudioVolumeIndicationEx:smooth:reportVad:connection:`	`interval: NSInteger, smooth: NSInteger, reportVad: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`enableContentInspectEx:config:connection:`	`enabled: BOOL, config: AgoraContentInspectConfig, connection: AgoraRtcConnection`	`int`	Error code index
`enableDualStreamModeEx:streamConfig:connection:`	`enabled: BOOL, streamConfig: AgoraSimulcastStreamConfig, connection: AgoraRtcConnection`	`int`	Error code index
`enableEncryptionEx:encryptionConfig:connection:`	`enabled: BOOL, config: AgoraEncryptionConfig, connection: AgoraRtcConnection`	`int`	Error code index
`enableLoopbackRecordingEx:deviceName:connection:`	`enabled: BOOL, deviceName?: NSString, connection: AgoraRtcConnection`	`int`	Error code index
`getCallIdEx:`	`connection: AgoraRtcConnection*`	`NSString*`	Error code index
`getConnectionStateEx:`	`connection: AgoraRtcConnection*`	`AgoraConnectionState`	Error code index
`getUserInfoByUidEx:connection:withError:`	`uid: NSUInteger, connection: AgoraRtcConnection, error?: AgoraErrorCode`	`AgoraUserInfo*`	Error code index
`getUserInfoByUserAccountEx:connection:withError:`	`userAccount: NSString, connection: AgoraRtcConnection, error?: AgoraErrorCode*`	`AgoraUserInfo*`	Error code index
`joinChannelExByToken:channelId:userAccount:delegate:mediaOptions:joinSuccess:`	`token?: NSString, channelId: NSString, userAccount: NSString, delegate?: id, mediaOptions: AgoraRtcChannelMediaOptions, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)`	`int`	Error code index
`joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:`	`token?: NSString, connection: AgoraRtcConnection, delegate?: id, mediaOptions: AgoraRtcChannelMediaOptions, joinSuccessBlock?: void(^ )(NSStringchannel,NSUInteger uid,NSInteger elapsed)`	`int`	Error code index
`leaveChannelEx:leaveChannelBlock:`	`connection: AgoraRtcConnection, leaveChannelBlock?: void(^ )(AgoraChannelStatsstat)`	`int`	Error code index
`leaveChannelEx:options:leaveChannelBlock:`	`connection: AgoraRtcConnection, options: AgoraLeaveChannelOptions, leaveChannelBlock?: void(^ )(AgoraChannelStats*stat)`	`int`	Error code index
`muteAllRemoteAudioStreamsEx:connection:`	`mute: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`muteAllRemoteVideoStreamsEx:connection:`	`mute: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`muteLocalAudioStreamEx:connection:`	`mute: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`muteLocalVideoStreamEx:connection:`	`mute: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`muteRemoteAudioStreamEx:mute:connection:`	`uid: NSUInteger, mute: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`muteRemoteVideoStreamEx:mute:connection:`	`uid: NSUInteger, mute: BOOL, connection: AgoraRtcConnection*`	`int`	Error code index
`pauseAllChannelMediaRelayEx:`	`connection: AgoraRtcConnection*`	`int`	Error code index
`playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:`	`connection: AgoraRtcConnection, soundId: int, filePath: NSString, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger`	`int`	Error code index
`playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:`	`connection: AgoraRtcConnection, soundId: int, filePath: NSString, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL`	`int`	Error code index
`playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:startPos:`	`connection: AgoraRtcConnection, soundId: int, filePath: NSString, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL, startPos: int`	`int`	Error code index
`playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:startPos:`	`connection: AgoraRtcConnection, soundId: int, filePath: NSString, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, startPos: int`	`int`	Error code index
`preloadEffectEx:soundId:filePath:`	`connection: AgoraRtcConnection, soundId: int, filePath: NSString`	`int`	Error code index
`preloadEffectEx:soundId:filePath:startPos:`	`connection: AgoraRtcConnection, soundId: int, filePath: NSString, startPos: int`	`int`	Error code index
`removeVideoWatermarkEx:connection:`	`id: NSString, connection: AgoraRtcConnection`	`int`	Error code index
`resumeAllChannelMediaRelayEx:`	`connection: AgoraRtcConnection*`	`int`	Error code index
`sendCustomReportMessageEx:category:event:label:value:connection:`	`messageId?: NSString, category?: NSString, event?: NSString, label?: NSString, value: NSInteger, connection: AgoraRtcConnection*`	`int`	Error code index
`setDualStreamModeEx:streamConfig:connection:`	`mode: AgoraSimulcastStreamMode, streamConfig: AgoraSimulcastStreamConfig, connection: AgoraRtcConnection`	`int`	Error code index
`setRemoteRenderModeEx:mode:mirror:connection:`	`uid: NSUInteger, mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorMode, connection: AgoraRtcConnection*`	`int`	Error code index
`setRemoteVideoStreamEx:type:connection:`	`uid: NSUInteger, streamType: AgoraVideoStreamType, connection: AgoraRtcConnection*`	`int`	Error code index
`setRemoteVideoSubscriptionOptionsEx:options:connection:`	`uid: NSUInteger, options: AgoraVideoSubscriptionOptions, connection: AgoraRtcConnection`	`int`	Error code index
`setRemoteVoicePositionEx:pan:gain:connection:`	`uid: NSUInteger, pan: double, gain: double, connection: AgoraRtcConnection*`	`int`	Error code index
`setSubscribeAudioAllowlistEx:connection:`	`allowlist: NSArray, connection: AgoraRtcConnection`	`int`	Error code index
`setSubscribeAudioBlocklistEx:connection:`	`blocklist: NSArray, connection: AgoraRtcConnection`	`int`	Error code index
`setSubscribeVideoAllowlistEx:connection:`	`allowlist: NSArray, connection: AgoraRtcConnection`	`int`	Error code index
`setSubscribeVideoBlocklistEx:connection:`	`blocklist: NSArray, connection: AgoraRtcConnection`	`int`	Error code index
`setVideoEncoderConfigurationEx:connection:`	`config: AgoraVideoEncoderConfiguration, connection: AgoraRtcConnection`	`int`	Error code index
`setupRemoteVideoEx:connection:`	`remote: AgoraRtcVideoCanvas, connection: AgoraRtcConnection`	`int`	Error code index
`startMediaRenderingTracingEx:`	`connection: AgoraRtcConnection*`	`int`	Error code index
`startOrUpdateChannelMediaRelayEx:connection:`	`config: AgoraChannelMediaRelayConfiguration, connection: AgoraRtcConnection`	`int`	Error code index
`startRtmpStreamWithTranscodingEx:transcoding:connection:`	`url: NSString, transcoding?: AgoraLiveTranscoding, connection: AgoraRtcConnection*`	`int`	Error code index
`startRtmpStreamWithoutTranscodingEx:connection:`	`url: NSString, connection: AgoraRtcConnection`	`int`	Error code index
`stopChannelMediaRelayEx:`	`connection: AgoraRtcConnection*`	`int`	Error code index
`stopRtmpStreamEx:connection:`	`url: NSString, connection: AgoraRtcConnection`	`int`	Error code index
`takeSnapshotEx:uid:filePath:`	`connection: AgoraRtcConnection, uid: NSInteger, filePath: NSString`	`NSInteger`	Error code index
`takeSnapshotExWithConfig:uid:config:`	`connection: AgoraRtcConnection, uid: NSInteger, config: AgoraSnapshotConfig`	`NSInteger`	Error code index
`updateChannelExWithMediaOptions:connection:`	`mediaOptions: AgoraRtcChannelMediaOptions, connection: AgoraRtcConnection`	`int`	Error code index
`updateRtmpTranscodingEx:connection:`	`transcoding?: AgoraLiveTranscoding, connection: AgoraRtcConnection`	`int`	Error code index

AdvancedConfigInfo 0 method / 1 Property

Property	Type	read-only
`logUploadServer`	`LogUploadServerInfo*`	No

AgoraAdvancedAudioOptions 0 method / 1 Property

Property	Type	read-only
`audioProcessingChannels`	`AgoraAudioProcessChannels`	No

AgoraAdvancedVideoOptions 0 method / 3 Property

Property	Type	read-only
`encodingPreference`	`AgoraEncodingPreference`	No
`compressionPreference`	`AgoraCompressionPreference`	No
`encodeAlpha`	`BOOL`	No

AgoraAudioEncodedFrameDelegate 3 method / 0 Property

typescript

onMixedEncodedAudioFrame:info:(frameData: NSData*, info: AgoraEncodedAudioFrameInfo*): void
onPlaybackEncodedAudioFrame:info:(frameData: NSData*, info: AgoraEncodedAudioFrameInfo*): void
onRecordEncodedAudioFrame:info:(frameData: NSData*, info: AgoraEncodedAudioFrameInfo*): void

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

Method	Parameters	Returns	Errors
`onMixedEncodedAudioFrame:info:`	`frameData: NSData, info: AgoraEncodedAudioFrameInfo`	`void`	Error code index
`onPlaybackEncodedAudioFrame:info:`	`frameData: NSData, info: AgoraEncodedAudioFrameInfo`	`void`	Error code index
`onRecordEncodedAudioFrame:info:`	`frameData: NSData, info: AgoraEncodedAudioFrameInfo`	`void`	Error code index

AgoraAudioEncodedFrameDelegateConfig 0 method / 2 Property

Property	Type	read-only
`postionType`	`AgoraAudioEncodedFrameDelegatePosition`	No
`encodingType`	`AgoraAudioEncodingType`	No

AgoraAudioFrame 0 method / 8 Property

Property	Type	read-only
`samplesPerChannel`	`NSInteger`	No
`bytesPerSample`	`NSInteger`	No
`channels`	`NSInteger`	No
`samplesPerSec`	`NSInteger`	No
`buffer`	`void*`	No
`renderTimeMs`	`int64_t`	No
`avSyncType`	`NSInteger`	No
`rtpTimestamp`	`uint32_t`	No

AgoraAudioFrameDelegate 10 method / 0 Property

typescript

getEarMonitoringAudioParams(): AgoraAudioParams*
getMixedAudioParams(): AgoraAudioParams*
getObservedAudioFramePosition(): AgoraAudioFramePosition
getPlaybackAudioParams(): AgoraAudioParams*
getRecordAudioParams(): AgoraAudioParams*
onEarMonitoringAudioFrame:(frame: AgoraAudioFrame*): BOOL
onMixedAudioFrame:channelId:(frame: AgoraAudioFrame*, channelId: NSString*): BOOL
onPlaybackAudioFrame:channelId:(frame: AgoraAudioFrame*, channelId: NSString*): BOOL
onPlaybackAudioFrameBeforeMixing:channelId:uid:(frame: AgoraAudioFrame*, channelId: NSString*, uid: NSUInteger): BOOL
onRecordAudioFrame:channelId:(frame: AgoraAudioFrame*, channelId: NSString*): BOOL

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

Method	Parameters	Returns	Errors
`getEarMonitoringAudioParams`	—	`AgoraAudioParams*`	Error code index
`getMixedAudioParams`	—	`AgoraAudioParams*`	Error code index
`getObservedAudioFramePosition`	—	`AgoraAudioFramePosition`	Error code index
`getPlaybackAudioParams`	—	`AgoraAudioParams*`	Error code index
`getRecordAudioParams`	—	`AgoraAudioParams*`	Error code index
`onEarMonitoringAudioFrame:`	`frame: AgoraAudioFrame*`	`BOOL`	Error code index
`onMixedAudioFrame:channelId:`	`frame: AgoraAudioFrame, channelId: NSString`	`BOOL`	Error code index
`onPlaybackAudioFrame:channelId:`	`frame: AgoraAudioFrame, channelId: NSString`	`BOOL`	Error code index
`onPlaybackAudioFrameBeforeMixing:channelId:uid:`	`frame: AgoraAudioFrame, channelId: NSString, uid: NSUInteger`	`BOOL`	Error code index
`onRecordAudioFrame:channelId:`	`frame: AgoraAudioFrame, channelId: NSString`	`BOOL`	Error code index

AgoraAudioParams 0 method / 4 Property

Property	Type	read-only
`sampleRate`	`NSInteger`	No
`channel`	`NSInteger`	No
`mode`	`AgoraAudioRawFrameOperationMode`	No
`samplesPerCall`	`NSInteger`	No

AgoraAudioRecordingConfiguration 0 method / 5 Property

Property	Type	read-only
`filePath`	`NSString*`	No
`sampleRate`	`NSUInteger`	No
`fileRecordOption`	`AgoraAudioFileRecordingType`	No
`quality`	`AgoraAudioRecordingQuality`	No
`recordingChannel`	`NSInteger`	No

AgoraAudioSpectrumDelegate 2 method / 0 Property

typescript

onLocalAudioSpectrum:(audioSpectrumData?: NSArray*): BOOL
onRemoteAudioSpectrum:(AudioSpectrumInfo?: NSArray*): BOOL

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

Method	Parameters	Returns	Errors
`onLocalAudioSpectrum:`	`audioSpectrumData?: NSArray*`	`BOOL`	Error code index
`onRemoteAudioSpectrum:`	`AudioSpectrumInfo?: NSArray*`	`BOOL`	Error code index

AgoraAudioSpectrumInfo 0 method / 2 Property

Property	Type	read-only
`uid`	`NSInteger`	No
`audioSpectrumData`	`NSArray*`	No

AgoraAudioTrackConfig 0 method / 2 Property

Property	Type	read-only
`enableLocalPlayback`	`BOOL`	No
`enableAudioProcessing`	`BOOL`	No

AgoraBeautyOptions 0 method / 5 Property

Property	Type	read-only
`lighteningContrastLevel`	`AgoraLighteningContrastLevel`	No
`lighteningLevel`	`float`	No
`smoothnessLevel`	`float`	No
`rednessLevel`	`float`	No
`sharpnessLevel`	`float`	No

AgoraCameraCapturerConfiguration 0 method / 6 Property

Property	Type	read-only
`cameraDirection`	`AgoraCameraDirection`	No
`cameraFocalLengthType`	`AgoraFocalLength`	No
`deviceId`	`NSString*`	No
`dimensions`	`CGSize`	No
`frameRate`	`int`	No
`followEncodeDimensionRatio`	`BOOL`	No

AgoraChannelMediaRelayConfiguration 2 method / 2 Property

typescript

removeDestinationInfoForChannelName:(channelName: NSString*): BOOL
setDestinationInfo:forChannelName:(destinationInfo: AgoraChannelMediaRelayInfo*, channelName: NSString*): BOOL

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

Method	Parameters	Returns	Errors
`removeDestinationInfoForChannelName:`	`channelName: NSString*`	`BOOL`	Error code index
`setDestinationInfo:forChannelName:`	`destinationInfo: AgoraChannelMediaRelayInfo, channelName: NSString`	`BOOL`	Error code index

Property	Type	read-only
`destinationInfos`	`NSDictionary*`	No
`sourceInfo`	`AgoraChannelMediaRelayInfo*`	No

AgoraChannelMediaRelayInfo 0 method / 3 Property

Property	Type	read-only
`token`	`NSString*`	No
`channelName`	`NSString*`	No
`uid`	`NSUInteger`	No

AgoraChannelStats 0 method / 28 Property

Property	Type	read-only
`duration`	`NSUInteger`	No
`txBytes`	`NSUInteger`	No
`rxBytes`	`NSUInteger`	No
`txAudioKBitrate`	`NSUInteger`	No
`rxAudioKBitrate`	`NSUInteger`	No
`txVideoKBitrate`	`NSUInteger`	No
`rxVideoKBitrate`	`NSUInteger`	No
`txAudioBytes`	`NSUInteger`	No
`txVideoBytes`	`NSUInteger`	No
`rxAudioBytes`	`NSUInteger`	No
`rxVideoBytes`	`NSUInteger`	No
`lastmileDelay`	`NSUInteger`	No
`userCount`	`NSUInteger`	No
`cpuAppUsage`	`double`	No
`cpuTotalUsage`	`double`	No
`gatewayRtt`	`NSInteger`	No
`memoryAppUsageRatio`	`double`	No
`memoryTotalUsageRatio`	`double`	No
`memoryAppUsageInKbytes`	`NSInteger`	No
`connectTimeMs`	`NSInteger`	No
`txKBitrate`	`NSUInteger`	No
`rxKBitrate`	`NSUInteger`	No
`firstAudioPacketDuration`	`NSInteger`	No
`firstVideoPacketDuration`	`NSInteger`	No
`firstVideoKeyFramePacketDuration`	`NSInteger`	No
`packetsBeforeFirstKeyFramePacket`	`NSInteger`	No
`txPacketLossRate`	`NSInteger`	No
`rxPacketLossRate`	`NSInteger`	No

AgoraClientRoleOptions 0 method / 1 Property

Property	Type	read-only
`audienceLatencyLevel`	`AgoraAudienceLatencyLevelType`	No

AgoraColorEnhanceOptions 0 method / 2 Property

Property	Type	read-only
`strengthLevel`	`float`	No
`skinProtectLevel`	`float`	No

AgoraContentInspectConfig 0 method / 3 Property

Property	Type	read-only
`extraInfo`	`NSString*`	No
`serverConfig`	`NSString*`	No
`modules`	`NSArray*`	No

AgoraContentInspectModule 0 method / 3 Property

Property	Type	read-only
`type`	`AgoraContentInspectType`	No
`interval`	`NSInteger`	No
`position`	`AgoraVideoModulePosition`	No

AgoraDataStreamConfig 0 method / 2 Property

Property	Type	read-only
`ordered`	`BOOL`	No
`syncWithAudio`	`BOOL`	No

AgoraEchoTestConfiguration 0 method / 6 Property

Property	Type	read-only
`view`	`VIEW_CLASS*`	No
`enableAudio`	`BOOL`	No
`enableVideo`	`BOOL`	No
`token`	`NSString*`	No
`channelId`	`NSString*`	No
`intervalInSeconds`	`NSInteger`	No

AgoraEncodedAudioFrameInfo 0 method / 4 Property

Property	Type	read-only
`samplesPerChannel`	`NSInteger`	No
`channels`	`NSInteger`	No
`samplesPerSec`	`NSInteger`	No
`codecType`	`AgoraAudioCodecType`	No

AgoraEncodedVideoFrameDelegate 1 method / 0 Property

typescript

onEncodedVideoFrameReceived:length:info:channelId:uid:(videoData: NSData*, length: size_t, videoFrameInfo: AgoraEncodedVideoFrameInfo*, channelId: NSString*, uid: NSUInteger): BOOL

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

Method	Parameters	Returns	Errors
`onEncodedVideoFrameReceived:length:info:channelId:uid:`	`videoData: NSData, length: size_t, videoFrameInfo: AgoraEncodedVideoFrameInfo, channelId: NSString*, uid: NSUInteger`	`BOOL`	Error code index

AgoraEncodedVideoFrameInfo 0 method / 10 Property

Property	Type	read-only
`codecType`	`AgoraVideoCodecType`	No
`width`	`NSInteger`	No
`height`	`NSInteger`	No
`framesPerSecond`	`NSInteger`	No
`frameType`	`AgoraVideoFrameType`	No
`rotation`	`NSInteger`	No
`trackId`	`NSInteger`	No
`captureTimeMs`	`NSInteger`	No
`decodeTimeMs`	`NSInteger`	No
`streamType`	`AgoraVideoStreamType`	No

AgoraEncryptionConfig 0 method / 4 Property

Property	Type	read-only
`encryptionMode`	`AgoraEncryptionMode`	No
`encryptionKey`	`NSString*`	No
`encryptionKdfSalt`	`NSData*`	No
`datastreamEncryptionEnabled`	`BOOL`	No

AgoraExtensionContext 0 method / 4 Property

Property	Type	read-only
`isValid`	`BOOL`	No
`uid`	`NSUInteger`	No
`providerName`	`NSString*`	No
`extensionName`	`NSString*`	No

AgoraFaceShapeAreaOptions 0 method / 2 Property

Property	Type	read-only
`shapeArea`	`AgoraFaceShapeArea`	No
`shapeIntensity`	`int`	No

AgoraFaceShapeBeautyOptions 0 method / 2 Property

Property	Type	read-only
`shapeStyle`	`AgoraFaceShapeStyle`	No
`styleIntensity`	`int`	No

AgoraFilterEffectOptions 0 method / 2 Property

Property	Type	read-only
`path`	`NSString*`	No
`strength`	`float`	No

AgoraImage 0 method / 4 Property

Property	Type	read-only
`url`	`NSURL*`	No
`rect`	`CGRect`	No
`zOrder`	`NSInteger`	No
`alpha`	`double`	No

AgoraImageTrackOptions 0 method / 3 Property

Property	Type	read-only
`imageUrl`	`NSString*`	No
`fps`	`int`	No
`mirrorMode`	`AgoraVideoMirrorMode`	No

AgoraLastmileProbeConfig 0 method / 4 Property

Property	Type	read-only
`probeUplink`	`BOOL`	No
`probeDownlink`	`BOOL`	No
`expectedUplinkBitrate`	`NSUInteger`	No
`expectedDownlinkBitrate`	`NSUInteger`	No

AgoraLastmileProbeOneWayResult 0 method / 3 Property

Property	Type	read-only
`packetLossRate`	`NSUInteger`	No
`jitter`	`NSUInteger`	No
`availableBandwidth`	`NSUInteger`	No

AgoraLastmileProbeResult 0 method / 4 Property

Property	Type	read-only
`state`	`AgoraLastmileProbeResultState`	No
`rtt`	`NSUInteger`	No
`uplinkReport`	`AgoraLastmileProbeOneWayResult*`	No
`downlinkReport`	`AgoraLastmileProbeOneWayResult*`	No

AgoraLeaveChannelOptions 0 method / 3 Property

Property	Type	read-only
`stopAudioMixing`	`BOOL`	No
`stopAllEffect`	`BOOL`	No
`stopMicrophoneRecording`	`BOOL`	No

AgoraLiveStreamAdvancedFeature 0 method / 2 Property

Property	Type	read-only
`featureName`	`NSString*`	No
`opened`	`BOOL`	No

AgoraLiveTranscoding 5 method / 16 Property

typescript

addUser:(user: AgoraLiveTranscodingUser*): int
defaultTranscoding(): AgoraLiveTranscoding*
getAdvancedFeatures(): NSArray*
removeUser:(uid: NSUInteger): int
setAdvancedFeatures:opened:(featureName: NSString*, opened: BOOL): void

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

Method	Parameters	Returns	Errors
`addUser:`	`user: AgoraLiveTranscodingUser*`	`int`	Error code index
`defaultTranscoding`	—	`AgoraLiveTranscoding*`	Error code index
`getAdvancedFeatures`	—	`NSArray*`	Error code index
`removeUser:`	`uid: NSUInteger`	`int`	Error code index
`setAdvancedFeatures:opened:`	`featureName: NSString*, opened: BOOL`	`void`	Error code index

Property	Type	read-only
`transcodingUsers`	`NSArray*`	No
`size`	`CGSize`	No
`videoBitrate`	`NSInteger`	No
`videoFramerate`	`NSInteger`	No
`lowLatency`	`BOOL`	No
`videoGop`	`NSInteger`	No
`videoCodecProfile`	`AgoraVideoCodecProfileType`	No
`videoCodecType`	`AgoraVideoCodecTypeForStream`	No
`transcodingExtraInfo`	`NSString*`	No
`watermarkArray`	`NSArray*`	No
`backgroundImageArray`	`NSArray*`	No
`backgroundColor`	`COLOR_CLASS*`	No
`audioSampleRate`	`AgoraAudioSampleRateType`	No
`audioBitrate`	`NSInteger`	No
`audioChannels`	`NSInteger`	No
`audioCodecProfile`	`AgoraAudioCodecProfileType`	No

AgoraLiveTranscodingUser 0 method / 5 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`rect`	`CGRect`	No
`zOrder`	`NSInteger`	No
`alpha`	`double`	No
`audioChannel`	`NSInteger`	No

AgoraLocalAccessPointConfiguration 0 method / 6 Property

Property	Type	read-only
`ipList`	`NSArray*`	No
`domainList`	`NSArray*`	No
`verifyDomainName`	`NSString*`	No
`mode`	`AgoraLocalProxyMode`	No
`advancedConfig`	`AdvancedConfigInfo*`	No
`disableAut`	`BOOL`	No

AgoraLocalAudioMixerConfiguration 0 method / 2 Property

Property	Type	read-only
`audioInputStreams`	`NSArray*`	No
`syncWithLocalMic`	`BOOL`	No

AgoraLocalSpatialAudioConfig 0 method / 1 Property

Property	Type	read-only
`rtcEngine`	`AgoraRtcEngineKit*`	No

AgoraLocalSpatialAudioKit 5 method / 0 Property

typescript

destroy(): void
removeRemotePosition:(uid: NSUInteger): int
setRemoteAudioAttenuation:uid:forceSet:(attenuation: double, uid: NSUInteger, forceSet: BOOL): int
sharedLocalSpatialAudioWithConfig:(config: AgoraLocalSpatialAudioConfig*): instancetype
updateRemotePosition:positionInfo:(uid: NSUInteger, posInfo: AgoraRemoteVoicePositionInfo*): int

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

Method	Parameters	Returns	Errors
`destroy`	—	`void`	Error code index
`removeRemotePosition:`	`uid: NSUInteger`	`int`	Error code index
`setRemoteAudioAttenuation:uid:forceSet:`	`attenuation: double, uid: NSUInteger, forceSet: BOOL`	`int`	Error code index
`sharedLocalSpatialAudioWithConfig:`	`config: AgoraLocalSpatialAudioConfig*`	`instancetype`	Error code index
`updateRemotePosition:positionInfo:`	`uid: NSUInteger, posInfo: AgoraRemoteVoicePositionInfo*`	`int`	Error code index

AgoraLocalTranscoderConfiguration 0 method / 3 Property

Property	Type	read-only
`videoInputStreams`	`NSArray*`	No
`videoOutputConfiguration`	`AgoraVideoEncoderConfiguration*`	No
`syncWithPrimaryCamera`	`BOOL`	No

AgoraLogConfig 0 method / 3 Property

Property	Type	read-only
`filePath`	`NSString*`	No
`fileSizeInKB`	`NSInteger`	No
`level`	`AgoraLogLevel`	No

AgoraLowlightEnhanceOptions 0 method / 2 Property

Property	Type	read-only
`mode`	`AgoraLowlightEnhanceMode`	No
`level`	`AgoraLowlightEnhanceLevel`	No

AgoraMediaMetadataDataSource 2 method / 0 Property

typescript

metadataMaxSize(): NSInteger
readyToSendMetadataAtTimestamp:sourceType:(timestamp: NSTimeInterval, sourceType: AgoraVideoSourceType): NSData*

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

Method	Parameters	Returns	Errors
`metadataMaxSize`	—	`NSInteger`	Error code index
`readyToSendMetadataAtTimestamp:sourceType:`	`timestamp: NSTimeInterval, sourceType: AgoraVideoSourceType`	`NSData*`	Error code index

AgoraMediaMetadataDelegate 1 method / 0 Property

typescript

didMetadataReceived:(metadata: AgoraMetadata*): void

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

Method	Parameters	Returns	Errors
`didMetadataReceived:`	`metadata: AgoraMetadata*`	`void`	Error code index

AgoraMediaPlayerCacheStatistics 0 method / 3 Property

Property	Type	read-only
`fileSize`	`NSInteger`	No
`cacheSize`	`NSInteger`	No
`downloadSize`	`NSInteger`	No

AgoraMediaPlayerPlaybackStats 0 method / 4 Property

Property	Type	read-only
`videoFps`	`NSInteger`	No
`videoBitrateInKbps`	`NSInteger`	No
`audioBitrateInKbps`	`NSInteger`	No
`totalBitrateInKbps`	`NSInteger`	No

AgoraMediaPlayerSrcInfo 0 method / 2 Property

Property	Type	read-only
`bitrateInKbps`	`int`	No
`name`	`NSString*`	No

AgoraMediaPlayerUpdatedInfo 0 method / 6 Property

Property	Type	read-only
`deviceId`	`NSString*`	No
`videoHeight`	`NSInteger`	No
`videoWidth`	`NSInteger`	No
`audioSampleRate`	`NSInteger`	No
`audioChannels`	`NSInteger`	No
`audioBitsPerSample`	`NSInteger`	No

AgoraMediaRecorder 4 method / 0 Property

typescript

enableMainQueueDispatch:(enabled: BOOL): int
setMediaRecorderDelegate:(delegate?: id): int
startRecording:(config: AgoraMediaRecorderConfiguration*): int
stopRecording(): int

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

Method	Parameters	Returns	Errors
`enableMainQueueDispatch:`	`enabled: BOOL`	`int`	Error code index
`setMediaRecorderDelegate:`	`delegate?: id`	`int`	Error code index
`startRecording:`	`config: AgoraMediaRecorderConfiguration*`	`int`	Error code index
`stopRecording`	—	`int`	Error code index

AgoraMediaRecorderConfiguration 0 method / 11 Property

Property	Type	read-only
`storagePath`	`NSString*`	No
`containerFormat`	`AgoraMediaRecorderContainerFormat`	No
`streamType`	`AgoraMediaRecorderStreamType`	No
`maxDurationMs`	`NSUInteger`	No
`recorderInfoUpdateInterval`	`NSUInteger`	No
`width`	`NSUInteger`	No
`height`	`NSUInteger`	No
`fps`	`NSUInteger`	No
`sample_rate`	`NSUInteger`	No
`channel_num`	`NSUInteger`	No
`videoSourceType`	`AgoraVideoSourceType`	No

AgoraMediaRecorderDelegate 2 method / 0 Property

typescript

mediaRecorder:informationDidUpdated:uid:info:(recorder: AgoraMediaRecorder*, channelId: NSString*, uid: NSUInteger, info: AgoraMediaRecorderInfo*): void
mediaRecorder:stateDidChanged:uid:state:reason:(recorder: AgoraMediaRecorder*, channelId: NSString*, uid: NSUInteger, state: AgoraMediaRecorderState, reason: AgoraMediaRecorderReasonCode): void

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

Method	Parameters	Returns	Errors
`mediaRecorder:informationDidUpdated:uid:info:`	`recorder: AgoraMediaRecorder, channelId: NSString, uid: NSUInteger, info: AgoraMediaRecorderInfo*`	`void`	Error code index
`mediaRecorder:stateDidChanged:uid:state:reason:`	`recorder: AgoraMediaRecorder, channelId: NSString, uid: NSUInteger, state: AgoraMediaRecorderState, reason: AgoraMediaRecorderReasonCode`	`void`	Error code index

AgoraMediaRecorderInfo 0 method / 3 Property

Property	Type	read-only
`recorderFileName`	`NSString*`	No
`durationMs`	`NSUInteger`	No
`fileSize`	`NSUInteger`	No

AgoraMediaSource 0 method / 10 Property

Property	Type	read-only
`url`	`NSString*`	No
`uri`	`NSString*`	No
`startPos`	`NSUInteger`	No
`autoPlay`	`BOOL`	No
`enableCache`	`BOOL`	No
`enableMultiAudioTrack`	`BOOL`	No
`isAgoraSource`	`BOOL`	No
`isLiveSource`	`BOOL`	No
`playerOnReadCallback`	`AgoraRtcMediaPlayerCustomSourceOnReadCallback`	No
`playerOnSeekCallback`	`AgoraRtcMediaPlayerCustomSourceOnSeekCallback`	No

AgoraMetadata 0 method / 4 Property

Property	Type	read-only
`channelId`	`NSString*`	No
`uid`	`NSInteger`	No
`data`	`NSData*`	No
`timestamp`	`NSTimeInterval`	No

AgoraMixedAudioStream 0 method / 4 Property

Property	Type	read-only
`sourceType`	`AgoraAudioSourceType`	No
`remoteUserUid`	`NSUInteger`	No
`channelId`	`NSString*`	No
`trackId`	`NSUInteger`	No

AgoraMultipathStats 0 method / 8 Property

Property	Type	read-only
`lanRxBytes`	`NSUInteger`	No
`lanTxBytes`	`NSUInteger`	No
`wifiRxBytes`	`NSUInteger`	No
`wifiTxBytes`	`NSUInteger`	No
`mobileRxBytes`	`NSUInteger`	No
`mobileTxBytes`	`NSUInteger`	No
`activePathNum`	`NSUInteger`	No
`pathStats`	`NSArray*`	No

AgoraOutputVideoFrame 0 method / 17 Property

Property	Type	read-only
`type`	`NSInteger`	No
`width`	`int`	No
`height`	`int`	No
`yStride`	`int`	No
`uStride`	`int`	No
`vStride`	`int`	No
`yBuffer`	`uint8_t*`	No
`uBuffer`	`uint8_t*`	No
`vBuffer`	`uint8_t*`	No
`rotation`	`int`	No
`renderTimeMs`	`int64_t`	No
`avSyncType`	`int`	No
`pixelBuffer`	`CVPixelBufferRef`	No
`alphaBuffer`	`uint8_t*`	No
`alphaStitchMode`	`AgoraAlphaStitchMode`	No
`metaInfo`	`NSDictionary*`	No
`colorSpace`	`AgoraColorSpace*`	No

AgoraPathStats 0 method / 3 Property

Property	Type	read-only
`pathType`	`AgoraMultipathType`	No
`txKBitRate`	`NSUInteger`	No
`rxKBitRate`	`NSUInteger`	No

AgoraRecorderStreamInfo 0 method / 3 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`channelId`	`NSString*`	No
`type`	`AgoraRecorderStreamType`	No

AgoraRemoteVoicePositionInfo 0 method / 2 Property

Property	Type	read-only
`position`	`simd_float3`	No
`forward`	`simd_float3`	No

AgoraRhythmPlayerConfig 0 method / 2 Property

Property	Type	read-only
`beatsPerMeasure`	`int`	No
`beatsPerMinute`	`int`	No

AgoraRtcAudioVolumeInfo 0 method / 4 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`volume`	`NSUInteger`	No
`vad`	`NSUInteger`	No
`voicePitch`	`double`	No

AgoraRtcChannelMediaOptions 0 method / 38 Property

Property	Type	read-only
`publishCameraTrack`	`BOOL`	No
`publishSecondaryCameraTrack`	`BOOL`	No
`publishMicrophoneTrack`	`BOOL`	No
`publishScreenCaptureVideo`	`BOOL`	No
`publishScreenCaptureAudio`	`BOOL`	No
`publishThirdCameraTrack`	`BOOL`	No
`publishFourthCameraTrack`	`BOOL`	No
`publishScreenTrack`	`BOOL`	No
`publishSecondaryScreenTrack`	`BOOL`	No
`publishThirdScreenTrack`	`BOOL`	No
`publishFourthScreenTrack`	`BOOL`	No
`publishCustomAudioTrack`	`BOOL`	No
`publishCustomAudioTrackId`	`NSInteger`	No
`publishCustomVideoTrack`	`BOOL`	No
`publishEncodedVideoTrack`	`BOOL`	No
`publishMediaPlayerAudioTrack`	`BOOL`	No
`publishMediaPlayerVideoTrack`	`BOOL`	No
`publishTranscodedVideoTrack`	`BOOL`	No
`publishLipSyncTrack`	`BOOL`	No
`autoSubscribeAudio`	`BOOL`	No
`autoSubscribeVideo`	`BOOL`	No
`enableAudioRecordingOrPlayout`	`BOOL`	No
`publishMediaPlayerId`	`NSInteger`	No
`clientRoleType`	`AgoraClientRole`	No
`audienceLatencyLevel`	`AgoraAudienceLatencyLevelType`	No
`defaultVideoStreamType`	`AgoraVideoStreamType`	No
`channelProfile`	`AgoraChannelProfile`	No
`publishMixedAudioTrack`	`BOOL`	No
`audioDelayMs`	`NSInteger`	No
`mediaPlayerAudioDelayMs`	`NSInteger`	No
`token`	`NSString*`	No
`enableBuiltInMediaEncryption`	`BOOL`	No
`publishRhythmPlayerTrack`	`BOOL`	No
`isInteractiveAudience`	`BOOL`	No
`customVideoTrackId`	`NSInteger`	No
`isAudioFilterable`	`BOOL`	No
`enableMultipath`	`BOOL`	No
`preferMultipathType`	`AgoraMultipathType`	No

AgoraRtcConnection 0 method / 2 Property

Property	Type	read-only
`channelId`	`NSString*`	No
`localUid`	`NSUInteger`	No

AgoraRtcDeviceInfo 0 method / 4 Property

Property	Type	read-only
`type`	`AgoraMediaDeviceType`	No
`deviceId`	`NSString*`	No
`deviceName`	`NSString*`	No
`deviceTypeName`	`NSString*`	No

AgoraRtcEngineConfig 0 method / 10 Property

Property	Type	read-only
`appId`	`NSString*`	No
`channelProfile`	`AgoraChannelProfile`	No
`license`	`NSString*`	No
`audioScenario`	`AgoraAudioScenario`	No
`areaCode`	`AgoraAreaCodeType`	No
`logConfig`	`AgoraLogConfig*`	No
`threadPriority`	`AgoraThreadPriorityType`	No
`eventDelegate`	`id`	No
`domainLimit`	`BOOL`	No
`autoRegisterAgoraExtensions`	`BOOL`	No

AgoraRtcEngineDelegate 77 method / 0 Property

typescript

audioQualityBlock:(audioQualityBlock?: void(^ )(NSUInteger uid,AgoraNetworkQuality quality,NSUInteger delay,NSUInteger lost)): void
onEventWithContext:key:value:(context: AgoraExtensionContext*, key?: NSString*, value?: NSString*): void
onExtensionErrorWithContext:error:message:(context: AgoraExtensionContext*, error: int, message?: NSString*): void
onExtensionStartedWithContext:(context: AgoraExtensionContext*): void
onExtensionStoppedWithContext:(context: AgoraExtensionContext*): void
rtcEngine:activeSpeaker:(engine: AgoraRtcEngineKit*, speakerUid: NSUInteger): void
rtcEngine:audioMixingPositionChanged:(engine: AgoraRtcEngineKit*, position: NSInteger): void
rtcEngine:audioMixingStateChanged:reasonCode:(engine: AgoraRtcEngineKit*, state: AgoraAudioMixingStateType, reasonCode: AgoraAudioMixingReasonCode): void
rtcEngine:audioTransportStatsOfUid:delay:lost:rxKBitRate:(engine: AgoraRtcEngineKit*, uid: NSUInteger, delay: NSUInteger, lost: NSUInteger, rxKBitRate: NSUInteger): void
rtcEngine:channelMediaRelayStateDidChange:error:(engine: unknown, state: unknown, error: unknown): unknown
rtcEngine:connectionChangedToState:reason:(engine: AgoraRtcEngineKit*, state: AgoraConnectionState, reason: AgoraConnectionChangedReason): void
rtcEngine:didAudioMuted:byUid:(engine: AgoraRtcEngineKit*, muted: BOOL, uid: NSUInteger): void
rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:(engine: unknown, channelId: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown): unknown
rtcEngine:didAudioRouteChanged:(engine: AgoraRtcEngineKit*, routing: AgoraAudioOutputRouting): void
rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:(engine: unknown, channelId: unknown, uid: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown): unknown
rtcEngine:didClientRoleChangeFailed:currentRole:(engine: AgoraRtcEngineKit*, reason: AgoraClientRoleChangeFailedReason, currentRole: AgoraClientRole): void
rtcEngine:didClientRoleChanged:newRole:newRoleOptions:(engine: AgoraRtcEngineKit*, oldRole: AgoraClientRole, newRole: AgoraClientRole, newRoleOptions?: AgoraClientRoleOptions*): void
rtcEngine:didJoinChannel:withUid:elapsed:(engine: AgoraRtcEngineKit*, channel: NSString*, uid: NSUInteger, elapsed: NSInteger): void
rtcEngine:didJoinedOfUid:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSInteger): void
rtcEngine:didLeaveChannelWithStats:(engine: AgoraRtcEngineKit*, stats: AgoraChannelStats*): void
rtcEngine:didLocalUserRegisteredWithUserId:userAccount:(engine: AgoraRtcEngineKit*, uid: NSUInteger, userAccount: NSString*): void
rtcEngine:didLocalVideoEnabled:byUid:(engine: AgoraRtcEngineKit*, enabled: BOOL, uid: NSUInteger): void
rtcEngine:didLocalVideoTranscoderErrorWithStream:errorCode:(engine: AgoraRtcEngineKit*, stream: AgoraTranscodingVideoStream*, errorCode: AgoraVideoTranscoderError): void
rtcEngine:didOccurEncryptionError:(engine: AgoraRtcEngineKit*, errorType: AgoraEncryptionErrorType): void
rtcEngine:didOccurError:(engine: AgoraRtcEngineKit*, errorCode: AgoraErrorCode): void
rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:(engine: AgoraRtcEngineKit*, uid: NSUInteger, streamId: NSInteger, error: NSInteger, missed: NSInteger, cached: NSInteger): void
rtcEngine:didOfflineOfUid:reason:(engine: AgoraRtcEngineKit*, uid: NSUInteger, reason: AgoraUserOfflineReason): void
rtcEngine:didProxyConnected:withUid:proxyType:localProxyIp:elapsed:(engine: AgoraRtcEngineKit*, channel: NSString*, uid: NSUInteger, proxyType: AgoraProxyType, localProxyIp: NSString*, elapsed: NSInteger): void
rtcEngine:didRejoinChannel:withUid:elapsed:(engine: AgoraRtcEngineKit*, channel: NSString*, uid: NSUInteger, elapsed: NSInteger): void
rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:(engine: AgoraRtcEngineKit*, isFallbackOrRecover: BOOL, uid: NSUInteger): void
rtcEngine:didRhythmPlayerStateChanged:reason:(engine: AgoraRtcEngineKit*, state: AgoraRhythmPlayerState, reason: AgoraRhythmPlayerReason): void
rtcEngine:didUserInfoUpdatedWithUserId:userInfo:(engine: AgoraRtcEngineKit*, uid: NSUInteger, userInfo: AgoraUserInfo*): void
rtcEngine:didVideoEnabled:byUid:(engine: AgoraRtcEngineKit*, enabled: BOOL, uid: NSUInteger): void
rtcEngine:didVideoMuted:byUid:(engine: AgoraRtcEngineKit*, muted: BOOL, uid: NSUInteger): void
rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:(engine: unknown, channelId: unknown, sourceType: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown): unknown
rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:(engine: unknown, channelId: unknown, uid: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown): unknown
rtcEngine:firstLocalAudioFramePublished:(engine: AgoraRtcEngineKit*, elapsed: NSInteger): void
rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:(engine: AgoraRtcEngineKit*, elapsed: NSInteger, sourceType: AgoraVideoSourceType): void
rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:(engine: AgoraRtcEngineKit*, size: CGSize, elapsed: NSInteger, sourceType: AgoraVideoSourceType): void
rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSInteger): void
rtcEngine:firstRemoteAudioFrameOfUid:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSInteger): void
rtcEngine:firstRemoteVideoDecodedOfUid:size:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, size: CGSize, elapsed: NSInteger): void
rtcEngine:firstRemoteVideoFrameOfUid:size:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, size: CGSize, elapsed: NSInteger): void
rtcEngine:lastmileProbeTestResult:(engine: AgoraRtcEngineKit*, result: AgoraLastmileProbeResult*): void
rtcEngine:lastmileQuality:(engine: AgoraRtcEngineKit*, quality: AgoraNetworkQuality): void
rtcEngine:localAudioStateChanged:reason:(engine: AgoraRtcEngineKit*, state: AgoraAudioLocalState, reason: AgoraAudioLocalReason): void
rtcEngine:localAudioStats:(engine: AgoraRtcEngineKit*, stats: AgoraRtcLocalAudioStats*): void
rtcEngine:localVideoStateChangedOfState:reason:sourceType:(engine: AgoraRtcEngineKit*, state: AgoraVideoLocalState, reason: AgoraLocalVideoStreamReason, sourceType: AgoraVideoSourceType): void
rtcEngine:localVideoStats:sourceType:(engine: AgoraRtcEngineKit*, stats: AgoraRtcLocalVideoStats*, sourceType: AgoraVideoSourceType): void
rtcEngine:multiPathStats:(engine: AgoraRtcEngineKit*, stats: AgoraMultipathStats*): void
rtcEngine:networkQuality:txQuality:rxQuality:(engine: AgoraRtcEngineKit*, uid: NSUInteger, txQuality: AgoraNetworkQuality, rxQuality: AgoraNetworkQuality): void
rtcEngine:networkTypeChanged:(engine: AgoraRtcEngineKit*, type: AgoraNetworkType): void
rtcEngine:permissionError:(engine: AgoraRtcEngineKit*, type: AgoraPermissionType): void
rtcEngine:receiveStreamMessageFromUid:streamId:data:(engine: AgoraRtcEngineKit*, uid: NSUInteger, streamId: NSInteger, data: NSData*): void
rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, state: AgoraAudioRemoteState, reason: AgoraAudioRemoteReason, elapsed: NSInteger): void
rtcEngine:remoteAudioStats:(engine: AgoraRtcEngineKit*, stats: AgoraRtcRemoteAudioStats*): void
rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:(engine: AgoraRtcEngineKit*, uid: NSUInteger, state: AgoraVideoRemoteState, reason: AgoraVideoRemoteReason, elapsed: NSInteger): void
rtcEngine:remoteVideoStats:(engine: AgoraRtcEngineKit*, stats: AgoraRtcRemoteVideoStats*): void
rtcEngine:renewTokenResult:code:(engine: AgoraRtcEngineKit*, token: NSString*, code: AgoraRenewTokenErrorCode): void
rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:(engine: AgoraRtcEngineKit*, speakers: NSArray*, totalVolume: NSInteger): void
rtcEngine:reportRtcStats:(engine: AgoraRtcEngineKit*, stats: AgoraChannelStats*): void
rtcEngine:rtmpStreamingChangedToState:state:reason:(engine: AgoraRtcEngineKit*, url: NSString*, state: AgoraRtmpStreamingState, reason: AgoraRtmpStreamingReason): void
rtcEngine:rtmpStreamingEventWithUrl:eventCode:(engine: AgoraRtcEngineKit*, url: NSString*, eventCode: AgoraRtmpStreamingEvent): void
rtcEngine:snapshotTaken:filePath:width:height:errCode:(engine: AgoraRtcEngineKit*, uid: NSUInteger, filePath: NSString*, width: NSInteger, height: NSInteger, errCode: NSInteger): void
rtcEngine:tokenPrivilegeWillExpire:(engine: AgoraRtcEngineKit*, token: NSString*): void
rtcEngine:uplinkNetworkInfoUpdate:(engine: AgoraRtcEngineKit*, networkInfo: AgoraUplinkNetworkInfo*): void
rtcEngine:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:(engine: AgoraRtcEngineKit*, uid: NSUInteger, currentEvent: AgoraMediaTraceEvent, tracingInfo: AgoraVideoRenderingTracingInfo*): void
rtcEngine:videoSizeChangedOfSourceType:uid:size:rotation:(engine: AgoraRtcEngineKit*, sourceType: AgoraVideoSourceType, uid: NSUInteger, size: CGSize, rotation: NSInteger): void
rtcEngine:videoTransportStatsOfUid:delay:lost:rxKBitRate:(engine: AgoraRtcEngineKit*, uid: NSUInteger, delay: NSUInteger, lost: NSUInteger, rxKBitRate: NSUInteger): void
rtcEngineConnectionDidBanned:(engine: AgoraRtcEngineKit*): void
rtcEngineConnectionDidInterrupted:(engine: AgoraRtcEngineKit*): void
rtcEngineConnectionDidLost:(engine: AgoraRtcEngineKit*): void
rtcEngineDidAudioEffectFinish:soundId:(engine: AgoraRtcEngineKit*, soundId: int): void
rtcEngineLocalAudioMixingDidFinish:(engine: AgoraRtcEngineKit*): void
rtcEngineRequestToken:(engine: AgoraRtcEngineKit*): void
rtcEngineTranscodingUpdated:(engine: AgoraRtcEngineKit*): void
rtcEngineVideoDidStop:(engine: AgoraRtcEngineKit*): void

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

Method	Parameters	Returns	Errors
`audioQualityBlock:`	`audioQualityBlock?: void(^ )(NSUInteger uid,AgoraNetworkQuality quality,NSUInteger delay,NSUInteger lost)`	`void`	Error code index
`onEventWithContext:key:value:`	`context: AgoraExtensionContext, key?: NSString, value?: NSString*`	`void`	Error code index
`onExtensionErrorWithContext:error:message:`	`context: AgoraExtensionContext, error: int, message?: NSString`	`void`	Error code index
`onExtensionStartedWithContext:`	`context: AgoraExtensionContext*`	`void`	Error code index
`onExtensionStoppedWithContext:`	`context: AgoraExtensionContext*`	`void`	Error code index
`rtcEngine:activeSpeaker:`	`engine: AgoraRtcEngineKit*, speakerUid: NSUInteger`	`void`	Error code index
`rtcEngine:audioMixingPositionChanged:`	`engine: AgoraRtcEngineKit*, position: NSInteger`	`void`	Error code index
`rtcEngine:audioMixingStateChanged:reasonCode:`	`engine: AgoraRtcEngineKit*, state: AgoraAudioMixingStateType, reasonCode: AgoraAudioMixingReasonCode`	`void`	Error code index
`rtcEngine:audioTransportStatsOfUid:delay:lost:rxKBitRate:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, delay: NSUInteger, lost: NSUInteger, rxKBitRate: NSUInteger`	`void`	Error code index
`rtcEngine:channelMediaRelayStateDidChange:error:`	`engine: unknown, state: unknown, error: unknown`	`unknown`	Error code index
`rtcEngine:connectionChangedToState:reason:`	`engine: AgoraRtcEngineKit*, state: AgoraConnectionState, reason: AgoraConnectionChangedReason`	`void`	Error code index
`rtcEngine:didAudioMuted:byUid:`	`engine: AgoraRtcEngineKit*, muted: BOOL, uid: NSUInteger`	`void`	Error code index
`rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:`	`engine: unknown, channelId: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown`	`unknown`	Error code index
`rtcEngine:didAudioRouteChanged:`	`engine: AgoraRtcEngineKit*, routing: AgoraAudioOutputRouting`	`void`	Error code index
`rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:`	`engine: unknown, channelId: unknown, uid: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown`	`unknown`	Error code index
`rtcEngine:didClientRoleChangeFailed:currentRole:`	`engine: AgoraRtcEngineKit*, reason: AgoraClientRoleChangeFailedReason, currentRole: AgoraClientRole`	`void`	Error code index
`rtcEngine:didClientRoleChanged:newRole:newRoleOptions:`	`engine: AgoraRtcEngineKit, oldRole: AgoraClientRole, newRole: AgoraClientRole, newRoleOptions?: AgoraClientRoleOptions`	`void`	Error code index
`rtcEngine:didJoinChannel:withUid:elapsed:`	`engine: AgoraRtcEngineKit, channel: NSString, uid: NSUInteger, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:didJoinedOfUid:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:didLeaveChannelWithStats:`	`engine: AgoraRtcEngineKit, stats: AgoraChannelStats`	`void`	Error code index
`rtcEngine:didLocalUserRegisteredWithUserId:userAccount:`	`engine: AgoraRtcEngineKit, uid: NSUInteger, userAccount: NSString`	`void`	Error code index
`rtcEngine:didLocalVideoEnabled:byUid:`	`engine: AgoraRtcEngineKit*, enabled: BOOL, uid: NSUInteger`	`void`	Error code index
`rtcEngine:didLocalVideoTranscoderErrorWithStream:errorCode:`	`engine: AgoraRtcEngineKit, stream: AgoraTranscodingVideoStream, errorCode: AgoraVideoTranscoderError`	`void`	Error code index
`rtcEngine:didOccurEncryptionError:`	`engine: AgoraRtcEngineKit*, errorType: AgoraEncryptionErrorType`	`void`	Error code index
`rtcEngine:didOccurError:`	`engine: AgoraRtcEngineKit*, errorCode: AgoraErrorCode`	`void`	Error code index
`rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, streamId: NSInteger, error: NSInteger, missed: NSInteger, cached: NSInteger`	`void`	Error code index
`rtcEngine:didOfflineOfUid:reason:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, reason: AgoraUserOfflineReason`	`void`	Error code index
`rtcEngine:didProxyConnected:withUid:proxyType:localProxyIp:elapsed:`	`engine: AgoraRtcEngineKit, channel: NSString, uid: NSUInteger, proxyType: AgoraProxyType, localProxyIp: NSString*, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:didRejoinChannel:withUid:elapsed:`	`engine: AgoraRtcEngineKit, channel: NSString, uid: NSUInteger, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:`	`engine: AgoraRtcEngineKit*, isFallbackOrRecover: BOOL, uid: NSUInteger`	`void`	Error code index
`rtcEngine:didRhythmPlayerStateChanged:reason:`	`engine: AgoraRtcEngineKit*, state: AgoraRhythmPlayerState, reason: AgoraRhythmPlayerReason`	`void`	Error code index
`rtcEngine:didUserInfoUpdatedWithUserId:userInfo:`	`engine: AgoraRtcEngineKit, uid: NSUInteger, userInfo: AgoraUserInfo`	`void`	Error code index
`rtcEngine:didVideoEnabled:byUid:`	`engine: AgoraRtcEngineKit*, enabled: BOOL, uid: NSUInteger`	`void`	Error code index
`rtcEngine:didVideoMuted:byUid:`	`engine: AgoraRtcEngineKit*, muted: BOOL, uid: NSUInteger`	`void`	Error code index
`rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:`	`engine: unknown, channelId: unknown, sourceType: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown`	`unknown`	Error code index
`rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:`	`engine: unknown, channelId: unknown, uid: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknown`	`unknown`	Error code index
`rtcEngine:firstLocalAudioFramePublished:`	`engine: AgoraRtcEngineKit*, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:`	`engine: AgoraRtcEngineKit*, elapsed: NSInteger, sourceType: AgoraVideoSourceType`	`void`	Error code index
`rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:`	`engine: AgoraRtcEngineKit*, size: CGSize, elapsed: NSInteger, sourceType: AgoraVideoSourceType`	`void`	Error code index
`rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:firstRemoteAudioFrameOfUid:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:firstRemoteVideoDecodedOfUid:size:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, size: CGSize, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:firstRemoteVideoFrameOfUid:size:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, size: CGSize, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:lastmileProbeTestResult:`	`engine: AgoraRtcEngineKit, result: AgoraLastmileProbeResult`	`void`	Error code index
`rtcEngine:lastmileQuality:`	`engine: AgoraRtcEngineKit*, quality: AgoraNetworkQuality`	`void`	Error code index
`rtcEngine:localAudioStateChanged:reason:`	`engine: AgoraRtcEngineKit*, state: AgoraAudioLocalState, reason: AgoraAudioLocalReason`	`void`	Error code index
`rtcEngine:localAudioStats:`	`engine: AgoraRtcEngineKit, stats: AgoraRtcLocalAudioStats`	`void`	Error code index
`rtcEngine:localVideoStateChangedOfState:reason:sourceType:`	`engine: AgoraRtcEngineKit*, state: AgoraVideoLocalState, reason: AgoraLocalVideoStreamReason, sourceType: AgoraVideoSourceType`	`void`	Error code index
`rtcEngine:localVideoStats:sourceType:`	`engine: AgoraRtcEngineKit, stats: AgoraRtcLocalVideoStats, sourceType: AgoraVideoSourceType`	`void`	Error code index
`rtcEngine:multiPathStats:`	`engine: AgoraRtcEngineKit, stats: AgoraMultipathStats`	`void`	Error code index
`rtcEngine:networkQuality:txQuality:rxQuality:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, txQuality: AgoraNetworkQuality, rxQuality: AgoraNetworkQuality`	`void`	Error code index
`rtcEngine:networkTypeChanged:`	`engine: AgoraRtcEngineKit*, type: AgoraNetworkType`	`void`	Error code index
`rtcEngine:permissionError:`	`engine: AgoraRtcEngineKit*, type: AgoraPermissionType`	`void`	Error code index
`rtcEngine:receiveStreamMessageFromUid:streamId:data:`	`engine: AgoraRtcEngineKit, uid: NSUInteger, streamId: NSInteger, data: NSData`	`void`	Error code index
`rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, state: AgoraAudioRemoteState, reason: AgoraAudioRemoteReason, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:remoteAudioStats:`	`engine: AgoraRtcEngineKit, stats: AgoraRtcRemoteAudioStats`	`void`	Error code index
`rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, state: AgoraVideoRemoteState, reason: AgoraVideoRemoteReason, elapsed: NSInteger`	`void`	Error code index
`rtcEngine:remoteVideoStats:`	`engine: AgoraRtcEngineKit, stats: AgoraRtcRemoteVideoStats`	`void`	Error code index
`rtcEngine:renewTokenResult:code:`	`engine: AgoraRtcEngineKit, token: NSString, code: AgoraRenewTokenErrorCode`	`void`	Error code index
`rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:`	`engine: AgoraRtcEngineKit, speakers: NSArray, totalVolume: NSInteger`	`void`	Error code index
`rtcEngine:reportRtcStats:`	`engine: AgoraRtcEngineKit, stats: AgoraChannelStats`	`void`	Error code index
`rtcEngine:rtmpStreamingChangedToState:state:reason:`	`engine: AgoraRtcEngineKit, url: NSString, state: AgoraRtmpStreamingState, reason: AgoraRtmpStreamingReason`	`void`	Error code index
`rtcEngine:rtmpStreamingEventWithUrl:eventCode:`	`engine: AgoraRtcEngineKit, url: NSString, eventCode: AgoraRtmpStreamingEvent`	`void`	Error code index
`rtcEngine:snapshotTaken:filePath:width:height:errCode:`	`engine: AgoraRtcEngineKit, uid: NSUInteger, filePath: NSString, width: NSInteger, height: NSInteger, errCode: NSInteger`	`void`	Error code index
`rtcEngine:tokenPrivilegeWillExpire:`	`engine: AgoraRtcEngineKit, token: NSString`	`void`	Error code index
`rtcEngine:uplinkNetworkInfoUpdate:`	`engine: AgoraRtcEngineKit, networkInfo: AgoraUplinkNetworkInfo`	`void`	Error code index
`rtcEngine:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:`	`engine: AgoraRtcEngineKit, uid: NSUInteger, currentEvent: AgoraMediaTraceEvent, tracingInfo: AgoraVideoRenderingTracingInfo`	`void`	Error code index
`rtcEngine:videoSizeChangedOfSourceType:uid:size:rotation:`	`engine: AgoraRtcEngineKit*, sourceType: AgoraVideoSourceType, uid: NSUInteger, size: CGSize, rotation: NSInteger`	`void`	Error code index
`rtcEngine:videoTransportStatsOfUid:delay:lost:rxKBitRate:`	`engine: AgoraRtcEngineKit*, uid: NSUInteger, delay: NSUInteger, lost: NSUInteger, rxKBitRate: NSUInteger`	`void`	Error code index
`rtcEngineConnectionDidBanned:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index
`rtcEngineConnectionDidInterrupted:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index
`rtcEngineConnectionDidLost:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index
`rtcEngineDidAudioEffectFinish:soundId:`	`engine: AgoraRtcEngineKit*, soundId: int`	`void`	Error code index
`rtcEngineLocalAudioMixingDidFinish:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index
`rtcEngineRequestToken:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index
`rtcEngineTranscodingUpdated:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index
`rtcEngineVideoDidStop:`	`engine: AgoraRtcEngineKit*`	`void`	Error code index

AgoraRtcEngineKit 289 method / 0 Property

typescript

addVideoWatermark:(watermark: AgoraImage*): int
addVideoWatermark:options:(url: NSURL*, options: WatermarkOptions*): int
addVideoWatermarkWithConfig:(config: WatermarkConfig*): int
adjustAudioMixingPlayoutVolume:(volume: NSInteger): int
adjustAudioMixingPublishVolume:(volume: NSInteger): int
adjustAudioMixingVolume:(volume: NSInteger): int
adjustCustomAudioPlayoutVolume:volume:(trackId: NSInteger, volume: NSInteger): int
adjustCustomAudioPublishVolume:volume:(trackId: NSInteger, volume: NSInteger): int
adjustLoopbackSignalVolume:(volume: NSInteger): int
adjustPlaybackSignalVolume:(volume: NSInteger): int
adjustRecordingSignalVolume:(volume: NSInteger): int
adjustUserPlaybackSignalVolume:volume:(uid: NSUInteger, volume: int): int
clearVideoWatermarks(): int
complain:description:(callId: NSString*, description?: NSString*): int
configRhythmPlayer:(config?: AgoraRhythmPlayerConfig*): int
createCustomAudioTrack:config:(trackType: AgoraAudioTrackType, config: AgoraAudioTrackConfig*): int
createCustomVideoTrack(): unsigned int
createDataStream:config:(streamId: NSInteger*, config: AgoraDataStreamConfig*): int
createDataStream:reliable:ordered:(streamId: NSInteger*, reliable: BOOL, ordered: BOOL): int
createMediaPlayerWithDelegate:(delegate?: id): id
createMediaRecorder:(info: AgoraRecorderStreamInfo*): AgoraMediaRecorder*
createVideoEffectObjectWithBundlePath:sourceType:(bundlePath: NSString*, sourceType: AgoraMediaSourceType): id
delegate(): unknown
destroy(): void
destroy:(engineReleasedBlock?: void (^ )(void)): void
destroyCustomAudioTrack:(trackId: NSInteger): int
destroyCustomVideoTrack:(videoTrackId: NSUInteger): int
destroyMediaPlayer:(mediaPlayer?: id): int
destroyMediaRecorder:(mediaRecorder?: AgoraMediaRecorder*): int
destroyVideoEffectObject:(videoEffectObject?: id): int
disableAudio(): int
disableAudioSpectrumMonitor(): int
disableVideo(): int
enableAudio(): int
enableAudioSpectrumMonitor:(intervalInMS: int): int
enableAudioVolumeIndication:smooth:reportVad:(interval: NSInteger, smooth: NSInteger, reportVad: BOOL): int
enableCameraCenterStage:(enabled: BOOL): int
enableContentInspect:config:(enabled: BOOL, config: AgoraContentInspectConfig*): int
enableCustomAudioLocalPlayback:enabled:(trackId: NSInteger, enabled: BOOL): int
enableDualStreamMode:(enabled: BOOL): int
enableDualStreamMode:streamConfig:(enabled: BOOL, streamConfig: AgoraSimulcastStreamConfig*): int
enableEncryption:encryptionConfig:(enabled: BOOL, config: AgoraEncryptionConfig*): int
enableExtensionWithVendor:extension:enabled:sourceType:(provider: NSString*, extension: NSString*, enabled: BOOL, sourceType: AgoraMediaSourceType): int
enableExternalAudioSink:sampleRate:channels:(enabled: BOOL, sampleRate: NSUInteger, channels: NSUInteger): void
enableInEarMonitoring:(enabled: BOOL): int
enableInEarMonitoring:includeAudioFilters:(enabled: BOOL, includeAudioFilters: AgoraEarMonitoringFilterType): int
enableInstantMediaRendering(): int
enableLocalAudio:(enabled: BOOL): int
enableLocalVideo:(enabled: BOOL): int
enableLoopbackRecording:deviceName:(enabled: BOOL, deviceName?: NSString*): int
enableMainQueueDispatch:(enabled: BOOL): int
enableSoundPositionIndication:(enabled: BOOL): int
enableSpatialAudio:(enabled: BOOL): int
enableVideo(): int
enableVideoImageSource:options:(enable: BOOL, options?: AgoraImageTrackOptions*): int
enableVirtualBackground:backData:segData:(enable: BOOL, backData?: AgoraVirtualBackgroundSource*, segData?: AgoraSegmentationProperty*): int
enableVirtualBackground:backData:segData:sourceType:(enable: BOOL, backData?: AgoraVirtualBackgroundSource*, segData?: AgoraSegmentationProperty*, sourceType: AgoraMediaSourceType): int
enableVoiceAITuner:type:(enabled: BOOL, type: AgoraVoiceAITunerType): int
enableWebSdkInteroperability:(enabled: BOOL): int
enumerateDevices:(type: AgoraMediaDeviceType): NSArray*
followSystemPlaybackDevice:(enable: BOOL): int
followSystemRecordingDevice:(enable: BOOL): int
getAudioMixingCurrentPosition(): int
getAudioMixingDuration(): int
getAudioMixingPlayoutVolume(): int
getAudioMixingPublishVolume(): int
getAudioTrackCount(): int
getCallId(): NSString*
getConnectionState(): AgoraConnectionState
getCurrentMonotonicTimeInMs(): int64_t
getDefaultAudioDevice:(type: AgoraMediaDeviceType): AgoraRtcDeviceInfo*
getDeviceInfo:(type: AgoraMediaDeviceType): AgoraRtcDeviceInfo*
getDeviceVolume:(type: AgoraMediaDeviceType): int
getEffectCurrentPosition:(soundId: int): int
getEffectDuration:(filePath: NSString*): int
getEffectsVolume(): int
getErrorDescription:(error: NSInteger): NSString*
getExtensionPropertyWithVendor:extension:key:(provider: NSString*, extension: NSString*, key: NSString*): NSString*
getExtensionPropertyWithVendor:extension:key:sourceType:(provider: NSString*, extension: NSString*, key: NSString*, sourceType: AgoraMediaSourceType): NSString*
getFaceShapeAreaOptions:(area: AgoraFaceShapeArea): AgoraFaceShapeAreaOptions*
getFaceShapeAreaOptions:sourceType:(area: AgoraFaceShapeArea, sourceType: AgoraMediaSourceType): AgoraFaceShapeAreaOptions*
getFaceShapeBeautyOptions(): AgoraFaceShapeBeautyOptions*
getFaceShapeBeautyOptions:(sourceType: AgoraMediaSourceType): AgoraFaceShapeBeautyOptions*
getNativeHandle(): void*
getNetworkType(): int
getNtpWallTimeInMs(): uint64_t
getScreenCaptureSourcesWithThumbSize:iconSize:includeScreen:(thumbSize: NSSize, iconSize: NSSize, includeScreen: BOOL): NSArray*
getSdkVersion(): NSString*
getUserInfoByUid:withError:(uid: NSUInteger, error?: AgoraErrorCode*): AgoraUserInfo*
getUserInfoByUserAccount:withError:(userAccount: NSString*, error?: AgoraErrorCode*): AgoraUserInfo*
getVolumeOfEffect:(soundId: int): int
isCameraCenterStageSupported(): BOOL
isFeatureAvailableOnDevice:(type: AgoraFeatureType): BOOL
joinChannelByToken:channelId:info:uid:joinSuccess:(token?: NSString*, channelId: NSString*, info?: NSString*, uid: NSUInteger, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:(token?: NSString*, channelId: NSString*, uid: NSUInteger, mediaOptions: AgoraRtcChannelMediaOptions*, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
joinChannelByToken:channelId:userAccount:joinSuccess:(token?: NSString*, channelId: NSString*, userAccount: NSString*, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
joinChannelByToken:channelId:userAccount:mediaOptions:joinSuccess:(token?: NSString*, channelId: NSString*, userAccount: NSString*, mediaOptions: AgoraRtcChannelMediaOptions*, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
leaveChannel:(leaveChannelBlock?: void(^ )(AgoraChannelStats*stat)): int
leaveChannel:leaveChannelBlock:(options: unknown, leaveChannelBlock: unknown): unknown
monitorDeviceChange:(enabled: BOOL): void
muteAllRemoteAudioStreams:(mute: BOOL): int
muteAllRemoteVideoStreams:(mute: BOOL): int
muteLocalAudioStream:(mute: BOOL): int
muteLocalVideoStream:(mute: BOOL): int
muteRecordingSignal:(muted: BOOL): int
muteRemoteAudioStream:mute:(uid: NSUInteger, mute: BOOL): int
muteRemoteVideoStream:mute:(uid: NSUInteger, mute: BOOL): int
pauseAllChannelMediaRelay(): int
pauseAllEffects(): int
pauseAudioMixing(): int
pauseEffect:(soundId: int): int
playAllEffectsWithLoopCount:pitch:pan:gain:publish:(loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL): int
playEffect:filePath:loopCount:pitch:pan:gain:(soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger): int
playEffect:filePath:loopCount:pitch:pan:gain:publish:(soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL): int
playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:(soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL, startPos: int): int
preloadChannelByToken:channelId:uid:(token?: NSString*, channelId: NSString*, uid: NSUInteger): int
preloadChannelByTokenWithUserAccount:channelId:userAccount:(token?: NSString*, channelId: NSString*, userAccount: NSString*): int
preloadEffect:filePath:(soundId: int, filePath: NSString*): int
preloadEffect:filePath:startPos:(soundId: int, filePath: NSString*, startPos: int): int
pullPlaybackAudioFrameRawData:lengthInByte:(data: void*, lengthInByte: NSUInteger): BOOL
pullPlaybackAudioFrameSampleBufferByLengthInByte:(lengthInByte: NSUInteger): CMSampleBufferRef
pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:(data: void*, samples: NSInteger, sampleRate: NSInteger, channels: NSInteger, trackId: NSInteger, timestamp: NSTimeInterval): int
pushExternalAudioFrameSampleBuffer:(sampleBuffer: CMSampleBufferRef): int
pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:(sampleBuffer: CMSampleBufferRef, sampleRate: NSInteger, channels: NSInteger, trackId: NSInteger): int
pushExternalVideoFrame:(frame: AgoraVideoFrame*): BOOL
pushExternalVideoFrame:videoTrackId:(frame: AgoraVideoFrame*, videoTrackId: NSUInteger): BOOL
queryCodecCapability(): NSArray*
queryDeviceScore(): int
rate:rating:description:(callId: NSString*, rating: NSInteger, description?: NSString*): int
registerAudioSpectrumDelegate:(delegate?: id): int
registerExtensionWithVendor:extension:sourceType:(provider: NSString*, extension: NSString*, sourceType: AgoraMediaSourceType): int
registerLocalUserAccount:appId:(userAccount: NSString*, appId: NSString*): int
removeVideoWatermark:(id: NSString*): int
renewToken:(token: NSString*): int
resumeAllChannelMediaRelay(): int
resumeAllEffects(): int
resumeAudioMixing(): int
resumeEffect:(soundId: int): int
rtcEngine:device:type:stateChanged:(engine: AgoraRtcEngineKit*, deviceId: NSString*, deviceType: AgoraMediaDeviceType, state: NSInteger): void
selectAudioTrack:(index: NSInteger): int
sendCustomReportMessage:category:event:label:value:(messageId?: NSString*, category?: NSString*, event?: NSString*, label?: NSString*, value: NSInteger): int
sendStreamMessage:data:(streamId: NSInteger, data: NSData*): int
setAINSMode:mode:(enabled: BOOL, mode: AUDIO_AINS_MODE): int
setAVSyncSource:uid:(channelId: NSString*, uid: NSUInteger): int
setAdvancedAudioOptions:(options: AgoraAdvancedAudioOptions*): int
setAudioEffectParameters:param1:param2:(preset: AgoraAudioEffectPreset, param1: int, param2: int): int
setAudioEffectPreset:(preset: AgoraAudioEffectPreset): int
setAudioEncodedFrameDelegate:config:(delegate?: id, config: AgoraAudioEncodedFrameDelegateConfig*): int
setAudioFrameDelegate:(delegate?: id): BOOL
setAudioMixingDualMonoMode:(mode: AgoraAudioMixingDualMonoMode): int
setAudioMixingPitch:(pitch: NSInteger): int
setAudioMixingPlaybackSpeed:(speed: NSInteger): int
setAudioMixingPosition:(pos: NSInteger): int
setAudioProfile:(profile: AgoraAudioProfile): int
setAudioProfile:scenario:(profile: AgoraAudioProfile, scenario: AgoraAudioScenario): int
setAudioScenario:(scenario: AgoraAudioScenario): int
setBeautyEffectOptions:options:(enable: BOOL, options?: AgoraBeautyOptions*): int
setBeautyEffectOptions:options:sourceType:(enable: BOOL, options?: AgoraBeautyOptions*, sourceType: AgoraMediaSourceType): int
setCameraCapturerConfiguration:(config?: AgoraCameraCapturerConfiguration*): int
setChannelProfile:(profile: AgoraChannelProfile): int
setClientRole:(role: AgoraClientRole): int
setClientRole:options:(role: AgoraClientRole, options?: AgoraClientRoleOptions*): int
setCloudProxy:(proxyType: AgoraCloudProxyType): int
setColorEnhanceOptions:options:(enable: BOOL, options?: AgoraColorEnhanceOptions*): int
setColorEnhanceOptions:options:sourceType:(enable: BOOL, options?: AgoraColorEnhanceOptions*, sourceType: AgoraMediaSourceType): int
setDevice:deviceId:(type: AgoraMediaDeviceType, deviceId: NSString*): int
setDeviceVolume:volume:(type: AgoraMediaDeviceType, volume: int): int
setDualStreamMode:(mode: AgoraSimulcastStreamMode): int
setDualStreamMode:streamConfig:(mode: AgoraSimulcastStreamMode, streamConfig: AgoraSimulcastStreamConfig*): int
setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:(sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSInteger): int
setEffectPosition:pos:(soundId: int, pos: NSInteger): int
setEffectsVolume:(volume: NSInteger): int
setEncodedVideoFrameDelegate:(delegate?: id): BOOL
setExtensionPropertyWithVendor:extension:key:value:(provider: NSString*, extension: NSString*, key: NSString*, value: NSString*): int
setExtensionProviderPropertyWithVendor:key:value:(provider: NSString*, key: NSString*, value: NSString*): int
setExternalAudioSource:sampleRate:channels:(enabled: BOOL, sampleRate: NSInteger, channels: NSInteger): int
setExternalAudioSource:sampleRate:channels:localPlayback:publish:(enabled: BOOL, sampleRate: NSInteger, channels: NSInteger, localPlayback: BOOL, publish: BOOL): int
setExternalVideoSource:useTexture:sourceType:(enable: BOOL, useTexture: BOOL, sourceType: AgoraExternalVideoSourceType): void
setFaceShapeAreaOptions:(options?: AgoraFaceShapeAreaOptions*): int
setFaceShapeAreaOptions:sourceType:(options?: AgoraFaceShapeAreaOptions*, sourceType: AgoraMediaSourceType): int
setFaceShapeBeautyOptions:options:(enable: BOOL, options?: AgoraFaceShapeBeautyOptions*): int
setFaceShapeBeautyOptions:options:sourceType:(enable: BOOL, options?: AgoraFaceShapeBeautyOptions*, sourceType: AgoraMediaSourceType): int
setFilterEffectOptions:options:(enable: BOOL, options?: AgoraFilterEffectOptions*): int
setFilterEffectOptions:options:sourceType:(enable: BOOL, options?: AgoraFilterEffectOptions*, sourceType: AgoraMediaSourceType): int
setHeadphoneEQParameters:highGain:(lowGain: int, highGain: int): int
setHeadphoneEQPreset:(preset: AgoraHeadphoneEQPreset): int
setInEarMonitoringVolume:(volume: NSInteger): int
setLocalAccessPoint:(config: AgoraLocalAccessPointConfiguration*): int
setLocalRenderMode:mirror:(mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorMode): int
setLocalRenderMode:mode:(uid: NSUInteger, mode: AgoraVideoRenderMode): int
setLocalRenderTargetFps:targetFps:(sourceType: AgoraVideoSourceType, targetFps: int): int
setLocalVideoMirrorMode:(mode: AgoraVideoMirrorMode): int
setLocalVoiceEqualizationOfBandFrequency:withGain:(bandFrequency: AgoraAudioEqualizationBandFrequency, gain: NSInteger): int
setLocalVoiceFormant:(formantRatio: double): int
setLocalVoicePitch:(pitch: double): int
setLocalVoiceReverbOfType:withValue:(reverbType: AgoraAudioReverbType, value: NSInteger): int
setLogFile:(filePath: NSString*): int
setLogFileSize:(fileSizeInKBytes: NSUInteger): int
setLogFilter:(filter: NSUInteger): int
setLogLevel:(level: AgoraLogLevel): int
setLowlightEnhanceOptions:options:(enable: BOOL, options?: AgoraLowlightEnhanceOptions*): int
setLowlightEnhanceOptions:options:sourceType:(enable: BOOL, options?: AgoraLowlightEnhanceOptions*, sourceType: AgoraMediaSourceType): int
setMediaMetadataDataSource:withType:(metadataDataSource?: id, type: AgoraMetadataType): BOOL
setMediaMetadataDelegate:withType:(metadataDelegate?: id, type: AgoraMetadataType): BOOL
setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:(sampleRate: NSInteger, channel: NSInteger, samplesPerCall: NSInteger): int
setParameters:(options: NSString*): int
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:(sampleRate: NSInteger, channel: NSInteger): int
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:samplesPerCall:(sampleRate: NSInteger, channel: NSInteger, samplesPerCall: NSInteger): int
setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:(sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSInteger): int
setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:(sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSInteger): int
setRemoteDefaultVideoStreamType:(streamType: AgoraVideoStreamType): int
setRemoteRenderMode:mode:mirror:(uid: NSUInteger, mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorMode): int
setRemoteRenderTargetFps:(targetFps: int): int
setRemoteSubscribeFallbackOption:(option: AgoraStreamFallbackOptions): int
setRemoteUserSpatialAudioParams:params:(uid: NSUInteger, params: AgoraSpatialAudioParams*): int
setRemoteVideoStream:type:(uid: NSUInteger, streamType: AgoraVideoStreamType): int
setRemoteVideoSubscriptionOptions:options:(uid: NSUInteger, options: AgoraVideoSubscriptionOptions*): int
setRemoteVoicePosition:pan:gain:(uid: NSUInteger, pan: double, gain: double): int
setScreenCaptureScenario:(scenarioType: AgoraScreenScenarioType): int
setSubscribeAudioAllowlist:(allowlist: NSArray*): int
setSubscribeAudioBlocklist:(blocklist: NSArray*): int
setSubscribeVideoAllowlist:(allowlist: NSArray*): int
setSubscribeVideoBlocklist:(blocklist: NSArray*): int
setVideoDenoiserOptions:options:(enable: BOOL, options?: AgoraVideoDenoiserOptions*): int
setVideoDenoiserOptions:options:sourceType:(enable: BOOL, options?: AgoraVideoDenoiserOptions*, sourceType: AgoraMediaSourceType): int
setVideoEncoderConfiguration:(config: AgoraVideoEncoderConfiguration*): int
setVideoFrameDelegate:(delegate?: id): BOOL
setVideoResolution:andFrameRate:bitrate:(size: CGSize, frameRate: NSInteger, bitrate: NSInteger): int
setVideoScenario:(scenarioType: AgoraApplicationScenarioType): int
setVoiceBeautifierParameters:param1:param2:(preset: AgoraVoiceBeautifierPreset, param1: int, param2: int): int
setVoiceBeautifierPreset:(preset: AgoraVoiceBeautifierPreset): int
setVoiceConversionPreset:(preset: AgoraVoiceConversionPreset): int
setVolumeOfEffect:withVolume:(soundId: int, volume: int): int
setupLocalVideo:(local?: AgoraRtcVideoCanvas*): int
setupRemoteVideo:(remote: AgoraRtcVideoCanvas*): int
sharedEngineWithAppId:delegate:(appId: NSString*, delegate?: id): instancetype
sharedEngineWithConfig:delegate:(config: AgoraRtcEngineConfig*, delegate?: id): instancetype
startAudioDeviceLoopbackTest:(indicationInterval: int): int
startAudioMixing:loopback:cycle:(filePath: NSString*, loopback: BOOL, cycle: NSInteger): int
startAudioMixing:loopback:cycle:startPos:(filePath: NSString*, loopback: BOOL, cycle: NSInteger, startPos: NSInteger): int
startAudioRecording:quality:(filePath: NSString*, quality: AgoraAudioRecordingQuality): int
startAudioRecordingWithConfig:(config: AgoraAudioRecordingConfiguration*): int
startCameraCapture:config:(sourceType: AgoraVideoSourceType, config?: AgoraCameraCapturerConfiguration*): int
startEchoTestWithConfig:(config: AgoraEchoTestConfiguration*): int
startLastmileProbeTest:(config?: AgoraLastmileProbeConfig*): int
startLocalAudioMixer:(config: AgoraLocalAudioMixerConfiguration*): int
startLocalVideoTranscoder:(config: AgoraLocalTranscoderConfiguration*): int
startMediaRenderingTracing(): int
startOrUpdateChannelMediaRelay:(config: AgoraChannelMediaRelayConfiguration*): int
startPlaybackDeviceTest:(audioFileName: NSString*): int
startPreview(): int
startPreview:(sourceType: AgoraVideoSourceType): int
startRecordingDeviceTest:(indicationInterval: int): int
startRhythmPlayer:sound2:config:(sound1: NSString*, sound2: NSString*, config?: AgoraRhythmPlayerConfig*): int
startRtmpStreamWithTranscoding:transcoding:(url: NSString*, transcoding?: AgoraLiveTranscoding*): int
startRtmpStreamWithoutTranscoding:(url: NSString*): int
startScreenCapture:config:(sourceType: AgoraVideoSourceType, config?: AgoraScreenCaptureConfiguration*): int
startScreenCaptureByDisplayId:regionRect:captureParams:(displayId: UInt32, regionRect: CGRect, captureParams: AgoraScreenCaptureParameters*): int
startScreenCaptureByWindowId:regionRect:captureParams:(windowId: UInt32, regionRect: CGRect, captureParams: AgoraScreenCaptureParameters*): int
stopAllEffects(): int
stopAudioDeviceLoopbackTest(): int
stopAudioMixing(): int
stopAudioRecording(): int
stopCameraCapture:(sourceType: AgoraVideoSourceType): int
stopChannelMediaRelay(): int
stopEchoTest(): int
stopEffect:(soundId: int): int
stopLastmileProbeTest(): int
stopLocalAudioMixer(): int
stopLocalVideoTranscoder(): int
stopPlaybackDeviceTest(): int
stopPreview(): int
stopPreview:(sourceType: AgoraVideoSourceType): int
stopRecordingDeviceTest(): int
stopRhythmPlayer(): int
stopRtmpStream:(url: NSString*): int
stopScreenCapture(): int
stopScreenCapture:(sourceType: AgoraVideoSourceType): int
takeSnapshot:filePath:(uid: NSInteger, filePath: NSString*): NSInteger
takeSnapshotWithConfig:config:(uid: NSInteger, config: AgoraSnapshotConfig*): NSInteger
unloadEffect:(soundId: int): int
unregisterAudioSpectrumDelegate:(delegate?: id): int
updateChannelWithMediaOptions:(mediaOptions: AgoraRtcChannelMediaOptions*): int
updateLocalAudioMixerConfiguration:(config: AgoraLocalAudioMixerConfiguration*): int
updateLocalTranscoderConfiguration:(config: AgoraLocalTranscoderConfiguration*): int
updatePreloadChannelToken:(token: NSString*): int
updateRtmpTranscoding:(transcoding?: AgoraLiveTranscoding*): int
updateScreenCaptureParameters:(captureParams: AgoraScreenCaptureParameters*): int
updateScreenCaptureRegion:(rect: CGRect): int

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

Method	Parameters	Returns	Errors
`addVideoWatermark:`	`watermark: AgoraImage*`	`int`	Error code index
`addVideoWatermark:options:`	`url: NSURL, options: WatermarkOptions`	`int`	Error code index
`addVideoWatermarkWithConfig:`	`config: WatermarkConfig*`	`int`	Error code index
`adjustAudioMixingPlayoutVolume:`	`volume: NSInteger`	`int`	Error code index
`adjustAudioMixingPublishVolume:`	`volume: NSInteger`	`int`	Error code index
`adjustAudioMixingVolume:`	`volume: NSInteger`	`int`	Error code index
`adjustCustomAudioPlayoutVolume:volume:`	`trackId: NSInteger, volume: NSInteger`	`int`	Error code index
`adjustCustomAudioPublishVolume:volume:`	`trackId: NSInteger, volume: NSInteger`	`int`	Error code index
`adjustLoopbackSignalVolume:`	`volume: NSInteger`	`int`	Error code index
`adjustPlaybackSignalVolume:`	`volume: NSInteger`	`int`	Error code index
`adjustRecordingSignalVolume:`	`volume: NSInteger`	`int`	Error code index
`adjustUserPlaybackSignalVolume:volume:`	`uid: NSUInteger, volume: int`	`int`	Error code index
`clearVideoWatermarks`	—	`int`	Error code index
`complain:description:`	`callId: NSString, description?: NSString`	`int`	Error code index
`configRhythmPlayer:`	`config?: AgoraRhythmPlayerConfig*`	`int`	Error code index
`createCustomAudioTrack:config:`	`trackType: AgoraAudioTrackType, config: AgoraAudioTrackConfig*`	`int`	Error code index
`createCustomVideoTrack`	—	`unsigned int`	Error code index
`createDataStream:config:`	`streamId: NSInteger, config: AgoraDataStreamConfig`	`int`	Error code index
`createDataStream:reliable:ordered:`	`streamId: NSInteger*, reliable: BOOL, ordered: BOOL`	`int`	Error code index
`createMediaPlayerWithDelegate:`	`delegate?: id`	`id`	Error code index
`createMediaRecorder:`	`info: AgoraRecorderStreamInfo*`	`AgoraMediaRecorder*`	Error code index
`createVideoEffectObjectWithBundlePath:sourceType:`	`bundlePath: NSString*, sourceType: AgoraMediaSourceType`	`id`	Error code index
`delegate`	—	`unknown`	Error code index
`destroy`	—	`void`	Error code index
`destroy:`	`engineReleasedBlock?: void (^ )(void)`	`void`	Error code index
`destroyCustomAudioTrack:`	`trackId: NSInteger`	`int`	Error code index
`destroyCustomVideoTrack:`	`videoTrackId: NSUInteger`	`int`	Error code index
`destroyMediaPlayer:`	`mediaPlayer?: id`	`int`	Error code index
`destroyMediaRecorder:`	`mediaRecorder?: AgoraMediaRecorder*`	`int`	Error code index
`destroyVideoEffectObject:`	`videoEffectObject?: id`	`int`	Error code index
`disableAudio`	—	`int`	Error code index
`disableAudioSpectrumMonitor`	—	`int`	Error code index
`disableVideo`	—	`int`	Error code index
`enableAudio`	—	`int`	Error code index
`enableAudioSpectrumMonitor:`	`intervalInMS: int`	`int`	Error code index
`enableAudioVolumeIndication:smooth:reportVad:`	`interval: NSInteger, smooth: NSInteger, reportVad: BOOL`	`int`	Error code index
`enableCameraCenterStage:`	`enabled: BOOL`	`int`	Error code index
`enableContentInspect:config:`	`enabled: BOOL, config: AgoraContentInspectConfig*`	`int`	Error code index
`enableCustomAudioLocalPlayback:enabled:`	`trackId: NSInteger, enabled: BOOL`	`int`	Error code index
`enableDualStreamMode:`	`enabled: BOOL`	`int`	Error code index
`enableDualStreamMode:streamConfig:`	`enabled: BOOL, streamConfig: AgoraSimulcastStreamConfig*`	`int`	Error code index
`enableEncryption:encryptionConfig:`	`enabled: BOOL, config: AgoraEncryptionConfig*`	`int`	Error code index
`enableExtensionWithVendor:extension:enabled:sourceType:`	`provider: NSString, extension: NSString, enabled: BOOL, sourceType: AgoraMediaSourceType`	`int`	Error code index
`enableExternalAudioSink:sampleRate:channels:`	`enabled: BOOL, sampleRate: NSUInteger, channels: NSUInteger`	`void`	Error code index
`enableInEarMonitoring:`	`enabled: BOOL`	`int`	Error code index
`enableInEarMonitoring:includeAudioFilters:`	`enabled: BOOL, includeAudioFilters: AgoraEarMonitoringFilterType`	`int`	Error code index
`enableInstantMediaRendering`	—	`int`	Error code index
`enableLocalAudio:`	`enabled: BOOL`	`int`	Error code index
`enableLocalVideo:`	`enabled: BOOL`	`int`	Error code index
`enableLoopbackRecording:deviceName:`	`enabled: BOOL, deviceName?: NSString*`	`int`	Error code index
`enableMainQueueDispatch:`	`enabled: BOOL`	`int`	Error code index
`enableSoundPositionIndication:`	`enabled: BOOL`	`int`	Error code index
`enableSpatialAudio:`	`enabled: BOOL`	`int`	Error code index
`enableVideo`	—	`int`	Error code index
`enableVideoImageSource:options:`	`enable: BOOL, options?: AgoraImageTrackOptions*`	`int`	Error code index
`enableVirtualBackground:backData:segData:`	`enable: BOOL, backData?: AgoraVirtualBackgroundSource, segData?: AgoraSegmentationProperty`	`int`	Error code index
`enableVirtualBackground:backData:segData:sourceType:`	`enable: BOOL, backData?: AgoraVirtualBackgroundSource, segData?: AgoraSegmentationProperty, sourceType: AgoraMediaSourceType`	`int`	Error code index
`enableVoiceAITuner:type:`	`enabled: BOOL, type: AgoraVoiceAITunerType`	`int`	Error code index
`enableWebSdkInteroperability:`	`enabled: BOOL`	`int`	Error code index
`enumerateDevices:`	`type: AgoraMediaDeviceType`	`NSArray*`	Error code index
`followSystemPlaybackDevice:`	`enable: BOOL`	`int`	Error code index
`followSystemRecordingDevice:`	`enable: BOOL`	`int`	Error code index
`getAudioMixingCurrentPosition`	—	`int`	Error code index
`getAudioMixingDuration`	—	`int`	Error code index
`getAudioMixingPlayoutVolume`	—	`int`	Error code index
`getAudioMixingPublishVolume`	—	`int`	Error code index
`getAudioTrackCount`	—	`int`	Error code index
`getCallId`	—	`NSString*`	Error code index
`getConnectionState`	—	`AgoraConnectionState`	Error code index
`getCurrentMonotonicTimeInMs`	—	`int64_t`	Error code index
`getDefaultAudioDevice:`	`type: AgoraMediaDeviceType`	`AgoraRtcDeviceInfo*`	Error code index
`getDeviceInfo:`	`type: AgoraMediaDeviceType`	`AgoraRtcDeviceInfo*`	Error code index
`getDeviceVolume:`	`type: AgoraMediaDeviceType`	`int`	Error code index
`getEffectCurrentPosition:`	`soundId: int`	`int`	Error code index
`getEffectDuration:`	`filePath: NSString*`	`int`	Error code index
`getEffectsVolume`	—	`int`	Error code index
`getErrorDescription:`	`error: NSInteger`	`NSString*`	Error code index
`getExtensionPropertyWithVendor:extension:key:`	`provider: NSString, extension: NSString, key: NSString*`	`NSString*`	Error code index
`getExtensionPropertyWithVendor:extension:key:sourceType:`	`provider: NSString, extension: NSString, key: NSString*, sourceType: AgoraMediaSourceType`	`NSString*`	Error code index
`getFaceShapeAreaOptions:`	`area: AgoraFaceShapeArea`	`AgoraFaceShapeAreaOptions*`	Error code index
`getFaceShapeAreaOptions:sourceType:`	`area: AgoraFaceShapeArea, sourceType: AgoraMediaSourceType`	`AgoraFaceShapeAreaOptions*`	Error code index
`getFaceShapeBeautyOptions`	—	`AgoraFaceShapeBeautyOptions*`	Error code index
`getFaceShapeBeautyOptions:`	`sourceType: AgoraMediaSourceType`	`AgoraFaceShapeBeautyOptions*`	Error code index
`getNativeHandle`	—	`void*`	Error code index
`getNetworkType`	—	`int`	Error code index
`getNtpWallTimeInMs`	—	`uint64_t`	Error code index
`getScreenCaptureSourcesWithThumbSize:iconSize:includeScreen:`	`thumbSize: NSSize, iconSize: NSSize, includeScreen: BOOL`	`NSArray*`	Error code index
`getSdkVersion`	—	`NSString*`	Error code index
`getUserInfoByUid:withError:`	`uid: NSUInteger, error?: AgoraErrorCode*`	`AgoraUserInfo*`	Error code index
`getUserInfoByUserAccount:withError:`	`userAccount: NSString, error?: AgoraErrorCode`	`AgoraUserInfo*`	Error code index
`getVolumeOfEffect:`	`soundId: int`	`int`	Error code index
`isCameraCenterStageSupported`	—	`BOOL`	Error code index
`isFeatureAvailableOnDevice:`	`type: AgoraFeatureType`	`BOOL`	Error code index
`joinChannelByToken:channelId:info:uid:joinSuccess:`	`token?: NSString, channelId: NSString, info?: NSString, uid: NSUInteger, joinSuccessBlock?: void(^ )(NSStringchannel,NSUInteger uid,NSInteger elapsed)`	`int`	Error code index
`joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:`	`token?: NSString, channelId: NSString, uid: NSUInteger, mediaOptions: AgoraRtcChannelMediaOptions, joinSuccessBlock?: void(^ )(NSStringchannel,NSUInteger uid,NSInteger elapsed)`	`int`	Error code index
`joinChannelByToken:channelId:userAccount:joinSuccess:`	`token?: NSString, channelId: NSString, userAccount: NSString, joinSuccessBlock?: void(^ )(NSStringchannel,NSUInteger uid,NSInteger elapsed)`	`int`	Error code index
`joinChannelByToken:channelId:userAccount:mediaOptions:joinSuccess:`	`token?: NSString, channelId: NSString, userAccount: NSString, mediaOptions: AgoraRtcChannelMediaOptions, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)`	`int`	Error code index
`leaveChannel:`	`leaveChannelBlock?: void(^ )(AgoraChannelStats*stat)`	`int`	Error code index
`leaveChannel:leaveChannelBlock:`	`options: unknown, leaveChannelBlock: unknown`	`unknown`	Error code index
`monitorDeviceChange:`	`enabled: BOOL`	`void`	Error code index
`muteAllRemoteAudioStreams:`	`mute: BOOL`	`int`	Error code index
`muteAllRemoteVideoStreams:`	`mute: BOOL`	`int`	Error code index
`muteLocalAudioStream:`	`mute: BOOL`	`int`	Error code index
`muteLocalVideoStream:`	`mute: BOOL`	`int`	Error code index
`muteRecordingSignal:`	`muted: BOOL`	`int`	Error code index
`muteRemoteAudioStream:mute:`	`uid: NSUInteger, mute: BOOL`	`int`	Error code index
`muteRemoteVideoStream:mute:`	`uid: NSUInteger, mute: BOOL`	`int`	Error code index
`pauseAllChannelMediaRelay`	—	`int`	Error code index
`pauseAllEffects`	—	`int`	Error code index
`pauseAudioMixing`	—	`int`	Error code index
`pauseEffect:`	`soundId: int`	`int`	Error code index
`playAllEffectsWithLoopCount:pitch:pan:gain:publish:`	`loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL`	`int`	Error code index
`playEffect:filePath:loopCount:pitch:pan:gain:`	`soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger`	`int`	Error code index
`playEffect:filePath:loopCount:pitch:pan:gain:publish:`	`soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL`	`int`	Error code index
`playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:`	`soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL, startPos: int`	`int`	Error code index
`preloadChannelByToken:channelId:uid:`	`token?: NSString, channelId: NSString, uid: NSUInteger`	`int`	Error code index
`preloadChannelByTokenWithUserAccount:channelId:userAccount:`	`token?: NSString, channelId: NSString, userAccount: NSString*`	`int`	Error code index
`preloadEffect:filePath:`	`soundId: int, filePath: NSString*`	`int`	Error code index
`preloadEffect:filePath:startPos:`	`soundId: int, filePath: NSString*, startPos: int`	`int`	Error code index
`pullPlaybackAudioFrameRawData:lengthInByte:`	`data: void*, lengthInByte: NSUInteger`	`BOOL`	Error code index
`pullPlaybackAudioFrameSampleBufferByLengthInByte:`	`lengthInByte: NSUInteger`	`CMSampleBufferRef`	Error code index
`pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:`	`data: void*, samples: NSInteger, sampleRate: NSInteger, channels: NSInteger, trackId: NSInteger, timestamp: NSTimeInterval`	`int`	Error code index
`pushExternalAudioFrameSampleBuffer:`	`sampleBuffer: CMSampleBufferRef`	`int`	Error code index
`pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:`	`sampleBuffer: CMSampleBufferRef, sampleRate: NSInteger, channels: NSInteger, trackId: NSInteger`	`int`	Error code index
`pushExternalVideoFrame:`	`frame: AgoraVideoFrame*`	`BOOL`	Error code index
`pushExternalVideoFrame:videoTrackId:`	`frame: AgoraVideoFrame*, videoTrackId: NSUInteger`	`BOOL`	Error code index
`queryCodecCapability`	—	`NSArray*`	Error code index
`queryDeviceScore`	—	`int`	Error code index
`rate:rating:description:`	`callId: NSString, rating: NSInteger, description?: NSString`	`int`	Error code index
`registerAudioSpectrumDelegate:`	`delegate?: id`	`int`	Error code index
`registerExtensionWithVendor:extension:sourceType:`	`provider: NSString, extension: NSString, sourceType: AgoraMediaSourceType`	`int`	Error code index
`registerLocalUserAccount:appId:`	`userAccount: NSString, appId: NSString`	`int`	Error code index
`removeVideoWatermark:`	`id: NSString*`	`int`	Error code index
`renewToken:`	`token: NSString*`	`int`	Error code index
`resumeAllChannelMediaRelay`	—	`int`	Error code index
`resumeAllEffects`	—	`int`	Error code index
`resumeAudioMixing`	—	`int`	Error code index
`resumeEffect:`	`soundId: int`	`int`	Error code index
`rtcEngine:device:type:stateChanged:`	`engine: AgoraRtcEngineKit, deviceId: NSString, deviceType: AgoraMediaDeviceType, state: NSInteger`	`void`	Error code index
`selectAudioTrack:`	`index: NSInteger`	`int`	Error code index
`sendCustomReportMessage:category:event:label:value:`	`messageId?: NSString, category?: NSString, event?: NSString, label?: NSString, value: NSInteger`	`int`	Error code index
`sendStreamMessage:data:`	`streamId: NSInteger, data: NSData*`	`int`	Error code index
`setAINSMode:mode:`	`enabled: BOOL, mode: AUDIO_AINS_MODE`	`int`	Error code index
`setAVSyncSource:uid:`	`channelId: NSString*, uid: NSUInteger`	`int`	Error code index
`setAdvancedAudioOptions:`	`options: AgoraAdvancedAudioOptions*`	`int`	Error code index
`setAudioEffectParameters:param1:param2:`	`preset: AgoraAudioEffectPreset, param1: int, param2: int`	`int`	Error code index
`setAudioEffectPreset:`	`preset: AgoraAudioEffectPreset`	`int`	Error code index
`setAudioEncodedFrameDelegate:config:`	`delegate?: id, config: AgoraAudioEncodedFrameDelegateConfig*`	`int`	Error code index
`setAudioFrameDelegate:`	`delegate?: id`	`BOOL`	Error code index
`setAudioMixingDualMonoMode:`	`mode: AgoraAudioMixingDualMonoMode`	`int`	Error code index
`setAudioMixingPitch:`	`pitch: NSInteger`	`int`	Error code index
`setAudioMixingPlaybackSpeed:`	`speed: NSInteger`	`int`	Error code index
`setAudioMixingPosition:`	`pos: NSInteger`	`int`	Error code index
`setAudioProfile:`	`profile: AgoraAudioProfile`	`int`	Error code index
`setAudioProfile:scenario:`	`profile: AgoraAudioProfile, scenario: AgoraAudioScenario`	`int`	Error code index
`setAudioScenario:`	`scenario: AgoraAudioScenario`	`int`	Error code index
`setBeautyEffectOptions:options:`	`enable: BOOL, options?: AgoraBeautyOptions*`	`int`	Error code index
`setBeautyEffectOptions:options:sourceType:`	`enable: BOOL, options?: AgoraBeautyOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setCameraCapturerConfiguration:`	`config?: AgoraCameraCapturerConfiguration*`	`int`	Error code index
`setChannelProfile:`	`profile: AgoraChannelProfile`	`int`	Error code index
`setClientRole:`	`role: AgoraClientRole`	`int`	Error code index
`setClientRole:options:`	`role: AgoraClientRole, options?: AgoraClientRoleOptions*`	`int`	Error code index
`setCloudProxy:`	`proxyType: AgoraCloudProxyType`	`int`	Error code index
`setColorEnhanceOptions:options:`	`enable: BOOL, options?: AgoraColorEnhanceOptions*`	`int`	Error code index
`setColorEnhanceOptions:options:sourceType:`	`enable: BOOL, options?: AgoraColorEnhanceOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setDevice:deviceId:`	`type: AgoraMediaDeviceType, deviceId: NSString*`	`int`	Error code index
`setDeviceVolume:volume:`	`type: AgoraMediaDeviceType, volume: int`	`int`	Error code index
`setDualStreamMode:`	`mode: AgoraSimulcastStreamMode`	`int`	Error code index
`setDualStreamMode:streamConfig:`	`mode: AgoraSimulcastStreamMode, streamConfig: AgoraSimulcastStreamConfig*`	`int`	Error code index
`setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:`	`sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSInteger`	`int`	Error code index
`setEffectPosition:pos:`	`soundId: int, pos: NSInteger`	`int`	Error code index
`setEffectsVolume:`	`volume: NSInteger`	`int`	Error code index
`setEncodedVideoFrameDelegate:`	`delegate?: id`	`BOOL`	Error code index
`setExtensionPropertyWithVendor:extension:key:value:`	`provider: NSString, extension: NSString, key: NSString, value: NSString`	`int`	Error code index
`setExtensionProviderPropertyWithVendor:key:value:`	`provider: NSString, key: NSString, value: NSString*`	`int`	Error code index
`setExternalAudioSource:sampleRate:channels:`	`enabled: BOOL, sampleRate: NSInteger, channels: NSInteger`	`int`	Error code index
`setExternalAudioSource:sampleRate:channels:localPlayback:publish:`	`enabled: BOOL, sampleRate: NSInteger, channels: NSInteger, localPlayback: BOOL, publish: BOOL`	`int`	Error code index
`setExternalVideoSource:useTexture:sourceType:`	`enable: BOOL, useTexture: BOOL, sourceType: AgoraExternalVideoSourceType`	`void`	Error code index
`setFaceShapeAreaOptions:`	`options?: AgoraFaceShapeAreaOptions*`	`int`	Error code index
`setFaceShapeAreaOptions:sourceType:`	`options?: AgoraFaceShapeAreaOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setFaceShapeBeautyOptions:options:`	`enable: BOOL, options?: AgoraFaceShapeBeautyOptions*`	`int`	Error code index
`setFaceShapeBeautyOptions:options:sourceType:`	`enable: BOOL, options?: AgoraFaceShapeBeautyOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setFilterEffectOptions:options:`	`enable: BOOL, options?: AgoraFilterEffectOptions*`	`int`	Error code index
`setFilterEffectOptions:options:sourceType:`	`enable: BOOL, options?: AgoraFilterEffectOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setHeadphoneEQParameters:highGain:`	`lowGain: int, highGain: int`	`int`	Error code index
`setHeadphoneEQPreset:`	`preset: AgoraHeadphoneEQPreset`	`int`	Error code index
`setInEarMonitoringVolume:`	`volume: NSInteger`	`int`	Error code index
`setLocalAccessPoint:`	`config: AgoraLocalAccessPointConfiguration*`	`int`	Error code index
`setLocalRenderMode:mirror:`	`mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorMode`	`int`	Error code index
`setLocalRenderMode:mode:`	`uid: NSUInteger, mode: AgoraVideoRenderMode`	`int`	Error code index
`setLocalRenderTargetFps:targetFps:`	`sourceType: AgoraVideoSourceType, targetFps: int`	`int`	Error code index
`setLocalVideoMirrorMode:`	`mode: AgoraVideoMirrorMode`	`int`	Error code index
`setLocalVoiceEqualizationOfBandFrequency:withGain:`	`bandFrequency: AgoraAudioEqualizationBandFrequency, gain: NSInteger`	`int`	Error code index
`setLocalVoiceFormant:`	`formantRatio: double`	`int`	Error code index
`setLocalVoicePitch:`	`pitch: double`	`int`	Error code index
`setLocalVoiceReverbOfType:withValue:`	`reverbType: AgoraAudioReverbType, value: NSInteger`	`int`	Error code index
`setLogFile:`	`filePath: NSString*`	`int`	Error code index
`setLogFileSize:`	`fileSizeInKBytes: NSUInteger`	`int`	Error code index
`setLogFilter:`	`filter: NSUInteger`	`int`	Error code index
`setLogLevel:`	`level: AgoraLogLevel`	`int`	Error code index
`setLowlightEnhanceOptions:options:`	`enable: BOOL, options?: AgoraLowlightEnhanceOptions*`	`int`	Error code index
`setLowlightEnhanceOptions:options:sourceType:`	`enable: BOOL, options?: AgoraLowlightEnhanceOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setMediaMetadataDataSource:withType:`	`metadataDataSource?: id, type: AgoraMetadataType`	`BOOL`	Error code index
`setMediaMetadataDelegate:withType:`	`metadataDelegate?: id, type: AgoraMetadataType`	`BOOL`	Error code index
`setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:`	`sampleRate: NSInteger, channel: NSInteger, samplesPerCall: NSInteger`	`int`	Error code index
`setParameters:`	`options: NSString*`	`int`	Error code index
`setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:`	`sampleRate: NSInteger, channel: NSInteger`	`int`	Error code index
`setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:samplesPerCall:`	`sampleRate: NSInteger, channel: NSInteger, samplesPerCall: NSInteger`	`int`	Error code index
`setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:`	`sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSInteger`	`int`	Error code index
`setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:`	`sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSInteger`	`int`	Error code index
`setRemoteDefaultVideoStreamType:`	`streamType: AgoraVideoStreamType`	`int`	Error code index
`setRemoteRenderMode:mode:mirror:`	`uid: NSUInteger, mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorMode`	`int`	Error code index
`setRemoteRenderTargetFps:`	`targetFps: int`	`int`	Error code index
`setRemoteSubscribeFallbackOption:`	`option: AgoraStreamFallbackOptions`	`int`	Error code index
`setRemoteUserSpatialAudioParams:params:`	`uid: NSUInteger, params: AgoraSpatialAudioParams*`	`int`	Error code index
`setRemoteVideoStream:type:`	`uid: NSUInteger, streamType: AgoraVideoStreamType`	`int`	Error code index
`setRemoteVideoSubscriptionOptions:options:`	`uid: NSUInteger, options: AgoraVideoSubscriptionOptions*`	`int`	Error code index
`setRemoteVoicePosition:pan:gain:`	`uid: NSUInteger, pan: double, gain: double`	`int`	Error code index
`setScreenCaptureScenario:`	`scenarioType: AgoraScreenScenarioType`	`int`	Error code index
`setSubscribeAudioAllowlist:`	`allowlist: NSArray*`	`int`	Error code index
`setSubscribeAudioBlocklist:`	`blocklist: NSArray*`	`int`	Error code index
`setSubscribeVideoAllowlist:`	`allowlist: NSArray*`	`int`	Error code index
`setSubscribeVideoBlocklist:`	`blocklist: NSArray*`	`int`	Error code index
`setVideoDenoiserOptions:options:`	`enable: BOOL, options?: AgoraVideoDenoiserOptions*`	`int`	Error code index
`setVideoDenoiserOptions:options:sourceType:`	`enable: BOOL, options?: AgoraVideoDenoiserOptions*, sourceType: AgoraMediaSourceType`	`int`	Error code index
`setVideoEncoderConfiguration:`	`config: AgoraVideoEncoderConfiguration*`	`int`	Error code index
`setVideoFrameDelegate:`	`delegate?: id`	`BOOL`	Error code index
`setVideoResolution:andFrameRate:bitrate:`	`size: CGSize, frameRate: NSInteger, bitrate: NSInteger`	`int`	Error code index
`setVideoScenario:`	`scenarioType: AgoraApplicationScenarioType`	`int`	Error code index
`setVoiceBeautifierParameters:param1:param2:`	`preset: AgoraVoiceBeautifierPreset, param1: int, param2: int`	`int`	Error code index
`setVoiceBeautifierPreset:`	`preset: AgoraVoiceBeautifierPreset`	`int`	Error code index
`setVoiceConversionPreset:`	`preset: AgoraVoiceConversionPreset`	`int`	Error code index
`setVolumeOfEffect:withVolume:`	`soundId: int, volume: int`	`int`	Error code index
`setupLocalVideo:`	`local?: AgoraRtcVideoCanvas*`	`int`	Error code index
`setupRemoteVideo:`	`remote: AgoraRtcVideoCanvas*`	`int`	Error code index
`sharedEngineWithAppId:delegate:`	`appId: NSString*, delegate?: id`	`instancetype`	Error code index
`sharedEngineWithConfig:delegate:`	`config: AgoraRtcEngineConfig*, delegate?: id`	`instancetype`	Error code index
`startAudioDeviceLoopbackTest:`	`indicationInterval: int`	`int`	Error code index
`startAudioMixing:loopback:cycle:`	`filePath: NSString*, loopback: BOOL, cycle: NSInteger`	`int`	Error code index
`startAudioMixing:loopback:cycle:startPos:`	`filePath: NSString*, loopback: BOOL, cycle: NSInteger, startPos: NSInteger`	`int`	Error code index
`startAudioRecording:quality:`	`filePath: NSString*, quality: AgoraAudioRecordingQuality`	`int`	Error code index
`startAudioRecordingWithConfig:`	`config: AgoraAudioRecordingConfiguration*`	`int`	Error code index
`startCameraCapture:config:`	`sourceType: AgoraVideoSourceType, config?: AgoraCameraCapturerConfiguration*`	`int`	Error code index
`startEchoTestWithConfig:`	`config: AgoraEchoTestConfiguration*`	`int`	Error code index
`startLastmileProbeTest:`	`config?: AgoraLastmileProbeConfig*`	`int`	Error code index
`startLocalAudioMixer:`	`config: AgoraLocalAudioMixerConfiguration*`	`int`	Error code index
`startLocalVideoTranscoder:`	`config: AgoraLocalTranscoderConfiguration*`	`int`	Error code index
`startMediaRenderingTracing`	—	`int`	Error code index
`startOrUpdateChannelMediaRelay:`	`config: AgoraChannelMediaRelayConfiguration*`	`int`	Error code index
`startPlaybackDeviceTest:`	`audioFileName: NSString*`	`int`	Error code index
`startPreview`	—	`int`	Error code index
`startPreview:`	`sourceType: AgoraVideoSourceType`	`int`	Error code index
`startRecordingDeviceTest:`	`indicationInterval: int`	`int`	Error code index
`startRhythmPlayer:sound2:config:`	`sound1: NSString, sound2: NSString, config?: AgoraRhythmPlayerConfig*`	`int`	Error code index
`startRtmpStreamWithTranscoding:transcoding:`	`url: NSString, transcoding?: AgoraLiveTranscoding`	`int`	Error code index
`startRtmpStreamWithoutTranscoding:`	`url: NSString*`	`int`	Error code index
`startScreenCapture:config:`	`sourceType: AgoraVideoSourceType, config?: AgoraScreenCaptureConfiguration*`	`int`	Error code index
`startScreenCaptureByDisplayId:regionRect:captureParams:`	`displayId: UInt32, regionRect: CGRect, captureParams: AgoraScreenCaptureParameters*`	`int`	Error code index
`startScreenCaptureByWindowId:regionRect:captureParams:`	`windowId: UInt32, regionRect: CGRect, captureParams: AgoraScreenCaptureParameters*`	`int`	Error code index
`stopAllEffects`	—	`int`	Error code index
`stopAudioDeviceLoopbackTest`	—	`int`	Error code index
`stopAudioMixing`	—	`int`	Error code index
`stopAudioRecording`	—	`int`	Error code index
`stopCameraCapture:`	`sourceType: AgoraVideoSourceType`	`int`	Error code index
`stopChannelMediaRelay`	—	`int`	Error code index
`stopEchoTest`	—	`int`	Error code index
`stopEffect:`	`soundId: int`	`int`	Error code index
`stopLastmileProbeTest`	—	`int`	Error code index
`stopLocalAudioMixer`	—	`int`	Error code index
`stopLocalVideoTranscoder`	—	`int`	Error code index
`stopPlaybackDeviceTest`	—	`int`	Error code index
`stopPreview`	—	`int`	Error code index
`stopPreview:`	`sourceType: AgoraVideoSourceType`	`int`	Error code index
`stopRecordingDeviceTest`	—	`int`	Error code index
`stopRhythmPlayer`	—	`int`	Error code index
`stopRtmpStream:`	`url: NSString*`	`int`	Error code index
`stopScreenCapture`	—	`int`	Error code index
`stopScreenCapture:`	`sourceType: AgoraVideoSourceType`	`int`	Error code index
`takeSnapshot:filePath:`	`uid: NSInteger, filePath: NSString*`	`NSInteger`	Error code index
`takeSnapshotWithConfig:config:`	`uid: NSInteger, config: AgoraSnapshotConfig*`	`NSInteger`	Error code index
`unloadEffect:`	`soundId: int`	`int`	Error code index
`unregisterAudioSpectrumDelegate:`	`delegate?: id`	`int`	Error code index
`updateChannelWithMediaOptions:`	`mediaOptions: AgoraRtcChannelMediaOptions*`	`int`	Error code index
`updateLocalAudioMixerConfiguration:`	`config: AgoraLocalAudioMixerConfiguration*`	`int`	Error code index
`updateLocalTranscoderConfiguration:`	`config: AgoraLocalTranscoderConfiguration*`	`int`	Error code index
`updatePreloadChannelToken:`	`token: NSString*`	`int`	Error code index
`updateRtmpTranscoding:`	`transcoding?: AgoraLiveTranscoding*`	`int`	Error code index
`updateScreenCaptureParameters:`	`captureParams: AgoraScreenCaptureParameters*`	`int`	Error code index
`updateScreenCaptureRegion:`	`rect: CGRect`	`int`	Error code index

AgoraRtcLocalAudioStats 0 method / 9 Property

Property	Type	read-only
`numChannels`	`NSUInteger`	No
`sentSampleRate`	`NSUInteger`	No
`sentBitrate`	`NSUInteger`	No
`internalCodec`	`NSUInteger`	No
`txPacketLossRate`	`NSUInteger`	No
`audioDeviceDelay`	`NSUInteger`	No
`audioPlayoutDelay`	`NSUInteger`	No
`earMonitorDelay`	`NSUInteger`	No
`aecEstimatedDelay`	`NSUInteger`	No

AgoraRtcLocalVideoStats 0 method / 23 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`sentBitrate`	`NSUInteger`	No
`sentFrameRate`	`NSUInteger`	No
`captureFrameRate`	`NSInteger`	No
`captureFrameWidth`	`NSInteger`	No
`captureFrameHeight`	`NSInteger`	No
`regulatedCaptureFrameRate`	`NSInteger`	No
`regulatedCaptureFrameWidth`	`NSInteger`	No
`regulatedCaptureFrameHeight`	`NSInteger`	No
`encoderOutputFrameRate`	`NSInteger`	No
`rendererOutputFrameRate`	`NSInteger`	No
`targetFrameRate`	`NSInteger`	No
`qualityAdaptIndication`	`AgoraVideoQualityAdaptIndication`	No
`targetBitrate`	`NSInteger`	No
`encodedBitrate`	`NSInteger`	No
`encodedFrameWidth`	`NSInteger`	No
`encodedFrameHeight`	`NSInteger`	No
`encodedFrameCount`	`NSInteger`	No
`codecType`	`AgoraVideoCodecType`	No
`hwEncoderAccelerating`	`AgoraVideoHwEncoderAccelerating`	No
`txPacketLossRate`	`NSInteger`	No
`captureBrightnessLevel`	`AgoraCaptureBrightnessLevelType`	No
`dualStreamEnabled`	`BOOL`	No

AgoraRtcMediaPlayerAudioFrameDelegate 1 method / 0 Property

typescript

AgoraRtcMediaPlayer:didReceiveAudioFrame:(playerKit: id, audioFrame: AgoraAudioFrame*): void

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

Method	Parameters	Returns	Errors
`AgoraRtcMediaPlayer:didReceiveAudioFrame:`	`playerKit: id, audioFrame: AgoraAudioFrame*`	`void`	Error code index

AgoraRtcMediaPlayerCacheManagerProtocol 13 method / 0 Property

typescript

cacheDir(): NSString*
cacheFileCount(): NSInteger
createMediaPlayerCacheManager(): id
enableAutoRemoveCache:(enable: BOOL): int
maxCacheFileCount(): NSInteger
maxCacheFileSize(): NSInteger
removeAllCaches(): int
removeCacheByUri:(uri: NSString*): int
removeOldCache(): int
setCacheDir:(cacheDir: NSString*): int
setMaxCacheFileCount:(count: NSInteger): int
setMaxCacheFileSize:(cacheSize: NSInteger): int
sharedInstance(): instancetype

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

Method	Parameters	Returns	Errors
`cacheDir`	—	`NSString*`	Error code index
`cacheFileCount`	—	`NSInteger`	Error code index
`createMediaPlayerCacheManager`	—	`id`	Error code index
`enableAutoRemoveCache:`	`enable: BOOL`	`int`	Error code index
`maxCacheFileCount`	—	`NSInteger`	Error code index
`maxCacheFileSize`	—	`NSInteger`	Error code index
`removeAllCaches`	—	`int`	Error code index
`removeCacheByUri:`	`uri: NSString*`	`int`	Error code index
`removeOldCache`	—	`int`	Error code index
`setCacheDir:`	`cacheDir: NSString*`	`int`	Error code index
`setMaxCacheFileCount:`	`count: NSInteger`	`int`	Error code index
`setMaxCacheFileSize:`	`cacheSize: NSInteger`	`int`	Error code index
`sharedInstance`	—	`instancetype`	Error code index

AgoraRtcMediaPlayerDelegate 11 method / 0 Property

typescript

AgoraRtcMediaPlayer:cacheStats:(playerKit: id, info: AgoraMediaPlayerCacheStatistics*): void
AgoraRtcMediaPlayer:didChangedToPosition:atTimestamp:(playerKit: id, positionMs: NSInteger, timestampMs: NSTimeInterval): void
AgoraRtcMediaPlayer:didChangedToState:reason:(playerKit: id, state: AgoraMediaPlayerState, reason: AgoraMediaPlayerReason): void
AgoraRtcMediaPlayer:didOccurEvent:elapsedTime:message:(playerKit: id, eventCode: AgoraMediaPlayerEvent, elapsedTime: NSInteger, message?: NSString*): void
AgoraRtcMediaPlayer:didPlayBufferUpdated:(playerKit: id, playCachedBuffer: NSInteger): void
AgoraRtcMediaPlayer:didPreloadEvent:(playerKit: id, event: AgoraMediaPlayerPreloadEvent): void
AgoraRtcMediaPlayer:didReceiveData:length:(playerKit: id, data?: NSString*, length: NSInteger): void
AgoraRtcMediaPlayer:infoUpdated:(playerKit: id, info: AgoraMediaPlayerUpdatedInfo*): void
AgoraRtcMediaPlayer:playbackStats:(playerKit: id, info: AgoraMediaPlayerPlaybackStats*): void
AgoraRtcMediaPlayer:playerSrcInfoDidChange:from:(playerKit: id, to: AgoraMediaPlayerSrcInfo*, from: AgoraMediaPlayerSrcInfo*): void
AgoraRtcMediaPlayer:volumeIndicationDidReceive:(playerKit: id, volume: NSInteger): void

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

Method	Parameters	Returns	Errors
`AgoraRtcMediaPlayer:cacheStats:`	`playerKit: id, info: AgoraMediaPlayerCacheStatistics*`	`void`	Error code index
`AgoraRtcMediaPlayer:didChangedToPosition:atTimestamp:`	`playerKit: id, positionMs: NSInteger, timestampMs: NSTimeInterval`	`void`	Error code index
`AgoraRtcMediaPlayer:didChangedToState:reason:`	`playerKit: id, state: AgoraMediaPlayerState, reason: AgoraMediaPlayerReason`	`void`	Error code index
`AgoraRtcMediaPlayer:didOccurEvent:elapsedTime:message:`	`playerKit: id, eventCode: AgoraMediaPlayerEvent, elapsedTime: NSInteger, message?: NSString*`	`void`	Error code index
`AgoraRtcMediaPlayer:didPlayBufferUpdated:`	`playerKit: id, playCachedBuffer: NSInteger`	`void`	Error code index
`AgoraRtcMediaPlayer:didPreloadEvent:`	`playerKit: id, event: AgoraMediaPlayerPreloadEvent`	`void`	Error code index
`AgoraRtcMediaPlayer:didReceiveData:length:`	`playerKit: id, data?: NSString*, length: NSInteger`	`void`	Error code index
`AgoraRtcMediaPlayer:infoUpdated:`	`playerKit: id, info: AgoraMediaPlayerUpdatedInfo*`	`void`	Error code index
`AgoraRtcMediaPlayer:playbackStats:`	`playerKit: id, info: AgoraMediaPlayerPlaybackStats*`	`void`	Error code index
`AgoraRtcMediaPlayer:playerSrcInfoDidChange:from:`	`playerKit: id, to: AgoraMediaPlayerSrcInfo, from: AgoraMediaPlayerSrcInfo`	`void`	Error code index
`AgoraRtcMediaPlayer:volumeIndicationDidReceive:`	`playerKit: id, volume: NSInteger`	`void`	Error code index

AgoraRtcMediaPlayerProtocol 36 method / 0 Property

typescript

adjustPlayoutVolume:(volume: int): int
adjustPublishSignalVolume:(volume: int): int
getDuration(): NSInteger
getMediaPlayerId(): int
getMute(): BOOL
getPlaySrc(): NSString*
getPlayerState(): AgoraMediaPlayerState
getPlayoutVolume(): int
getPosition(): NSInteger
getPublishSignalVolume(): int
getStreamByIndex:(index: int): AgoraRtcMediaStreamInfo*
getStreamCount(): NSInteger
mute:(isMute: BOOL): int
open:startPos:(url: NSString*, startPos: NSInteger): int
openWithMediaSource:(source: AgoraMediaSource*): int
pause(): int
play(): int
playPreloadedSrc:(src: NSString*): int
preloadSrc:startPos:(src: NSString*, startPos: int): int
resume(): int
seekToPosition:(position: NSInteger): int
selectAudioTrack:(index: int): int
selectMultiAudioTrack:publishTrackIndex:(playoutTrackIndex: NSInteger, publishTrackIndex: NSInteger): int
setAudioDualMonoMode:(mode: AgoraAudioDualMonoMode): int
setAudioPitch:(pitch: NSInteger): int
setLoopCount:(loopCount: int): int
setPlaybackSpeed:(speed: int): int
setPlayerOption:value:(key: NSString*, value: NSInteger): int
setPlayerOptionString:value:(key: NSString*, value: NSString*): int
setRenderMode:(mode: AgoraMediaPlayerRenderMode): int
setSpatialAudioParams:(params: AgoraSpatialAudioParams*): int
setVideoFrameDelegate:(delegate?: id): BOOL
setView:(view?: View*): int
stop:(): unknown
switchSrc:syncPts:(src: NSString*, syncPts: BOOL): int
unloadSrc:(src: NSString*): int

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

Method	Parameters	Returns	Errors
`adjustPlayoutVolume:`	`volume: int`	`int`	Error code index
`adjustPublishSignalVolume:`	`volume: int`	`int`	Error code index
`getDuration`	—	`NSInteger`	Error code index
`getMediaPlayerId`	—	`int`	Error code index
`getMute`	—	`BOOL`	Error code index
`getPlaySrc`	—	`NSString*`	Error code index
`getPlayerState`	—	`AgoraMediaPlayerState`	Error code index
`getPlayoutVolume`	—	`int`	Error code index
`getPosition`	—	`NSInteger`	Error code index
`getPublishSignalVolume`	—	`int`	Error code index
`getStreamByIndex:`	`index: int`	`AgoraRtcMediaStreamInfo*`	Error code index
`getStreamCount`	—	`NSInteger`	Error code index
`mute:`	`isMute: BOOL`	`int`	Error code index
`open:startPos:`	`url: NSString*, startPos: NSInteger`	`int`	Error code index
`openWithMediaSource:`	`source: AgoraMediaSource*`	`int`	Error code index
`pause`	—	`int`	Error code index
`play`	—	`int`	Error code index
`playPreloadedSrc:`	`src: NSString*`	`int`	Error code index
`preloadSrc:startPos:`	`src: NSString*, startPos: int`	`int`	Error code index
`resume`	—	`int`	Error code index
`seekToPosition:`	`position: NSInteger`	`int`	Error code index
`selectAudioTrack:`	`index: int`	`int`	Error code index
`selectMultiAudioTrack:publishTrackIndex:`	`playoutTrackIndex: NSInteger, publishTrackIndex: NSInteger`	`int`	Error code index
`setAudioDualMonoMode:`	`mode: AgoraAudioDualMonoMode`	`int`	Error code index
`setAudioPitch:`	`pitch: NSInteger`	`int`	Error code index
`setLoopCount:`	`loopCount: int`	`int`	Error code index
`setPlaybackSpeed:`	`speed: int`	`int`	Error code index
`setPlayerOption:value:`	`key: NSString*, value: NSInteger`	`int`	Error code index
`setPlayerOptionString:value:`	`key: NSString, value: NSString`	`int`	Error code index
`setRenderMode:`	`mode: AgoraMediaPlayerRenderMode`	`int`	Error code index
`setSpatialAudioParams:`	`params: AgoraSpatialAudioParams*`	`int`	Error code index
`setVideoFrameDelegate:`	`delegate?: id`	`BOOL`	Error code index
`setView:`	`view?: View*`	`int`	Error code index
`stop:`	—	`unknown`	Error code index
`switchSrc:syncPts:`	`src: NSString*, syncPts: BOOL`	`int`	Error code index
`unloadSrc:`	`src: NSString*`	`int`	Error code index

AgoraRtcMediaPlayerVideoFrameDelegate 3 method / 0 Property

typescript

AgoraRtcMediaPlayer:didReceivePixelBuffer:(playerKit: id, pixelBuffer: CVPixelBufferRef): void
AgoraRtcMediaPlayer:didReceiveVideoFrame:(playerKit: id, videoFrame: AgoraOutputVideoFrame*): void
AgoraRtcMediaPlayerGetVideoPixelFormat(): AgoraVideoFormat

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

Method	Parameters	Returns	Errors
`AgoraRtcMediaPlayer:didReceivePixelBuffer:`	`playerKit: id, pixelBuffer: CVPixelBufferRef`	`void`	Error code index
`AgoraRtcMediaPlayer:didReceiveVideoFrame:`	`playerKit: id, videoFrame: AgoraOutputVideoFrame*`	`void`	Error code index
`AgoraRtcMediaPlayerGetVideoPixelFormat`	—	`AgoraVideoFormat`	Error code index

AgoraRtcMediaStreamInfo 0 method / 12 Property

Property	Type	read-only
`streamIndex`	`NSInteger`	No
`streamType`	`AgoraMediaStreamType`	No
`codecName`	`NSString*`	No
`language`	`NSString*`	No
`videoFrameRate`	`NSInteger`	No
`videoBitRate`	`NSInteger`	No
`videoWidth`	`NSInteger`	No
`videoHeight`	`NSInteger`	No
`audioSampleRate`	`NSInteger`	No
`audioChannels`	`NSInteger`	No
`duration`	`NSInteger`	No
`rotation`	`NSInteger`	No

AgoraRtcRemoteAudioStats 0 method / 19 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`quality`	`NSUInteger`	No
`networkTransportDelay`	`NSUInteger`	No
`jitterBufferDelay`	`NSUInteger`	No
`audioLossRate`	`NSUInteger`	No
`numChannels`	`NSUInteger`	No
`receivedSampleRate`	`NSUInteger`	No
`receivedBitrate`	`NSUInteger`	No
`totalFrozenTime`	`NSUInteger`	No
`totalActiveTime`	`NSUInteger`	No
`publishDuration`	`NSInteger`	No
`frozenRate`	`NSUInteger`	No
`mosValue`	`NSUInteger`	No
`frozenRateByCustomPlcCount`	`NSUInteger`	No
`plcCount`	`NSUInteger`	No
`qoeQuality`	`AgoraExperienceQuality`	No
`qualityChangedReason`	`AgoraExperiencePoorReason`	No
`rxAudioBytes`	`NSUInteger`	No
`e2eDelay`	`NSInteger`	No

AgoraRtcRemoteVideoStats 0 method / 18 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`delay`	`NSUInteger`	No
`e2eDelay`	`NSUInteger`	No
`width`	`NSUInteger`	No
`height`	`NSUInteger`	No
`receivedBitrate`	`NSUInteger`	No
`rxStreamType`	`AgoraVideoStreamType`	No
`decoderOutputFrameRate`	`NSInteger`	No
`rendererOutputFrameRate`	`NSInteger`	No
`frameLossRate`	`NSInteger`	No
`packetLossRate`	`NSInteger`	No
`totalFrozenTime`	`NSInteger`	No
`totalActiveTime`	`NSUInteger`	No
`publishDuration`	`NSInteger`	No
`frozenRate`	`NSInteger`	No
`avSyncTimeMs`	`NSInteger`	No
`mosValue`	`NSInteger`	No
`rxVideoBytes`	`NSUInteger`	No

AgoraRtcVideoCanvas 0 method / 12 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`subviewUid`	`NSUInteger`	No
`view`	`VIEW_CLASS*`	No
`renderMode`	`AgoraVideoRenderMode`	No
`mirrorMode`	`AgoraVideoMirrorMode`	No
`setupMode`	`AgoraVideoViewSetupMode`	No
`sourceType`	`AgoraVideoSourceType`	No
`mediaPlayerId`	`int`	No
`cropArea`	`CGRect`	No
`backgroundColor`	`UInt32`	No
`enableAlphaMask`	`BOOL`	No
`position`	`AgoraVideoModulePosition`	No

AgoraRte 6 method / 0 Property

typescript

destroy:(error?: AgoraRteError*): BOOL
getConfigs:error:(config: AgoraRteConfig*, error?: AgoraRteError*): BOOL
getFromBridge:(error?: AgoraRteError*): instancetype
initMediaEngine:error:(cb?: void (^ )(AgoraRteError*err), error?: AgoraRteError*): BOOL
initWithInitialConfig:(config?: AgoraRteInitialConfig*): instancetype
setConfigs:error:(config: AgoraRteConfig*, error?: AgoraRteError*): BOOL

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

Method	Parameters	Returns	Errors
`destroy:`	`error?: AgoraRteError*`	`BOOL`	Error code index
`getConfigs:error:`	`config: AgoraRteConfig, error?: AgoraRteError`	`BOOL`	Error code index
`getFromBridge:`	`error?: AgoraRteError*`	`instancetype`	Error code index
`initMediaEngine:error:`	`cb?: void (^ )(AgoraRteErrorerr), error?: AgoraRteError`	`BOOL`	Error code index
`initWithInitialConfig:`	`config?: AgoraRteInitialConfig*`	`instancetype`	Error code index
`setConfigs:error:`	`config: AgoraRteConfig, error?: AgoraRteError`	`BOOL`	Error code index

AgoraRteCanvas 5 method / 0 Property

typescript

addView:config:error:(view: AgoraRteView*, config?: AgoraRteViewConfig*, error?: AgoraRteError*): BOOL
getConfigs:error:(config: AgoraRteCanvasConfig*, error?: AgoraRteError*): BOOL
initWithRte:initialConfig:(rte: AgoraRte*, config?: AgoraRteCanvasInitialConfig*): instancetype
removeView:config:error:(view: AgoraRteView*, config?: AgoraRteViewConfig*, error?: AgoraRteError*): BOOL
setConfigs:error:(config: AgoraRteCanvasConfig*, error?: AgoraRteError*): BOOL

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

Method	Parameters	Returns	Errors
`addView:config:error:`	`view: AgoraRteView, config?: AgoraRteViewConfig, error?: AgoraRteError*`	`BOOL`	Error code index
`getConfigs:error:`	`config: AgoraRteCanvasConfig, error?: AgoraRteError`	`BOOL`	Error code index
`initWithRte:initialConfig:`	`rte: AgoraRte, config?: AgoraRteCanvasInitialConfig`	`instancetype`	Error code index
`removeView:config:error:`	`view: AgoraRteView, config?: AgoraRteViewConfig, error?: AgoraRteError*`	`BOOL`	Error code index
`setConfigs:error:`	`config: AgoraRteCanvasConfig, error?: AgoraRteError`	`BOOL`	Error code index

AgoraRteCanvasConfig 4 method / 0 Property

typescript

setVideoMirrorMode:error:(mode: AgoraRteVideoMirrorMode, error?: AgoraRteError*): void
setVideoRenderMode:error:(mode: AgoraRteVideoRenderMode, error?: AgoraRteError*): void
videoMirrorMode:(error?: AgoraRteError*): AgoraRteVideoMirrorMode
videoRenderMode:(error?: AgoraRteError*): AgoraRteVideoRenderMode

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

Method	Parameters	Returns	Errors
`setVideoMirrorMode:error:`	`mode: AgoraRteVideoMirrorMode, error?: AgoraRteError*`	`void`	Error code index
`setVideoRenderMode:error:`	`mode: AgoraRteVideoRenderMode, error?: AgoraRteError*`	`void`	Error code index
`videoMirrorMode:`	`error?: AgoraRteError*`	`AgoraRteVideoMirrorMode`	Error code index
`videoRenderMode:`	`error?: AgoraRteError*`	`AgoraRteVideoRenderMode`	Error code index

AgoraRteConfig 4 method / 0 Property

typescript

appId:(error?: AgoraRteError*): NSString*
jsonParameter:(error?: AgoraRteError*): NSString*
setAppId:error:(appId?: NSString*, error?: AgoraRteError*): void
setJsonParameter:error:(jsonParameter?: NSString*, error?: AgoraRteError*): void

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

Method	Parameters	Returns	Errors
`appId:`	`error?: AgoraRteError*`	`NSString*`	Error code index
`jsonParameter:`	`error?: AgoraRteError*`	`NSString*`	Error code index
`setAppId:error:`	`appId?: NSString, error?: AgoraRteError`	`void`	Error code index
`setJsonParameter:error:`	`jsonParameter?: NSString, error?: AgoraRteError`	`void`	Error code index

AgoraRteError 2 method / 0 Property

typescript

code(): AgoraRteErrorCode
message(): NSString*

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

Method	Parameters	Returns	Errors
`code`	—	`AgoraRteErrorCode`	Error code index
`message`	—	`NSString*`	Error code index

AgoraRtePlayer 18 method / 0 Property

typescript

getConfigs:error:(config: AgoraRtePlayerConfig*, error?: AgoraRteError*): BOOL
getInfo:error:(info: AgoraRtePlayerInfo*, error?: AgoraRteError*): BOOL
getPosition:(error?: AgoraRteError*): uint64_t
getStats:(cb?: void (^)(AgoraRtePlayerStats*stats,AgoraRteError*err)): void
initWithRte:initialConfig:(rte: AgoraRte*, config?: AgoraRtePlayerInitialConfig*): instancetype
muteAudio:error:(mute: BOOL, error?: AgoraRteError*): BOOL
muteVideo:error:(mute: BOOL, error?: AgoraRteError*): BOOL
openWithUrl:startTime:cb:(url: NSString*, startTime: uint64_t, cb?: void (^)(AgoraRteError*err)): void
pause:(error?: AgoraRteError*): BOOL
play:(error?: AgoraRteError*): BOOL
preloadWithUrl:error:(url: NSString*, error?: AgoraRteError*): BOOL
registerObserver:error:(observer: AgoraRtePlayerObserver*, error?: AgoraRteError*): BOOL
seek:error:(newTime: uint64_t, error?: AgoraRteError*): BOOL
setCanvas:error:(canvas: AgoraRteCanvas*, error?: AgoraRteError*): BOOL
setConfigs:error:(config: AgoraRtePlayerConfig*, error?: AgoraRteError*): BOOL
stop:(error?: AgoraRteError*): BOOL
switchWithUrl:syncPts:cb:(url: NSString*, syncPts: BOOL, cb?: void (^)(AgoraRteError*err)): void
unregisterObserver:error:(observer?: AgoraRtePlayerObserver*, error?: AgoraRteError*): BOOL

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

Method	Parameters	Returns	Errors
`getConfigs:error:`	`config: AgoraRtePlayerConfig, error?: AgoraRteError`	`BOOL`	Error code index
`getInfo:error:`	`info: AgoraRtePlayerInfo, error?: AgoraRteError`	`BOOL`	Error code index
`getPosition:`	`error?: AgoraRteError*`	`uint64_t`	Error code index
`getStats:`	`cb?: void (^)(AgoraRtePlayerStatsstats,AgoraRteErrorerr)`	`void`	Error code index
`initWithRte:initialConfig:`	`rte: AgoraRte, config?: AgoraRtePlayerInitialConfig`	`instancetype`	Error code index
`muteAudio:error:`	`mute: BOOL, error?: AgoraRteError*`	`BOOL`	Error code index
`muteVideo:error:`	`mute: BOOL, error?: AgoraRteError*`	`BOOL`	Error code index
`openWithUrl:startTime:cb:`	`url: NSString, startTime: uint64_t, cb?: void (^)(AgoraRteErrorerr)`	`void`	Error code index
`pause:`	`error?: AgoraRteError*`	`BOOL`	Error code index
`play:`	`error?: AgoraRteError*`	`BOOL`	Error code index
`preloadWithUrl:error:`	`url: NSString, error?: AgoraRteError`	`BOOL`	Error code index
`registerObserver:error:`	`observer: AgoraRtePlayerObserver, error?: AgoraRteError`	`BOOL`	Error code index
`seek:error:`	`newTime: uint64_t, error?: AgoraRteError*`	`BOOL`	Error code index
`setCanvas:error:`	`canvas: AgoraRteCanvas, error?: AgoraRteError`	`BOOL`	Error code index
`setConfigs:error:`	`config: AgoraRtePlayerConfig, error?: AgoraRteError`	`BOOL`	Error code index
`stop:`	`error?: AgoraRteError*`	`BOOL`	Error code index
`switchWithUrl:syncPts:cb:`	`url: NSString, syncPts: BOOL, cb?: void (^)(AgoraRteErrorerr)`	`void`	Error code index
`unregisterObserver:error:`	`observer?: AgoraRtePlayerObserver, error?: AgoraRteError`	`BOOL`	Error code index

AgoraRtePlayerConfig 12 method / 0 Property

typescript

abrFallbackLayer:(error?: AgoraRteError*): AgoraRteAbrFallbackLayer
abrSubscriptionLayer:(error?: AgoraRteError*): AgoraRteAbrSubscriptionLayer
autoPlay:(error?: AgoraRteError*): BOOL
loopCount:(error?: AgoraRteError*): int32_t
playbackSpeed:(error?: AgoraRteError*): int32_t
playoutVolume:(error?: AgoraRteError*): int32_t
setAbrFallbackLayer:error:(layer: AgoraRteAbrFallbackLayer, error?: AgoraRteError*): void
setAbrSubscriptionLayer:error:(layer: AgoraRteAbrSubscriptionLayer, error?: AgoraRteError*): void
setAutoPlay:error:(autoPlay: BOOL, error?: AgoraRteError*): void
setLoopCount:error:(count: int32_t, error?: AgoraRteError*): void
setPlaybackSpeed:error:(speed: int32_t, error?: AgoraRteError*): void
setPlayoutVolume:error:(volume: int32_t, error?: AgoraRteError*): void

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

Method	Parameters	Returns	Errors
`abrFallbackLayer:`	`error?: AgoraRteError*`	`AgoraRteAbrFallbackLayer`	Error code index
`abrSubscriptionLayer:`	`error?: AgoraRteError*`	`AgoraRteAbrSubscriptionLayer`	Error code index
`autoPlay:`	`error?: AgoraRteError*`	`BOOL`	Error code index
`loopCount:`	`error?: AgoraRteError*`	`int32_t`	Error code index
`playbackSpeed:`	`error?: AgoraRteError*`	`int32_t`	Error code index
`playoutVolume:`	`error?: AgoraRteError*`	`int32_t`	Error code index
`setAbrFallbackLayer:error:`	`layer: AgoraRteAbrFallbackLayer, error?: AgoraRteError*`	`void`	Error code index
`setAbrSubscriptionLayer:error:`	`layer: AgoraRteAbrSubscriptionLayer, error?: AgoraRteError*`	`void`	Error code index
`setAutoPlay:error:`	`autoPlay: BOOL, error?: AgoraRteError*`	`void`	Error code index
`setLoopCount:error:`	`count: int32_t, error?: AgoraRteError*`	`void`	Error code index
`setPlaybackSpeed:error:`	`speed: int32_t, error?: AgoraRteError*`	`void`	Error code index
`setPlayoutVolume:error:`	`volume: int32_t, error?: AgoraRteError*`	`void`	Error code index

AgoraRtePlayerObserver 7 method / 0 Property

typescript

onAudioVolumeIndication:(volume: int32_t): void
onEvent:(event: AgoraRtePlayerEvent): void
onMetadata:data:(type: AgoraRtePlayerMetadataType, data: NSData*): void
onPlayerInfoUpdated:(info: AgoraRtePlayerInfo*): void
onPositionChanged:utcTime:(currentTime: uint64_t, utcTime: uint64_t): void
onResolutionChanged:height:(width: int, height: int): void
onStateChanged:newState:error:(oldState: AgoraRtePlayerState, newState: AgoraRtePlayerState, error?: AgoraRteError*): void

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

Method	Parameters	Returns	Errors
`onAudioVolumeIndication:`	`volume: int32_t`	`void`	Error code index
`onEvent:`	`event: AgoraRtePlayerEvent`	`void`	Error code index
`onMetadata:data:`	`type: AgoraRtePlayerMetadataType, data: NSData*`	`void`	Error code index
`onPlayerInfoUpdated:`	`info: AgoraRtePlayerInfo*`	`void`	Error code index
`onPositionChanged:utcTime:`	`currentTime: uint64_t, utcTime: uint64_t`	`void`	Error code index
`onResolutionChanged:height:`	`width: int, height: int`	`void`	Error code index
`onStateChanged:newState:error:`	`oldState: AgoraRtePlayerState, newState: AgoraRtePlayerState, error?: AgoraRteError*`	`void`	Error code index

AgoraRtePlayerStats 0 method / 0 Property

No public members.

AgoraScreenCaptureConfiguration 0 method / 5 Property

Property	Type	read-only
`isCaptureWindow`	`BOOL`	No
`displayId`	`UInt32`	No
`windowId`	`UInt32`	No
`params`	`AgoraScreenCaptureParameters*`	No
`regionRect`	`CGRect`	No

AgoraScreenCaptureParameters 0 method / 9 Property

Property	Type	read-only
`dimensions`	`CGSize`	No
`frameRate`	`NSInteger`	No
`bitrate`	`NSInteger`	No
`captureMouseCursor`	`BOOL`	No
`windowFocus`	`BOOL`	No
`excludeWindowList`	`NSArray*`	No
`highLighted`	`BOOL`	No
`highLightColor`	`COLOR_CLASS*`	No
`highLightWidth`	`NSUInteger`	No

AgoraScreenCaptureSourceInfo 0 method / 9 Property

Property	Type	read-only
`type`	`AgoraScreenCaptureSourceType`	No
`sourceId`	`CGWindowID`	No
`sourceName`	`NSString*`	No
`thumbImage`	`NSImage*`	No
`iconImage`	`NSImage*`	No
`processPath`	`NSString*`	No
`sourceTitle`	`NSString*`	No
`position`	`CGRect`	No
`primaryMonitor`	`BOOL`	No

AgoraSegmentationProperty 0 method / 3 Property

Property	Type	read-only
`modelType`	`SegModelType`	No
`greenCapacity`	`float`	No
`screenColorType`	`ScreenColorType`	No

AgoraSimulcastStreamConfig 0 method / 0 Property

No public members.

AgoraSnapshotConfig 0 method / 2 Property

Property	Type	read-only
`filePath`	`NSString*`	No
`position`	`AgoraVideoModulePosition`	No

AgoraSpatialAudioKitBase 11 method / 0 Property

typescript

clearRemotePositions:(): unknown
muteAllRemoteAudioStreams:(mute: BOOL): int
muteLocalAudioStream:(mute: BOOL): int
muteRemoteAudioStream:mute:(uid: NSUInteger, mute: BOOL): int
setAudioRecvRange:(range: float): int
setDistanceUnit:(unit: float): int
setMaxAudioRecvCount:(maxCount: NSUInteger): int
setPlayerAttenuation:playerId:forceSet:(attenuation: double, playerId: NSUInteger, forceSet: BOOL): int
setZones:(zones?: NSArray*): int
updatePlayerPositionInfo:positionInfo:(playerId: NSInteger, positionInfo: AgoraRemoteVoicePositionInfo*): int
updateSelfPosition:axisForward:axisRight:axisUp:(position: simd_float3, axisForward: simd_float3, axisRight: simd_float3, axisUp: simd_float3): int

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

Method	Parameters	Returns	Errors
`clearRemotePositions:`	—	`unknown`	Error code index
`muteAllRemoteAudioStreams:`	`mute: BOOL`	`int`	Error code index
`muteLocalAudioStream:`	`mute: BOOL`	`int`	Error code index
`muteRemoteAudioStream:mute:`	`uid: NSUInteger, mute: BOOL`	`int`	Error code index
`setAudioRecvRange:`	`range: float`	`int`	Error code index
`setDistanceUnit:`	`unit: float`	`int`	Error code index
`setMaxAudioRecvCount:`	`maxCount: NSUInteger`	`int`	Error code index
`setPlayerAttenuation:playerId:forceSet:`	`attenuation: double, playerId: NSUInteger, forceSet: BOOL`	`int`	Error code index
`setZones:`	`zones?: NSArray*`	`int`	Error code index
`updatePlayerPositionInfo:positionInfo:`	`playerId: NSInteger, positionInfo: AgoraRemoteVoicePositionInfo*`	`int`	Error code index
`updateSelfPosition:axisForward:axisRight:axisUp:`	`position: simd_float3, axisForward: simd_float3, axisRight: simd_float3, axisUp: simd_float3`	`int`	Error code index

AgoraSpatialAudioParams 0 method / 8 Property

Property	Type	read-only
`speaker_azimuth`	`double`	No
`speaker_elevation`	`double`	No
`speaker_distance`	`double`	No
`speaker_orientation`	`NSInteger`	No
`enable_blur`	`BOOL`	No
`enable_air_absorb`	`BOOL`	No
`speaker_attenuation`	`double`	No
`enable_doppler`	`BOOL`	No

AgoraSpatialAudioZone 0 method / 9 Property

Property	Type	read-only
`zoneSetId`	`NSInteger`	No
`position`	`simd_float3`	No
`forward`	`simd_float3`	No
`right`	`simd_float3`	No
`up`	`simd_float3`	No
`forwardLength`	`float`	No
`rightLength`	`float`	No
`upLength`	`float`	No
`audioAttenuation`	`float`	No

AgoraTranscodingVideoStream 0 method / 8 Property

Property	Type	read-only
`remoteUserUid`	`NSUInteger`	No
`sourceType`	`AgoraVideoSourceType`	No
`imageUrl`	`NSString*`	No
`mediaPlayerId`	`NSUInteger`	No
`rect`	`CGRect`	No
`zOrder`	`NSInteger`	No
`alpha`	`double`	No
`mirror`	`BOOL`	No

AgoraUplinkNetworkInfo 0 method / 1 Property

Property	Type	read-only
`videoEncoderTargetBitrateBps`	`int`	No

AgoraUserInfo 0 method / 2 Property

Property	Type	read-only
`uid`	`NSUInteger`	No
`userAccount`	`NSString*`	No

AgoraVideoCodecCapInfo 0 method / 3 Property

Property	Type	read-only
`codecType`	`AgoraVideoCodecType`	No
`codecCapMask`	`NSUInteger`	No
`codecCapLevels`	`AgoraVideoCodecCapLevels*`	No

AgoraVideoCodecCapLevels 0 method / 2 Property

Property	Type	read-only
`hwDecodingLevel`	`AgoraVideoCodecCapabilityLevel`	No
`swDecodingLevel`	`AgoraVideoCodecCapabilityLevel`	No

AgoraVideoDenoiserOptions 0 method / 2 Property

Property	Type	read-only
`mode`	`AgoraVideoDenoiserMode`	No
`level`	`AgoraVideoDenoiserLevel`	No

AgoraVideoEffectObject 10 method / 1 Property

typescript

addOrUpdateVideoEffectWithNodeId:templateName:(nodeId: NSUInteger, templateNameNS_SWIFT_NAME: NSString*): int
getVideoEffectBoolParamWithOption:key:(option: NSString*, keyNS_SWIFT_NAME: NSString*): BOOL
getVideoEffectFloatParamWithOption:key:(option: NSString*, keyNS_SWIFT_NAME: NSString*): float
getVideoEffectIntParamWithOption:key:(option: NSString*, keyNS_SWIFT_NAME: NSString*): int
performVideoEffectActionWithNodeId:actionId:(nodeId: NSUInteger, actionIdNS_SWIFT_NAME: AgoraVideoEffectAction): int
removeVideoEffectWithNodeId:(nodeIdNS_SWIFT_NAME: NSUInteger): int
setVideoEffectBoolParamWithOption:key:boolValue:(option: NSString*, key: NSString*, boolValueNS_SWIFT_NAME: BOOL): int
setVideoEffectFloatParamWithOption:key:floatValue:(option: NSString*, key: NSString*, floatValueNS_SWIFT_NAME: float): int
setVideoEffectIntParamWithOption:key:intValue:(option: NSString*, key: NSString*, intValueNS_SWIFT_NAME: int): int
setVideoEffectStringParamWithOption:key:stringValue:(option: NSString*, key: NSString*, stringValueNS_SWIFT_NAME: NSString*): int

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

Method	Parameters	Returns	Errors
`addOrUpdateVideoEffectWithNodeId:templateName:`	`nodeId: NSUInteger, templateNameNS_SWIFT_NAME: NSString*`	`int`	Error code index
`getVideoEffectBoolParamWithOption:key:`	`option: NSString, keyNS_SWIFT_NAME: NSString`	`BOOL`	Error code index
`getVideoEffectFloatParamWithOption:key:`	`option: NSString, keyNS_SWIFT_NAME: NSString`	`float`	Error code index
`getVideoEffectIntParamWithOption:key:`	`option: NSString, keyNS_SWIFT_NAME: NSString`	`int`	Error code index
`performVideoEffectActionWithNodeId:actionId:`	`nodeId: NSUInteger, actionIdNS_SWIFT_NAME: AgoraVideoEffectAction`	`int`	Error code index
`removeVideoEffectWithNodeId:`	`nodeIdNS_SWIFT_NAME: NSUInteger`	`int`	Error code index
`setVideoEffectBoolParamWithOption:key:boolValue:`	`option: NSString, key: NSString, boolValueNS_SWIFT_NAME: BOOL`	`int`	Error code index
`setVideoEffectFloatParamWithOption:key:floatValue:`	`option: NSString, key: NSString, floatValueNS_SWIFT_NAME: float`	`int`	Error code index
`setVideoEffectIntParamWithOption:key:intValue:`	`option: NSString, key: NSString, intValueNS_SWIFT_NAME: int`	`int`	Error code index
`setVideoEffectStringParamWithOption:key:stringValue:`	`option: NSString, key: NSString, stringValueNS_SWIFT_NAME: NSString*`	`int`	Error code index

Property	Type	read-only
`AgoraVideoEffectNodeSticker`	`unknown`	No

AgoraVideoEncoderConfiguration 2 method / 9 Property

typescript

initWithSize:frameRate:bitrate:orientationMode:mirrorMode:(size: CGSize, frameRate: NSInteger, bitrate: NSInteger, orientationMode: AgoraVideoOutputOrientationMode, mirrorMode: AgoraVideoMirrorMode): instancetype
initWithWidth:height:frameRate:bitrate:orientationMode:mirrorMode:(width: NSInteger, height: NSInteger, frameRate: NSInteger, bitrate: NSInteger, orientationMode: AgoraVideoOutputOrientationMode, mirrorMode: AgoraVideoMirrorMode): instancetype

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

Method	Parameters	Returns	Errors
`initWithSize:frameRate:bitrate:orientationMode:mirrorMode:`	`size: CGSize, frameRate: NSInteger, bitrate: NSInteger, orientationMode: AgoraVideoOutputOrientationMode, mirrorMode: AgoraVideoMirrorMode`	`instancetype`	Error code index
`initWithWidth:height:frameRate:bitrate:orientationMode:mirrorMode:`	`width: NSInteger, height: NSInteger, frameRate: NSInteger, bitrate: NSInteger, orientationMode: AgoraVideoOutputOrientationMode, mirrorMode: AgoraVideoMirrorMode`	`instancetype`	Error code index

Property	Type	read-only
`dimensions`	`CGSize`	No
`codecType`	`AgoraVideoCodecType`	No
`frameRate`	`NSInteger`	No
`bitrate`	`NSInteger`	No
`minBitrate`	`NSInteger`	No
`orientationMode`	`AgoraVideoOutputOrientationMode`	No
`mirrorMode`	`AgoraVideoMirrorMode`	No
`degradationPreference`	`AgoraDegradationPreference`	No
`advancedVideoOptions`	`AgoraAdvancedVideoOptions*`	No

AgoraVideoFrame 0 method / 16 Property

Property	Type	read-only
`format`	`NSInteger`	No
`time`	`CMTime`	No
`stride`	`int`	No
`strideInPixels`	`int stride DEPRECATED_MSG_ATTRIBUTE("use`	No
`height`	`int`	No
`textureBuf`	`CVPixelBufferRef`	No
`image`	`IMAGE_CLASS*`	No
`dataBuf`	`NSData*`	No
`alphaBuf`	`NSData*`	No
`alphaStitchMode`	`AgoraAlphaStitchMode`	No
`cropLeft`	`int`	No
`cropTop`	`int`	No
`cropRight`	`int`	No
`cropBottom`	`int`	No
`rotation`	`int`	No
`colorSpace`	`AgoraColorSpace*`	No

AgoraVideoFrameDelegate 8 method / 0 Property

typescript

getMirrorApplied(): BOOL
getObservedFramePosition(): AgoraVideoFramePosition
getRotationApplied(): BOOL
getVideoFormatPreference(): AgoraVideoFormat
getVideoFrameProcessMode(): AgoraVideoFrameProcessMode
onCaptureVideoFrame:sourceType:(videoFrame: AgoraOutputVideoFrame*, sourceType: AgoraVideoSourceType): BOOL
onPreEncodeVideoFrame:sourceType:(videoFrame: AgoraOutputVideoFrame*, sourceType: AgoraVideoSourceType): BOOL
onRenderVideoFrame:uid:channelId:(videoFrame: AgoraOutputVideoFrame*, uid: NSUInteger, channelId: NSString*): BOOL

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

Method	Parameters	Returns	Errors
`getMirrorApplied`	—	`BOOL`	Error code index
`getObservedFramePosition`	—	`AgoraVideoFramePosition`	Error code index
`getRotationApplied`	—	`BOOL`	Error code index
`getVideoFormatPreference`	—	`AgoraVideoFormat`	Error code index
`getVideoFrameProcessMode`	—	`AgoraVideoFrameProcessMode`	Error code index
`onCaptureVideoFrame:sourceType:`	`videoFrame: AgoraOutputVideoFrame*, sourceType: AgoraVideoSourceType`	`BOOL`	Error code index
`onPreEncodeVideoFrame:sourceType:`	`videoFrame: AgoraOutputVideoFrame*, sourceType: AgoraVideoSourceType`	`BOOL`	Error code index
`onRenderVideoFrame:uid:channelId:`	`videoFrame: AgoraOutputVideoFrame, uid: NSUInteger, channelId: NSString`	`BOOL`	Error code index

AgoraVideoLayout 0 method / 8 Property

Property	Type	read-only
`channelId`	`NSString*`	No
`uid`	`NSUInteger`	No
`strUid`	`NSString*`	No
`videoState`	`NSUInteger`	No
`x`	`NSUInteger`	No
`y`	`NSUInteger`	No
`width`	`NSUInteger`	No
`height`	`NSUInteger`	No

AgoraVideoRenderingTracingInfo 0 method / 7 Property

Property	Type	read-only
`elapsedTime`	`NSInteger`	No
`start2JoinChannel`	`NSInteger`	No
`join2JoinSuccess`	`NSInteger`	No
`joinSuccess2RemoteJoined`	`NSInteger`	No
`remoteJoined2SetView`	`NSInteger`	No
`remoteJoined2UnmuteVideo`	`NSInteger`	No
`remoteJoined2PacketReceived`	`NSInteger`	No

AgoraVideoSubscriptionOptions 0 method / 2 Property

Property	Type	read-only
`type`	`AgoraVideoStreamType`	No
`encodedFrameOnly`	`BOOL`	No

AgoraVirtualBackgroundSource 0 method / 4 Property

Property	Type	read-only
`backgroundSourceType`	`AgoraVirtualBackgroundSourceType`	No
`color`	`NSUInteger`	No
`source`	`NSString*`	No
`blurDegree`	`AgoraBlurDegree`	No

LogUploadServerInfo 0 method / 4 Property

Property	Type	read-only
`serverDomain`	`NSString*`	No
`serverPath`	`NSString*`	No
`serverPort`	`NSInteger`	No
`serverHttps`	`BOOL`	No

WatermarkBuffer 0 method / 5 Property

Property	Type	read-only
`width`	`int`	No
`height`	`int`	No
`length`	`int`	No
`buffer`	`NSData*`	No
`format`	`WatermarkBufferFormat`	No

WatermarkConfig 0 method / 5 Property

Property	Type	read-only
`id`	`NSString*`	No
`type`	`WatermarkType`	No
`buffer`	`WatermarkBuffer*`	No
`imageUrl`	`NSURL*`	No
`options`	`WatermarkOptions*`	No

WatermarkOptions 0 method / 4 Property

Property	Type	read-only
`visibleInPreview`	`BOOL`	No
`positionInLandscapeMode`	`CGRect`	No
`positionInPortraitMode`	`CGRect`	No
`zOrder`	`int`	No

Enums

Enums	Member count	Example value
`AgoraAlphaStitchMode`	5	`AgoraNoAlphaStitch = 0`
`AgoraApplicationScenarioType`	4	`AgoraApplicationGeneralScenario = 0`
`AgoraAreaCodeType`	8	`AgoraAreaCodeTypeCN = 1`
`AgoraAudienceLatencyLevelType`	2	`AgoraAudienceLatencyLevelLowLatency = 1`
`AgoraAudioCodecProfileType`	3	`AgoraAudioCodecProfileLCAAC = 0`
`AgoraAudioCodecType`	4	`AgoraAudioCodecTypeOPUS = 1`
`AgoraAudioDualMonoMode`	4	`AgoraAudioDualMonoStereo = 0`
`AgoraAudioEffectPreset`	21	`AgoraAudioEffectPresetOff = 0`
`AgoraAudioEncodedFrameDelegatePosition`	3	`AgoraAudioEncodedFrameObserverPositionRecord = 1`
`AgoraAudioEncodingType`	11	`AgoraAudioEncodingTypeAAC16000Low = 65793`
`AgoraAudioEqualizationBandFrequency`	10	`AgoraAudioEqualizationBand31 = 0`
`AgoraAudioFileRecordingType`	3	`AgoraAudioFileRecordingTypeMic = 1`
`AgoraAudioLocalReason`	9	`AgoraAudioLocalReasonOK = 0`
`AgoraAudioLocalState`	4	`AgoraAudioLocalStateStopped = 0`
`AgoraAudioMixingDualMonoMode`	4	`AgoraAudioMixingDualMonoAuto = 0`
`AgoraAudioMixingReasonCode`	8	`AgoraAudioMixingReasonCanNotOpen = 701`
`AgoraAudioMixingStateType`	4	`AgoraAudioMixingStateTypePlaying = 710`
`AgoraAudioOutputRouting`	12	`AgoraAudioOutputRoutingDefault = -1`
`AgoraAudioProcessChannels`	2	`AgoraAudioProcessChannelsMono = 1`
`AgoraAudioProfile`	7	`AgoraAudioProfileDefault = 0`
`AgoraAudioRawFrameOperationMode`	2	`AgoraAudioRawFrameOperationModeReadOnly = 0`
`AgoraAudioRecordingQuality`	4	`AgoraAudioRecordingQualityLow = 0`
`AgoraAudioRemoteReason`	8	`AgoraAudioRemoteReasonInternal = 0`
`AgoraAudioRemoteState`	5	`AgoraAudioRemoteStateStopped = 0`
`AgoraAudioReverbType`	5	`AgoraAudioReverbDryLevel = 0`
`AgoraAudioSampleRateType`	3	`AgoraAudioSampleRateType32000 = 32000`
`AgoraAudioScenario`	6	`AgoraAudioScenarioDefault = 0`
`AgoraAudioSessionOperationRestriction`	5	`AgoraAudioSessionOperationRestrictionNone = 0`
`AgoraAudioSourceType`	8	`AgoraAudioSourceMicrophone = 0`
`AgoraAudioTrackType`	2	`AgoraAudioTrackTypeMixable = 0`
`AgoraBlurDegree`	3	`AgoraBlurLow = 1`
`AgoraCaptureBrightnessLevelType`	4	`AgoraCaptureBrightnessLevelInvalid = -1`
`AgoraChannelMediaRelayError`	12	`AgoraChannelMediaRelayErrorNone = 0`
`AgoraChannelMediaRelayState`	4	`AgoraChannelMediaRelayStateIdle = 0`
`AgoraChannelProfile`	5	`AgoraChannelProfileCommunication = 0`
`AgoraClientRole`	2	`AgoraClientRoleBroadcaster = 1`
`AgoraClientRoleChangeFailedReason`	4	`AgoraClientRoleChangeFailedTooManyBroadcasters = 1`
`AgoraCloudProxyType`	3	`AgoraNoneProxy = 0`
`AgoraCodecCapMask`	5	`AgoraCodecMaskNone = 0`
`AgoraCompressionPreference`	3	`AgoraCompressionAuto = -1`
`AgoraConnectionChangedReason`	23	`AgoraConnectionChangedReasonConnecting = 0`
`AgoraConnectionState`	5	`AgoraConnectionStateDisconnected = 1`
`AgoraContentInspectType`	4	`AgoraContentInspectTypeInvalid = 0`
`AgoraDegradationPreference`	6	`AgoraDegradationMaintainAuto = -1`
`AgoraEarMonitoringFilterType`	5	`AgoraEarMonitoringFilterNone = null`
`AgoraEncodingPreference`	3	`AgoraEncodingPreferAuto = -1`
`AgoraEncryptionErrorType`	5	`ENCRYPTION_ERROR_INTERNAL_FAILURE = 0`
`AgoraEncryptionMode`	9	`AgoraEncryptionModeAES128XTS = 1`
`AgoraErrorCode`	70	`AgoraErrorCodeNoError = 0`
`AgoraExperiencePoorReason`	5	`AgoraExperiencePoorReasonNone = 0`
`AgoraExperienceQuality`	2	`AgoraExperienceQualityGood = 0`
`AgoraExternalVideoSourceType`	2	`AgoraExternalVideoSourceTypeVideoFrame = 0`
`AgoraFaceShapeArea`	32	`AgoraFaceShapeAreaNone = -1`
`AgoraFaceShapeStyle`	3	`AgoraFaceShapeStyleFemale = 0`
`AgoraFeatureType`	2	`AgoraVideoPreprocessVirtualBackground = 1`
`AgoraHeadphoneEQPreset`	3	`AgoraAudioHeadphoneEQPresetOff = 0`
`AgoraLastmileProbeResultState`	3	`AgoraLastmileProbeResultComplete = 1`
`AgoraLighteningContrastLevel`	3	`AgoraLighteningContrastLow = 0`
`AgoraLocalProxyMode`	2	`AgoraConnectivityFirst = 0`
`AgoraLocalVideoStreamReason`	16	`AgoraLocalVideoStreamReasonOK = 0`
`AgoraLogFilter`	6	`AgoraLogFilterOff = 0`
`AgoraLogLevel`	5	`AgoraLogLevelNone = 0`
`AgoraLowlightEnhanceLevel`	2	`AgoraLowlightEnhanceLevelQuality = 0`
`AgoraLowlightEnhanceMode`	2	`AgoraLowlightEnhanceModeAuto = 0`
`AgoraMediaDeviceType`	8	`AgoraMediaDeviceTypeAudioUnknown = -1`
`AgoraMediaPlayerEvent`	17	`AgoraMediaPlayerEventSeekBegin = 0`
`AgoraMediaPlayerMetaDataType`	2	`AgoraMediaPlayerMetaDataTypeUnknown = 0`
`AgoraMediaPlayerPreloadEvent`	3	`AgoraMediaPlayerPreloadEventBegin = 0`
`AgoraMediaPlayerReason`	18	`AgoraMediaPlayerReasonNone = 0`
`AgoraMediaPlayerRenderMode`	2	`AgoraMediaPlayerRenderModeHidden = 1`
`AgoraMediaPlayerState`	9	`AgoraMediaPlayerStateIdle = 0`
`AgoraMediaRecorderContainerFormat`	1	`AgoraMediaRecorderContainerFormatMP4 = 1`
`AgoraMediaRecorderReasonCode`	5	`AgoraMediaRecorderReasonCodeNoError = 0`
`AgoraMediaRecorderState`	3	`AgoraMediaRecorderStateError = -1`
`AgoraMediaRecorderStreamType`	3	`AgoraMediaRecorderStreamTypeAudio = 1`
`AgoraMediaSourceType`	15	`AgoraMediaSourceTypeAudioPlayout = 0`
`AgoraMediaStreamType`	4	`AgoraMediaStreamTypeUnknown = 0`
`AgoraMediaTraceEvent`	2	`AgoraMediaTraceEventVideoRendered = 0`
`AgoraMetadataType`	2	`AgoraMetadataTypeUnknown = -1`
`AgoraMultipathMode`	1	`AgoraMultipathModeDuplicate = 0`
`AgoraMultipathType`	4	`AgoraMultipathTypeLAN = 0`
`AgoraNetworkQuality`	9	`AgoraNetworkQualityUnknown = 0`
`AgoraNetworkType`	8	`AgoraNetworkTypeUnknown = -1`
`AgoraPermissionType`	2	`AgoraPermissionTypeRecordAudio = 0`
`AgoraProxyType`	7	`AgoraNoneProxyType = 0`
`AgoraRecorderStreamType`	2	`AgoraRecorderStreamTypeRtc = 0`
`AgoraRenewTokenErrorCode`	7	`AgoraRenewTokenSuccess = 0`
`AgoraRhythmPlayerReason`	5	`AgoraRhythmPlayerReasonOK = 0`
`AgoraRhythmPlayerState`	5	`AgoraRhythmPlayerStateIdle = 810`
`AgoraRteAbrFallbackLayer`	9	`AgoraRteAbrFallbackDisabled = 0`
`AgoraRteAbrSubscriptionLayer`	8	`AgoraRteAbrSubscriptionHigh = 0`
`AgoraRteErrorCode`	7	`AgoraRteOk = 0`
`AgoraRtePlayerEvent`	21	`AgoraRtePlayerEventSeekBegin = 0`
`AgoraRtePlayerMetadataType`	1	`AgoraRtePlayerMetadataTypeSei = 0`
`AgoraRtePlayerState`	8	`AgoraRtePlayerStateIdle = 0`
`AgoraRteVideoMirrorMode`	3	`AgoraRteVideoMirrorModeAuto = 0`
`AgoraRteVideoRenderMode`	2	`AgoraRteVideoRenderModeHidden = 0`
`AgoraRtmpStreamingEvent`	4	`AgoraRtmpStreamingEventFailedLoadImage = 1`
`AgoraRtmpStreamingReason`	17	`AgoraRtmpStreamingReasonOK = 0`
`AgoraRtmpStreamingState`	6	`AgoraRtmpStreamingStateIdle = 0`
`AgoraRtmpStreamLifeCycle`	2	`AgoraRtmpStreamLifeCycleBindToChannel = 1`
`AgoraScreenCaptureSourceType`	4	`AgoraScreenCaptureSourceTypeUnknown = -1`
`AgoraScreenScenarioType`	4	`AgoraScreenScenarioDocument = 1`
`AgoraSimulcastStreamMode`	3	`AgoraAutoSimulcastStream = -1`
`AgoraStreamFallbackOptions`	9	`AgoraStreamFallbackOptionDisabled = 0`
`AgoraStreamPublishState`	4	`AgoraStreamPublishStateIdle = 0`
`AgoraStreamSubscribeState`	4	`AgoraStreamSubscribeStateIdle = 0`
`AgoraUserOfflineReason`	3	`AgoraUserOfflineReasonQuit = 0`
`AgoraVideoCodecCapabilityLevel`	5	`AgoraVideoCodecCapabilityLevelUnspecified = -1`
`AgoraVideoCodecProfileType`	3	`AgoraVideoCodecProfileTypeBaseLine = 66`
`AgoraVideoCodecType`	7	`AgoraVideoCodecTypeNone = 0`
`AgoraVideoCodecTypeForStream`	2	`AgoraVideoCodecTypeH264ForStream = 1`
`AgoraVideoDenoiserLevel`	2	`AgoraVideoDenoiserLevelHighQuality = 0`
`AgoraVideoDenoiserMode`	2	`AgoraVideoDenoiserModeAuto = null`
`AgoraVideoEffectAction`	2	`AgoraVideoEffectActionSave = 1`
`AgoraVideoEffectNodeId`	4	`AgoraVideoEffectNodeBeauty = 1`
`AgoraVideoFormat`	12	`AgoraVideoFormatI420 = 1`
`AgoraVideoFrameOrientation`	4	`AgoraVideoFrameOrientation0 = 0`
`AgoraVideoFramePosition`	3	`AgoraVideoFramePositionPostCapture = 1`
`AgoraVideoFrameProcessMode`	2	`AgoraVideoFrameProcessModeReadOnly = null`
`AgoraVideoFrameRate`	7	`AgoraVideoFrameRateFps1 = 1`
`AgoraVideoFrameType`	6	`AgoraVideoFrameTypeBlankFrame = 0`
`AgoraVideoHwEncoderAccelerating`	2	`AgoraVideoHwEncoderSoftware = 0`
`AgoraVideoLocalState`	4	`AgoraVideoLocalStateStopped = 0`
`AgoraVideoMirrorMode`	3	`AgoraVideoMirrorModeAuto = 0`
`AgoraVideoModulePosition`	4	`AgoraVideoModulePositionPostCapture = 1`
`AgoraVideoOutputOrientationMode`	3	`AgoraVideoOutputOrientationModeAdaptative = 0`
`AgoraVideoQualityAdaptIndication`	3	`AgoraVideoQualityAdaptNone = 0`
`AgoraVideoRemoteReason`	12	`AgoraVideoRemoteReasonInternal = 0`
`AgoraVideoRemoteState`	5	`AgoraVideoRemoteStateStopped = 0`
`AgoraVideoRenderMode`	3	`AgoraVideoRenderModeHidden = 1`
`AgoraVideoSourceType`	17	`AgoraVideoSourceTypeCamera = 0`
`AgoraVideoStreamType`	8	`AgoraVideoStreamTypeHigh = 0`
`AgoraVideoTranscoderError`	7	`AgoraVideoTranscoderErrorOK = 0`
`AgoraVideoViewSetupMode`	3	`AgoraVideoViewSetupReplace = 0`
`AgoraVirtualBackgroundSourceType`	5	`AgoraVirtualBackgroundNone = 0`
`AgoraVoiceAITunerType`	10	`AgoraVoiceAITunerMatureMale = 0`
`AgoraVoiceBeautifierPreset`	14	`AgoraVoiceBeautifierPresetOff = 0`
`AgoraVoiceConversionPreset`	16	`AgoraVoiceConversionPresetOff = 0`
`AUDIO_AINS_MODE`	3	`AINS_MODE_BALANCED = 0`
`ScreenColorType`	3	`ScreenColorAuto = 0`
`SegModelType`	2	`SegModelAgoraAi = null`
`WatermarkBufferFormat`	4	`WatermarkBufferFormatI420 = 1`
`WatermarkType`	2	`WatermarkTypeImage = 0`

AgoraAlphaStitchMode 5 members

Member	value
`AgoraNoAlphaStitch`	`0`
`AgoraAlphaStitchUp`	`1`
`AgoraAlphaStitchBelow`	`2`
`AgoraAlphaStitchLeft`	`3`
`AgoraAlphaStitchRight`	`4`

AgoraApplicationScenarioType 4 members

Member	value
`AgoraApplicationGeneralScenario`	`0`
`AgoraApplicationMeetingScenario`	`1`
`AgoraApplication1V1Scenario`	`2`
`AgoraApplicationLiveShowScenario`	`3`

AgoraAreaCodeType 8 members

Member	value
`AgoraAreaCodeTypeCN`	`1`
`AgoraAreaCodeTypeNA`	`2`
`AgoraAreaCodeTypeEUR`	`4`
`AgoraAreaCodeTypeAS`	`8`
`AgoraAreaCodeTypeJP`	`16`
`AgoraAreaCodeTypeIN`	`32`
`AgoraAreaCodeTypeRU`	`4096`
`AgoraAreaCodeTypeGlobal`	`4294967295`

AgoraAudienceLatencyLevelType 2 members

Member	value
`AgoraAudienceLatencyLevelLowLatency`	`1`
`AgoraAudienceLatencyLevelUltraLowLatency`	`2`

AgoraAudioCodecProfileType 3 members

Member	value
`AgoraAudioCodecProfileLCAAC`	`0`
`AgoraAudioCodecProfileHEAAC`	`1`
`AgoraAudioCodecProfileHEAACv2`	`2`

AgoraAudioCodecType 4 members

Member	value
`AgoraAudioCodecTypeOPUS`	`1`
`AgoraAudioCodecTypeAACLC`	`8`
`AgoraAudioCodecTypeHEAAC`	`9`
`AgoraAudioCodecTypeHEAAC2`	`11`

AgoraAudioDualMonoMode 4 members

Member	value
`AgoraAudioDualMonoStereo`	`0`
`AgoraAudioDualMonoL`	`1`
`AgoraAudioDualMonoR`	`2`
`AgoraAudioDualMonoMix`	`3`

AgoraAudioEffectPreset 21 members

Member	value
`AgoraAudioEffectPresetOff`	`0`
`AgoraAudioEffectPresetRoomAcousticsKTV`	`33620224`
`AgoraAudioEffectPresetRoomAcousVocalConcer`	`33620480`
`AgoraAudioEffectPresetRoomAcousStudio`	`33620736`
`AgoraAudioEffectPresetRoomAcousPhonograph`	`33620992`
`AgoraAudioEffectPresetRoomAcousVirtualStereo`	`33621248`
`AgoraAudioEffectPresetRoomAcousSpatial`	`33621504`
`AgoraAudioEffectPresetRoomAcousEthereal`	`33621760`
`AgoraAudioEffectPresetRoomAcous3DVoice`	`33622016`
`AgoraAudioEffectPresetRoomAcousVirtualSurroundSound`	`33622272`
`AgoraAudioEffectPresetRoomAcousticsChorus`	`33623296`
`AgoraAudioEffectPresetVoiceChangerEffectUncle`	`33685760`
`AgoraAudioEffectPresetVoiceChangerEffectOldMan`	`33686016`
`AgoraAudioEffectPresetVoiceChangerEffectBoy`	`33686272`
`AgoraAudioEffectPresetVoiceChangerEffectSister`	`33686528`
`AgoraAudioEffectPresetVoiceChangerEffectGirl`	`33686784`
`AgoraAudioEffectPresetVoiceChangerEffectPigKin`	`33687040`
`AgoraAudioEffectPresetVoiceChangerEffectHulk`	`33687296`
`AgoraAudioEffectPresetStyleTransformationRnb`	`33751296`
`AgoraAudioEffectPresetStyleTransformationPopular`	`33751552`
`AgoraAudioEffectPresetPitchCorrection`	`33816832`

AgoraAudioEncodedFrameDelegatePosition 3 members

Member	value
`AgoraAudioEncodedFrameObserverPositionRecord`	`1`
`AgoraAudioEncodedFrameObserverPositionPlayback`	`2`
`AgoraAudioEncodedFrameObserverPositionMixed`	`3`

AgoraAudioEncodingType 11 members

Member	value
`AgoraAudioEncodingTypeAAC16000Low`	`65793`
`AgoraAudioEncodingTypeAAC16000Medium`	`65794`
`AgoraAudioEncodingTypeAAC32000Low`	`66049`
`AgoraAudioEncodingTypeAAC32000Medium`	`66050`
`AgoraAudioEncodingTypeAAC32000High`	`66051`
`AgoraAudioEncodingTypeAAC48000Medium`	`66306`
`AgoraAudioEncodingTypeAAC48000High`	`66307`
`AgoraAudioEncodingTypeOPUS16000Low`	`131329`
`AgoraAudioEncodingTypeOPUS6000Medium`	`131330`
`AgoraAudioEncodingTypeOPUS48000Medium`	`131842`
`AgoraAudioEncodingTypeOPUS48000High`	`131843`

AgoraAudioEqualizationBandFrequency 10 members

Member	value
`AgoraAudioEqualizationBand31`	`0`
`AgoraAudioEqualizationBand62`	`1`
`AgoraAudioEqualizationBand125`	`2`
`AgoraAudioEqualizationBand250`	`3`
`AgoraAudioEqualizationBand500`	`4`
`AgoraAudioEqualizationBand1K`	`5`
`AgoraAudioEqualizationBand2K`	`6`
`AgoraAudioEqualizationBand4K`	`7`
`AgoraAudioEqualizationBand8K`	`8`
`AgoraAudioEqualizationBand16K`	`9`

AgoraAudioFileRecordingType 3 members

Member	value
`AgoraAudioFileRecordingTypeMic`	`1`
`AgoraAudioFileRecordingTypePlayback`	`2`
`AgoraAudioFileRecordingTypeMixed`	`3`

AgoraAudioLocalReason 9 members

Member	value
`AgoraAudioLocalReasonOK`	`0`
`AgoraAudioLocalReasonFailure`	`1`
`AgoraAudioLocalReasonDeviceNoPermission`	`2`
`AgoraAudioLocalReasonDeviceBusy`	`3`
`AgoraAudioLocalReasonRecordFailure`	`4`
`AgoraAudioLocalReasonEncodeFailure`	`5`
`AgoraAudioLocalReasonNoRecordingDevice`	`6`
`AgoraAudioLocalReasonNoPlayoutDevice`	`7`
`AgoraAudioLocalReasonInterrupted`	`8`

AgoraAudioLocalState 4 members

Member	value
`AgoraAudioLocalStateStopped`	`0`
`AgoraAudioLocalStateRecording`	`1`
`AgoraAudioLocalStateEncoding`	`2`
`AgoraAudioLocalStateFailed`	`3`

AgoraAudioMixingDualMonoMode 4 members

Member	value
`AgoraAudioMixingDualMonoAuto`	`0`
`AgoraAudioMixingDualMonoL`	`1`
`AgoraAudioMixingDualMonoR`	`2`
`AgoraAudioMixingDualMonoMix`	`3`

AgoraAudioMixingReasonCode 8 members

Member	value
`AgoraAudioMixingReasonCanNotOpen`	`701`
`AgoraAudioMixingReasonTooFrequentlyCall`	`702`
`AgoraAudioMixingReasonInterruptedEOF`	`703`
`AgoraAudioMixingReasonOneLoopCompleted`	`721`
`AgoraAudioMixingReasonAllLoopsCompleted`	`723`
`AgoraAudioMixingReasonStoppedByUser`	`724`
`AgoraAudioMixingReasonResumedByUser`	`726`
`AgoraAudioMixingReasonTypeOk`	`0`

AgoraAudioMixingStateType 4 members

Member	value
`AgoraAudioMixingStateTypePlaying`	`710`
`AgoraAudioMixingStateTypePaused`	`711`
`AgoraAudioMixingStateTypeStopped`	`713`
`AgoraAudioMixingStateTypeFailed`	`714`

AgoraAudioOutputRouting 12 members

Member	value
`AgoraAudioOutputRoutingDefault`	`-1`
`AgoraAudioOutputRoutingHeadset`	`0`
`AgoraAudioOutputRoutingEarpiece`	`1`
`AgoraAudioOutputRoutingHeadsetNoMic`	`2`
`AgoraAudioOutputRoutingSpeakerphone`	`3`
`AgoraAudioOutputRoutingLoudspeaker`	`4`
`AgoraAudioOutputRoutingBluetoothDeviceHfp`	`5`
`AgoraAudioOutputRoutingUsb`	`6`
`AgoraAudioOutputRoutingHdmi`	`7`
`AgoraAudioOutputRoutingDisplayPort`	`8`
`AgoraAudioOutputRoutingAirPlay`	`9`
`AgoraAudioOutputRoutingBluetoothDeviceA2dp`	`10`

AgoraAudioProcessChannels 2 members

Member	value
`AgoraAudioProcessChannelsMono`	`1`
`AgoraAudioProcessChannelstereo`	`2`

AgoraAudioProfile 7 members

Member	value
`AgoraAudioProfileDefault`	`0`
`AgoraAudioProfileSpeechStandard`	`1`
`AgoraAudioProfileMusicStandard`	`2`
`AgoraAudioProfileMusicStandardStereo`	`3`
`AgoraAudioProfileMusicHighQuality`	`4`
`AgoraAudioProfileMusicHighQualityStereo`	`5`
`AgoraAudioProfileIot`	`6`

AgoraAudioRawFrameOperationMode 2 members

Member	value
`AgoraAudioRawFrameOperationModeReadOnly`	`0`
`AgoraAudioRawFrameOperationModeReadWrite`	`2`

AgoraAudioRecordingQuality 4 members

Member	value
`AgoraAudioRecordingQualityLow`	`0`
`AgoraAudioRecordingQualityMedium`	`1`
`AgoraAudioRecordingQualityHigh`	`2`
`AgoraAudioRecordingQualityUltraHigh`	`3`

AgoraAudioRemoteReason 8 members

Member	value
`AgoraAudioRemoteReasonInternal`	`0`
`AgoraAudioRemoteReasonNetworkCongestion`	`1`
`AgoraAudioRemoteReasonNetworkRecovery`	`2`
`AgoraAudioRemoteReasonLocalMuted`	`3`
`AgoraAudioRemoteReasonLocalUnmuted`	`4`
`AgoraAudioRemoteReasonRemoteMuted`	`5`
`AgoraAudioRemoteReasonRemoteUnmuted`	`6`
`AgoraAudioRemoteReasonRemoteOffline`	`7`

AgoraAudioRemoteState 5 members

Member	value
`AgoraAudioRemoteStateStopped`	`0`
`AgoraAudioRemoteStateStarting`	`1`
`AgoraAudioRemoteStateDecoding`	`2`
`AgoraAudioRemoteStateFrozen`	`3`
`AgoraAudioRemoteStateFailed`	`4`

AgoraAudioReverbType 5 members

Member	value
`AgoraAudioReverbDryLevel`	`0`
`AgoraAudioReverbWetLevel`	`1`
`AgoraAudioReverbRoomSize`	`2`
`AgoraAudioReverbWetDelay`	`3`
`AgoraAudioReverbStrength`	`4`

AgoraAudioSampleRateType 3 members

Member	value
`AgoraAudioSampleRateType32000`	`32000`
`AgoraAudioSampleRateType44100`	`44100`
`AgoraAudioSampleRateType48000`	`48000`

AgoraAudioScenario 6 members

Member	value
`AgoraAudioScenarioDefault`	`0`
`AgoraAudioScenarioGameStreaming`	`3`
`AgoraAudioScenarioChatRoom`	`5`
`AgoraAudioScenarioChorus`	`7`
`AgoraAudioScenarioMeeting`	`8`
`AgoraAudioScenarioAiClient`	`10`

AgoraAudioSessionOperationRestriction 5 members

Member	value
`AgoraAudioSessionOperationRestrictionNone`	`0`
`AgoraAudioSessionOperationRestrictionSetCategory`	`1`
`AgoraAudioSessionOperationRestrictionConfigureSession`	`2`
`AgoraAudioSessionOperationRestrictionDeactivateSession`	`4`
`AgoraAudioSessionOperationRestrictionAll`	`128`

AgoraAudioSourceType 8 members

Member	value
`AgoraAudioSourceMicrophone`	`0`
`AgoraAudioSourceCustom`	`1`
`AgoraAudioSourceMediaPlayer`	`2`
`AgoraAudioSourceLoopbackRecording`	`3`
`AgoraAudioSourceMixedStream`	`4`
`AgoraAudioSourceRemoteUser`	`5`
`AgoraAudioSourceRemoteChannel`	`6`
`AgoraAudioSourceTypeUnknown`	`100`

AgoraAudioTrackType 2 members

Member	value
`AgoraAudioTrackTypeMixable`	`0`
`AgoraAudioTrackTypeDirect`	`1`

AgoraBlurDegree 3 members

Member	value
`AgoraBlurLow`	`1`
`AgoraBlurMedium`	`2`
`AgoraBlurHigh`	`3`

AgoraCaptureBrightnessLevelType 4 members

Member	value
`AgoraCaptureBrightnessLevelInvalid`	`-1`
`AgoraCaptureBrightnessLevelNormal`	`0`
`AgoraCaptureBrightnessLevelBright`	`1`
`AgoraCaptureBrightnessLevelDark`	`2`

AgoraChannelMediaRelayError 12 members

Member	value
`AgoraChannelMediaRelayErrorNone`	`0`
`AgoraChannelMediaRelayErrorServerErrorResponse`	`1`
`AgoraChannelMediaRelayErrorServerNoResponse`	`2`
`AgoraChannelMediaRelayErrorNoResourceAvailable`	`3`
`AgoraChannelMediaRelayErrorFailedJoinSourceChannel`	`4`
`AgoraChannelMediaRelayErrorFailedJoinDestinationChannel`	`5`
`AgoraChannelMediaRelayErrorFailedPacketReceivedFromSource`	`6`
`AgoraChannelMediaRelayErrorFailedPacketSentToDestination`	`7`
`AgoraChannelMediaRelayErrorServerConnectionLost`	`8`
`AgoraChannelMediaRelayErrorInternalError`	`9`
`AgoraChannelMediaRelayErrorSourceTokenExpired`	`10`
`AgoraChannelMediaRelayErrorDestinationTokenExpired`	`11`

AgoraChannelMediaRelayState 4 members

Member	value
`AgoraChannelMediaRelayStateIdle`	`0`
`AgoraChannelMediaRelayStateConnecting`	`1`
`AgoraChannelMediaRelayStateRunning`	`2`
`AgoraChannelMediaRelayStateFailure`	`3`

AgoraChannelProfile 5 members

Member	value
`AgoraChannelProfileCommunication`	`0`
`AgoraChannelProfileLiveBroadcasting`	`1`
`AgoraChannelProfileGame`	`2`
`AgoraChannelProfileCloudGaming`	`3`
`AgoraChannelProfileCommunication_1v1`	`4`

AgoraClientRole 2 members

Member	value
`AgoraClientRoleBroadcaster`	`1`
`AgoraClientRoleAudience`	`2`

AgoraClientRoleChangeFailedReason 4 members

Member	value
`AgoraClientRoleChangeFailedTooManyBroadcasters`	`1`
`AgoraClientRoleChangeFailedNotAuthorized`	`2`
`AgoraClientRoleChangeFailedRequestTimeout`	`3`
`AgoraClientRoleChangeFailedConnectionFailed`	`4`

AgoraCloudProxyType 3 members

Member	value
`AgoraNoneProxy`	`0`
`AgoraUdpProxy`	`1`
`AgoraTcpProxy`	`2`

AgoraCodecCapMask 5 members

Member	value
`AgoraCodecMaskNone`	`0`
`AgoraCodecMaskHwDec`	`1`
`AgoraCodecMaskHwEnc`	`2`
`AgoraCodecMaskSwDec`	`4`
`AgoraCodecMaskSwEnc`	`8`

AgoraCompressionPreference 3 members

Member	value
`AgoraCompressionAuto`	`-1`
`AgoraCompressionLowLatency`	`0`
`AgoraCompressionQuality`	`1`

AgoraConnectionChangedReason 23 members

Member	value
`AgoraConnectionChangedReasonConnecting`	`0`
`AgoraConnectionChangedReasonJoinSuccess`	`1`
`AgoraConnectionChangedReasonInterrupted`	`2`
`AgoraConnectionChangedReasonBannedByServer`	`3`
`AgoraConnectionChangedReasonJoinFailed`	`4`
`AgoraConnectionChangedReasonLeaveChannel`	`5`
`AgoraConnectionChangedReasonInvalidAppId`	`6`
`AgoraConnectionChangedReasonInvalidChannelName`	`7`
`AgoraConnectionChangedReasonInvalidToken`	`8`
`AgoraConnectionChangedReasonTokenExpired`	`9`
`AgoraConnectionChangedReasonRejectedByServer`	`10`
`AgoraConnectionChangedReasonSettingProxyServer`	`11`
`AgoraConnectionChangedReasonRenewToken`	`12`
`AgoraConnectionChangedReasonClientIpAddressChanged`	`13`
`AgoraConnectionChangedReasonKeepAliveTimeout`	`14`
`AgoraConnectionChangedReasonRejoinSuccess`	`15`
`AgoraConnectionChangedReasonLost`	`16`
`AgoraConnectionChangedReasonEchoTest`	`17`
`AgoraConnectionChangedClientIpAddressChangedByUser`	`18`
`AgoraConnectionChangedSameUidLogin`	`19`
`AgoraConnectionChangedTooManyBroadcasters`	`20`
`AgoraConnectionChangedLicenseValidationFailure`	`21`
`AgoraConnectionChangedCertificationVerifyFailure`	`22`

AgoraConnectionState 5 members

Member	value
`AgoraConnectionStateDisconnected`	`1`
`AgoraConnectionStateConnecting`	`2`
`AgoraConnectionStateConnected`	`3`
`AgoraConnectionStateReconnecting`	`4`
`AgoraConnectionStateFailed`	`5`

AgoraContentInspectType 4 members

Member	value
`AgoraContentInspectTypeInvalid`	`0`
`AgoraContentInspectTypeModeration`	`1`
`AgoraContentInspectTypeSupervise`	`2`
`AgoraContentInspectTypeImageModeration`	`3`

AgoraDegradationPreference 6 members

Member	value
`AgoraDegradationMaintainAuto`	`-1`
`AgoraDegradationMaintainQuality`	`0`
`AgoraDegradationMaintainFramerate`	`1`
`AgoraDegradationBalanced`	`2`
`AgoraDegradationMaintainResolution`	`3`
`AgoraDegradationDisable`	`100`

AgoraEarMonitoringFilterType 5 members

Member	value
`AgoraEarMonitoringFilterNone`	`null`
`AgoraEarMonitoringFilterBuiltInAudioFilters`	`null`
`AgoraEarMonitoringFilterNoiseSuppression`	`null`
`AgoraEarMonitoringFilterBuiltInAudioFiltersWithNoiseSuppression`	`6`
`AgoraEarMonitoringFilterReusePostProcessingFilter`	`null`

AgoraEncodingPreference 3 members

Member	value
`AgoraEncodingPreferAuto`	`-1`
`AgoraEncodingPrefersoftware`	`0`
`AgoraEncodingPreferhardware`	`1`

AgoraEncryptionErrorType 5 members

Member	value
`ENCRYPTION_ERROR_INTERNAL_FAILURE`	`0`
`ENCRYPTION_ERROR_DECRYPTION_FAILURE`	`1`
`ENCRYPTION_ERROR_ENCRYPTION_FAILURE`	`2`
`ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE`	`3`
`ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE`	`4`

AgoraEncryptionMode 9 members

Member	value
`AgoraEncryptionModeAES128XTS`	`1`
`AgoraEncryptionModeAES128ECB`	`2`
`AgoraEncryptionModeAES256XTS`	`3`
`AgoraEncryptionModeSM4128ECB`	`4`
`AgoraEncryptionModeAES128GCM`	`5`
`AgoraEncryptionModeAES256GCM`	`6`
`AgoraEncryptionModeAES128GCM2`	`7`
`AgoraEncryptionModeAES256GCM2`	`8`
`AgoraEncryptionModeEnd`	`9`

AgoraErrorCode 70 members

Member	value
`AgoraErrorCodeNoError`	`0`
`AgoraErrorCodeFailed`	`1`
`AgoraErrorCodeInvalidArgument`	`2`
`AgoraErrorCodeNotReady`	`3`
`AgoraErrorCodeNotSupported`	`4`
`AgoraErrorCodeBufferTooSmall`	`6`
`AgoraErrorCodeNotInitialized`	`7`
`AgoraErrorCodeInvalidState`	`8`
`AgoraErrorCodeTimedOut`	`10`
`AgoraErrorCodeJoinChannelRejected`	`17`
`AgoraErrorCodeLeaveChannelRejected`	`18`
`AgoraErrorCodeAlreadyInUse`	`19`
`AgoraErrorCodeInitNetEngine`	`21`
`AgoraErrorCodeResourceLimited`	`22`
`AgoraErrorCodeInvalidAppId`	`101`
`AgoraErrorCodeInvalidChannelId`	`102`
`AgoraErrorCodeNoServerResources`	`103`
`AgoraErrorCodeTokenExpired`	`109`
`AgoraErrorCodeInvalidToken`	`110`
`AgoraErrorCodeConnectionInterrupted`	`111`
`AgoraErrorCodeConnectionLost`	`112`
`AgoraErrorCodeNotInChannel`	`113`
`AgoraErrorCodeSizeTooLarge`	`114`
`AgoraErrorCodeBitrateLimit`	`115`
`AgoraErrorCodeTooManyDataStreams`	`116`
`AgoraErrorCodeDecryptionFailed`	`120`
`AgoraErrorCodeEncryptedStreamNotAllowedPublish`	`130`
`AgoraErrorCodeInvalidUserAccount`	`134`
`AgoraErrorCodeWatermarkParam`	`124`
`AgoraErrorCodeWatermarkPath`	`125`
`AgoraErrorCodeWatermarkPng`	`126`
`AgoraErrorCodeWatermarkInfo`	`127`
`AgoraErrorCodeWatermarkAGRB`	`128`
`AgoraErrorCodeWatermarkRead`	`129`
`AgoraErrorCodePcmSendFormat`	`200`
`AgoraErrorCodePcmSendBufferOverflow`	`201`
`AgoraErrorCodeLoadMediaEngine`	`1001`
`AgoraErrorCodeStartCall`	`1002`
`AgoraErrorCodeStartCamera`	`1003`
`AgoraErrorCodeStartVideoRender`	`1004`
`AgoraErrorCodeAdmGeneralError`	`1005`
`AgoraErrorCodeAdmJavaResource`	`1006`
`AgoraErrorCodeAdmSampleRate`	`1007`
`AgoraErrorCodeAdmInitPlayout`	`1008`
`AgoraErrorCodeAdmStartPlayout`	`1009`
`AgoraErrorCodeAdmStopPlayout`	`1010`
`AgoraErrorCodeAdmInitRecording`	`1011`
`AgoraErrorCodeAdmStartRecording`	`1012`
`AgoraErrorCodeAdmStopRecording`	`1013`
`AgoraErrorCodeAdmRuntimePlayoutError`	`1015`
`AgoraErrorCodeAdmRuntimeRecordingError`	`1017`
`AgoraErrorCodeAdmRecordAudioFailed`	`1018`
`AgoraErrorCodeAdmPlayAbnormalFrequency`	`1020`
`AgoraErrorCodeAdmRecordAbnormalFrequency`	`1021`
`AgoraErrorCodeAdmInitLoopback`	`1022`
`AgoraErrorCodeAdmStartLoopback`	`1023`
`AgoraErrorCodeAdmNoRecordingDevice`	`1359`
`AgoraErrorCodeAdmNoPlayoutDevice`	`1360`
`AgoraErrorCodeVdmCameraNotAuthorized`	`1501`
`AgoraErrorCodeVcmUnknownError`	`1600`
`AgoraErrorCodeVcmEncoderInitError`	`1601`
`AgoraErrorCodeVcmEncoderEncodeError`	`1602`
`AgoraErrorCodeVcmEncoderSetError`	`1603`
`AgoraErrorCodeVideoEffectAssetInvalid`	`1700`
`AgoraErrorCodeVideoEffectSaveFailed`	`1701`
`AgoraErrorCodeVideoEffectEngineInvalid`	`1702`
`AgoraErrorCodeVideoEffectNodeNotActive`	`1704`
`AgoraErrorCodeVideoEffectInvalidParam`	`1705`
`AgoraErrorCodeVideoEffectNotSupported`	`1706`
`AgoraErrorCodeVideoEffectInvalidBundlePath`	`1707`

AgoraExperiencePoorReason 5 members

Member	value
`AgoraExperiencePoorReasonNone`	`0`
`AgoraExperiencePoorReasonRemoteNetworkQualityPoor`	`1`
`AgoraExperiencePoorReasonLocalNetworkQualityPoor`	`2`
`AgoraExperiencePoorReasonWirelessSignalPoor`	`4`
`AgoraExperiencePoorReasonWifiBluetoothCoexist`	`8`

AgoraExperienceQuality 2 members

Member	value
`AgoraExperienceQualityGood`	`0`
`AgoraExperienceQualityBad`	`1`

AgoraExternalVideoSourceType 2 members

Member	value
`AgoraExternalVideoSourceTypeVideoFrame`	`0`
`AgoraExternalVideoSourceTypeEncodedVideoFrame`	`1`

AgoraFaceShapeArea 32 members

Member	value
`AgoraFaceShapeAreaNone`	`-1`
`AgoraFaceShapeAreaHeadScale`	`100`
`AgoraFaceShapeAreaForehead`	`101`
`AgoraFaceShapeAreaFaceContour`	`102`
`AgoraFaceShapeAreaFaceLength`	`103`
`AgoraFaceShapeAreaFaceWidth`	`104`
`AgoraFaceShapeAreaCheekbone`	`105`
`AgoraFaceShapeAreaCheek`	`106`
`AgoraFaceShapeAreaMandible`	`107`
`AgoraFaceShapeAreaChin`	`108`
`AgoraFaceShapeAreaFaceSmall`	`109`
`AgoraFaceShapeAreaEyeScale`	`200`
`AgoraFaceShapeAreaEyeDistance`	`201`
`AgoraFaceShapeAreaEyePosition`	`202`
`AgoraFaceShapeAreaLowerEyelid`	`203`
`AgoraFaceShapeAreaEyePupils`	`204`
`AgoraFaceShapeAreaEyeInnerCorner`	`205`
`AgoraFaceShapeAreaEyeOuterCorner`	`206`
`AgoraFaceShapeAreaEyeAngle`	`207`
`AgoraFaceShapeAreaNoseLength`	`300`
`AgoraFaceShapeAreaNoseWidth`	`301`
`AgoraFaceShapeAreaNoseWing`	`302`
`AgoraFaceShapeAreaNoseRoot`	`303`
`AgoraFaceShapeAreaNoseBridge`	`304`
`AgoraFaceShapeAreaNoseTip`	`305`
`AgoraFaceShapeAreaNoseGeneral`	`306`
`AgoraFaceShapeAreaMouthScale`	`400`
`AgoraFaceShapeAreaMouthPosition`	`401`
`AgoraFaceShapeAreaMouthSmile`	`402`
`AgoraFaceShapeAreaMouthLip`	`403`
`AgoraFaceShapeAreaEyebrowPosition`	`500`
`AgoraFaceShapeAreaEyebrowThickness`	`501`

AgoraFaceShapeStyle 3 members

Member	value
`AgoraFaceShapeStyleFemale`	`0`
`AgoraFaceShapeStyleMale`	`1`
`AgoraFaceShapeStyleNatural`	`2`

AgoraFeatureType 2 members

Member	value
`AgoraVideoPreprocessVirtualBackground`	`1`
`AgoraVideoPreprocessBeauty`	`2`

AgoraHeadphoneEQPreset 3 members

Member	value
`AgoraAudioHeadphoneEQPresetOff`	`0`
`AgoraAudioHeadphoneEQPresetOverear`	`67108865`
`AgoraAudioHeadphoneEQPresetInear`	`67108866`

AgoraLastmileProbeResultState 3 members

Member	value
`AgoraLastmileProbeResultComplete`	`1`
`AgoraLastmileProbeResultIncompleteNoBwe`	`2`
`AgoraLastmileProbeResultUnavailable`	`3`

AgoraLighteningContrastLevel 3 members

Member	value
`AgoraLighteningContrastLow`	`0`
`AgoraLighteningContrastNormal`	`1`
`AgoraLighteningContrastHigh`	`2`

AgoraLocalProxyMode 2 members

Member	value
`AgoraConnectivityFirst`	`0`
`AgoraLocalOnly`	`1`

AgoraLocalVideoStreamReason 16 members

Member	value
`AgoraLocalVideoStreamReasonOK`	`0`
`AgoraLocalVideoStreamReasonFailure`	`1`
`AgoraLocalVideoStreamReasonDeviceNoPermission`	`2`
`AgoraLocalVideoStreamReasonDeviceBusy`	`3`
`AgoraLocalVideoStreamReasonCaptureFailure`	`4`
`AgoraLocalVideoStreamReasonCodecNotSupport`	`5`
`AgoraLocalVideoStreamReasonCaptureInBackGround`	`6`
`AgoraLocalVideoStreamReasonCaptureMultipleForegroundApps`	`7`
`AgoraLocalVideoStreamReasonCaptureNoDeviceFound`	`8`
`AgoraLocalVideoStreamReasonCaptureDeviceDisconnected`	`9`
`AgoraLocalVideoStreamReasonCaptureDeviceInvalidId`	`10`
`AgoraLocalVideoStreamReasonScreenCaptureWindowMinimized`	`11`
`AgoraLocalVideoStreamReasonScreenCaptureWindowClosed`	`12`
`AgoraLocalVideoStreamReasonScreenCaptureNoPermission`	`22`
`AgoraLocalVideoStreamReasonScreenCaptureRecoverFromMinimized`	`27`
`AgoraLocalVideoStreamReasonScreenCaptureDisplayDisconnected`	`30`

AgoraLogFilter 6 members

Member	value
`AgoraLogFilterOff`	`0`
`AgoraLogFilterDebug`	`2063`
`AgoraLogFilterInfo`	`15`
`AgoraLogFilterWarning`	`14`
`AgoraLogFilterError`	`12`
`AgoraLogFilterCritical`	`8`

AgoraLogLevel 5 members

Member	value
`AgoraLogLevelNone`	`0`
`AgoraLogLevelInfo`	`1`
`AgoraLogLevelWarn`	`2`
`AgoraLogLevelError`	`4`
`AgoraLogLevelFatal`	`8`

AgoraLowlightEnhanceLevel 2 members

Member	value
`AgoraLowlightEnhanceLevelQuality`	`0`
`AgoraLowlightEnhanceLevelFast`	`1`

AgoraLowlightEnhanceMode 2 members

Member	value
`AgoraLowlightEnhanceModeAuto`	`0`
`AgoraLowlightEnhanceModeManual`	`1`

AgoraMediaDeviceType 8 members

Member	value
`AgoraMediaDeviceTypeAudioUnknown`	`-1`
`AgoraMediaDeviceTypeAudioPlayout`	`0`
`AgoraMediaDeviceTypeAudioRecording`	`1`
`AgoraMediaDeviceTypeVideoRender`	`2`
`AgoraMediaDeviceTypeVideoCapture`	`3`
`AgoraMediaDeviceTypeAudioApplicationPlayout`	`4`
`AgoraMediaDeviceTypeAudioVirtualPlayout`	`5`
`AgoraMediaDeviceTypeAudioVirtualRecording`	`6`

AgoraMediaPlayerEvent 17 members

Member	value
`AgoraMediaPlayerEventSeekBegin`	`0`
`AgoraMediaPlayerEventSeekComplete`	`1`
`AgoraMediaPlayerEventSeekError`	`2`
`AgoraMediaPlayerEventAudioTrackChanged`	`5`
`AgoraMediaPlayerEventBufferLow`	`6`
`AgoraMediaPlayerEventBufferRecover`	`7`
`AgoraMediaPlayerEventFreezeStart`	`8`
`AgoraMediaPlayerEventFreezeStop`	`9`
`AgoraMediaPlayerEventSwitchBegin`	`10`
`AgoraMediaPlayerEventSwitchComplete`	`11`
`AgoraMediaPlayerEventSwitchError`	`12`
`AgoraMediaPlayerEventFirstDisplayed`	`13`
`AgoraMediaPlayerEventReachCacheFileMaxCount`	`14`
`AgoraMediaPlayerEventReachCacheFileMaxSize`	`15`
`AgoraMediaPlayerEventTryOpenStart`	`16`
`AgoraMediaPlayerEventTryOpenSucceed`	`17`
`AgoraMediaPlayerEventTryOpenFailed`	`18`

AgoraMediaPlayerMetaDataType 2 members

Member	value
`AgoraMediaPlayerMetaDataTypeUnknown`	`0`
`AgoraMediaPlayerMetaDataTypeSEI`	`1`

AgoraMediaPlayerPreloadEvent 3 members

Member	value
`AgoraMediaPlayerPreloadEventBegin`	`0`
`AgoraMediaPlayerPreloadEventComplete`	`1`
`AgoraMediaPlayerPreloadEventError`	`2`

AgoraMediaPlayerReason 18 members

Member	value
`AgoraMediaPlayerReasonNone`	`0`
`AgoraMediaPlayerReasonInvalidArguments`	`-1`
`AgoraMediaPlayerReasonInternal`	`-2`
`AgoraMediaPlayerReasonNoSource`	`-3`
`AgoraMediaPlayerReasonInvalidMediaSource`	`-4`
`AgoraMediaPlayerReasonUnknowStreamType`	`-5`
`AgoraMediaPlayerReasonObjNotInitialized`	`-6`
`AgoraMediaPlayerReasonCodecNotSupported`	`-7`
`AgoraMediaPlayerReasonVideoRenderFailed`	`-8`
`AgoraMediaPlayerReasonInvalidState`	`-9`
`AgoraMediaPlayerReasonUrlNotFound`	`-10`
`AgoraMediaPlayerReasonInvalidConnectState`	`-11`
`AgoraMediaPlayerReasonSrcBufferUnderflow`	`-12`
`AgoraMediaPlayerReasonInterrupted`	`-13`
`AgoraMediaPlayerReasonNotSupported`	`-14`
`AgoraMediaPlayerReasonTokenExpired`	`-15`
`AgoraMediaPlayerReasonIpExpired`	`-16`
`AgoraMediaPlayerReasonUnknown`	`-17`

AgoraMediaPlayerRenderMode 2 members

Member	value
`AgoraMediaPlayerRenderModeHidden`	`1`
`AgoraMediaPlayerRenderModeFit`	`2`

AgoraMediaPlayerState 9 members

Member	value
`AgoraMediaPlayerStateIdle`	`0`
`AgoraMediaPlayerStateOpening`	`1`
`AgoraMediaPlayerStateOpenCompleted`	`2`
`AgoraMediaPlayerStatePlaying`	`3`
`AgoraMediaPlayerStatePaused`	`4`
`AgoraMediaPlayerStatePlayBackCompleted`	`5`
`AgoraMediaPlayerStatePlayBackAllLoopsCompleted`	`6`
`AgoraMediaPlayerStateStopped`	`7`
`AgoraMediaPlayerStateFailed`	`100`

AgoraMediaRecorderContainerFormat 1 members

Member	value
`AgoraMediaRecorderContainerFormatMP4`	`1`

AgoraMediaRecorderReasonCode 5 members

Member	value
`AgoraMediaRecorderReasonCodeNoError`	`0`
`AgoraMediaRecorderReasonCodeWriteFailed`	`1`
`AgoraMediaRecorderReasonCodeNoStream`	`2`
`AgoraMediaRecorderReasonCodeOverMaxDuration`	`3`
`AgoraMediaRecorderReasonCodeConfigChange`	`4`

AgoraMediaRecorderState 3 members

Member	value
`AgoraMediaRecorderStateError`	`-1`
`AgoraMediaRecorderStateStarted`	`2`
`AgoraMediaRecorderStateStopped`	`3`

AgoraMediaRecorderStreamType 3 members

Member	value
`AgoraMediaRecorderStreamTypeAudio`	`1`
`AgoraMediaRecorderStreamTypeVideo`	`2`
`AgoraMediaRecorderStreamTypeBoth`	`3`

AgoraMediaSourceType 15 members

Member	value
`AgoraMediaSourceTypeAudioPlayout`	`0`
`AgoraMediaSourceTypeRecording`	`1`
`AgoraMediaSourceTypePrimaryCamera`	`2`
`AgoraMediaSourceTypeSecondaryCamera`	`3`
`AgoraMediaSourceTypePrimaryScreen`	`4`
`AgoraMediaSourceTypeSecondaryScreen`	`5`
`AgoraMediaSourceTypeCustomVideo`	`6`
`AgoraMediaSourceTypeMediaPlayer`	`7`
`AgoraMediaSourceTypeRtcImagePng`	`8`
`AgoraMediaSourceTypeRtcImageJpeg`	`9`
`AgoraMediaSourceTypeRtcImageGif`	`10`
`AgoraMediaSourceTypeRemoteVideo`	`11`
`AgoraMediaSourceTypeTranscodedVideo`	`12`
`AgoraMediaSourceTypeSpeechDriven`	`13`
`AgoraMediaSourceTypeUnknown`	`100`

AgoraMediaStreamType 4 members

Member	value
`AgoraMediaStreamTypeUnknown`	`0`
`AgoraMediaStreamTypeVideo`	`1`
`AgoraMediaStreamTypeAudio`	`2`
`AgoraMediaStreamTypeSubtitle`	`3`

AgoraMediaTraceEvent 2 members

Member	value
`AgoraMediaTraceEventVideoRendered`	`0`
`AgoraMediaTraceEventVideoDecoded`	`1`

AgoraMetadataType 2 members

Member	value
`AgoraMetadataTypeUnknown`	`-1`
`AgoraMetadataTypeVideo`	`0`

AgoraMultipathMode 1 members

Member	value
`AgoraMultipathModeDuplicate`	`0`

AgoraMultipathType 4 members

Member	value
`AgoraMultipathTypeLAN`	`0`
`AgoraMultipathTypeWIFI`	`1`
`AgoraMultipathTypeMobile`	`2`
`AgoraMultipathTypeUnknown`	`99`

AgoraNetworkQuality 9 members

Member	value
`AgoraNetworkQualityUnknown`	`0`
`AgoraNetworkQualityExcellent`	`1`
`AgoraNetworkQualityGood`	`2`
`AgoraNetworkQualityPoor`	`3`
`AgoraNetworkQualityBad`	`4`
`AgoraNetworkQualityVBad`	`5`
`AgoraNetworkQualityDown`	`6`
`AgoraNetworkQualityUnsupported`	`7`
`AgoraNetworkQualityDetecting`	`8`

AgoraNetworkType 8 members

Member	value
`AgoraNetworkTypeUnknown`	`-1`
`AgoraNetworkTypeDisconnected`	`0`
`AgoraNetworkTypeLAN`	`1`
`AgoraNetworkTypeWIFI`	`2`
`AgoraNetworkType2G`	`3`
`AgoraNetworkType3G`	`4`
`AgoraNetworkType4G`	`5`
`AgoraNetworkType5G`	`6`

AgoraPermissionType 2 members

Member	value
`AgoraPermissionTypeRecordAudio`	`0`
`AgoraPermissionTypeCamera`	`1`

AgoraProxyType 7 members

Member	value
`AgoraNoneProxyType`	`0`
`AgoraUdpProxyType`	`1`
`AgoraTcpProxyType`	`2`
`AgoraLocalProxyType`	`3`
`AgoraTcpProxyAutoFallbackType`	`4`
`AgoraHttpProxyType`	`5`
`AgoraHttpsProxyType`	`6`

AgoraRecorderStreamType 2 members

Member	value
`AgoraRecorderStreamTypeRtc`	`0`
`AgoraRecorderStreamTypePreview`	`1`

AgoraRenewTokenErrorCode 7 members

Member	value
`AgoraRenewTokenSuccess`	`0`
`AgoraRenewTokenFailure`	`1`
`AgoraRenewTokenExpiredToken`	`2`
`AgoraRenewTokenInvalidToken`	`3`
`AgoraRenewTokenInvalidChannelName`	`4`
`AgoraRenewTokenInconsistentAppId`	`5`
`AgoraRenewTokenCanceledByNewRequest`	`6`

AgoraRhythmPlayerReason 5 members

Member	value
`AgoraRhythmPlayerReasonOK`	`0`
`AgoraRhythmPlayerReasonFailed`	`1`
`AgoraRhythmPlayerReasonCanNotOpen`	`801`
`AgoraRhythmPlayerReasonCanNotPlay`	`802`
`AgoraRhythmPlayerReasonFileOverDurationLimit`	`803`

AgoraRhythmPlayerState 5 members

Member	value
`AgoraRhythmPlayerStateIdle`	`810`
`AgoraRhythmPlayerStateOpening`	`811`
`AgoraRhythmPlayerStateDecoding`	`812`
`AgoraRhythmPlayerStatePlaying`	`813`
`AgoraRhythmPlayerStateFailed`	`814`

AgoraRteAbrFallbackLayer 9 members

Member	value
`AgoraRteAbrFallbackDisabled`	`0`
`AgoraRteAbrFallbackLow`	`1`
`AgoraRteAbrFallbackAudioOnly`	`2`
`AgoraRteAbrFallbackLayer1`	`3`
`AgoraRteAbrFallbackLayer2`	`4`
`AgoraRteAbrFallbackLayer3`	`5`
`AgoraRteAbrFallbackLayer4`	`6`
`AgoraRteAbrFallbackLayer5`	`7`
`AgoraRteAbrFallbackLayer6`	`8`

AgoraRteAbrSubscriptionLayer 8 members

Member	value
`AgoraRteAbrSubscriptionHigh`	`0`
`AgoraRteAbrSubscriptionLow`	`1`
`AgoraRteAbrSubscriptionLayer1`	`2`
`AgoraRteAbrSubscriptionLayer2`	`3`
`AgoraRteAbrSubscriptionLayer3`	`4`
`AgoraRteAbrSubscriptionLayer4`	`5`
`AgoraRteAbrSubscriptionLayer5`	`6`
`AgoraRteAbrSubscriptionLayer6`	`7`

AgoraRteErrorCode 7 members

Member	value
`AgoraRteOk`	`0`
`AgoraRteErrorDefault`	`1`
`AgoraRteErrorInvalidArgument`	`2`
`AgoraRteErrorInvalidOperation`	`3`
`AgoraRteErrorNetworkError`	`4`
`AgoraRteErrorAuthenticationFailed`	`5`
`AgoraRteErrorStreamNotFound`	`6`

AgoraRtePlayerEvent 21 members

Member	value
`AgoraRtePlayerEventSeekBegin`	`0`
`AgoraRtePlayerEventSeekComplete`	`1`
`AgoraRtePlayerEventSeekError`	`2`
`AgoraRtePlayerEventBufferLow`	`3`
`AgoraRtePlayerEventBufferRecover`	`4`
`AgoraRtePlayerEventFreezeStart`	`5`
`AgoraRtePlayerEventFreezeStop`	`6`
`AgoraRtePlayerEventOneLoopPlaybackCompleted`	`7`
`AgoraRtePlayerEventAuthenticationWillExpire`	`8`
`AgoraRtePlayerEventAbrFallbackToAudioOnlyLayer`	`9`
`AgoraRtePlayerEventAbrRecoverFromAudioOnlyLayer`	`10`
`AgoraRtePlayerEventSwitchBegin`	`11`
`AgoraRtePlayerEventSwitchComplete`	`12`
`AgoraRtePlayerEventSwitchError`	`13`
`AgoraRtePlayerEventFirstDisplayed`	`14`
`AgoraRtePlayerEventReachCacheFileMaxCount`	`15`
`AgoraRtePlayerEventReachCacheFileMaxSize`	`16`
`AgoraRtePlayerEventTryOpenStart`	`17`
`AgoraRtePlayerEventTryOpenSucceed`	`18`
`AgoraRtePlayerEventTryOpenFailed`	`19`
`AgoraRtePlayerEventAudioTrackChanged`	`20`

AgoraRtePlayerMetadataType 1 members

Member	value
`AgoraRtePlayerMetadataTypeSei`	`0`

AgoraRtePlayerState 8 members

Member	value
`AgoraRtePlayerStateIdle`	`0`
`AgoraRtePlayerStateOpening`	`1`
`AgoraRtePlayerStateOpenCompleted`	`2`
`AgoraRtePlayerStatePlaying`	`3`
`AgoraRtePlayerStatePaused`	`4`
`AgoraRtePlayerStatePlaybackCompleted`	`5`
`AgoraRtePlayerStateStopped`	`6`
`AgoraRtePlayerStateFailed`	`7`

AgoraRteVideoMirrorMode 3 members

Member	value
`AgoraRteVideoMirrorModeAuto`	`0`
`AgoraRteVideoMirrorModeEnabled`	`1`
`AgoraRteVideoMirrorModeDisabled`	`2`

AgoraRteVideoRenderMode 2 members

Member	value
`AgoraRteVideoRenderModeHidden`	`0`
`AgoraRteVideoRenderModeFit`	`1`

AgoraRtmpStreamingEvent 4 members

Member	value
`AgoraRtmpStreamingEventFailedLoadImage`	`1`
`AgoraRtmpStreamingEventUrlAlreadyInUse`	`2`
`AgoraRtmpStreamingEventAdvancedFeatureNotSupport`	`3`
`AgoraRtmpStreamingEventRequestTooOften`	`4`

AgoraRtmpStreamingReason 17 members

Member	value
`AgoraRtmpStreamingReasonOK`	`0`
`AgoraRtmpStreamingReasonInvalidParameters`	`1`
`AgoraRtmpStreamingReasonEncryptedStreamNotAllowed`	`2`
`AgoraRtmpStreamingReasonConnectionTimeout`	`3`
`AgoraRtmpStreamingReasonInternalServerError`	`4`
`AgoraRtmpStreamingReasonRtmpServerError`	`5`
`AgoraRtmpStreamingReasonTooOften`	`6`
`AgoraRtmpStreamingReasonReachLimit`	`7`
`AgoraRtmpStreamingReasonNotAuthorized`	`8`
`AgoraRtmpStreamingReasonStreamNotFound`	`9`
`AgoraRtmpStreamingReasonFormatNotSupported`	`10`
`AgoraRtmpStreamingReasonNotBroadcaster`	`11`
`AgoraRtmpStreamingReasonTranscodingNoMixStream`	`13`
`AgoraRtmpStreamingReasonNetDown`	`14`
`AgoraRtmpStreamingReasonInvalidAppId`	`15`
`AgoraRtmpStreamingReasonInvalidPrivilege`	`16`
`AgoraRtmpStreamingReasonUnpublishOK`	`100`

AgoraRtmpStreamingState 6 members

Member	value
`AgoraRtmpStreamingStateIdle`	`0`
`AgoraRtmpStreamingStateConnecting`	`1`
`AgoraRtmpStreamingStateRunning`	`2`
`AgoraRtmpStreamingStateRecovering`	`3`
`AgoraRtmpStreamingStateFailure`	`4`
`AgoraRtmpStreamingStateDisconnecting`	`5`

AgoraRtmpStreamLifeCycle 2 members

Member	value
`AgoraRtmpStreamLifeCycleBindToChannel`	`1`
`AgoraRtmpStreamLifeCycleBindToOwner`	`2`

AgoraScreenCaptureSourceType 4 members

Member	value
`AgoraScreenCaptureSourceTypeUnknown`	`-1`
`AgoraScreenCaptureSourceTypeWindow`	`0`
`AgoraScreenCaptureSourceTypeScreen`	`1`
`AgoraScreenCaptureSourceTypeCustom`	`2`

AgoraScreenScenarioType 4 members

Member	value
`AgoraScreenScenarioDocument`	`1`
`AgoraScreenScenarioGaming`	`2`
`AgoraScreenScenarioVideo`	`3`
`AgoraScreenScenarioRDC`	`4`

AgoraSimulcastStreamMode 3 members

Member	value
`AgoraAutoSimulcastStream`	`-1`
`AgoraDisableSimulcastStream`	`0`
`AgoraEnableSimulcastStream`	`1`

AgoraStreamFallbackOptions 9 members

Member	value
`AgoraStreamFallbackOptionDisabled`	`0`
`AgoraStreamFallbackOptionVideoStreamLow`	`1`
`AgoraStreamFallbackOptionAudioOnly`	`2`
`AgoraStreamFallbackOptionVideoStreamLayer1`	`3`
`AgoraStreamFallbackOptionVideoStreamLayer2`	`4`
`AgoraStreamFallbackOptionVideoStreamLayer3`	`5`
`AgoraStreamFallbackOptionVideoStreamLayer4`	`6`
`AgoraStreamFallbackOptionVideoStreamLayer5`	`7`
`AgoraStreamFallbackOptionVideoStreamLayer6`	`8`

AgoraStreamPublishState 4 members

Member	value
`AgoraStreamPublishStateIdle`	`0`
`AgoraStreamPublishStateNoPublished`	`1`
`AgoraStreamPublishStatePublishing`	`2`
`AgoraStreamPublishStatePublished`	`3`

AgoraStreamSubscribeState 4 members

Member	value
`AgoraStreamSubscribeStateIdle`	`0`
`AgoraStreamSubscribeStateNoSubscribed`	`1`
`AgoraStreamSubscribeStateSubscribing`	`2`
`AgoraStreamSubscribeStateSubscribed`	`3`

AgoraUserOfflineReason 3 members

Member	value
`AgoraUserOfflineReasonQuit`	`0`
`AgoraUserOfflineReasonDropped`	`1`
`AgoraUserOfflineReasonBecomeAudience`	`2`

AgoraVideoCodecCapabilityLevel 5 members

Member	value
`AgoraVideoCodecCapabilityLevelUnspecified`	`-1`
`AgoraVideoCodecCapabilityLevelBasicSupport`	`5`
`AgoraVideoCodecCapabilityLevel1080p30fps`	`10`
`AgoraVideoCodecCapabilityLevel1080p60fps`	`20`
`AgoraVideoCodecCapabilityLevel4k60fps`	`30`

AgoraVideoCodecProfileType 3 members

Member	value
`AgoraVideoCodecProfileTypeBaseLine`	`66`
`AgoraVideoCodecProfileTypeMain`	`77`
`AgoraVideoCodecProfileTypeHigh`	`100`

AgoraVideoCodecType 7 members

Member	value
`AgoraVideoCodecTypeNone`	`0`
`AgoraVideoCodecTypeVP8`	`1`
`AgoraVideoCodecTypeH264`	`2`
`AgoraVideoCodecTypeH265`	`3`
`AgoraVideoCodecTypeGeneric`	`6`
`AgoraVideoCodecTypeVP9`	`13`
`AgoraVideoCodecTypeGenericJpeg`	`20`

AgoraVideoCodecTypeForStream 2 members

Member	value
`AgoraVideoCodecTypeH264ForStream`	`1`
`AgoraVideoCodecTypeH265ForStream`	`2`

AgoraVideoDenoiserLevel 2 members

Member	value
`AgoraVideoDenoiserLevelHighQuality`	`0`
`AgoraVideoDenoiserLevelFast`	`1`

AgoraVideoDenoiserMode 2 members

Member	value
`AgoraVideoDenoiserModeAuto`	`null`
`AgoraVideoDenoiserModeManual`	`1`

AgoraVideoEffectAction 2 members

Member	value
`AgoraVideoEffectActionSave`	`1`
`AgoraVideoEffectActionReset`	`2`

AgoraVideoEffectNodeId 4 members

Member	value
`AgoraVideoEffectNodeBeauty`	`1`
`AgoraVideoEffectNodeStyleMakeup`	`2`
`AgoraVideoEffectNodeFilter`	`4`
`AgoraVideoEffectNodeSticker`	`8`

AgoraVideoFormat 12 members

Member	value
`AgoraVideoFormatI420`	`1`
`AgoraVideoFormatBGRA`	`2`
`AgoraVideoFormatNV21`	`3`
`AgoraVideoFormatRGBA`	`4`
`AgoraVideoFormatNV12`	`8`
`AgoraVideoFormatCVPixelNV12`	`12`
`AgoraVideoFormatCVPixelI420`	`13`
`AgoraVideoFormatCVPixelBGRA`	`14`
`AgoraVideoFormatCVPixelP010`	`15`
`AgoraVideoFormatI422`	`16`
`AgoraVideoFormatI010`	`18`
`AgoraVideoFormatDefault`	`0`

AgoraVideoFrameOrientation 4 members

Member	value
`AgoraVideoFrameOrientation0`	`0`
`AgoraVideoFrameOrientation90`	`90`
`AgoraVideoFrameOrientation180`	`180`
`AgoraVideoFrameOrientation270`	`270`

AgoraVideoFramePosition 3 members

Member	value
`AgoraVideoFramePositionPostCapture`	`1`
`AgoraVideoFramePositionPreRenderer`	`2`
`AgoraVideoFramePositionPreEncoder`	`4`

AgoraVideoFrameProcessMode 2 members

Member	value
`AgoraVideoFrameProcessModeReadOnly`	`null`
`AgoraVideoFrameProcessModeReadWrite`	`null`

AgoraVideoFrameRate 7 members

Member	value
`AgoraVideoFrameRateFps1`	`1`
`AgoraVideoFrameRateFps7`	`7`
`AgoraVideoFrameRateFps10`	`10`
`AgoraVideoFrameRateFps15`	`15`
`AgoraVideoFrameRateFps24`	`24`
`AgoraVideoFrameRateFps30`	`30`
`AgoraVideoFrameRateFps60`	`60`

AgoraVideoFrameType 6 members

Member	value
`AgoraVideoFrameTypeBlankFrame`	`0`
`AgoraVideoFrameTypeKeyFrame`	`3`
`AgoraVideoFrameTypeDeltaFrame`	`4`
`AgoraVideoFrameTypeBFrame`	`5`
`AgoraVideoFrameTypeDroppableFrame`	`6`
`AgoraVideoFrameTypeUnknow`	`null`

AgoraVideoHwEncoderAccelerating 2 members

Member	value
`AgoraVideoHwEncoderSoftware`	`0`
`AgoraVideoHwEncoderHardware`	`1`

AgoraVideoLocalState 4 members

Member	value
`AgoraVideoLocalStateStopped`	`0`
`AgoraVideoLocalStateCapturing`	`1`
`AgoraVideoLocalStateEncoding`	`2`
`AgoraVideoLocalStateFailed`	`3`

AgoraVideoMirrorMode 3 members

Member	value
`AgoraVideoMirrorModeAuto`	`0`
`AgoraVideoMirrorModeEnabled`	`1`
`AgoraVideoMirrorModeDisabled`	`2`

AgoraVideoModulePosition 4 members

Member	value
`AgoraVideoModulePositionPostCapture`	`1`
`AgoraVideoModulePositionPreRenderer`	`2`
`AgoraVideoModulePositionPreEncoder`	`4`
`AgoraVideoModulePositionPostCaptureOrigin`	`8`

AgoraVideoOutputOrientationMode 3 members

Member	value
`AgoraVideoOutputOrientationModeAdaptative`	`0`
`AgoraVideoOutputOrientationModeFixedLandscape`	`1`
`AgoraVideoOutputOrientationModeFixedPortrait`	`2`

AgoraVideoQualityAdaptIndication 3 members

Member	value
`AgoraVideoQualityAdaptNone`	`0`
`AgoraVideoQualityAdaptUpBandwidth`	`1`
`AgoraVideoQualityAdaptDownBandwidth`	`2`

AgoraVideoRemoteReason 12 members

Member	value
`AgoraVideoRemoteReasonInternal`	`0`
`AgoraVideoRemoteReasonCongestion`	`1`
`AgoraVideoRemoteReasonRecovery`	`2`
`AgoraVideoRemoteReasonLocalMuted`	`3`
`AgoraVideoRemoteReasonLocalUnmuted`	`4`
`AgoraVideoRemoteReasonRemoteMuted`	`5`
`AgoraVideoRemoteReasonRemoteUnmuted`	`6`
`AgoraVideoRemoteReasonRemoteOffline`	`7`
`AgoraVideoRemoteReasonAudioFallback`	`8`
`AgoraVideoRemoteReasonAudioFallbackRecovery`	`9`
`AgoraVideoRemoteReasonSDKInBackground`	`12`
`AgoraVideoRemoteReasonCodecNotSupport`	`13`

AgoraVideoRemoteState 5 members

Member	value
`AgoraVideoRemoteStateStopped`	`0`
`AgoraVideoRemoteStateStarting`	`1`
`AgoraVideoRemoteStateDecoding`	`2`
`AgoraVideoRemoteStateFrozen`	`3`
`AgoraVideoRemoteStateFailed`	`4`

AgoraVideoRenderMode 3 members

Member	value
`AgoraVideoRenderModeHidden`	`1`
`AgoraVideoRenderModeFit`	`2`
`AgoraVideoRenderModeAdaptive`	`3`

AgoraVideoSourceType 17 members

Member	value
`AgoraVideoSourceTypeCamera`	`0`
`AgoraVideoSourceTypeCameraSecondary`	`1`
`AgoraVideoSourceTypeScreen`	`2`
`AgoraVideoSourceTypeScreenSecondary`	`3`
`AgoraVideoSourceTypeCustom`	`4`
`AgoraVideoSourceTypeMediaPlayer`	`5`
`AgoraVideoSourceTypeImagePNG`	`6`
`AgoraVideoSourceTypeImageJPEG`	`7`
`AgoraVideoSourceTypeImageGIF`	`8`
`AgoraVideoSourceTypeRemote`	`9`
`AgoraVideoSourceTypeTransCoded`	`10`
`AgoraVideoSourceTypeCameraThird`	`11`
`AgoraVideoSourceTypeCameraFourth`	`12`
`AgoraVideoSourceTypeScreenThird`	`13`
`AgoraVideoSourceTypeScreenFourth`	`14`
`AgoraVideoSourceTypeSpeechDriven`	`15`
`AgoraVideoSourceTypeUnknown`	`100`

AgoraVideoStreamType 8 members

Member	value
`AgoraVideoStreamTypeHigh`	`0`
`AgoraVideoStreamTypeLow`	`1`
`AgoraVideoStreamTypeLayer1`	`4`
`AgoraVideoStreamTypeLayer2`	`5`
`AgoraVideoStreamTypeLayer3`	`6`
`AgoraVideoStreamTypeLayer4`	`7`
`AgoraVideoStreamTypeLayer5`	`8`
`AgoraVideoStreamTypeLayer6`	`9`

AgoraVideoTranscoderError 7 members

Member	value
`AgoraVideoTranscoderErrorOK`	`0`
`AgoraVideoTranscoderErrorVideoSourceNotReady`	`1`
`AgoraVideoTranscoderErrorInvalidVideoSourceType`	`2`
`AgoraVideoTranscoderErrorInvalidImagePath`	`3`
`AgoraVideoTranscoderErrorUnsupportImageFormat`	`4`
`AgoraVideoTranscoderErrorInvalidLayout`	`5`
`AgoraVideoTranscoderErrorInternal`	`20`

AgoraVideoViewSetupMode 3 members

Member	value
`AgoraVideoViewSetupReplace`	`0`
`AgoraVideoViewSetupAdd`	`1`
`AgoraVideoViewSetupRemove`	`2`

AgoraVirtualBackgroundSourceType 5 members

Member	value
`AgoraVirtualBackgroundNone`	`0`
`AgoraVirtualBackgroundColor`	`1`
`AgoraVirtualBackgroundImg`	`2`
`AgoraVirtualBackgroundBlur`	`3`
`AgoraVirtualBackgroundVideo`	`4`

AgoraVoiceAITunerType 10 members

Member	value
`AgoraVoiceAITunerMatureMale`	`0`
`AgoraVoiceAITunerFreshMale`	`1`
`AgoraVoiceAITunerElegantFemale`	`2`
`AgoraVoiceAITunerSweetFemale`	`3`
`AgoraVoiceAITunerWarmMaleSinging`	`4`
`AgoraVoiceAITunerGentleFemaleSinging`	`5`
`AgoraVoiceAITunerHuskyMaleSinging`	`6`
`AgoraVoiceAITunerWarmElegantFemaleSinging`	`7`
`AgoraVoiceAITunerPowerfulMaleSinging`	`8`
`AgoraVoiceAITunerDreamyFemaleSinging`	`9`

AgoraVoiceBeautifierPreset 14 members

Member	value
`AgoraVoiceBeautifierPresetOff`	`0`
`AgoraVoiceBeautifierPresetChatBeautifierMagnetic`	`16843008`
`AgoraVoiceBeautifierPresetChatBeautifierFresh`	`16843264`
`AgoraVoiceBeautifierPresetChatBeautifierVitality`	`16843520`
`AgoraVoiceBeautifierPresetSingingBeautifier`	`16908544`
`AgoraVoiceBeautifierTimbreTransformationVigorous`	`16974080`
`AgoraVoiceBeautifierTimbreTransformationDeep`	`16974336`
`AgoraVoiceBeautifierTimbreTransformationMellow`	`16974592`
`AgoraVoiceBeautifierTimbreTransformationFalsetto`	`16974848`
`AgoraVoiceBeautifierTimbreTransformationFull`	`16975104`
`AgoraVoiceBeautifierTimbreTransformationClear`	`16975360`
`AgoraVoiceBeautifierTimbreTransformationResounding`	`16975616`
`AgoraVoiceBeautifierTimbreTransformatRinging`	`16975872`
`AgoraVoiceBeautifierUltraHighQuality`	`17039616`

AgoraVoiceConversionPreset 16 members

Member	value
`AgoraVoiceConversionPresetOff`	`0`
`AgoraVoiceConversionPresetNeutral`	`50397440`
`AgoraVoiceConversionPresetSweet`	`50397696`
`AgoraVoiceConversionPresetChangerSolid`	`50397952`
`AgoraVoiceConversionPresetChangerBass`	`50398208`
`AgoraVoiceConversionPresetChangerCartoon`	`50398464`
`AgoraVoiceConversionPresetChangerChildlike`	`50398720`
`AgoraVoiceConversionPresetChangerPhoneOperator`	`50398976`
`AgoraVoiceConversionPresetChangerMonster`	`50399232`
`AgoraVoiceConversionPresetChangerTransformers`	`50399488`
`AgoraVoiceConversionPresetChangerGroot`	`50399744`
`AgoraVoiceConversionPresetChangerDarthVader`	`50400000`
`AgoraVoiceConversionPresetChangerIronLady`	`50400256`
`AgoraVoiceConversionPresetChangerShinchan`	`50400512`
`AgoraVoiceConversionPresetChangerGirlishMan`	`50400768`
`AgoraVoiceConversionPresetChangerChipmunk`	`50401024`

AUDIO_AINS_MODE 3 members

Member	value
`AINS_MODE_BALANCED`	`0`
`AINS_MODE_AGGRESSIVE`	`1`
`AINS_MODE_ULTRALOWLATENCY`	`2`

ScreenColorType 3 members

Member	value
`ScreenColorAuto`	`0`
`ScreenColorGreen`	`1`
`ScreenColorBlue`	`2`

SegModelType 2 members

Member	value
`SegModelAgoraAi`	`null`
`SegModelAgoraGreen`	`2`

WatermarkBufferFormat 4 members

Member	value
`WatermarkBufferFormatI420`	`1`
`WatermarkBufferFormatBGRA`	`2`
`WatermarkBufferFormatNV21`	`3`
`WatermarkBufferFormatRGBA`	`4`

WatermarkType 2 members

Member	value
`WatermarkTypeImage`	`0`
`WatermarkTypeBuffer`	`1`

error-code constants

Constant	value
`AgoraErrorCodeAdmGeneralError`	`1005`
`AgoraErrorCodeAdmInitLoopback`	`1022`
`AgoraErrorCodeAdmInitPlayout`	`1008`
`AgoraErrorCodeAdmInitRecording`	`1011`
`AgoraErrorCodeAdmJavaResource`	`1006`
`AgoraErrorCodeAdmNoPlayoutDevice`	`1360`
`AgoraErrorCodeAdmNoRecordingDevice`	`1359`
`AgoraErrorCodeAdmPlayAbnormalFrequency`	`1020`
`AgoraErrorCodeAdmRecordAbnormalFrequency`	`1021`
`AgoraErrorCodeAdmRecordAudioFailed`	`1018`
`AgoraErrorCodeAdmRuntimePlayoutError`	`1015`
`AgoraErrorCodeAdmRuntimeRecordingError`	`1017`
`AgoraErrorCodeAdmSampleRate`	`1007`
`AgoraErrorCodeAdmStartLoopback`	`1023`
`AgoraErrorCodeAdmStartPlayout`	`1009`
`AgoraErrorCodeAdmStartRecording`	`1012`
`AgoraErrorCodeAdmStopPlayout`	`1010`
`AgoraErrorCodeAdmStopRecording`	`1013`
`AgoraErrorCodeAlreadyInUse`	`19`
`AgoraErrorCodeBitrateLimit`	`115`
`AgoraErrorCodeBufferTooSmall`	`6`
`AgoraErrorCodeConnectionInterrupted`	`111`
`AgoraErrorCodeConnectionLost`	`112`
`AgoraErrorCodeDecryptionFailed`	`120`
`AgoraErrorCodeEncryptedStreamNotAllowedPublish`	`130`
`AgoraErrorCodeFailed`	`1`
`AgoraErrorCodeInitNetEngine`	`21`
`AgoraErrorCodeInvalidAppId`	`101`
`AgoraErrorCodeInvalidArgument`	`2`
`AgoraErrorCodeInvalidChannelId`	`102`
`AgoraErrorCodeInvalidState`	`8`
`AgoraErrorCodeInvalidToken`	`110`
`AgoraErrorCodeInvalidUserAccount`	`134`
`AgoraErrorCodeJoinChannelRejected`	`17`
`AgoraErrorCodeLeaveChannelRejected`	`18`
`AgoraErrorCodeLoadMediaEngine`	`1001`
`AgoraErrorCodeNoError`	`0`
`AgoraErrorCodeNoServerResources`	`103`
`AgoraErrorCodeNotInChannel`	`113`
`AgoraErrorCodeNotInitialized`	`7`
`AgoraErrorCodeNotReady`	`3`
`AgoraErrorCodeNotSupported`	`4`
`AgoraErrorCodePcmSendBufferOverflow`	`201`
`AgoraErrorCodePcmSendFormat`	`200`
`AgoraErrorCodeResourceLimited`	`22`
`AgoraErrorCodeSizeTooLarge`	`114`
`AgoraErrorCodeStartCall`	`1002`
`AgoraErrorCodeStartCamera`	`1003`
`AgoraErrorCodeStartVideoRender`	`1004`
`AgoraErrorCodeTimedOut`	`10`
`AgoraErrorCodeTokenExpired`	`109`
`AgoraErrorCodeTooManyDataStreams`	`116`
`AgoraErrorCodeVcmEncoderEncodeError`	`1602`
`AgoraErrorCodeVcmEncoderInitError`	`1601`
`AgoraErrorCodeVcmEncoderSetError`	`1603`
`AgoraErrorCodeVcmUnknownError`	`1600`
`AgoraErrorCodeVdmCameraNotAuthorized`	`1501`
`AgoraErrorCodeVideoEffectAssetInvalid`	`1700`
`AgoraErrorCodeVideoEffectEngineInvalid`	`1702`
`AgoraErrorCodeVideoEffectInvalidBundlePath`	`1707`
`AgoraErrorCodeVideoEffectInvalidParam`	`1705`
`AgoraErrorCodeVideoEffectNodeNotActive`	`1704`
`AgoraErrorCodeVideoEffectNotSupported`	`1706`
`AgoraErrorCodeVideoEffectSaveFailed`	`1701`
`AgoraErrorCodeWatermarkAGRB`	`128`
`AgoraErrorCodeWatermarkInfo`	`127`
`AgoraErrorCodeWatermarkParam`	`124`
`AgoraErrorCodeWatermarkPath`	`125`
`AgoraErrorCodeWatermarkPng`	`126`
`AgoraErrorCodeWatermarkRead`	`129`

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.

Interface	Member
`AgoraAudioEncodedFrameDelegate`	`onMixedEncodedAudioFrame`
`AgoraAudioEncodedFrameDelegate`	`onPlaybackEncodedAudioFrame`
`AgoraAudioEncodedFrameDelegate`	`onRecordEncodedAudioFrame`
`AgoraAudioFrameDelegate`	`getEarMonitoringAudioParams`
`AgoraAudioFrameDelegate`	`getMixedAudioParams`
`AgoraAudioFrameDelegate`	`getObservedAudioFramePosition`
`AgoraAudioFrameDelegate`	`getPlaybackAudioParams`
`AgoraAudioFrameDelegate`	`getRecordAudioParams`
`AgoraAudioFrameDelegate`	`onEarMonitoringAudioFrame`
`AgoraAudioFrameDelegate`	`onMixedAudioFrame`
`AgoraAudioFrameDelegate`	`onPlaybackAudioFrame`
`AgoraAudioFrameDelegate`	`onPlaybackAudioFrameBeforeMixing`
`AgoraAudioFrameDelegate`	`onRecordAudioFrame`
`AgoraAudioSpectrumDelegate`	`onLocalAudioSpectrum`
`AgoraAudioSpectrumDelegate`	`onRemoteAudioSpectrum`
`AgoraChannelMediaRelayConfiguration`	`removeDestinationInfoForChannelName`
`AgoraChannelMediaRelayConfiguration`	`setDestinationInfo`
`AgoraEncodedVideoFrameDelegate`	`onEncodedVideoFrameReceived`
`AgoraLiveTranscoding`	`addUser`
`AgoraLiveTranscoding`	`defaultTranscoding`
`AgoraLiveTranscoding`	`getAdvancedFeatures`
`AgoraLiveTranscoding`	`removeUser`
`AgoraLiveTranscoding`	`setAdvancedFeatures`
`AgoraLocalSpatialAudioKit`	`destroy`
`AgoraLocalSpatialAudioKit`	`removeRemotePosition`
`AgoraLocalSpatialAudioKit`	`setRemoteAudioAttenuation`
`AgoraLocalSpatialAudioKit`	`sharedLocalSpatialAudioWithConfig`
`AgoraLocalSpatialAudioKit`	`updateRemotePosition`
`AgoraMediaMetadataDataSource`	`metadataMaxSize`
`AgoraMediaMetadataDataSource`	`readyToSendMetadataAtTimestamp`
`AgoraMediaMetadataDelegate`	`didMetadataReceived`
`AgoraMediaRecorder`	`enableMainQueueDispatch`
`AgoraMediaRecorder`	`setMediaRecorderDelegate`
`AgoraMediaRecorder`	`startRecording`
`AgoraMediaRecorder`	`stopRecording`
`AgoraMediaRecorderDelegate`	`mediaRecorder`
`AgoraRtcEngineDelegate`	`audioQualityBlock`
`AgoraRtcEngineDelegate`	`onEventWithContext`
`AgoraRtcEngineDelegate`	`onExtensionErrorWithContext`
`AgoraRtcEngineDelegate`	`onExtensionStartedWithContext`
`AgoraRtcEngineDelegate`	`onExtensionStoppedWithContext`
`AgoraRtcEngineDelegate`	`rtcEngineConnectionDidBanned`
`AgoraRtcEngineDelegate`	`rtcEngineConnectionDidInterrupted`
`AgoraRtcEngineDelegate`	`rtcEngineConnectionDidLost`
`AgoraRtcEngineDelegate`	`rtcEngineDidAudioEffectFinish`
`AgoraRtcEngineDelegate`	`rtcEngineLocalAudioMixingDidFinish`
`AgoraRtcEngineDelegate`	`rtcEngineRequestToken`
`AgoraRtcEngineDelegate`	`rtcEngineTranscodingUpdated`
`AgoraRtcEngineDelegate`	`rtcEngineVideoDidStop`
`AgoraRtcEngineKit`	`adjustCustomAudioPlayoutVolume`
`AgoraRtcEngineKit`	`adjustCustomAudioPublishVolume`
`AgoraRtcEngineKit`	`adjustLoopbackSignalVolume`
`AgoraRtcEngineKit`	`createCustomAudioTrack`
`AgoraRtcEngineKit`	`createCustomVideoTrack`
`AgoraRtcEngineKit`	`createMediaPlayerWithDelegate`
`AgoraRtcEngineKit`	`createMediaRecorder`
`AgoraRtcEngineKit`	`createVideoEffectObjectWithBundlePath`
`AgoraRtcEngineKit`	`delegate`
`AgoraRtcEngineKit`	`destroyCustomAudioTrack`
`AgoraRtcEngineKit`	`destroyCustomVideoTrack`
`AgoraRtcEngineKit`	`destroyMediaPlayer`
`AgoraRtcEngineKit`	`destroyMediaRecorder`
`AgoraRtcEngineKit`	`destroyVideoEffectObject`
`AgoraRtcEngineKit`	`enableContentInspect`
`AgoraRtcEngineKit`	`enableCustomAudioLocalPlayback`
`AgoraRtcEngineKit`	`enableExtensionWithVendor`
`AgoraRtcEngineKit`	`enableLoopbackRecording`
`AgoraRtcEngineKit`	`getExtensionPropertyWithVendor`
`AgoraRtcEngineKit`	`getScreenCaptureSourcesWithThumbSize`
`AgoraRtcEngineKit`	`pauseAllChannelMediaRelay`
`AgoraRtcEngineKit`	`pullPlaybackAudioFrameRawData`
`AgoraRtcEngineKit`	`pullPlaybackAudioFrameSampleBufferByLengthInByte`
`AgoraRtcEngineKit`	`pushExternalAudioFrameRawData`
`AgoraRtcEngineKit`	`pushExternalAudioFrameSampleBuffer`
`AgoraRtcEngineKit`	`pushExternalVideoFrame`
`AgoraRtcEngineKit`	`registerAudioSpectrumDelegate`
`AgoraRtcEngineKit`	`registerExtensionWithVendor`
`AgoraRtcEngineKit`	`resumeAllChannelMediaRelay`
`AgoraRtcEngineKit`	`rtcEngine`
`AgoraRtcEngineKit`	`setAVSyncSource`
`AgoraRtcEngineKit`	`setAudioEncodedFrameDelegate`
`AgoraRtcEngineKit`	`setAudioFrameDelegate`
`AgoraRtcEngineKit`	`setCloudProxy`
`AgoraRtcEngineKit`	`setEncodedVideoFrameDelegate`
`AgoraRtcEngineKit`	`setExtensionPropertyWithVendor`
`AgoraRtcEngineKit`	`setExtensionProviderPropertyWithVendor`
`AgoraRtcEngineKit`	`setExternalVideoSource`
`AgoraRtcEngineKit`	`setMediaMetadataDataSource`
`AgoraRtcEngineKit`	`setMediaMetadataDelegate`
`AgoraRtcEngineKit`	`setSubscribeAudioAllowlist`
`AgoraRtcEngineKit`	`setSubscribeAudioBlocklist`
`AgoraRtcEngineKit`	`setSubscribeVideoAllowlist`
`AgoraRtcEngineKit`	`setSubscribeVideoBlocklist`
`AgoraRtcEngineKit`	`setVideoFrameDelegate`
`AgoraRtcEngineKit`	`startLocalVideoTranscoder`
`AgoraRtcEngineKit`	`startOrUpdateChannelMediaRelay`
`AgoraRtcEngineKit`	`startRtmpStreamWithTranscoding`
`AgoraRtcEngineKit`	`startRtmpStreamWithoutTranscoding`
`AgoraRtcEngineKit`	`startScreenCaptureByDisplayId`
`AgoraRtcEngineKit`	`startScreenCaptureByWindowId`
`AgoraRtcEngineKit`	`stopChannelMediaRelay`
`AgoraRtcEngineKit`	`stopLocalVideoTranscoder`
`AgoraRtcEngineKit`	`stopRtmpStream`
`AgoraRtcEngineKit`	`unregisterAudioSpectrumDelegate`
`AgoraRtcEngineKit`	`updateLocalTranscoderConfiguration`
`AgoraRtcEngineKit`	`updateRtmpTranscoding`
`AgoraRtcEngineKit`	`updateScreenCaptureParameters`
`AgoraRtcEngineKit`	`updateScreenCaptureRegion`
`AgoraRtcMediaPlayerAudioFrameDelegate`	`AgoraRtcMediaPlayer`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`cacheDir`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`cacheFileCount`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`createMediaPlayerCacheManager`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`enableAutoRemoveCache`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`maxCacheFileCount`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`maxCacheFileSize`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`removeAllCaches`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`removeCacheByUri`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`removeOldCache`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`setCacheDir`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`setMaxCacheFileCount`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`setMaxCacheFileSize`
`AgoraRtcMediaPlayerCacheManagerProtocol`	`sharedInstance`
`AgoraRtcMediaPlayerProtocol`	`adjustPlayoutVolume`
`AgoraRtcMediaPlayerProtocol`	`adjustPublishSignalVolume`
`AgoraRtcMediaPlayerProtocol`	`getDuration`
`AgoraRtcMediaPlayerProtocol`	`getMediaPlayerId`
`AgoraRtcMediaPlayerProtocol`	`getMute`
`AgoraRtcMediaPlayerProtocol`	`getPlaySrc`
`AgoraRtcMediaPlayerProtocol`	`getPlayerState`
`AgoraRtcMediaPlayerProtocol`	`getPlayoutVolume`
`AgoraRtcMediaPlayerProtocol`	`getPosition`
`AgoraRtcMediaPlayerProtocol`	`getPublishSignalVolume`
`AgoraRtcMediaPlayerProtocol`	`getStreamByIndex`
`AgoraRtcMediaPlayerProtocol`	`getStreamCount`
`AgoraRtcMediaPlayerProtocol`	`mute`
`AgoraRtcMediaPlayerProtocol`	`open`
`AgoraRtcMediaPlayerProtocol`	`openWithMediaSource`
`AgoraRtcMediaPlayerProtocol`	`pause`
`AgoraRtcMediaPlayerProtocol`	`play`
`AgoraRtcMediaPlayerProtocol`	`playPreloadedSrc`
`AgoraRtcMediaPlayerProtocol`	`preloadSrc`
`AgoraRtcMediaPlayerProtocol`	`resume`
`AgoraRtcMediaPlayerProtocol`	`seekToPosition`
`AgoraRtcMediaPlayerProtocol`	`selectAudioTrack`
`AgoraRtcMediaPlayerProtocol`	`selectMultiAudioTrack`
`AgoraRtcMediaPlayerProtocol`	`setAudioDualMonoMode`
`AgoraRtcMediaPlayerProtocol`	`setAudioPitch`
`AgoraRtcMediaPlayerProtocol`	`setLoopCount`
`AgoraRtcMediaPlayerProtocol`	`setPlaybackSpeed`
`AgoraRtcMediaPlayerProtocol`	`setPlayerOption`
`AgoraRtcMediaPlayerProtocol`	`setPlayerOptionString`
`AgoraRtcMediaPlayerProtocol`	`setRenderMode`
`AgoraRtcMediaPlayerProtocol`	`setSpatialAudioParams`
`AgoraRtcMediaPlayerProtocol`	`setVideoFrameDelegate`
`AgoraRtcMediaPlayerProtocol`	`setView`
`AgoraRtcMediaPlayerProtocol`	`switchSrc`
`AgoraRtcMediaPlayerProtocol`	`unloadSrc`
`AgoraRtcMediaPlayerVideoFrameDelegate`	`AgoraRtcMediaPlayerGetVideoPixelFormat`
`AgoraRte`	`destroy`
`AgoraRte`	`getConfigs`
`AgoraRte`	`getFromBridge`
`AgoraRte`	`initMediaEngine`
`AgoraRte`	`initWithInitialConfig`
`AgoraRte`	`setConfigs`
`AgoraRteCanvas`	`addView`
`AgoraRteCanvas`	`getConfigs`
`AgoraRteCanvas`	`initWithRte`
`AgoraRteCanvas`	`removeView`
`AgoraRteCanvas`	`setConfigs`
`AgoraRteCanvasConfig`	`setVideoMirrorMode`
`AgoraRteCanvasConfig`	`setVideoRenderMode`
`AgoraRteCanvasConfig`	`videoMirrorMode`
`AgoraRteCanvasConfig`	`videoRenderMode`
`AgoraRteConfig`	`appId`
`AgoraRteConfig`	`jsonParameter`
`AgoraRteConfig`	`setAppId`
`AgoraRteConfig`	`setJsonParameter`
`AgoraRteError`	`code`
`AgoraRteError`	`message`
`AgoraRtePlayer`	`getConfigs`
`AgoraRtePlayer`	`getInfo`
`AgoraRtePlayer`	`getPosition`
`AgoraRtePlayer`	`getStats`
`AgoraRtePlayer`	`initWithRte`
`AgoraRtePlayer`	`muteAudio`
`AgoraRtePlayer`	`muteVideo`
`AgoraRtePlayer`	`openWithUrl`
`AgoraRtePlayer`	`pause`
`AgoraRtePlayer`	`play`
`AgoraRtePlayer`	`preloadWithUrl`
`AgoraRtePlayer`	`registerObserver`
`AgoraRtePlayer`	`seek`
`AgoraRtePlayer`	`setCanvas`
`AgoraRtePlayer`	`setConfigs`
`AgoraRtePlayer`	`stop`
`AgoraRtePlayer`	`switchWithUrl`
`AgoraRtePlayer`	`unregisterObserver`
`AgoraRtePlayerConfig`	`abrFallbackLayer`
`AgoraRtePlayerConfig`	`abrSubscriptionLayer`
`AgoraRtePlayerConfig`	`autoPlay`
`AgoraRtePlayerConfig`	`loopCount`
`AgoraRtePlayerConfig`	`playbackSpeed`
`AgoraRtePlayerConfig`	`playoutVolume`
`AgoraRtePlayerConfig`	`setAbrFallbackLayer`
`AgoraRtePlayerConfig`	`setAbrSubscriptionLayer`
`AgoraRtePlayerConfig`	`setAutoPlay`
`AgoraRtePlayerConfig`	`setLoopCount`
`AgoraRtePlayerConfig`	`setPlaybackSpeed`
`AgoraRtePlayerConfig`	`setPlayoutVolume`
`AgoraRtePlayerObserver`	`onAudioVolumeIndication`
`AgoraRtePlayerObserver`	`onEvent`
`AgoraRtePlayerObserver`	`onMetadata`
`AgoraRtePlayerObserver`	`onPlayerInfoUpdated`
`AgoraRtePlayerObserver`	`onPositionChanged`
`AgoraRtePlayerObserver`	`onResolutionChanged`
`AgoraRtePlayerObserver`	`onStateChanged`
`AgoraSpatialAudioKitBase`	`muteAllRemoteAudioStreams`
`AgoraSpatialAudioKitBase`	`muteLocalAudioStream`
`AgoraSpatialAudioKitBase`	`muteRemoteAudioStream`
`AgoraSpatialAudioKitBase`	`setAudioRecvRange`
`AgoraSpatialAudioKitBase`	`setDistanceUnit`
`AgoraSpatialAudioKitBase`	`setMaxAudioRecvCount`
`AgoraSpatialAudioKitBase`	`setPlayerAttenuation`
`AgoraSpatialAudioKitBase`	`setZones`
`AgoraSpatialAudioKitBase`	`updatePlayerPositionInfo`
`AgoraSpatialAudioKitBase`	`updateSelfPosition`
`AgoraVideoEffectObject`	`addOrUpdateVideoEffectWithNodeId`
`AgoraVideoEffectObject`	`getVideoEffectBoolParamWithOption`
`AgoraVideoEffectObject`	`getVideoEffectFloatParamWithOption`
`AgoraVideoEffectObject`	`getVideoEffectIntParamWithOption`
`AgoraVideoEffectObject`	`performVideoEffectActionWithNodeId`
`AgoraVideoEffectObject`	`removeVideoEffectWithNodeId`
`AgoraVideoEffectObject`	`setVideoEffectBoolParamWithOption`
`AgoraVideoEffectObject`	`setVideoEffectFloatParamWithOption`
`AgoraVideoEffectObject`	`setVideoEffectIntParamWithOption`
`AgoraVideoEffectObject`	`setVideoEffectStringParamWithOption`
`AgoraVideoEncoderConfiguration`	`initWithSize`
`AgoraVideoEncoderConfiguration`	`initWithWidth`
`AgoraVideoFrameDelegate`	`getMirrorApplied`
`AgoraVideoFrameDelegate`	`getObservedFramePosition`
`AgoraVideoFrameDelegate`	`getRotationApplied`
`AgoraVideoFrameDelegate`	`getVideoFormatPreference`
`AgoraVideoFrameDelegate`	`getVideoFrameProcessMode`
`AgoraVideoFrameDelegate`	`onCaptureVideoFrame`
`AgoraVideoFrameDelegate`	`onPreEncodeVideoFrame`
`AgoraVideoFrameDelegate`	`onRenderVideoFrame`
`__unattributed__`	`enableContentInspectEx`
`__unattributed__`	`enableLoopbackRecordingEx`
`__unattributed__`	`joinChannelExByToken`
`__unattributed__`	`leaveChannelEx`
`__unattributed__`	`pauseAllChannelMediaRelayEx`
`__unattributed__`	`resumeAllChannelMediaRelayEx`
`__unattributed__`	`setSubscribeAudioAllowlistEx`
`__unattributed__`	`setSubscribeAudioBlocklistEx`
`__unattributed__`	`setSubscribeVideoAllowlistEx`
`__unattributed__`	`setSubscribeVideoBlocklistEx`
`__unattributed__`	`startOrUpdateChannelMediaRelayEx`
`__unattributed__`	`startRtmpStreamWithTranscodingEx`
`__unattributed__`	`startRtmpStreamWithoutTranscodingEx`
`__unattributed__`	`stopChannelMediaRelayEx`
`__unattributed__`	`stopRtmpStreamEx`
`__unattributed__`	`updateRtmpTranscodingEx`