nimeet 文档中心
English

iOS API 参考

构建时从公开 SDK 接口定义生成:接口、方法重载、属性、事件、枚举与错误码。

由公开 SDK 接口定义生成

版本 v1.1.0 · 更新于 2026-10-26 · 修订 1

接口概览

本页列出 iOS 端公开 API 的类、方法、重载、属性、事件与错误码,接口定义与 SDK 包版本一致。

核对项数量
接口 / 类132
方法649
方法重载649
属性560
枚举151
错误码常量70

可用性

该端 SDK:正式可用。接口定义与 SDK 包版本一致;运行时的能力边界以实际发布的 SDK 包为准。

加入频道核心链路

按 join / leave / publish / subscribe 的典型调用顺序整理;参数表在“最小可运行链路”一节展开。

步骤接口方法重载数
开启视频与预览AgoraRtcEngineKitenableVideo1
加入频道AgoraRtcEngineKitjoinChannelByToken:channelId:info:uid:joinSuccess:1
离开频道AgoraRtcEngineKitleaveChannel:1
创建 / 初始化AgoraRtcEngineKitsharedEngineWithAppId:delegate:1

最小可运行链路的参数

参数类型可选可变参数
tokenNSString*是否
channelIdNSString*否否
infoNSString*是否
uidNSUInteger否否
joinSuccessBlockvoid(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)是否
leaveChannelBlockvoid(^ )(AgoraChannelStats*stat)是否
appIdNSString*否否
delegateid是否

接口索引

接口方法属性事件
__unattributed__5500
AdvancedConfigInfo010
AgoraAdvancedAudioOptions010
AgoraAdvancedVideoOptions030
AgoraAudioEncodedFrameDelegate300
AgoraAudioEncodedFrameDelegateConfig020
AgoraAudioFrame080
AgoraAudioFrameDelegate1000
AgoraAudioParams040
AgoraAudioRecordingConfiguration050
AgoraAudioSpectrumDelegate200
AgoraAudioSpectrumInfo020
AgoraAudioTrackConfig020
AgoraBeautyOptions050
AgoraCameraCapturerConfiguration060
AgoraChannelMediaRelayConfiguration220
AgoraChannelMediaRelayInfo030
AgoraChannelStats0280
AgoraClientRoleOptions010
AgoraClimaxSegment020
AgoraColorEnhanceOptions020
AgoraContentInspectConfig030
AgoraContentInspectModule030
AgoraDataStreamConfig020
AgoraEchoTestConfiguration060
AgoraEncodedAudioFrameInfo040
AgoraEncodedVideoFrameDelegate100
AgoraEncodedVideoFrameInfo0100
AgoraEncryptionConfig040
AgoraExtensionContext040
AgoraFacePositionInfo050
AgoraFaceShapeAreaOptions020
AgoraFaceShapeBeautyOptions020
AgoraFilterEffectOptions020
AgoraFocalLengthInfo020
AgoraImage040
AgoraImageTrackOptions030
AgoraLastmileProbeConfig040
AgoraLastmileProbeOneWayResult030
AgoraLastmileProbeResult040
AgoraLeaveChannelOptions030
AgoraLiveStreamAdvancedFeature020
AgoraLiveTranscoding5160
AgoraLiveTranscodingUser050
AgoraLocalAccessPointConfiguration060
AgoraLocalAudioMixerConfiguration020
AgoraLocalSpatialAudioConfig010
AgoraLocalSpatialAudioKit500
AgoraLocalTranscoderConfiguration030
AgoraLogConfig030
AgoraLowlightEnhanceOptions020
AgoraMediaMetadataDataSource200
AgoraMediaMetadataDelegate100
AgoraMediaPlayerCacheStatistics030
AgoraMediaPlayerPlaybackStats040
AgoraMediaPlayerSrcInfo020
AgoraMediaPlayerUpdatedInfo060
AgoraMediaRecorder400
AgoraMediaRecorderConfiguration0110
AgoraMediaRecorderDelegate200
AgoraMediaRecorderInfo030
AgoraMediaSource0100
AgoraMetadata040
AgoraMixedAudioStream040
AgoraMultipathStats080
AgoraMusic0110
AgoraMusicCacheInfo020
AgoraMusicChartInfo020
AgoraMusicCollection050
AgoraMusicContentCenter1800
AgoraMusicContentCenterConfig060
AgoraMusicContentCenterEventDelegate500
AgoraMusicPlayerProtocol200
AgoraOutputVideoFrame0170
AgoraPathStats030
AgoraRecorderStreamInfo030
AgoraRemoteVoicePositionInfo020
AgoraRhythmPlayerConfig020
AgoraRtcAudioVolumeInfo040
AgoraRtcChannelMediaOptions0380
AgoraRtcConnection020
AgoraRtcEngineConfig0100
AgoraRtcEngineDelegate8200
AgoraRtcEngineKit29500
AgoraRtcLocalAudioStats090
AgoraRtcLocalVideoStats0230
AgoraRtcMediaPlayerAudioFrameDelegate100
AgoraRtcMediaPlayerCacheManagerProtocol1300
AgoraRtcMediaPlayerDelegate1100
AgoraRtcMediaPlayerProtocol3700
AgoraRtcMediaPlayerVideoFrameDelegate300
AgoraRtcMediaStreamInfo0120
AgoraRtcRemoteAudioStats0190
AgoraRtcRemoteVideoStats0180
AgoraRtcVideoCanvas0120
AgoraRte600
AgoraRteCanvas500
AgoraRteCanvasConfig400
AgoraRteConfig400
AgoraRteError200
AgoraRtePlayer1800
AgoraRtePlayerConfig1200
AgoraRtePlayerObserver700
AgoraRtePlayerStats000
AgoraScreenAudioParameters010
AgoraScreenCaptureParameters2040
AgoraScreenVideoParameters040
AgoraSegmentationProperty030
AgoraSimulcastStreamConfig000
AgoraSnapshotConfig020
AgoraSpatialAudioKitBase1200
AgoraSpatialAudioParams080
AgoraSpatialAudioZone090
AgoraTranscodingVideoStream080
AgoraUplinkNetworkInfo010
AgoraUserInfo020
AgoraVideoCodecCapInfo030
AgoraVideoCodecCapLevels020
AgoraVideoDenoiserOptions020
AgoraVideoEffectObject1010
AgoraVideoEncoderConfiguration290
AgoraVideoFrame0160
AgoraVideoFrameDelegate800
AgoraVideoLayout080
AgoraVideoLayoutInfo040
AgoraVideoRenderingTracingInfo070
AgoraVideoSubscriptionOptions020
AgoraVirtualBackgroundSource040
LogUploadServerInfo040
WatermarkBuffer050
WatermarkConfig050
WatermarkOptions040

全部接口

__unattributed__ 55 方法 / 0 属性
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
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

方法明细:55 / 55(参数、返回值、错误码)

方法参数返回值错误
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错误码索引
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: NSIntegerint错误码索引
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOLint错误码索引
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: intint错误码索引
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:startPos:connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, startPos: intint错误码索引
preloadEffectEx:soundId:filePath:connection: AgoraRtcConnection*, soundId: int, filePath: NSString*int错误码索引
preloadEffectEx:soundId:filePath:startPos:connection: AgoraRtcConnection*, soundId: int, filePath: NSString*, startPos: intint错误码索引
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错误码索引
AdvancedConfigInfo 0 方法 / 1 属性
属性类型只读
logUploadServerLogUploadServerInfo*否
AgoraAdvancedAudioOptions 0 方法 / 1 属性
属性类型只读
audioProcessingChannelsAgoraAudioProcessChannels否
AgoraAdvancedVideoOptions 0 方法 / 3 属性
属性类型只读
encodingPreferenceAgoraEncodingPreference否
compressionPreferenceAgoraCompressionPreference否
encodeAlphaBOOL否
AgoraAudioEncodedFrameDelegate 3 方法 / 0 属性
typescript
onMixedEncodedAudioFrame:info:(frameData: NSData*, info: AgoraEncodedAudioFrameInfo*): void
onPlaybackEncodedAudioFrame:info:(frameData: NSData*, info: AgoraEncodedAudioFrameInfo*): void
onRecordEncodedAudioFrame:info:(frameData: NSData*, info: AgoraEncodedAudioFrameInfo*): void

方法明细:3 / 3(参数、返回值、错误码)

方法参数返回值错误
onMixedEncodedAudioFrame:info:frameData: NSData*, info: AgoraEncodedAudioFrameInfo*void错误码索引
onPlaybackEncodedAudioFrame:info:frameData: NSData*, info: AgoraEncodedAudioFrameInfo*void错误码索引
onRecordEncodedAudioFrame:info:frameData: NSData*, info: AgoraEncodedAudioFrameInfo*void错误码索引
AgoraAudioEncodedFrameDelegateConfig 0 方法 / 2 属性
属性类型只读
postionTypeAgoraAudioEncodedFrameDelegatePosition否
encodingTypeAgoraAudioEncodingType否
AgoraAudioFrame 0 方法 / 8 属性
属性类型只读
samplesPerChannelNSInteger否
bytesPerSampleNSInteger否
channelsNSInteger否
samplesPerSecNSInteger否
buffervoid*否
renderTimeMsint64_t否
avSyncTypeNSInteger否
rtpTimestampuint32_t否
AgoraAudioFrameDelegate 10 方法 / 0 属性
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

方法明细:10 / 10(参数、返回值、错误码)

方法参数返回值错误
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: NSUIntegerBOOL错误码索引
onRecordAudioFrame:channelId:frame: AgoraAudioFrame*, channelId: NSString*BOOL错误码索引
AgoraAudioParams 0 方法 / 4 属性
属性类型只读
sampleRateNSInteger否
channelNSInteger否
modeAgoraAudioRawFrameOperationMode否
samplesPerCallNSInteger否
AgoraAudioRecordingConfiguration 0 方法 / 5 属性
属性类型只读
filePathNSString*否
sampleRateNSUInteger否
fileRecordOptionAgoraAudioFileRecordingType否
qualityAgoraAudioRecordingQuality否
recordingChannelNSInteger否
AgoraAudioSpectrumDelegate 2 方法 / 0 属性
typescript
onLocalAudioSpectrum:(audioSpectrumData?: NSArray*): BOOL
onRemoteAudioSpectrum:(AudioSpectrumInfo?: NSArray*): BOOL

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
onLocalAudioSpectrum:audioSpectrumData?: NSArray*BOOL错误码索引
onRemoteAudioSpectrum:AudioSpectrumInfo?: NSArray*BOOL错误码索引
AgoraAudioSpectrumInfo 0 方法 / 2 属性
属性类型只读
uidNSInteger否
audioSpectrumDataNSArray*否
AgoraAudioTrackConfig 0 方法 / 2 属性
属性类型只读
enableLocalPlaybackBOOL否
enableAudioProcessingBOOL否
AgoraBeautyOptions 0 方法 / 5 属性
属性类型只读
lighteningContrastLevelAgoraLighteningContrastLevel否
lighteningLevelfloat否
smoothnessLevelfloat否
rednessLevelfloat否
sharpnessLevelfloat否
AgoraCameraCapturerConfiguration 0 方法 / 6 属性
属性类型只读
cameraDirectionAgoraCameraDirection否
cameraFocalLengthTypeAgoraFocalLength否
deviceIdNSString*否
dimensionsCGSize否
frameRateint否
followEncodeDimensionRatioBOOL否
AgoraChannelMediaRelayConfiguration 2 方法 / 2 属性
typescript
removeDestinationInfoForChannelName:(channelName: NSString*): BOOL
setDestinationInfo:forChannelName:(destinationInfo: AgoraChannelMediaRelayInfo*, channelName: NSString*): BOOL

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
removeDestinationInfoForChannelName:channelName: NSString*BOOL错误码索引
setDestinationInfo:forChannelName:destinationInfo: AgoraChannelMediaRelayInfo*, channelName: NSString*BOOL错误码索引
属性类型只读
destinationInfosNSDictionary*否
sourceInfoAgoraChannelMediaRelayInfo*否
AgoraChannelMediaRelayInfo 0 方法 / 3 属性
属性类型只读
tokenNSString*否
channelNameNSString*否
uidNSUInteger否
AgoraChannelStats 0 方法 / 28 属性
属性类型只读
durationNSUInteger否
txBytesNSUInteger否
rxBytesNSUInteger否
txAudioKBitrateNSUInteger否
rxAudioKBitrateNSUInteger否
txVideoKBitrateNSUInteger否
rxVideoKBitrateNSUInteger否
txAudioBytesNSUInteger否
txVideoBytesNSUInteger否
rxAudioBytesNSUInteger否
rxVideoBytesNSUInteger否
lastmileDelayNSUInteger否
userCountNSUInteger否
cpuAppUsagedouble否
cpuTotalUsagedouble否
gatewayRttNSInteger否
memoryAppUsageRatiodouble否
memoryTotalUsageRatiodouble否
memoryAppUsageInKbytesNSInteger否
connectTimeMsNSInteger否
txKBitrateNSUInteger否
rxKBitrateNSUInteger否
firstAudioPacketDurationNSInteger否
firstVideoPacketDurationNSInteger否
firstVideoKeyFramePacketDurationNSInteger否
packetsBeforeFirstKeyFramePacketNSInteger否
txPacketLossRateNSInteger否
rxPacketLossRateNSInteger否
AgoraClientRoleOptions 0 方法 / 1 属性
属性类型只读
audienceLatencyLevelAgoraAudienceLatencyLevelType否
AgoraClimaxSegment 0 方法 / 2 属性
属性类型只读
startTimeMsNSInteger否
endTimeMsNSInteger否
AgoraColorEnhanceOptions 0 方法 / 2 属性
属性类型只读
strengthLevelfloat否
skinProtectLevelfloat否
AgoraContentInspectConfig 0 方法 / 3 属性
属性类型只读
extraInfoNSString*否
serverConfigNSString*否
modulesNSArray*否
AgoraContentInspectModule 0 方法 / 3 属性
属性类型只读
typeAgoraContentInspectType否
intervalNSInteger否
positionAgoraVideoModulePosition否
AgoraDataStreamConfig 0 方法 / 2 属性
属性类型只读
orderedBOOL否
syncWithAudioBOOL否
AgoraEchoTestConfiguration 0 方法 / 6 属性
属性类型只读
viewVIEW_CLASS*否
enableAudioBOOL否
enableVideoBOOL否
tokenNSString*否
channelIdNSString*否
intervalInSecondsNSInteger否
AgoraEncodedAudioFrameInfo 0 方法 / 4 属性
属性类型只读
samplesPerChannelNSInteger否
channelsNSInteger否
samplesPerSecNSInteger否
codecTypeAgoraAudioCodecType否
AgoraEncodedVideoFrameDelegate 1 方法 / 0 属性
typescript
onEncodedVideoFrameReceived:length:info:channelId:uid:(videoData: NSData*, length: size_t, videoFrameInfo: AgoraEncodedVideoFrameInfo*, channelId: NSString*, uid: NSUInteger): BOOL

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onEncodedVideoFrameReceived:length:info:channelId:uid:videoData: NSData*, length: size_t, videoFrameInfo: AgoraEncodedVideoFrameInfo*, channelId: NSString*, uid: NSUIntegerBOOL错误码索引
AgoraEncodedVideoFrameInfo 0 方法 / 10 属性
属性类型只读
codecTypeAgoraVideoCodecType否
widthNSInteger否
heightNSInteger否
framesPerSecondNSInteger否
frameTypeAgoraVideoFrameType否
rotationNSInteger否
trackIdNSInteger否
captureTimeMsNSInteger否
decodeTimeMsNSInteger否
streamTypeAgoraVideoStreamType否
AgoraEncryptionConfig 0 方法 / 4 属性
属性类型只读
encryptionModeAgoraEncryptionMode否
encryptionKeyNSString*否
encryptionKdfSaltNSData*否
datastreamEncryptionEnabledBOOL否
AgoraExtensionContext 0 方法 / 4 属性
属性类型只读
isValidBOOL否
uidNSUInteger否
providerNameNSString*否
extensionNameNSString*否
AgoraFacePositionInfo 0 方法 / 5 属性
属性类型只读
xNSInteger否
yNSInteger否
widthNSInteger否
heightNSInteger否
distanceNSInteger否
AgoraFaceShapeAreaOptions 0 方法 / 2 属性
属性类型只读
shapeAreaAgoraFaceShapeArea否
shapeIntensityint否
AgoraFaceShapeBeautyOptions 0 方法 / 2 属性
属性类型只读
shapeStyleAgoraFaceShapeStyle否
styleIntensityint否
AgoraFilterEffectOptions 0 方法 / 2 属性
属性类型只读
pathNSString*否
strengthfloat否
AgoraFocalLengthInfo 0 方法 / 2 属性
属性类型只读
cameraDirectionint否
focalLengthTypeAgoraFocalLength否
AgoraImage 0 方法 / 4 属性
属性类型只读
urlNSURL*否
rectCGRect否
zOrderNSInteger否
alphadouble否
AgoraImageTrackOptions 0 方法 / 3 属性
属性类型只读
imageUrlNSString*否
fpsint否
mirrorModeAgoraVideoMirrorMode否
AgoraLastmileProbeConfig 0 方法 / 4 属性
属性类型只读
probeUplinkBOOL否
probeDownlinkBOOL否
expectedUplinkBitrateNSUInteger否
expectedDownlinkBitrateNSUInteger否
AgoraLastmileProbeOneWayResult 0 方法 / 3 属性
属性类型只读
packetLossRateNSUInteger否
jitterNSUInteger否
availableBandwidthNSUInteger否
AgoraLastmileProbeResult 0 方法 / 4 属性
属性类型只读
stateAgoraLastmileProbeResultState否
rttNSUInteger否
uplinkReportAgoraLastmileProbeOneWayResult*否
downlinkReportAgoraLastmileProbeOneWayResult*否
AgoraLeaveChannelOptions 0 方法 / 3 属性
属性类型只读
stopAudioMixingBOOL否
stopAllEffectBOOL否
stopMicrophoneRecordingBOOL否
AgoraLiveStreamAdvancedFeature 0 方法 / 2 属性
属性类型只读
featureNameNSString*否
openedBOOL否
AgoraLiveTranscoding 5 方法 / 16 属性
typescript
addUser:(user: AgoraLiveTranscodingUser*): int
defaultTranscoding(): AgoraLiveTranscoding*
getAdvancedFeatures(): NSArray*
removeUser:(uid: NSUInteger): int
setAdvancedFeatures:opened:(featureName: NSString*, opened: BOOL): void

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
addUser:user: AgoraLiveTranscodingUser*int错误码索引
defaultTranscoding—AgoraLiveTranscoding*错误码索引
getAdvancedFeatures—NSArray*错误码索引
removeUser:uid: NSUIntegerint错误码索引
setAdvancedFeatures:opened:featureName: NSString*, opened: BOOLvoid错误码索引
属性类型只读
transcodingUsersNSArray*否
sizeCGSize否
videoBitrateNSInteger否
videoFramerateNSInteger否
lowLatencyBOOL否
videoGopNSInteger否
videoCodecProfileAgoraVideoCodecProfileType否
videoCodecTypeAgoraVideoCodecTypeForStream否
transcodingExtraInfoNSString*否
watermarkArrayNSArray*否
backgroundImageArrayNSArray*否
backgroundColorCOLOR_CLASS*否
audioSampleRateAgoraAudioSampleRateType否
audioBitrateNSInteger否
audioChannelsNSInteger否
audioCodecProfileAgoraAudioCodecProfileType否
AgoraLiveTranscodingUser 0 方法 / 5 属性
属性类型只读
uidNSUInteger否
rectCGRect否
zOrderNSInteger否
alphadouble否
audioChannelNSInteger否
AgoraLocalAccessPointConfiguration 0 方法 / 6 属性
属性类型只读
ipListNSArray*否
domainListNSArray*否
verifyDomainNameNSString*否
modeAgoraLocalProxyMode否
advancedConfigAdvancedConfigInfo*否
disableAutBOOL否
AgoraLocalAudioMixerConfiguration 0 方法 / 2 属性
属性类型只读
audioInputStreamsNSArray*否
syncWithLocalMicBOOL否
AgoraLocalSpatialAudioConfig 0 方法 / 1 属性
属性类型只读
rtcEngineAgoraRtcEngineKit*否
AgoraLocalSpatialAudioKit 5 方法 / 0 属性
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

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
destroy—void错误码索引
removeRemotePosition:uid: NSUIntegerint错误码索引
setRemoteAudioAttenuation:uid:forceSet:attenuation: double, uid: NSUInteger, forceSet: BOOLint错误码索引
sharedLocalSpatialAudioWithConfig:config: AgoraLocalSpatialAudioConfig*instancetype错误码索引
updateRemotePosition:positionInfo:uid: NSUInteger, posInfo: AgoraRemoteVoicePositionInfo*int错误码索引
AgoraLocalTranscoderConfiguration 0 方法 / 3 属性
属性类型只读
videoInputStreamsNSArray*否
videoOutputConfigurationAgoraVideoEncoderConfiguration*否
syncWithPrimaryCameraBOOL否
AgoraLogConfig 0 方法 / 3 属性
属性类型只读
filePathNSString*否
fileSizeInKBNSInteger否
levelAgoraLogLevel否
AgoraLowlightEnhanceOptions 0 方法 / 2 属性
属性类型只读
modeAgoraLowlightEnhanceMode否
levelAgoraLowlightEnhanceLevel否
AgoraMediaMetadataDataSource 2 方法 / 0 属性
typescript
metadataMaxSize(): NSInteger
readyToSendMetadataAtTimestamp:sourceType:(timestamp: NSTimeInterval, sourceType: AgoraVideoSourceType): NSData*

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
metadataMaxSize—NSInteger错误码索引
readyToSendMetadataAtTimestamp:sourceType:timestamp: NSTimeInterval, sourceType: AgoraVideoSourceTypeNSData*错误码索引
AgoraMediaMetadataDelegate 1 方法 / 0 属性
typescript
didMetadataReceived:(metadata: AgoraMetadata*): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
didMetadataReceived:metadata: AgoraMetadata*void错误码索引
AgoraMediaPlayerCacheStatistics 0 方法 / 3 属性
属性类型只读
fileSizeNSInteger否
cacheSizeNSInteger否
downloadSizeNSInteger否
AgoraMediaPlayerPlaybackStats 0 方法 / 4 属性
属性类型只读
videoFpsNSInteger否
videoBitrateInKbpsNSInteger否
audioBitrateInKbpsNSInteger否
totalBitrateInKbpsNSInteger否
AgoraMediaPlayerSrcInfo 0 方法 / 2 属性
属性类型只读
bitrateInKbpsint否
nameNSString*否
AgoraMediaPlayerUpdatedInfo 0 方法 / 6 属性
属性类型只读
deviceIdNSString*否
videoHeightNSInteger否
videoWidthNSInteger否
audioSampleRateNSInteger否
audioChannelsNSInteger否
audioBitsPerSampleNSInteger否
AgoraMediaRecorder 4 方法 / 0 属性
typescript
enableMainQueueDispatch:(enabled: BOOL): int
setMediaRecorderDelegate:(delegate?: id): int
startRecording:(config: AgoraMediaRecorderConfiguration*): int
stopRecording(): int

方法明细:4 / 4(参数、返回值、错误码)

方法参数返回值错误
enableMainQueueDispatch:enabled: BOOLint错误码索引
setMediaRecorderDelegate:delegate?: idint错误码索引
startRecording:config: AgoraMediaRecorderConfiguration*int错误码索引
stopRecording—int错误码索引
AgoraMediaRecorderConfiguration 0 方法 / 11 属性
属性类型只读
storagePathNSString*否
containerFormatAgoraMediaRecorderContainerFormat否
streamTypeAgoraMediaRecorderStreamType否
maxDurationMsNSUInteger否
recorderInfoUpdateIntervalNSUInteger否
widthNSUInteger否
heightNSUInteger否
fpsNSUInteger否
sample_rateNSUInteger否
channel_numNSUInteger否
videoSourceTypeAgoraVideoSourceType否
AgoraMediaRecorderDelegate 2 方法 / 0 属性
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

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
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: AgoraMediaRecorderReasonCodevoid错误码索引
AgoraMediaRecorderInfo 0 方法 / 3 属性
属性类型只读
recorderFileNameNSString*否
durationMsNSUInteger否
fileSizeNSUInteger否
AgoraMediaSource 0 方法 / 10 属性
属性类型只读
urlNSString*否
uriNSString*否
startPosNSUInteger否
autoPlayBOOL否
enableCacheBOOL否
enableMultiAudioTrackBOOL否
isAgoraSourceBOOL否
isLiveSourceBOOL否
playerOnReadCallbackAgoraRtcMediaPlayerCustomSourceOnReadCallback否
playerOnSeekCallbackAgoraRtcMediaPlayerCustomSourceOnSeekCallback否
AgoraMetadata 0 方法 / 4 属性
属性类型只读
channelIdNSString*否
uidNSInteger否
dataNSData*否
timestampNSTimeInterval否
AgoraMixedAudioStream 0 方法 / 4 属性
属性类型只读
sourceTypeAgoraAudioSourceType否
remoteUserUidNSUInteger否
channelIdNSString*否
trackIdNSUInteger否
AgoraMultipathStats 0 方法 / 8 属性
属性类型只读
lanRxBytesNSUInteger否
lanTxBytesNSUInteger否
wifiRxBytesNSUInteger否
wifiTxBytesNSUInteger否
mobileRxBytesNSUInteger否
mobileTxBytesNSUInteger否
activePathNumNSUInteger否
pathStatsNSArray*否
AgoraMusic 0 方法 / 11 属性
属性类型只读
songCodeNSInteger否
typeNSInteger否
pitchTypeNSInteger否
nameNSString*否
singerNSString*否
posterNSString*否
releaseTimeNSString*否
durationSNSInteger否
lyricListNSArray*否
mvPropertyListNSArray*否
climaxSegmentListNSArray*否
AgoraMusicCacheInfo 0 方法 / 2 属性
属性类型只读
songCodeNSInteger否
statusTypeAgoraMusicCacheStatusType否
AgoraMusicChartInfo 0 方法 / 2 属性
属性类型只读
chartNameNSString*否
identifyNSInteger否
AgoraMusicCollection 0 方法 / 5 属性
属性类型只读
countNSInteger否
totalNSInteger否
pageNSInteger否
pageSizeNSInteger否
musicListNSArray*否
AgoraMusicContentCenter 18 方法 / 0 属性
typescript
createMusicPlayerWithDelegate:(delegate?: id): id
destroy(): void
destroyMusicPlayer:(musicPlayer: id): NSInteger
enableMainQueueDispatch:(enabled: BOOL): void
getCaches(): NSArray*
getInternalSongCode:jsonOption:(songCode: NSInteger, jsonOption?: NSString*): NSInteger
getLyricWithSongCode:lyricType:(songCode: NSInteger, lyricType: NSInteger): NSString*
getMusicCharts(): NSString*
getMusicCollectionWithMusicChartId:page:pageSize:jsonOption:(musicChartId: NSInteger, page: NSInteger, pageSize: NSInteger, jsonOption?: NSString*): NSString*
getSongSimpleInfoWithSongCode:(songCode: NSInteger): NSString*
isPreloadedWithSongCode:(songCode: NSInteger): NSInteger
preloadWithSongCode:(songCode: NSInteger): NSString*
preloadWithSongCode:jsonOption:(songCode: NSInteger, jsonOption?: NSString*): NSInteger
registerEventDelegate:(eventDelegate?: id): NSInteger
removeCacheWithSongCode:(songCode: NSInteger): NSInteger
renewToken:(token: NSString*): NSInteger
searchMusicWithKeyWord:page:pageSize:jsonOption:(keyWord: NSString*, page: NSInteger, pageSize: NSInteger, jsonOption?: NSString*): NSString*
sharedContentCenterWithConfig:(config: AgoraMusicContentCenterConfig*): instancetype

方法明细:18 / 18(参数、返回值、错误码)

方法参数返回值错误
createMusicPlayerWithDelegate:delegate?: idid错误码索引
destroy—void错误码索引
destroyMusicPlayer:musicPlayer: idNSInteger错误码索引
enableMainQueueDispatch:enabled: BOOLvoid错误码索引
getCaches—NSArray*错误码索引
getInternalSongCode:jsonOption:songCode: NSInteger, jsonOption?: NSString*NSInteger错误码索引
getLyricWithSongCode:lyricType:songCode: NSInteger, lyricType: NSIntegerNSString*错误码索引
getMusicCharts—NSString*错误码索引
getMusicCollectionWithMusicChartId:page:pageSize:jsonOption:musicChartId: NSInteger, page: NSInteger, pageSize: NSInteger, jsonOption?: NSString*NSString*错误码索引
getSongSimpleInfoWithSongCode:songCode: NSIntegerNSString*错误码索引
isPreloadedWithSongCode:songCode: NSIntegerNSInteger错误码索引
preloadWithSongCode:songCode: NSIntegerNSString*错误码索引
preloadWithSongCode:jsonOption:songCode: NSInteger, jsonOption?: NSString*NSInteger错误码索引
registerEventDelegate:eventDelegate?: idNSInteger错误码索引
removeCacheWithSongCode:songCode: NSIntegerNSInteger错误码索引
renewToken:token: NSString*NSInteger错误码索引
searchMusicWithKeyWord:page:pageSize:jsonOption:keyWord: NSString*, page: NSInteger, pageSize: NSInteger, jsonOption?: NSString*NSString*错误码索引
sharedContentCenterWithConfig:config: AgoraMusicContentCenterConfig*instancetype错误码索引
AgoraMusicContentCenterConfig 0 方法 / 6 属性
属性类型只读
rtcEngineAgoraRtcEngineKit*否
appIdNSString*否
tokenNSString*否
mccUidNSInteger否
maxCacheSizeNSUInteger否
eventDelegateid否
AgoraMusicContentCenterEventDelegate 5 方法 / 0 属性
typescript
onLyricResult:songCode:lyricUrl:reason:(requestId: NSString*, songCode: NSInteger, lyricUrl?: NSString*, reason: AgoraMusicContentCenterStateReason): void
onMusicChartsResult:result:reason:(requestId: NSString*, result: NSArray*, reason: AgoraMusicContentCenterStateReason): void
onMusicCollectionResult:result:reason:(requestId: NSString*, result: AgoraMusicCollection*, reason: AgoraMusicContentCenterStateReason): void
onPreLoadEvent:songCode:percent:lyricUrl:state:reason:(requestId: NSString*, songCode: NSInteger, percent: NSInteger, lyricUrl?: NSString*, state: AgoraMusicContentCenterPreloadState, reason: AgoraMusicContentCenterStateReason): void
onSongSimpleInfoResult:songCode:simpleInfo:reason:(requestId: NSString*, songCode: NSInteger, simpleInfo?: NSString*, reason: AgoraMusicContentCenterStateReason): void

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
onLyricResult:songCode:lyricUrl:reason:requestId: NSString*, songCode: NSInteger, lyricUrl?: NSString*, reason: AgoraMusicContentCenterStateReasonvoid错误码索引
onMusicChartsResult:result:reason:requestId: NSString*, result: NSArray*, reason: AgoraMusicContentCenterStateReasonvoid错误码索引
onMusicCollectionResult:result:reason:requestId: NSString*, result: AgoraMusicCollection*, reason: AgoraMusicContentCenterStateReasonvoid错误码索引
onPreLoadEvent:songCode:percent:lyricUrl:state:reason:requestId: NSString*, songCode: NSInteger, percent: NSInteger, lyricUrl?: NSString*, state: AgoraMusicContentCenterPreloadState, reason: AgoraMusicContentCenterStateReasonvoid错误码索引
onSongSimpleInfoResult:songCode:simpleInfo:reason:requestId: NSString*, songCode: NSInteger, simpleInfo?: NSString*, reason: AgoraMusicContentCenterStateReasonvoid错误码索引
AgoraMusicPlayerProtocol 2 方法 / 0 属性
typescript
openMediaWithSongCode:startPos:(songCode: NSInteger, startPos: NSInteger): NSInteger
setPlayMode:(mode: AgoraMusicPlayMode): NSInteger

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
openMediaWithSongCode:startPos:songCode: NSInteger, startPos: NSIntegerNSInteger错误码索引
setPlayMode:mode: AgoraMusicPlayModeNSInteger错误码索引
AgoraOutputVideoFrame 0 方法 / 17 属性
属性类型只读
typeNSInteger否
widthint否
heightint否
yStrideint否
uStrideint否
vStrideint否
yBufferuint8_t*否
uBufferuint8_t*否
vBufferuint8_t*否
rotationint否
renderTimeMsint64_t否
avSyncTypeint否
pixelBufferCVPixelBufferRef否
alphaBufferuint8_t*否
alphaStitchModeAgoraAlphaStitchMode否
metaInfoNSDictionary*否
colorSpaceAgoraColorSpace*否
AgoraPathStats 0 方法 / 3 属性
属性类型只读
pathTypeAgoraMultipathType否
txKBitRateNSUInteger否
rxKBitRateNSUInteger否
AgoraRecorderStreamInfo 0 方法 / 3 属性
属性类型只读
uidNSUInteger否
channelIdNSString*否
typeAgoraRecorderStreamType否
AgoraRemoteVoicePositionInfo 0 方法 / 2 属性
属性类型只读
positionsimd_float3否
forwardsimd_float3否
AgoraRhythmPlayerConfig 0 方法 / 2 属性
属性类型只读
beatsPerMeasureint否
beatsPerMinuteint否
AgoraRtcAudioVolumeInfo 0 方法 / 4 属性
属性类型只读
uidNSUInteger否
volumeNSUInteger否
vadNSUInteger否
voicePitchdouble否
AgoraRtcChannelMediaOptions 0 方法 / 38 属性
属性类型只读
publishCameraTrackBOOL否
publishSecondaryCameraTrackBOOL否
publishMicrophoneTrackBOOL否
publishScreenCaptureVideoBOOL否
publishScreenCaptureAudioBOOL否
publishThirdCameraTrackBOOL否
publishFourthCameraTrackBOOL否
publishScreenTrackBOOL否
publishSecondaryScreenTrackBOOL否
publishThirdScreenTrackBOOL否
publishFourthScreenTrackBOOL否
publishCustomAudioTrackBOOL否
publishCustomAudioTrackIdNSInteger否
publishCustomVideoTrackBOOL否
publishEncodedVideoTrackBOOL否
publishMediaPlayerAudioTrackBOOL否
publishMediaPlayerVideoTrackBOOL否
publishTranscodedVideoTrackBOOL否
publishLipSyncTrackBOOL否
autoSubscribeAudioBOOL否
autoSubscribeVideoBOOL否
enableAudioRecordingOrPlayoutBOOL否
publishMediaPlayerIdNSInteger否
clientRoleTypeAgoraClientRole否
audienceLatencyLevelAgoraAudienceLatencyLevelType否
defaultVideoStreamTypeAgoraVideoStreamType否
channelProfileAgoraChannelProfile否
publishMixedAudioTrackBOOL否
audioDelayMsNSInteger否
mediaPlayerAudioDelayMsNSInteger否
tokenNSString*否
enableBuiltInMediaEncryptionBOOL否
publishRhythmPlayerTrackBOOL否
isInteractiveAudienceBOOL否
customVideoTrackIdNSInteger否
isAudioFilterableBOOL否
enableMultipathBOOL否
preferMultipathTypeAgoraMultipathType否
AgoraRtcConnection 0 方法 / 2 属性
属性类型只读
channelIdNSString*否
localUidNSUInteger否
AgoraRtcEngineConfig 0 方法 / 10 属性
属性类型只读
appIdNSString*否
channelProfileAgoraChannelProfile否
licenseNSString*否
audioScenarioAgoraAudioScenario否
areaCodeAgoraAreaCodeType否
logConfigAgoraLogConfig*否
threadPriorityAgoraThreadPriorityType否
eventDelegateid否
domainLimitBOOL否
autoRegisterAgoraExtensionsBOOL否
AgoraRtcEngineDelegate 82 方法 / 0 属性
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:cameraExposureDidChangedToRect:(engine: AgoraRtcEngineKit*, rect: CGRect): void
rtcEngine:cameraFocusDidChangedToRect:(engine: AgoraRtcEngineKit*, rect: CGRect): 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:didTranscodedStreamLayoutInfoUpdatedWithUserId:videoLayoutInfo:(engine: AgoraRtcEngineKit*, uid: NSUInteger, videoLayoutInfo: AgoraVideoLayoutInfo*): 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:facePositionDidChangeWidth:previewHeight:faces:(engine: AgoraRtcEngineKit*, width: int, height: int, faces?: NSArray*): void
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
rtcEngineCameraDidReady:(engine: AgoraRtcEngineKit*): 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

方法明细:82 / 82(参数、返回值、错误码)

方法参数返回值错误
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: NSUIntegervoid错误码索引
rtcEngine:audioMixingPositionChanged:engine: AgoraRtcEngineKit*, position: NSIntegervoid错误码索引
rtcEngine:audioMixingStateChanged:reasonCode:engine: AgoraRtcEngineKit*, state: AgoraAudioMixingStateType, reasonCode: AgoraAudioMixingReasonCodevoid错误码索引
rtcEngine:audioTransportStatsOfUid:delay:lost:rxKBitRate:engine: AgoraRtcEngineKit*, uid: NSUInteger, delay: NSUInteger, lost: NSUInteger, rxKBitRate: NSUIntegervoid错误码索引
rtcEngine:cameraExposureDidChangedToRect:engine: AgoraRtcEngineKit*, rect: CGRectvoid错误码索引
rtcEngine:cameraFocusDidChangedToRect:engine: AgoraRtcEngineKit*, rect: CGRectvoid错误码索引
rtcEngine:channelMediaRelayStateDidChange:error:engine: unknown, state: unknown, error: unknownunknown错误码索引
rtcEngine:connectionChangedToState:reason:engine: AgoraRtcEngineKit*, state: AgoraConnectionState, reason: AgoraConnectionChangedReasonvoid错误码索引
rtcEngine:didAudioMuted:byUid:engine: AgoraRtcEngineKit*, muted: BOOL, uid: NSUIntegervoid错误码索引
rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:engine: unknown, channelId: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknownunknown错误码索引
rtcEngine:didAudioRouteChanged:engine: AgoraRtcEngineKit*, routing: AgoraAudioOutputRoutingvoid错误码索引
rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:engine: unknown, channelId: unknown, uid: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknownunknown错误码索引
rtcEngine:didClientRoleChangeFailed:currentRole:engine: AgoraRtcEngineKit*, reason: AgoraClientRoleChangeFailedReason, currentRole: AgoraClientRolevoid错误码索引
rtcEngine:didClientRoleChanged:newRole:newRoleOptions:engine: AgoraRtcEngineKit*, oldRole: AgoraClientRole, newRole: AgoraClientRole, newRoleOptions?: AgoraClientRoleOptions*void错误码索引
rtcEngine:didJoinChannel:withUid:elapsed:engine: AgoraRtcEngineKit*, channel: NSString*, uid: NSUInteger, elapsed: NSIntegervoid错误码索引
rtcEngine:didJoinedOfUid:elapsed:engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSIntegervoid错误码索引
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: NSUIntegervoid错误码索引
rtcEngine:didLocalVideoTranscoderErrorWithStream:errorCode:engine: AgoraRtcEngineKit*, stream: AgoraTranscodingVideoStream*, errorCode: AgoraVideoTranscoderErrorvoid错误码索引
rtcEngine:didOccurEncryptionError:engine: AgoraRtcEngineKit*, errorType: AgoraEncryptionErrorTypevoid错误码索引
rtcEngine:didOccurError:engine: AgoraRtcEngineKit*, errorCode: AgoraErrorCodevoid错误码索引
rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:engine: AgoraRtcEngineKit*, uid: NSUInteger, streamId: NSInteger, error: NSInteger, missed: NSInteger, cached: NSIntegervoid错误码索引
rtcEngine:didOfflineOfUid:reason:engine: AgoraRtcEngineKit*, uid: NSUInteger, reason: AgoraUserOfflineReasonvoid错误码索引
rtcEngine:didProxyConnected:withUid:proxyType:localProxyIp:elapsed:engine: AgoraRtcEngineKit*, channel: NSString*, uid: NSUInteger, proxyType: AgoraProxyType, localProxyIp: NSString*, elapsed: NSIntegervoid错误码索引
rtcEngine:didRejoinChannel:withUid:elapsed:engine: AgoraRtcEngineKit*, channel: NSString*, uid: NSUInteger, elapsed: NSIntegervoid错误码索引
rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:engine: AgoraRtcEngineKit*, isFallbackOrRecover: BOOL, uid: NSUIntegervoid错误码索引
rtcEngine:didRhythmPlayerStateChanged:reason:engine: AgoraRtcEngineKit*, state: AgoraRhythmPlayerState, reason: AgoraRhythmPlayerReasonvoid错误码索引
rtcEngine:didTranscodedStreamLayoutInfoUpdatedWithUserId:videoLayoutInfo:engine: AgoraRtcEngineKit*, uid: NSUInteger, videoLayoutInfo: AgoraVideoLayoutInfo*void错误码索引
rtcEngine:didUserInfoUpdatedWithUserId:userInfo:engine: AgoraRtcEngineKit*, uid: NSUInteger, userInfo: AgoraUserInfo*void错误码索引
rtcEngine:didVideoEnabled:byUid:engine: AgoraRtcEngineKit*, enabled: BOOL, uid: NSUIntegervoid错误码索引
rtcEngine:didVideoMuted:byUid:engine: AgoraRtcEngineKit*, muted: BOOL, uid: NSUIntegervoid错误码索引
rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:engine: unknown, channelId: unknown, sourceType: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknownunknown错误码索引
rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:engine: unknown, channelId: unknown, uid: unknown, oldState: unknown, newState: unknown, elapseSinceLastState: unknownunknown错误码索引
rtcEngine:facePositionDidChangeWidth:previewHeight:faces:engine: AgoraRtcEngineKit*, width: int, height: int, faces?: NSArray*void错误码索引
rtcEngine:firstLocalAudioFramePublished:engine: AgoraRtcEngineKit*, elapsed: NSIntegervoid错误码索引
rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:engine: AgoraRtcEngineKit*, elapsed: NSInteger, sourceType: AgoraVideoSourceTypevoid错误码索引
rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:engine: AgoraRtcEngineKit*, size: CGSize, elapsed: NSInteger, sourceType: AgoraVideoSourceTypevoid错误码索引
rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSIntegervoid错误码索引
rtcEngine:firstRemoteAudioFrameOfUid:elapsed:engine: AgoraRtcEngineKit*, uid: NSUInteger, elapsed: NSIntegervoid错误码索引
rtcEngine:firstRemoteVideoDecodedOfUid:size:elapsed:engine: AgoraRtcEngineKit*, uid: NSUInteger, size: CGSize, elapsed: NSIntegervoid错误码索引
rtcEngine:firstRemoteVideoFrameOfUid:size:elapsed:engine: AgoraRtcEngineKit*, uid: NSUInteger, size: CGSize, elapsed: NSIntegervoid错误码索引
rtcEngine:lastmileProbeTestResult:engine: AgoraRtcEngineKit*, result: AgoraLastmileProbeResult*void错误码索引
rtcEngine:lastmileQuality:engine: AgoraRtcEngineKit*, quality: AgoraNetworkQualityvoid错误码索引
rtcEngine:localAudioStateChanged:reason:engine: AgoraRtcEngineKit*, state: AgoraAudioLocalState, reason: AgoraAudioLocalReasonvoid错误码索引
rtcEngine:localAudioStats:engine: AgoraRtcEngineKit*, stats: AgoraRtcLocalAudioStats*void错误码索引
rtcEngine:localVideoStateChangedOfState:reason:sourceType:engine: AgoraRtcEngineKit*, state: AgoraVideoLocalState, reason: AgoraLocalVideoStreamReason, sourceType: AgoraVideoSourceTypevoid错误码索引
rtcEngine:localVideoStats:sourceType:engine: AgoraRtcEngineKit*, stats: AgoraRtcLocalVideoStats*, sourceType: AgoraVideoSourceTypevoid错误码索引
rtcEngine:multiPathStats:engine: AgoraRtcEngineKit*, stats: AgoraMultipathStats*void错误码索引
rtcEngine:networkQuality:txQuality:rxQuality:engine: AgoraRtcEngineKit*, uid: NSUInteger, txQuality: AgoraNetworkQuality, rxQuality: AgoraNetworkQualityvoid错误码索引
rtcEngine:networkTypeChanged:engine: AgoraRtcEngineKit*, type: AgoraNetworkTypevoid错误码索引
rtcEngine:permissionError:engine: AgoraRtcEngineKit*, type: AgoraPermissionTypevoid错误码索引
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: NSIntegervoid错误码索引
rtcEngine:remoteAudioStats:engine: AgoraRtcEngineKit*, stats: AgoraRtcRemoteAudioStats*void错误码索引
rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:engine: AgoraRtcEngineKit*, uid: NSUInteger, state: AgoraVideoRemoteState, reason: AgoraVideoRemoteReason, elapsed: NSIntegervoid错误码索引
rtcEngine:remoteVideoStats:engine: AgoraRtcEngineKit*, stats: AgoraRtcRemoteVideoStats*void错误码索引
rtcEngine:renewTokenResult:code:engine: AgoraRtcEngineKit*, token: NSString*, code: AgoraRenewTokenErrorCodevoid错误码索引
rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:engine: AgoraRtcEngineKit*, speakers: NSArray*, totalVolume: NSIntegervoid错误码索引
rtcEngine:reportRtcStats:engine: AgoraRtcEngineKit*, stats: AgoraChannelStats*void错误码索引
rtcEngine:rtmpStreamingChangedToState:state:reason:engine: AgoraRtcEngineKit*, url: NSString*, state: AgoraRtmpStreamingState, reason: AgoraRtmpStreamingReasonvoid错误码索引
rtcEngine:rtmpStreamingEventWithUrl:eventCode:engine: AgoraRtcEngineKit*, url: NSString*, eventCode: AgoraRtmpStreamingEventvoid错误码索引
rtcEngine:snapshotTaken:filePath:width:height:errCode:engine: AgoraRtcEngineKit*, uid: NSUInteger, filePath: NSString*, width: NSInteger, height: NSInteger, errCode: NSIntegervoid错误码索引
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: NSIntegervoid错误码索引
rtcEngine:videoTransportStatsOfUid:delay:lost:rxKBitRate:engine: AgoraRtcEngineKit*, uid: NSUInteger, delay: NSUInteger, lost: NSUInteger, rxKBitRate: NSUIntegervoid错误码索引
rtcEngineCameraDidReady:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineConnectionDidBanned:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineConnectionDidInterrupted:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineConnectionDidLost:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineDidAudioEffectFinish:soundId:engine: AgoraRtcEngineKit*, soundId: intvoid错误码索引
rtcEngineLocalAudioMixingDidFinish:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineRequestToken:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineTranscodingUpdated:engine: AgoraRtcEngineKit*void错误码索引
rtcEngineVideoDidStop:engine: AgoraRtcEngineKit*void错误码索引
AgoraRtcEngineKit 295 方法 / 0 属性
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
adjustPlaybackSignalVolume:(volume: NSInteger): int
adjustRecordingSignalVolume:(volume: NSInteger): int
adjustUserPlaybackSignalVolume:volume:(uid: NSUInteger, volume: int): int
cameraMaxZoomFactor(): CGFloat
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
enableFaceDetection:(enable: BOOL): int
enableInEarMonitoring:(enabled: BOOL): int
enableInEarMonitoring:includeAudioFilters:(enabled: BOOL, includeAudioFilters: AgoraEarMonitoringFilterType): int
enableInstantMediaRendering(): int
enableLocalAudio:(enabled: BOOL): int
enableLocalVideo:(enabled: BOOL): int
enableMainQueueDispatch:(enabled: BOOL): int
enableMultiCamera:config:(enabled: BOOL, config?: AgoraCameraCapturerConfiguration*): 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
getAudioMixingCurrentPosition(): int
getAudioMixingDuration(): int
getAudioMixingPlayoutVolume(): int
getAudioMixingPublishVolume(): int
getAudioTrackCount(): int
getCallId(): NSString*
getConnectionState(): AgoraConnectionState
getCurrentMonotonicTimeInMs(): int64_t
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
getSdkVersion(): NSString*
getUserInfoByUid:withError:(uid: NSUInteger, error?: AgoraErrorCode*): AgoraUserInfo*
getUserInfoByUserAccount:withError:(userAccount: NSString*, error?: AgoraErrorCode*): AgoraUserInfo*
getVolumeOfEffect:(soundId: int): int
isCameraAutoExposureFaceModeSupported(): BOOL
isCameraAutoFocusFaceModeSupported(): BOOL
isCameraCenterStageSupported(): BOOL
isCameraExposurePositionSupported(): BOOL
isCameraExposureSupported(): BOOL
isCameraFocusPositionInPreviewSupported(): BOOL
isCameraTorchSupported(): BOOL
isCameraZoomSupported(): BOOL
isFeatureAvailableOnDevice:(type: AgoraFeatureType): BOOL
isSpeakerphoneEnabled(): 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
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
queryCameraFocalLengthCapability(): NSArray*
queryCodecCapability(): NSArray*
queryDeviceScore(): int
queryScreenCaptureCapability(): AgoraScreenCaptureFrameRateCapability
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
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
setAudioSessionOperationRestriction:(restriction: AgoraAudioSessionOperationRestriction): void
setBeautyEffectOptions:options:(enable: BOOL, options?: AgoraBeautyOptions*): int
setBeautyEffectOptions:options:sourceType:(enable: BOOL, options?: AgoraBeautyOptions*, sourceType: AgoraMediaSourceType): int
setCameraAutoExposureFaceModeEnabled:(enable: BOOL): BOOL
setCameraAutoFocusFaceModeEnabled:(enable: BOOL): BOOL
setCameraCapturerConfiguration:(config?: AgoraCameraCapturerConfiguration*): int
setCameraExposureFactor:(exposureFactor: CGFloat): CGFloat
setCameraExposurePosition:(positionInView: CGPoint): BOOL
setCameraFocusPositionInPreview:(position: CGPoint): BOOL
setCameraStabilizationMode:(mode: AgoraCameraStabilizationMode): int
setCameraTorchOn:(isOn: BOOL): BOOL
setCameraZoomFactor:(zoomFactor: CGFloat): CGFloat
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
setDefaultAudioRouteToSpeakerphone:(defaultToSpeaker: BOOL): 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
setEnableSpeakerphone:(enableSpeaker: BOOL): 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
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:(parameters?: AgoraScreenCaptureParameters2*): int
stopAllEffects(): 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
switchCamera(): 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
updateScreenCapture:(parameters?: AgoraScreenCaptureParameters2*): int

方法明细:295 / 295(参数、返回值、错误码)

方法参数返回值错误
addVideoWatermark:watermark: AgoraImage*int错误码索引
addVideoWatermark:options:url: NSURL*, options: WatermarkOptions*int错误码索引
addVideoWatermarkWithConfig:config: WatermarkConfig*int错误码索引
adjustAudioMixingPlayoutVolume:volume: NSIntegerint错误码索引
adjustAudioMixingPublishVolume:volume: NSIntegerint错误码索引
adjustAudioMixingVolume:volume: NSIntegerint错误码索引
adjustCustomAudioPlayoutVolume:volume:trackId: NSInteger, volume: NSIntegerint错误码索引
adjustCustomAudioPublishVolume:volume:trackId: NSInteger, volume: NSIntegerint错误码索引
adjustPlaybackSignalVolume:volume: NSIntegerint错误码索引
adjustRecordingSignalVolume:volume: NSIntegerint错误码索引
adjustUserPlaybackSignalVolume:volume:uid: NSUInteger, volume: intint错误码索引
cameraMaxZoomFactor—CGFloat错误码索引
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: BOOLint错误码索引
createMediaPlayerWithDelegate:delegate?: idid错误码索引
createMediaRecorder:info: AgoraRecorderStreamInfo*AgoraMediaRecorder*错误码索引
createVideoEffectObjectWithBundlePath:sourceType:bundlePath: NSString*, sourceType: AgoraMediaSourceTypeid错误码索引
delegate—unknown错误码索引
destroy—void错误码索引
destroy:engineReleasedBlock?: void (^ )(void)void错误码索引
destroyCustomAudioTrack:trackId: NSIntegerint错误码索引
destroyCustomVideoTrack:videoTrackId: NSUIntegerint错误码索引
destroyMediaPlayer:mediaPlayer?: idint错误码索引
destroyMediaRecorder:mediaRecorder?: AgoraMediaRecorder*int错误码索引
destroyVideoEffectObject:videoEffectObject?: idint错误码索引
disableAudio—int错误码索引
disableAudioSpectrumMonitor—int错误码索引
disableVideo—int错误码索引
enableAudio—int错误码索引
enableAudioSpectrumMonitor:intervalInMS: intint错误码索引
enableAudioVolumeIndication:smooth:reportVad:interval: NSInteger, smooth: NSInteger, reportVad: BOOLint错误码索引
enableCameraCenterStage:enabled: BOOLint错误码索引
enableContentInspect:config:enabled: BOOL, config: AgoraContentInspectConfig*int错误码索引
enableCustomAudioLocalPlayback:enabled:trackId: NSInteger, enabled: BOOLint错误码索引
enableDualStreamMode:enabled: BOOLint错误码索引
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: AgoraMediaSourceTypeint错误码索引
enableExternalAudioSink:sampleRate:channels:enabled: BOOL, sampleRate: NSUInteger, channels: NSUIntegervoid错误码索引
enableFaceDetection:enable: BOOLint错误码索引
enableInEarMonitoring:enabled: BOOLint错误码索引
enableInEarMonitoring:includeAudioFilters:enabled: BOOL, includeAudioFilters: AgoraEarMonitoringFilterTypeint错误码索引
enableInstantMediaRendering—int错误码索引
enableLocalAudio:enabled: BOOLint错误码索引
enableLocalVideo:enabled: BOOLint错误码索引
enableMainQueueDispatch:enabled: BOOLint错误码索引
enableMultiCamera:config:enabled: BOOL, config?: AgoraCameraCapturerConfiguration*int错误码索引
enableSoundPositionIndication:enabled: BOOLint错误码索引
enableSpatialAudio:enabled: BOOLint错误码索引
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: AgoraMediaSourceTypeint错误码索引
enableVoiceAITuner:type:enabled: BOOL, type: AgoraVoiceAITunerTypeint错误码索引
enableWebSdkInteroperability:enabled: BOOLint错误码索引
getAudioMixingCurrentPosition—int错误码索引
getAudioMixingDuration—int错误码索引
getAudioMixingPlayoutVolume—int错误码索引
getAudioMixingPublishVolume—int错误码索引
getAudioTrackCount—int错误码索引
getCallId—NSString*错误码索引
getConnectionState—AgoraConnectionState错误码索引
getCurrentMonotonicTimeInMs—int64_t错误码索引
getEffectCurrentPosition:soundId: intint错误码索引
getEffectDuration:filePath: NSString*int错误码索引
getEffectsVolume—int错误码索引
getErrorDescription:error: NSIntegerNSString*错误码索引
getExtensionPropertyWithVendor:extension:key:provider: NSString*, extension: NSString*, key: NSString*NSString*错误码索引
getExtensionPropertyWithVendor:extension:key:sourceType:provider: NSString*, extension: NSString*, key: NSString*, sourceType: AgoraMediaSourceTypeNSString*错误码索引
getFaceShapeAreaOptions:area: AgoraFaceShapeAreaAgoraFaceShapeAreaOptions*错误码索引
getFaceShapeAreaOptions:sourceType:area: AgoraFaceShapeArea, sourceType: AgoraMediaSourceTypeAgoraFaceShapeAreaOptions*错误码索引
getFaceShapeBeautyOptions—AgoraFaceShapeBeautyOptions*错误码索引
getFaceShapeBeautyOptions:sourceType: AgoraMediaSourceTypeAgoraFaceShapeBeautyOptions*错误码索引
getNativeHandle—void*错误码索引
getNetworkType—int错误码索引
getNtpWallTimeInMs—uint64_t错误码索引
getSdkVersion—NSString*错误码索引
getUserInfoByUid:withError:uid: NSUInteger, error?: AgoraErrorCode*AgoraUserInfo*错误码索引
getUserInfoByUserAccount:withError:userAccount: NSString*, error?: AgoraErrorCode*AgoraUserInfo*错误码索引
getVolumeOfEffect:soundId: intint错误码索引
isCameraAutoExposureFaceModeSupported—BOOL错误码索引
isCameraAutoFocusFaceModeSupported—BOOL错误码索引
isCameraCenterStageSupported—BOOL错误码索引
isCameraExposurePositionSupported—BOOL错误码索引
isCameraExposureSupported—BOOL错误码索引
isCameraFocusPositionInPreviewSupported—BOOL错误码索引
isCameraTorchSupported—BOOL错误码索引
isCameraZoomSupported—BOOL错误码索引
isFeatureAvailableOnDevice:type: AgoraFeatureTypeBOOL错误码索引
isSpeakerphoneEnabled—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: unknownunknown错误码索引
muteAllRemoteAudioStreams:mute: BOOLint错误码索引
muteAllRemoteVideoStreams:mute: BOOLint错误码索引
muteLocalAudioStream:mute: BOOLint错误码索引
muteLocalVideoStream:mute: BOOLint错误码索引
muteRecordingSignal:muted: BOOLint错误码索引
muteRemoteAudioStream:mute:uid: NSUInteger, mute: BOOLint错误码索引
muteRemoteVideoStream:mute:uid: NSUInteger, mute: BOOLint错误码索引
pauseAllChannelMediaRelay—int错误码索引
pauseAllEffects—int错误码索引
pauseAudioMixing—int错误码索引
pauseEffect:soundId: intint错误码索引
playAllEffectsWithLoopCount:pitch:pan:gain:publish:loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOLint错误码索引
playEffect:filePath:loopCount:pitch:pan:gain:soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSIntegerint错误码索引
playEffect:filePath:loopCount:pitch:pan:gain:publish:soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOLint错误码索引
playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:soundId: int, filePath: NSString*, loopCount: NSInteger, pitch: double, pan: double, gain: NSInteger, publish: BOOL, startPos: intint错误码索引
preloadChannelByToken:channelId:uid:token?: NSString*, channelId: NSString*, uid: NSUIntegerint错误码索引
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: intint错误码索引
pullPlaybackAudioFrameRawData:lengthInByte:data: void*, lengthInByte: NSUIntegerBOOL错误码索引
pullPlaybackAudioFrameSampleBufferByLengthInByte:lengthInByte: NSUIntegerCMSampleBufferRef错误码索引
pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:data: void*, samples: NSInteger, sampleRate: NSInteger, channels: NSInteger, trackId: NSInteger, timestamp: NSTimeIntervalint错误码索引
pushExternalAudioFrameSampleBuffer:sampleBuffer: CMSampleBufferRefint错误码索引
pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:sampleBuffer: CMSampleBufferRef, sampleRate: NSInteger, channels: NSInteger, trackId: NSIntegerint错误码索引
pushExternalVideoFrame:frame: AgoraVideoFrame*BOOL错误码索引
pushExternalVideoFrame:videoTrackId:frame: AgoraVideoFrame*, videoTrackId: NSUIntegerBOOL错误码索引
queryCameraFocalLengthCapability—NSArray*错误码索引
queryCodecCapability—NSArray*错误码索引
queryDeviceScore—int错误码索引
queryScreenCaptureCapability—AgoraScreenCaptureFrameRateCapability错误码索引
rate:rating:description:callId: NSString*, rating: NSInteger, description?: NSString*int错误码索引
registerAudioSpectrumDelegate:delegate?: idint错误码索引
registerExtensionWithVendor:extension:sourceType:provider: NSString*, extension: NSString*, sourceType: AgoraMediaSourceTypeint错误码索引
registerLocalUserAccount:appId:userAccount: NSString*, appId: NSString*int错误码索引
removeVideoWatermark:id: NSString*int错误码索引
renewToken:token: NSString*int错误码索引
resumeAllChannelMediaRelay—int错误码索引
resumeAllEffects—int错误码索引
resumeAudioMixing—int错误码索引
resumeEffect:soundId: intint错误码索引
selectAudioTrack:index: NSIntegerint错误码索引
sendCustomReportMessage:category:event:label:value:messageId?: NSString*, category?: NSString*, event?: NSString*, label?: NSString*, value: NSIntegerint错误码索引
sendStreamMessage:data:streamId: NSInteger, data: NSData*int错误码索引
setAINSMode:mode:enabled: BOOL, mode: AUDIO_AINS_MODEint错误码索引
setAVSyncSource:uid:channelId: NSString*, uid: NSUIntegerint错误码索引
setAdvancedAudioOptions:options: AgoraAdvancedAudioOptions*int错误码索引
setAudioEffectParameters:param1:param2:preset: AgoraAudioEffectPreset, param1: int, param2: intint错误码索引
setAudioEffectPreset:preset: AgoraAudioEffectPresetint错误码索引
setAudioEncodedFrameDelegate:config:delegate?: id, config: AgoraAudioEncodedFrameDelegateConfig*int错误码索引
setAudioFrameDelegate:delegate?: idBOOL错误码索引
setAudioMixingDualMonoMode:mode: AgoraAudioMixingDualMonoModeint错误码索引
setAudioMixingPitch:pitch: NSIntegerint错误码索引
setAudioMixingPlaybackSpeed:speed: NSIntegerint错误码索引
setAudioMixingPosition:pos: NSIntegerint错误码索引
setAudioProfile:profile: AgoraAudioProfileint错误码索引
setAudioProfile:scenario:profile: AgoraAudioProfile, scenario: AgoraAudioScenarioint错误码索引
setAudioScenario:scenario: AgoraAudioScenarioint错误码索引
setAudioSessionOperationRestriction:restriction: AgoraAudioSessionOperationRestrictionvoid错误码索引
setBeautyEffectOptions:options:enable: BOOL, options?: AgoraBeautyOptions*int错误码索引
setBeautyEffectOptions:options:sourceType:enable: BOOL, options?: AgoraBeautyOptions*, sourceType: AgoraMediaSourceTypeint错误码索引
setCameraAutoExposureFaceModeEnabled:enable: BOOLBOOL错误码索引
setCameraAutoFocusFaceModeEnabled:enable: BOOLBOOL错误码索引
setCameraCapturerConfiguration:config?: AgoraCameraCapturerConfiguration*int错误码索引
setCameraExposureFactor:exposureFactor: CGFloatCGFloat错误码索引
setCameraExposurePosition:positionInView: CGPointBOOL错误码索引
setCameraFocusPositionInPreview:position: CGPointBOOL错误码索引
setCameraStabilizationMode:mode: AgoraCameraStabilizationModeint错误码索引
setCameraTorchOn:isOn: BOOLBOOL错误码索引
setCameraZoomFactor:zoomFactor: CGFloatCGFloat错误码索引
setChannelProfile:profile: AgoraChannelProfileint错误码索引
setClientRole:role: AgoraClientRoleint错误码索引
setClientRole:options:role: AgoraClientRole, options?: AgoraClientRoleOptions*int错误码索引
setCloudProxy:proxyType: AgoraCloudProxyTypeint错误码索引
setColorEnhanceOptions:options:enable: BOOL, options?: AgoraColorEnhanceOptions*int错误码索引
setColorEnhanceOptions:options:sourceType:enable: BOOL, options?: AgoraColorEnhanceOptions*, sourceType: AgoraMediaSourceTypeint错误码索引
setDefaultAudioRouteToSpeakerphone:defaultToSpeaker: BOOLint错误码索引
setDualStreamMode:mode: AgoraSimulcastStreamModeint错误码索引
setDualStreamMode:streamConfig:mode: AgoraSimulcastStreamMode, streamConfig: AgoraSimulcastStreamConfig*int错误码索引
setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSIntegerint错误码索引
setEffectPosition:pos:soundId: int, pos: NSIntegerint错误码索引
setEffectsVolume:volume: NSIntegerint错误码索引
setEnableSpeakerphone:enableSpeaker: BOOLint错误码索引
setEncodedVideoFrameDelegate:delegate?: idBOOL错误码索引
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: NSIntegerint错误码索引
setExternalAudioSource:sampleRate:channels:localPlayback:publish:enabled: BOOL, sampleRate: NSInteger, channels: NSInteger, localPlayback: BOOL, publish: BOOLint错误码索引
setExternalVideoSource:useTexture:sourceType:enable: BOOL, useTexture: BOOL, sourceType: AgoraExternalVideoSourceTypevoid错误码索引
setFaceShapeAreaOptions:options?: AgoraFaceShapeAreaOptions*int错误码索引
setFaceShapeAreaOptions:sourceType:options?: AgoraFaceShapeAreaOptions*, sourceType: AgoraMediaSourceTypeint错误码索引
setFaceShapeBeautyOptions:options:enable: BOOL, options?: AgoraFaceShapeBeautyOptions*int错误码索引
setFaceShapeBeautyOptions:options:sourceType:enable: BOOL, options?: AgoraFaceShapeBeautyOptions*, sourceType: AgoraMediaSourceTypeint错误码索引
setFilterEffectOptions:options:enable: BOOL, options?: AgoraFilterEffectOptions*int错误码索引
setFilterEffectOptions:options:sourceType:enable: BOOL, options?: AgoraFilterEffectOptions*, sourceType: AgoraMediaSourceTypeint错误码索引
setHeadphoneEQParameters:highGain:lowGain: int, highGain: intint错误码索引
setHeadphoneEQPreset:preset: AgoraHeadphoneEQPresetint错误码索引
setInEarMonitoringVolume:volume: NSIntegerint错误码索引
setLocalAccessPoint:config: AgoraLocalAccessPointConfiguration*int错误码索引
setLocalRenderMode:mirror:mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorModeint错误码索引
setLocalRenderMode:mode:uid: NSUInteger, mode: AgoraVideoRenderModeint错误码索引
setLocalRenderTargetFps:targetFps:sourceType: AgoraVideoSourceType, targetFps: intint错误码索引
setLocalVideoMirrorMode:mode: AgoraVideoMirrorModeint错误码索引
setLocalVoiceEqualizationOfBandFrequency:withGain:bandFrequency: AgoraAudioEqualizationBandFrequency, gain: NSIntegerint错误码索引
setLocalVoiceFormant:formantRatio: doubleint错误码索引
setLocalVoicePitch:pitch: doubleint错误码索引
setLocalVoiceReverbOfType:withValue:reverbType: AgoraAudioReverbType, value: NSIntegerint错误码索引
setLogFile:filePath: NSString*int错误码索引
setLogFileSize:fileSizeInKBytes: NSUIntegerint错误码索引
setLogFilter:filter: NSUIntegerint错误码索引
setLogLevel:level: AgoraLogLevelint错误码索引
setLowlightEnhanceOptions:options:enable: BOOL, options?: AgoraLowlightEnhanceOptions*int错误码索引
setLowlightEnhanceOptions:options:sourceType:enable: BOOL, options?: AgoraLowlightEnhanceOptions*, sourceType: AgoraMediaSourceTypeint错误码索引
setMediaMetadataDataSource:withType:metadataDataSource?: id, type: AgoraMetadataTypeBOOL错误码索引
setMediaMetadataDelegate:withType:metadataDelegate?: id, type: AgoraMetadataTypeBOOL错误码索引
setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:sampleRate: NSInteger, channel: NSInteger, samplesPerCall: NSIntegerint错误码索引
setParameters:options: NSString*int错误码索引
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:sampleRate: NSInteger, channel: NSIntegerint错误码索引
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:samplesPerCall:sampleRate: NSInteger, channel: NSInteger, samplesPerCall: NSIntegerint错误码索引
setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSIntegerint错误码索引
setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:sampleRate: NSInteger, channel: NSInteger, mode: AgoraAudioRawFrameOperationMode, samplesPerCall: NSIntegerint错误码索引
setRemoteDefaultVideoStreamType:streamType: AgoraVideoStreamTypeint错误码索引
setRemoteRenderMode:mode:mirror:uid: NSUInteger, mode: AgoraVideoRenderMode, mirror: AgoraVideoMirrorModeint错误码索引
setRemoteRenderTargetFps:targetFps: intint错误码索引
setRemoteSubscribeFallbackOption:option: AgoraStreamFallbackOptionsint错误码索引
setRemoteUserSpatialAudioParams:params:uid: NSUInteger, params: AgoraSpatialAudioParams*int错误码索引
setRemoteVideoStream:type:uid: NSUInteger, streamType: AgoraVideoStreamTypeint错误码索引
setRemoteVideoSubscriptionOptions:options:uid: NSUInteger, options: AgoraVideoSubscriptionOptions*int错误码索引
setRemoteVoicePosition:pan:gain:uid: NSUInteger, pan: double, gain: doubleint错误码索引
setScreenCaptureScenario:scenarioType: AgoraScreenScenarioTypeint错误码索引
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: AgoraMediaSourceTypeint错误码索引
setVideoEncoderConfiguration:config: AgoraVideoEncoderConfiguration*int错误码索引
setVideoFrameDelegate:delegate?: idBOOL错误码索引
setVideoResolution:andFrameRate:bitrate:size: CGSize, frameRate: NSInteger, bitrate: NSIntegerint错误码索引
setVideoScenario:scenarioType: AgoraApplicationScenarioTypeint错误码索引
setVoiceBeautifierParameters:param1:param2:preset: AgoraVoiceBeautifierPreset, param1: int, param2: intint错误码索引
setVoiceBeautifierPreset:preset: AgoraVoiceBeautifierPresetint错误码索引
setVoiceConversionPreset:preset: AgoraVoiceConversionPresetint错误码索引
setVolumeOfEffect:withVolume:soundId: int, volume: intint错误码索引
setupLocalVideo:local?: AgoraRtcVideoCanvas*int错误码索引
setupRemoteVideo:remote: AgoraRtcVideoCanvas*int错误码索引
sharedEngineWithAppId:delegate:appId: NSString*, delegate?: idinstancetype错误码索引
sharedEngineWithConfig:delegate:config: AgoraRtcEngineConfig*, delegate?: idinstancetype错误码索引
startAudioMixing:loopback:cycle:filePath: NSString*, loopback: BOOL, cycle: NSIntegerint错误码索引
startAudioMixing:loopback:cycle:startPos:filePath: NSString*, loopback: BOOL, cycle: NSInteger, startPos: NSIntegerint错误码索引
startAudioRecording:quality:filePath: NSString*, quality: AgoraAudioRecordingQualityint错误码索引
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: AgoraVideoSourceTypeint错误码索引
startRecordingDeviceTest:indicationInterval: intint错误码索引
startRhythmPlayer:sound2:config:sound1: NSString*, sound2: NSString*, config?: AgoraRhythmPlayerConfig*int错误码索引
startRtmpStreamWithTranscoding:transcoding:url: NSString*, transcoding?: AgoraLiveTranscoding*int错误码索引
startRtmpStreamWithoutTranscoding:url: NSString*int错误码索引
startScreenCapture:parameters?: AgoraScreenCaptureParameters2*int错误码索引
stopAllEffects—int错误码索引
stopAudioMixing—int错误码索引
stopAudioRecording—int错误码索引
stopCameraCapture:sourceType: AgoraVideoSourceTypeint错误码索引
stopChannelMediaRelay—int错误码索引
stopEchoTest—int错误码索引
stopEffect:soundId: intint错误码索引
stopLastmileProbeTest—int错误码索引
stopLocalAudioMixer—int错误码索引
stopLocalVideoTranscoder—int错误码索引
stopPlaybackDeviceTest—int错误码索引
stopPreview—int错误码索引
stopPreview:sourceType: AgoraVideoSourceTypeint错误码索引
stopRecordingDeviceTest—int错误码索引
stopRhythmPlayer—int错误码索引
stopRtmpStream:url: NSString*int错误码索引
stopScreenCapture—int错误码索引
switchCamera—int错误码索引
takeSnapshot:filePath:uid: NSInteger, filePath: NSString*NSInteger错误码索引
takeSnapshotWithConfig:config:uid: NSInteger, config: AgoraSnapshotConfig*NSInteger错误码索引
unloadEffect:soundId: intint错误码索引
unregisterAudioSpectrumDelegate:delegate?: idint错误码索引
updateChannelWithMediaOptions:mediaOptions: AgoraRtcChannelMediaOptions*int错误码索引
updateLocalAudioMixerConfiguration:config: AgoraLocalAudioMixerConfiguration*int错误码索引
updateLocalTranscoderConfiguration:config: AgoraLocalTranscoderConfiguration*int错误码索引
updatePreloadChannelToken:token: NSString*int错误码索引
updateRtmpTranscoding:transcoding?: AgoraLiveTranscoding*int错误码索引
updateScreenCapture:parameters?: AgoraScreenCaptureParameters2*int错误码索引
AgoraRtcLocalAudioStats 0 方法 / 9 属性
属性类型只读
numChannelsNSUInteger否
sentSampleRateNSUInteger否
sentBitrateNSUInteger否
internalCodecNSUInteger否
txPacketLossRateNSUInteger否
audioDeviceDelayNSUInteger否
audioPlayoutDelayNSUInteger否
earMonitorDelayNSUInteger否
aecEstimatedDelayNSUInteger否
AgoraRtcLocalVideoStats 0 方法 / 23 属性
属性类型只读
uidNSUInteger否
sentBitrateNSUInteger否
sentFrameRateNSUInteger否
captureFrameRateNSInteger否
captureFrameWidthNSInteger否
captureFrameHeightNSInteger否
regulatedCaptureFrameRateNSInteger否
regulatedCaptureFrameWidthNSInteger否
regulatedCaptureFrameHeightNSInteger否
encoderOutputFrameRateNSInteger否
rendererOutputFrameRateNSInteger否
targetFrameRateNSInteger否
qualityAdaptIndicationAgoraVideoQualityAdaptIndication否
targetBitrateNSInteger否
encodedBitrateNSInteger否
encodedFrameWidthNSInteger否
encodedFrameHeightNSInteger否
encodedFrameCountNSInteger否
codecTypeAgoraVideoCodecType否
hwEncoderAcceleratingAgoraVideoHwEncoderAccelerating否
txPacketLossRateNSInteger否
captureBrightnessLevelAgoraCaptureBrightnessLevelType否
dualStreamEnabledBOOL否
AgoraRtcMediaPlayerAudioFrameDelegate 1 方法 / 0 属性
typescript
AgoraRtcMediaPlayer:didReceiveAudioFrame:(playerKit: id, audioFrame: AgoraAudioFrame*): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
AgoraRtcMediaPlayer:didReceiveAudioFrame:playerKit: id, audioFrame: AgoraAudioFrame*void错误码索引
AgoraRtcMediaPlayerCacheManagerProtocol 13 方法 / 0 属性
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

方法明细:13 / 13(参数、返回值、错误码)

方法参数返回值错误
cacheDir—NSString*错误码索引
cacheFileCount—NSInteger错误码索引
createMediaPlayerCacheManager—id错误码索引
enableAutoRemoveCache:enable: BOOLint错误码索引
maxCacheFileCount—NSInteger错误码索引
maxCacheFileSize—NSInteger错误码索引
removeAllCaches—int错误码索引
removeCacheByUri:uri: NSString*int错误码索引
removeOldCache—int错误码索引
setCacheDir:cacheDir: NSString*int错误码索引
setMaxCacheFileCount:count: NSIntegerint错误码索引
setMaxCacheFileSize:cacheSize: NSIntegerint错误码索引
sharedInstance—instancetype错误码索引
AgoraRtcMediaPlayerDelegate 11 方法 / 0 属性
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

方法明细:11 / 11(参数、返回值、错误码)

方法参数返回值错误
AgoraRtcMediaPlayer:cacheStats:playerKit: id, info: AgoraMediaPlayerCacheStatistics*void错误码索引
AgoraRtcMediaPlayer:didChangedToPosition:atTimestamp:playerKit: id, positionMs: NSInteger, timestampMs: NSTimeIntervalvoid错误码索引
AgoraRtcMediaPlayer:didChangedToState:reason:playerKit: id, state: AgoraMediaPlayerState, reason: AgoraMediaPlayerReasonvoid错误码索引
AgoraRtcMediaPlayer:didOccurEvent:elapsedTime:message:playerKit: id, eventCode: AgoraMediaPlayerEvent, elapsedTime: NSInteger, message?: NSString*void错误码索引
AgoraRtcMediaPlayer:didPlayBufferUpdated:playerKit: id, playCachedBuffer: NSIntegervoid错误码索引
AgoraRtcMediaPlayer:didPreloadEvent:playerKit: id, event: AgoraMediaPlayerPreloadEventvoid错误码索引
AgoraRtcMediaPlayer:didReceiveData:length:playerKit: id, data?: NSString*, length: NSIntegervoid错误码索引
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: NSIntegervoid错误码索引
AgoraRtcMediaPlayerProtocol 37 方法 / 0 属性
typescript
adjustPlayoutVolume:(volume: int): int
adjustPublishSignalVolume:(volume: int): int
getAudioBufferDelay(): NSInteger
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

方法明细:37 / 37(参数、返回值、错误码)

方法参数返回值错误
adjustPlayoutVolume:volume: intint错误码索引
adjustPublishSignalVolume:volume: intint错误码索引
getAudioBufferDelay—NSInteger错误码索引
getDuration—NSInteger错误码索引
getMediaPlayerId—int错误码索引
getMute—BOOL错误码索引
getPlaySrc—NSString*错误码索引
getPlayerState—AgoraMediaPlayerState错误码索引
getPlayoutVolume—int错误码索引
getPosition—NSInteger错误码索引
getPublishSignalVolume—int错误码索引
getStreamByIndex:index: intAgoraRtcMediaStreamInfo*错误码索引
getStreamCount—NSInteger错误码索引
mute:isMute: BOOLint错误码索引
open:startPos:url: NSString*, startPos: NSIntegerint错误码索引
openWithMediaSource:source: AgoraMediaSource*int错误码索引
pause—int错误码索引
play—int错误码索引
playPreloadedSrc:src: NSString*int错误码索引
preloadSrc:startPos:src: NSString*, startPos: intint错误码索引
resume—int错误码索引
seekToPosition:position: NSIntegerint错误码索引
selectAudioTrack:index: intint错误码索引
selectMultiAudioTrack:publishTrackIndex:playoutTrackIndex: NSInteger, publishTrackIndex: NSIntegerint错误码索引
setAudioDualMonoMode:mode: AgoraAudioDualMonoModeint错误码索引
setAudioPitch:pitch: NSIntegerint错误码索引
setLoopCount:loopCount: intint错误码索引
setPlaybackSpeed:speed: intint错误码索引
setPlayerOption:value:key: NSString*, value: NSIntegerint错误码索引
setPlayerOptionString:value:key: NSString*, value: NSString*int错误码索引
setRenderMode:mode: AgoraMediaPlayerRenderModeint错误码索引
setSpatialAudioParams:params: AgoraSpatialAudioParams*int错误码索引
setVideoFrameDelegate:delegate?: idBOOL错误码索引
setView:view?: View*int错误码索引
stop:—unknown错误码索引
switchSrc:syncPts:src: NSString*, syncPts: BOOLint错误码索引
unloadSrc:src: NSString*int错误码索引
AgoraRtcMediaPlayerVideoFrameDelegate 3 方法 / 0 属性
typescript
AgoraRtcMediaPlayer:didReceivePixelBuffer:(playerKit: id, pixelBuffer: CVPixelBufferRef): void
AgoraRtcMediaPlayer:didReceiveVideoFrame:(playerKit: id, videoFrame: AgoraOutputVideoFrame*): void
AgoraRtcMediaPlayerGetVideoPixelFormat(): AgoraVideoFormat

方法明细:3 / 3(参数、返回值、错误码)

方法参数返回值错误
AgoraRtcMediaPlayer:didReceivePixelBuffer:playerKit: id, pixelBuffer: CVPixelBufferRefvoid错误码索引
AgoraRtcMediaPlayer:didReceiveVideoFrame:playerKit: id, videoFrame: AgoraOutputVideoFrame*void错误码索引
AgoraRtcMediaPlayerGetVideoPixelFormat—AgoraVideoFormat错误码索引
AgoraRtcMediaStreamInfo 0 方法 / 12 属性
属性类型只读
streamIndexNSInteger否
streamTypeAgoraMediaStreamType否
codecNameNSString*否
languageNSString*否
videoFrameRateNSInteger否
videoBitRateNSInteger否
videoWidthNSInteger否
videoHeightNSInteger否
audioSampleRateNSInteger否
audioChannelsNSInteger否
durationNSInteger否
rotationNSInteger否
AgoraRtcRemoteAudioStats 0 方法 / 19 属性
属性类型只读
uidNSUInteger否
qualityNSUInteger否
networkTransportDelayNSUInteger否
jitterBufferDelayNSUInteger否
audioLossRateNSUInteger否
numChannelsNSUInteger否
receivedSampleRateNSUInteger否
receivedBitrateNSUInteger否
totalFrozenTimeNSUInteger否
totalActiveTimeNSUInteger否
publishDurationNSInteger否
frozenRateNSUInteger否
mosValueNSUInteger否
frozenRateByCustomPlcCountNSUInteger否
plcCountNSUInteger否
qoeQualityAgoraExperienceQuality否
qualityChangedReasonAgoraExperiencePoorReason否
rxAudioBytesNSUInteger否
e2eDelayNSInteger否
AgoraRtcRemoteVideoStats 0 方法 / 18 属性
属性类型只读
uidNSUInteger否
delayNSUInteger否
e2eDelayNSUInteger否
widthNSUInteger否
heightNSUInteger否
receivedBitrateNSUInteger否
rxStreamTypeAgoraVideoStreamType否
decoderOutputFrameRateNSInteger否
rendererOutputFrameRateNSInteger否
frameLossRateNSInteger否
packetLossRateNSInteger否
totalFrozenTimeNSInteger否
totalActiveTimeNSUInteger否
publishDurationNSInteger否
frozenRateNSInteger否
avSyncTimeMsNSInteger否
mosValueNSInteger否
rxVideoBytesNSUInteger否
AgoraRtcVideoCanvas 0 方法 / 12 属性
属性类型只读
uidNSUInteger否
subviewUidNSUInteger否
viewVIEW_CLASS*否
renderModeAgoraVideoRenderMode否
mirrorModeAgoraVideoMirrorMode否
setupModeAgoraVideoViewSetupMode否
sourceTypeAgoraVideoSourceType否
mediaPlayerIdint否
cropAreaCGRect否
backgroundColorUInt32否
enableAlphaMaskBOOL否
positionAgoraVideoModulePosition否
AgoraRte 6 方法 / 0 属性
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

方法明细:6 / 6(参数、返回值、错误码)

方法参数返回值错误
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错误码索引
AgoraRteCanvas 5 方法 / 0 属性
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

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
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错误码索引
AgoraRteCanvasConfig 4 方法 / 0 属性
typescript
setVideoMirrorMode:error:(mode: AgoraRteVideoMirrorMode, error?: AgoraRteError*): void
setVideoRenderMode:error:(mode: AgoraRteVideoRenderMode, error?: AgoraRteError*): void
videoMirrorMode:(error?: AgoraRteError*): AgoraRteVideoMirrorMode
videoRenderMode:(error?: AgoraRteError*): AgoraRteVideoRenderMode

方法明细:4 / 4(参数、返回值、错误码)

方法参数返回值错误
setVideoMirrorMode:error:mode: AgoraRteVideoMirrorMode, error?: AgoraRteError*void错误码索引
setVideoRenderMode:error:mode: AgoraRteVideoRenderMode, error?: AgoraRteError*void错误码索引
videoMirrorMode:error?: AgoraRteError*AgoraRteVideoMirrorMode错误码索引
videoRenderMode:error?: AgoraRteError*AgoraRteVideoRenderMode错误码索引
AgoraRteConfig 4 方法 / 0 属性
typescript
appId:(error?: AgoraRteError*): NSString*
jsonParameter:(error?: AgoraRteError*): NSString*
setAppId:error:(appId?: NSString*, error?: AgoraRteError*): void
setJsonParameter:error:(jsonParameter?: NSString*, error?: AgoraRteError*): void

方法明细:4 / 4(参数、返回值、错误码)

方法参数返回值错误
appId:error?: AgoraRteError*NSString*错误码索引
jsonParameter:error?: AgoraRteError*NSString*错误码索引
setAppId:error:appId?: NSString*, error?: AgoraRteError*void错误码索引
setJsonParameter:error:jsonParameter?: NSString*, error?: AgoraRteError*void错误码索引
AgoraRteError 2 方法 / 0 属性
typescript
code(): AgoraRteErrorCode
message(): NSString*

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
code—AgoraRteErrorCode错误码索引
message—NSString*错误码索引
AgoraRtePlayer 18 方法 / 0 属性
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

方法明细:18 / 18(参数、返回值、错误码)

方法参数返回值错误
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错误码索引
AgoraRtePlayerConfig 12 方法 / 0 属性
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

方法明细:12 / 12(参数、返回值、错误码)

方法参数返回值错误
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错误码索引
AgoraRtePlayerObserver 7 方法 / 0 属性
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

方法明细:7 / 7(参数、返回值、错误码)

方法参数返回值错误
onAudioVolumeIndication:volume: int32_tvoid错误码索引
onEvent:event: AgoraRtePlayerEventvoid错误码索引
onMetadata:data:type: AgoraRtePlayerMetadataType, data: NSData*void错误码索引
onPlayerInfoUpdated:info: AgoraRtePlayerInfo*void错误码索引
onPositionChanged:utcTime:currentTime: uint64_t, utcTime: uint64_tvoid错误码索引
onResolutionChanged:height:width: int, height: intvoid错误码索引
onStateChanged:newState:error:oldState: AgoraRtePlayerState, newState: AgoraRtePlayerState, error?: AgoraRteError*void错误码索引
AgoraRtePlayerStats 0 方法 / 0 属性

无公开成员。

AgoraScreenAudioParameters 0 方法 / 1 属性
属性类型只读
captureSignalVolumeNSInteger否
AgoraScreenCaptureParameters2 0 方法 / 4 属性
属性类型只读
captureAudioBOOL否
audioParamsAgoraScreenAudioParameters*否
captureVideoBOOL否
videoParamsAgoraScreenVideoParameters*否
AgoraScreenVideoParameters 0 方法 / 4 属性
属性类型只读
dimensionsCGSize否
frameRateNSInteger否
bitrateNSInteger否
contentHintAgoraVideoContentHint否
AgoraSegmentationProperty 0 方法 / 3 属性
属性类型只读
modelTypeSegModelType否
greenCapacityfloat否
screenColorTypeScreenColorType否
AgoraSimulcastStreamConfig 0 方法 / 0 属性

无公开成员。

AgoraSnapshotConfig 0 方法 / 2 属性
属性类型只读
filePathNSString*否
positionAgoraVideoModulePosition否
AgoraSpatialAudioKitBase 12 方法 / 0 属性
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
updateSelfTransform:(transform: simd_float4x4): int

方法明细:12 / 12(参数、返回值、错误码)

方法参数返回值错误
clearRemotePositions:—unknown错误码索引
muteAllRemoteAudioStreams:mute: BOOLint错误码索引
muteLocalAudioStream:mute: BOOLint错误码索引
muteRemoteAudioStream:mute:uid: NSUInteger, mute: BOOLint错误码索引
setAudioRecvRange:range: floatint错误码索引
setDistanceUnit:unit: floatint错误码索引
setMaxAudioRecvCount:maxCount: NSUIntegerint错误码索引
setPlayerAttenuation:playerId:forceSet:attenuation: double, playerId: NSUInteger, forceSet: BOOLint错误码索引
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_float3int错误码索引
updateSelfTransform:transform: simd_float4x4int错误码索引
AgoraSpatialAudioParams 0 方法 / 8 属性
属性类型只读
speaker_azimuthdouble否
speaker_elevationdouble否
speaker_distancedouble否
speaker_orientationNSInteger否
enable_blurBOOL否
enable_air_absorbBOOL否
speaker_attenuationdouble否
enable_dopplerBOOL否
AgoraSpatialAudioZone 0 方法 / 9 属性
属性类型只读
zoneSetIdNSInteger否
positionsimd_float3否
forwardsimd_float3否
rightsimd_float3否
upsimd_float3否
forwardLengthfloat否
rightLengthfloat否
upLengthfloat否
audioAttenuationfloat否
AgoraTranscodingVideoStream 0 方法 / 8 属性
属性类型只读
remoteUserUidNSUInteger否
sourceTypeAgoraVideoSourceType否
imageUrlNSString*否
mediaPlayerIdNSUInteger否
rectCGRect否
zOrderNSInteger否
alphadouble否
mirrorBOOL否
AgoraUplinkNetworkInfo 0 方法 / 1 属性
属性类型只读
videoEncoderTargetBitrateBpsint否
AgoraUserInfo 0 方法 / 2 属性
属性类型只读
uidNSUInteger否
userAccountNSString*否
AgoraVideoCodecCapInfo 0 方法 / 3 属性
属性类型只读
codecTypeAgoraVideoCodecType否
codecCapMaskNSUInteger否
codecCapLevelsAgoraVideoCodecCapLevels*否
AgoraVideoCodecCapLevels 0 方法 / 2 属性
属性类型只读
hwDecodingLevelAgoraVideoCodecCapabilityLevel否
swDecodingLevelAgoraVideoCodecCapabilityLevel否
AgoraVideoDenoiserOptions 0 方法 / 2 属性
属性类型只读
modeAgoraVideoDenoiserMode否
levelAgoraVideoDenoiserLevel否
AgoraVideoEffectObject 10 方法 / 1 属性
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

方法明细:10 / 10(参数、返回值、错误码)

方法参数返回值错误
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: AgoraVideoEffectActionint错误码索引
removeVideoEffectWithNodeId:nodeIdNS_SWIFT_NAME: NSUIntegerint错误码索引
setVideoEffectBoolParamWithOption:key:boolValue:option: NSString*, key: NSString*, boolValueNS_SWIFT_NAME: BOOLint错误码索引
setVideoEffectFloatParamWithOption:key:floatValue:option: NSString*, key: NSString*, floatValueNS_SWIFT_NAME: floatint错误码索引
setVideoEffectIntParamWithOption:key:intValue:option: NSString*, key: NSString*, intValueNS_SWIFT_NAME: intint错误码索引
setVideoEffectStringParamWithOption:key:stringValue:option: NSString*, key: NSString*, stringValueNS_SWIFT_NAME: NSString*int错误码索引
属性类型只读
AgoraVideoEffectNodeStickerunknown否
AgoraVideoEncoderConfiguration 2 方法 / 9 属性
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

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
initWithSize:frameRate:bitrate:orientationMode:mirrorMode:size: CGSize, frameRate: NSInteger, bitrate: NSInteger, orientationMode: AgoraVideoOutputOrientationMode, mirrorMode: AgoraVideoMirrorModeinstancetype错误码索引
initWithWidth:height:frameRate:bitrate:orientationMode:mirrorMode:width: NSInteger, height: NSInteger, frameRate: NSInteger, bitrate: NSInteger, orientationMode: AgoraVideoOutputOrientationMode, mirrorMode: AgoraVideoMirrorModeinstancetype错误码索引
属性类型只读
dimensionsCGSize否
codecTypeAgoraVideoCodecType否
frameRateNSInteger否
bitrateNSInteger否
minBitrateNSInteger否
orientationModeAgoraVideoOutputOrientationMode否
mirrorModeAgoraVideoMirrorMode否
degradationPreferenceAgoraDegradationPreference否
advancedVideoOptionsAgoraAdvancedVideoOptions*否
AgoraVideoFrame 0 方法 / 16 属性
属性类型只读
formatNSInteger否
timeCMTime否
strideint否
strideInPixelsint stride DEPRECATED_MSG_ATTRIBUTE("use否
heightint否
textureBufCVPixelBufferRef否
imageIMAGE_CLASS*否
dataBufNSData*否
alphaBufNSData*否
alphaStitchModeAgoraAlphaStitchMode否
cropLeftint否
cropTopint否
cropRightint否
cropBottomint否
rotationint否
colorSpaceAgoraColorSpace*否
AgoraVideoFrameDelegate 8 方法 / 0 属性
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

方法明细:8 / 8(参数、返回值、错误码)

方法参数返回值错误
getMirrorApplied—BOOL错误码索引
getObservedFramePosition—AgoraVideoFramePosition错误码索引
getRotationApplied—BOOL错误码索引
getVideoFormatPreference—AgoraVideoFormat错误码索引
getVideoFrameProcessMode—AgoraVideoFrameProcessMode错误码索引
onCaptureVideoFrame:sourceType:videoFrame: AgoraOutputVideoFrame*, sourceType: AgoraVideoSourceTypeBOOL错误码索引
onPreEncodeVideoFrame:sourceType:videoFrame: AgoraOutputVideoFrame*, sourceType: AgoraVideoSourceTypeBOOL错误码索引
onRenderVideoFrame:uid:channelId:videoFrame: AgoraOutputVideoFrame*, uid: NSUInteger, channelId: NSString*BOOL错误码索引
AgoraVideoLayout 0 方法 / 8 属性
属性类型只读
channelIdNSString*否
uidNSUInteger否
strUidNSString*否
videoStateNSUInteger否
xNSUInteger否
yNSUInteger否
widthNSUInteger否
heightNSUInteger否
AgoraVideoLayoutInfo 0 方法 / 4 属性
属性类型只读
widthNSUInteger否
heightNSUInteger否
layoutCountNSUInteger否
layoutListNSArray*否
AgoraVideoRenderingTracingInfo 0 方法 / 7 属性
属性类型只读
elapsedTimeNSInteger否
start2JoinChannelNSInteger否
join2JoinSuccessNSInteger否
joinSuccess2RemoteJoinedNSInteger否
remoteJoined2SetViewNSInteger否
remoteJoined2UnmuteVideoNSInteger否
remoteJoined2PacketReceivedNSInteger否
AgoraVideoSubscriptionOptions 0 方法 / 2 属性
属性类型只读
typeAgoraVideoStreamType否
encodedFrameOnlyBOOL否
AgoraVirtualBackgroundSource 0 方法 / 4 属性
属性类型只读
backgroundSourceTypeAgoraVirtualBackgroundSourceType否
colorNSUInteger否
sourceNSString*否
blurDegreeAgoraBlurDegree否
LogUploadServerInfo 0 方法 / 4 属性
属性类型只读
serverDomainNSString*否
serverPathNSString*否
serverPortNSInteger否
serverHttpsBOOL否
WatermarkBuffer 0 方法 / 5 属性
属性类型只读
widthint否
heightint否
lengthint否
bufferNSData*否
formatWatermarkBufferFormat否
WatermarkConfig 0 方法 / 5 属性
属性类型只读
idNSString*否
typeWatermarkType否
bufferWatermarkBuffer*否
imageUrlNSURL*否
optionsWatermarkOptions*否
WatermarkOptions 0 方法 / 4 属性
属性类型只读
visibleInPreviewBOOL否
positionInLandscapeModeCGRect否
positionInPortraitModeCGRect否
zOrderint否

枚举

枚举成员数示例值
AgoraAlphaStitchMode5AgoraNoAlphaStitch = 0
AgoraApplicationScenarioType4AgoraApplicationGeneralScenario = 0
AgoraAreaCodeType8AgoraAreaCodeTypeCN = 1
AgoraAudienceLatencyLevelType2AgoraAudienceLatencyLevelLowLatency = 1
AgoraAudioCodecProfileType3AgoraAudioCodecProfileLCAAC = 0
AgoraAudioCodecType4AgoraAudioCodecTypeOPUS = 1
AgoraAudioDualMonoMode4AgoraAudioDualMonoStereo = 0
AgoraAudioEffectPreset21AgoraAudioEffectPresetOff = 0
AgoraAudioEncodedFrameDelegatePosition3AgoraAudioEncodedFrameObserverPositionRecord = 1
AgoraAudioEncodingType11AgoraAudioEncodingTypeAAC16000Low = 65793
AgoraAudioEqualizationBandFrequency10AgoraAudioEqualizationBand31 = 0
AgoraAudioFileRecordingType3AgoraAudioFileRecordingTypeMic = 1
AgoraAudioLocalReason9AgoraAudioLocalReasonOK = 0
AgoraAudioLocalState4AgoraAudioLocalStateStopped = 0
AgoraAudioMixingDualMonoMode4AgoraAudioMixingDualMonoAuto = 0
AgoraAudioMixingReasonCode8AgoraAudioMixingReasonCanNotOpen = 701
AgoraAudioMixingStateType4AgoraAudioMixingStateTypePlaying = 710
AgoraAudioOutputRouting12AgoraAudioOutputRoutingDefault = -1
AgoraAudioProcessChannels2AgoraAudioProcessChannelsMono = 1
AgoraAudioProfile7AgoraAudioProfileDefault = 0
AgoraAudioRawFrameOperationMode2AgoraAudioRawFrameOperationModeReadOnly = 0
AgoraAudioRecordingQuality4AgoraAudioRecordingQualityLow = 0
AgoraAudioRemoteReason8AgoraAudioRemoteReasonInternal = 0
AgoraAudioRemoteState5AgoraAudioRemoteStateStopped = 0
AgoraAudioReverbType5AgoraAudioReverbDryLevel = 0
AgoraAudioSampleRateType3AgoraAudioSampleRateType32000 = 32000
AgoraAudioScenario6AgoraAudioScenarioDefault = 0
AgoraAudioSessionOperationRestriction5AgoraAudioSessionOperationRestrictionNone = 0
AgoraAudioSourceType8AgoraAudioSourceMicrophone = 0
AgoraAudioTrackType2AgoraAudioTrackTypeMixable = 0
AgoraBlurDegree3AgoraBlurLow = 1
AgoraCameraDirection2AgoraCameraDirectionRear = 0
AgoraCameraStabilizationMode5AgoraCameraStabilizationModeOff = -1
AgoraCaptureBrightnessLevelType4AgoraCaptureBrightnessLevelInvalid = -1
AgoraChannelMediaRelayError12AgoraChannelMediaRelayErrorNone = 0
AgoraChannelMediaRelayState4AgoraChannelMediaRelayStateIdle = 0
AgoraChannelProfile5AgoraChannelProfileCommunication = 0
AgoraClientRole2AgoraClientRoleBroadcaster = 1
AgoraClientRoleChangeFailedReason4AgoraClientRoleChangeFailedTooManyBroadcasters = 1
AgoraCloudProxyType3AgoraNoneProxy = 0
AgoraCodecCapMask5AgoraCodecMaskNone = 0
AgoraCompressionPreference3AgoraCompressionAuto = -1
AgoraConnectionChangedReason23AgoraConnectionChangedReasonConnecting = 0
AgoraConnectionState5AgoraConnectionStateDisconnected = 1
AgoraContentInspectType4AgoraContentInspectTypeInvalid = 0
AgoraDegradationPreference6AgoraDegradationMaintainAuto = -1
AgoraEarMonitoringFilterType5AgoraEarMonitoringFilterNone = null
AgoraEncodingPreference3AgoraEncodingPreferAuto = -1
AgoraEncryptionErrorType5ENCRYPTION_ERROR_INTERNAL_FAILURE = 0
AgoraEncryptionMode9AgoraEncryptionModeAES128XTS = 1
AgoraErrorCode70AgoraErrorCodeNoError = 0
AgoraExperiencePoorReason5AgoraExperiencePoorReasonNone = 0
AgoraExperienceQuality2AgoraExperienceQualityGood = 0
AgoraExternalVideoSourceType2AgoraExternalVideoSourceTypeVideoFrame = 0
AgoraFaceShapeArea32AgoraFaceShapeAreaNone = -1
AgoraFaceShapeStyle3AgoraFaceShapeStyleFemale = 0
AgoraFeatureType2AgoraVideoPreprocessVirtualBackground = 1
AgoraFocalLength4AgoraFocalLengthDefault = 0
AgoraHeadphoneEQPreset3AgoraAudioHeadphoneEQPresetOff = 0
AgoraLastmileProbeResultState3AgoraLastmileProbeResultComplete = 1
AgoraLighteningContrastLevel3AgoraLighteningContrastLow = 0
AgoraLocalProxyMode2AgoraConnectivityFirst = 0
AgoraLocalVideoStreamReason16AgoraLocalVideoStreamReasonOK = 0
AgoraLogFilter6AgoraLogFilterOff = 0
AgoraLogLevel5AgoraLogLevelNone = 0
AgoraLowlightEnhanceLevel2AgoraLowlightEnhanceLevelQuality = 0
AgoraLowlightEnhanceMode2AgoraLowlightEnhanceModeAuto = 0
AgoraMediaPlayerEvent17AgoraMediaPlayerEventSeekBegin = 0
AgoraMediaPlayerMetaDataType2AgoraMediaPlayerMetaDataTypeUnknown = 0
AgoraMediaPlayerPreloadEvent3AgoraMediaPlayerPreloadEventBegin = 0
AgoraMediaPlayerReason18AgoraMediaPlayerReasonNone = 0
AgoraMediaPlayerRenderMode2AgoraMediaPlayerRenderModeHidden = 1
AgoraMediaPlayerState9AgoraMediaPlayerStateIdle = 0
AgoraMediaRecorderContainerFormat1AgoraMediaRecorderContainerFormatMP4 = 1
AgoraMediaRecorderReasonCode5AgoraMediaRecorderReasonCodeNoError = 0
AgoraMediaRecorderState3AgoraMediaRecorderStateError = -1
AgoraMediaRecorderStreamType3AgoraMediaRecorderStreamTypeAudio = 1
AgoraMediaSourceType15AgoraMediaSourceTypeAudioPlayout = 0
AgoraMediaStreamType4AgoraMediaStreamTypeUnknown = 0
AgoraMediaTraceEvent2AgoraMediaTraceEventVideoRendered = 0
AgoraMetadataType2AgoraMetadataTypeUnknown = -1
AgoraMultipathMode1AgoraMultipathModeDuplicate = 0
AgoraMultipathType4AgoraMultipathTypeLAN = 0
AgoraMusicCacheStatusType2AgoraMusicCacheStatusTypeCached = 0
AgoraMusicContentCenterPreloadState4AgoraMusicContentCenterPreloadStateOK = 0
AgoraMusicContentCenterStateReason8AgoraMusicContentCenterStateReasonOK = 0
AgoraMusicPlayMode3AgoraMusicPlayModeOriginal = 0
AgoraNetworkQuality9AgoraNetworkQualityUnknown = 0
AgoraNetworkType8AgoraNetworkTypeUnknown = -1
AgoraPermissionType2AgoraPermissionTypeRecordAudio = 0
AgoraProxyType7AgoraNoneProxyType = 0
AgoraRecorderStreamType2AgoraRecorderStreamTypeRtc = 0
AgoraRenewTokenErrorCode7AgoraRenewTokenSuccess = 0
AgoraRhythmPlayerReason5AgoraRhythmPlayerReasonOK = 0
AgoraRhythmPlayerState5AgoraRhythmPlayerStateIdle = 810
AgoraRteAbrFallbackLayer9AgoraRteAbrFallbackDisabled = 0
AgoraRteAbrSubscriptionLayer8AgoraRteAbrSubscriptionHigh = 0
AgoraRteErrorCode7AgoraRteOk = 0
AgoraRtePlayerEvent21AgoraRtePlayerEventSeekBegin = 0
AgoraRtePlayerMetadataType1AgoraRtePlayerMetadataTypeSei = 0
AgoraRtePlayerState8AgoraRtePlayerStateIdle = 0
AgoraRteVideoMirrorMode3AgoraRteVideoMirrorModeAuto = 0
AgoraRteVideoRenderMode2AgoraRteVideoRenderModeHidden = 0
AgoraRtmpStreamingEvent4AgoraRtmpStreamingEventFailedLoadImage = 1
AgoraRtmpStreamingReason17AgoraRtmpStreamingReasonOK = 0
AgoraRtmpStreamingState6AgoraRtmpStreamingStateIdle = 0
AgoraRtmpStreamLifeCycle2AgoraRtmpStreamLifeCycleBindToChannel = 1
AgoraScreenCaptureFrameRateCapability4AgoraScreenCaptureFrameRateUnKonw = -1
AgoraScreenScenarioType4AgoraScreenScenarioDocument = 1
AgoraSimulcastStreamMode3AgoraAutoSimulcastStream = -1
AgoraStreamFallbackOptions9AgoraStreamFallbackOptionDisabled = 0
AgoraStreamPublishState4AgoraStreamPublishStateIdle = 0
AgoraStreamSubscribeState4AgoraStreamSubscribeStateIdle = 0
AgoraUserOfflineReason3AgoraUserOfflineReasonQuit = 0
AgoraVideoCodecCapabilityLevel5AgoraVideoCodecCapabilityLevelUnspecified = -1
AgoraVideoCodecProfileType3AgoraVideoCodecProfileTypeBaseLine = 66
AgoraVideoCodecType7AgoraVideoCodecTypeNone = 0
AgoraVideoCodecTypeForStream2AgoraVideoCodecTypeH264ForStream = 1
AgoraVideoContentHint3AgoraVideoContentHintNone = 0
AgoraVideoDenoiserLevel2AgoraVideoDenoiserLevelHighQuality = 0
AgoraVideoDenoiserMode2AgoraVideoDenoiserModeAuto = null
AgoraVideoEffectAction2AgoraVideoEffectActionSave = 1
AgoraVideoEffectNodeId4AgoraVideoEffectNodeBeauty = 1
AgoraVideoFormat12AgoraVideoFormatI420 = 1
AgoraVideoFrameOrientation4AgoraVideoFrameOrientation0 = 0
AgoraVideoFramePosition3AgoraVideoFramePositionPostCapture = 1
AgoraVideoFrameProcessMode2AgoraVideoFrameProcessModeReadOnly = null
AgoraVideoFrameRate7AgoraVideoFrameRateFps1 = 1
AgoraVideoFrameType6AgoraVideoFrameTypeBlankFrame = 0
AgoraVideoHwEncoderAccelerating2AgoraVideoHwEncoderSoftware = 0
AgoraVideoLocalState4AgoraVideoLocalStateStopped = 0
AgoraVideoMirrorMode3AgoraVideoMirrorModeAuto = 0
AgoraVideoModulePosition4AgoraVideoModulePositionPostCapture = 1
AgoraVideoOutputOrientationMode3AgoraVideoOutputOrientationModeAdaptative = 0
AgoraVideoQualityAdaptIndication3AgoraVideoQualityAdaptNone = 0
AgoraVideoRemoteReason12AgoraVideoRemoteReasonInternal = 0
AgoraVideoRemoteState5AgoraVideoRemoteStateStopped = 0
AgoraVideoRenderMode3AgoraVideoRenderModeHidden = 1
AgoraVideoSourceType17AgoraVideoSourceTypeCamera = 0
AgoraVideoStreamType8AgoraVideoStreamTypeHigh = 0
AgoraVideoTranscoderError7AgoraVideoTranscoderErrorOK = 0
AgoraVideoViewSetupMode3AgoraVideoViewSetupReplace = 0
AgoraVirtualBackgroundSourceType5AgoraVirtualBackgroundNone = 0
AgoraVoiceAITunerType10AgoraVoiceAITunerMatureMale = 0
AgoraVoiceBeautifierPreset14AgoraVoiceBeautifierPresetOff = 0
AgoraVoiceConversionPreset16AgoraVoiceConversionPresetOff = 0
AUDIO_AINS_MODE3AINS_MODE_BALANCED = 0
ScreenColorType3ScreenColorAuto = 0
SegModelType2SegModelAgoraAi = null
WatermarkBufferFormat4WatermarkBufferFormatI420 = 1
WatermarkType2WatermarkTypeImage = 0
AgoraAlphaStitchMode 5 个成员
成员值
AgoraNoAlphaStitch0
AgoraAlphaStitchUp1
AgoraAlphaStitchBelow2
AgoraAlphaStitchLeft3
AgoraAlphaStitchRight4
AgoraApplicationScenarioType 4 个成员
成员值
AgoraApplicationGeneralScenario0
AgoraApplicationMeetingScenario1
AgoraApplication1V1Scenario2
AgoraApplicationLiveShowScenario3
AgoraAreaCodeType 8 个成员
成员值
AgoraAreaCodeTypeCN1
AgoraAreaCodeTypeNA2
AgoraAreaCodeTypeEUR4
AgoraAreaCodeTypeAS8
AgoraAreaCodeTypeJP16
AgoraAreaCodeTypeIN32
AgoraAreaCodeTypeRU4096
AgoraAreaCodeTypeGlobal4294967295
AgoraAudienceLatencyLevelType 2 个成员
成员值
AgoraAudienceLatencyLevelLowLatency1
AgoraAudienceLatencyLevelUltraLowLatency2
AgoraAudioCodecProfileType 3 个成员
成员值
AgoraAudioCodecProfileLCAAC0
AgoraAudioCodecProfileHEAAC1
AgoraAudioCodecProfileHEAACv22
AgoraAudioCodecType 4 个成员
成员值
AgoraAudioCodecTypeOPUS1
AgoraAudioCodecTypeAACLC8
AgoraAudioCodecTypeHEAAC9
AgoraAudioCodecTypeHEAAC211
AgoraAudioDualMonoMode 4 个成员
成员值
AgoraAudioDualMonoStereo0
AgoraAudioDualMonoL1
AgoraAudioDualMonoR2
AgoraAudioDualMonoMix3
AgoraAudioEffectPreset 21 个成员
成员值
AgoraAudioEffectPresetOff0
AgoraAudioEffectPresetRoomAcousticsKTV33620224
AgoraAudioEffectPresetRoomAcousVocalConcer33620480
AgoraAudioEffectPresetRoomAcousStudio33620736
AgoraAudioEffectPresetRoomAcousPhonograph33620992
AgoraAudioEffectPresetRoomAcousVirtualStereo33621248
AgoraAudioEffectPresetRoomAcousSpatial33621504
AgoraAudioEffectPresetRoomAcousEthereal33621760
AgoraAudioEffectPresetRoomAcous3DVoice33622016
AgoraAudioEffectPresetRoomAcousVirtualSurroundSound33622272
AgoraAudioEffectPresetRoomAcousticsChorus33623296
AgoraAudioEffectPresetVoiceChangerEffectUncle33685760
AgoraAudioEffectPresetVoiceChangerEffectOldMan33686016
AgoraAudioEffectPresetVoiceChangerEffectBoy33686272
AgoraAudioEffectPresetVoiceChangerEffectSister33686528
AgoraAudioEffectPresetVoiceChangerEffectGirl33686784
AgoraAudioEffectPresetVoiceChangerEffectPigKin33687040
AgoraAudioEffectPresetVoiceChangerEffectHulk33687296
AgoraAudioEffectPresetStyleTransformationRnb33751296
AgoraAudioEffectPresetStyleTransformationPopular33751552
AgoraAudioEffectPresetPitchCorrection33816832
AgoraAudioEncodedFrameDelegatePosition 3 个成员
成员值
AgoraAudioEncodedFrameObserverPositionRecord1
AgoraAudioEncodedFrameObserverPositionPlayback2
AgoraAudioEncodedFrameObserverPositionMixed3
AgoraAudioEncodingType 11 个成员
成员值
AgoraAudioEncodingTypeAAC16000Low65793
AgoraAudioEncodingTypeAAC16000Medium65794
AgoraAudioEncodingTypeAAC32000Low66049
AgoraAudioEncodingTypeAAC32000Medium66050
AgoraAudioEncodingTypeAAC32000High66051
AgoraAudioEncodingTypeAAC48000Medium66306
AgoraAudioEncodingTypeAAC48000High66307
AgoraAudioEncodingTypeOPUS16000Low131329
AgoraAudioEncodingTypeOPUS6000Medium131330
AgoraAudioEncodingTypeOPUS48000Medium131842
AgoraAudioEncodingTypeOPUS48000High131843
AgoraAudioEqualizationBandFrequency 10 个成员
成员值
AgoraAudioEqualizationBand310
AgoraAudioEqualizationBand621
AgoraAudioEqualizationBand1252
AgoraAudioEqualizationBand2503
AgoraAudioEqualizationBand5004
AgoraAudioEqualizationBand1K5
AgoraAudioEqualizationBand2K6
AgoraAudioEqualizationBand4K7
AgoraAudioEqualizationBand8K8
AgoraAudioEqualizationBand16K9
AgoraAudioFileRecordingType 3 个成员
成员值
AgoraAudioFileRecordingTypeMic1
AgoraAudioFileRecordingTypePlayback2
AgoraAudioFileRecordingTypeMixed3
AgoraAudioLocalReason 9 个成员
成员值
AgoraAudioLocalReasonOK0
AgoraAudioLocalReasonFailure1
AgoraAudioLocalReasonDeviceNoPermission2
AgoraAudioLocalReasonDeviceBusy3
AgoraAudioLocalReasonRecordFailure4
AgoraAudioLocalReasonEncodeFailure5
AgoraAudioLocalReasonNoRecordingDevice6
AgoraAudioLocalReasonNoPlayoutDevice7
AgoraAudioLocalReasonInterrupted8
AgoraAudioLocalState 4 个成员
成员值
AgoraAudioLocalStateStopped0
AgoraAudioLocalStateRecording1
AgoraAudioLocalStateEncoding2
AgoraAudioLocalStateFailed3
AgoraAudioMixingDualMonoMode 4 个成员
成员值
AgoraAudioMixingDualMonoAuto0
AgoraAudioMixingDualMonoL1
AgoraAudioMixingDualMonoR2
AgoraAudioMixingDualMonoMix3
AgoraAudioMixingReasonCode 8 个成员
成员值
AgoraAudioMixingReasonCanNotOpen701
AgoraAudioMixingReasonTooFrequentlyCall702
AgoraAudioMixingReasonInterruptedEOF703
AgoraAudioMixingReasonOneLoopCompleted721
AgoraAudioMixingReasonAllLoopsCompleted723
AgoraAudioMixingReasonStoppedByUser724
AgoraAudioMixingReasonResumedByUser726
AgoraAudioMixingReasonTypeOk0
AgoraAudioMixingStateType 4 个成员
成员值
AgoraAudioMixingStateTypePlaying710
AgoraAudioMixingStateTypePaused711
AgoraAudioMixingStateTypeStopped713
AgoraAudioMixingStateTypeFailed714
AgoraAudioOutputRouting 12 个成员
成员值
AgoraAudioOutputRoutingDefault-1
AgoraAudioOutputRoutingHeadset0
AgoraAudioOutputRoutingEarpiece1
AgoraAudioOutputRoutingHeadsetNoMic2
AgoraAudioOutputRoutingSpeakerphone3
AgoraAudioOutputRoutingLoudspeaker4
AgoraAudioOutputRoutingBluetoothDeviceHfp5
AgoraAudioOutputRoutingUsb6
AgoraAudioOutputRoutingHdmi7
AgoraAudioOutputRoutingDisplayPort8
AgoraAudioOutputRoutingAirPlay9
AgoraAudioOutputRoutingBluetoothDeviceA2dp10
AgoraAudioProcessChannels 2 个成员
成员值
AgoraAudioProcessChannelsMono1
AgoraAudioProcessChannelstereo2
AgoraAudioProfile 7 个成员
成员值
AgoraAudioProfileDefault0
AgoraAudioProfileSpeechStandard1
AgoraAudioProfileMusicStandard2
AgoraAudioProfileMusicStandardStereo3
AgoraAudioProfileMusicHighQuality4
AgoraAudioProfileMusicHighQualityStereo5
AgoraAudioProfileIot6
AgoraAudioRawFrameOperationMode 2 个成员
成员值
AgoraAudioRawFrameOperationModeReadOnly0
AgoraAudioRawFrameOperationModeReadWrite2
AgoraAudioRecordingQuality 4 个成员
成员值
AgoraAudioRecordingQualityLow0
AgoraAudioRecordingQualityMedium1
AgoraAudioRecordingQualityHigh2
AgoraAudioRecordingQualityUltraHigh3
AgoraAudioRemoteReason 8 个成员
成员值
AgoraAudioRemoteReasonInternal0
AgoraAudioRemoteReasonNetworkCongestion1
AgoraAudioRemoteReasonNetworkRecovery2
AgoraAudioRemoteReasonLocalMuted3
AgoraAudioRemoteReasonLocalUnmuted4
AgoraAudioRemoteReasonRemoteMuted5
AgoraAudioRemoteReasonRemoteUnmuted6
AgoraAudioRemoteReasonRemoteOffline7
AgoraAudioRemoteState 5 个成员
成员值
AgoraAudioRemoteStateStopped0
AgoraAudioRemoteStateStarting1
AgoraAudioRemoteStateDecoding2
AgoraAudioRemoteStateFrozen3
AgoraAudioRemoteStateFailed4
AgoraAudioReverbType 5 个成员
成员值
AgoraAudioReverbDryLevel0
AgoraAudioReverbWetLevel1
AgoraAudioReverbRoomSize2
AgoraAudioReverbWetDelay3
AgoraAudioReverbStrength4
AgoraAudioSampleRateType 3 个成员
成员值
AgoraAudioSampleRateType3200032000
AgoraAudioSampleRateType4410044100
AgoraAudioSampleRateType4800048000
AgoraAudioScenario 6 个成员
成员值
AgoraAudioScenarioDefault0
AgoraAudioScenarioGameStreaming3
AgoraAudioScenarioChatRoom5
AgoraAudioScenarioChorus7
AgoraAudioScenarioMeeting8
AgoraAudioScenarioAiClient10
AgoraAudioSessionOperationRestriction 5 个成员
成员值
AgoraAudioSessionOperationRestrictionNone0
AgoraAudioSessionOperationRestrictionSetCategory1
AgoraAudioSessionOperationRestrictionConfigureSession2
AgoraAudioSessionOperationRestrictionDeactivateSession4
AgoraAudioSessionOperationRestrictionAll128
AgoraAudioSourceType 8 个成员
成员值
AgoraAudioSourceMicrophone0
AgoraAudioSourceCustom1
AgoraAudioSourceMediaPlayer2
AgoraAudioSourceLoopbackRecording3
AgoraAudioSourceMixedStream4
AgoraAudioSourceRemoteUser5
AgoraAudioSourceRemoteChannel6
AgoraAudioSourceTypeUnknown100
AgoraAudioTrackType 2 个成员
成员值
AgoraAudioTrackTypeMixable0
AgoraAudioTrackTypeDirect1
AgoraBlurDegree 3 个成员
成员值
AgoraBlurLow1
AgoraBlurMedium2
AgoraBlurHigh3
AgoraCameraDirection 2 个成员
成员值
AgoraCameraDirectionRear0
AgoraCameraDirectionFront1
AgoraCameraStabilizationMode 5 个成员
成员值
AgoraCameraStabilizationModeOff-1
AgoraCameraStabilizationModeAuto0
AgoraCameraStabilizationModeLevel11
AgoraCameraStabilizationModeLevel22
AgoraCameraStabilizationModeLevel33
AgoraCaptureBrightnessLevelType 4 个成员
成员值
AgoraCaptureBrightnessLevelInvalid-1
AgoraCaptureBrightnessLevelNormal0
AgoraCaptureBrightnessLevelBright1
AgoraCaptureBrightnessLevelDark2
AgoraChannelMediaRelayError 12 个成员
成员值
AgoraChannelMediaRelayErrorNone0
AgoraChannelMediaRelayErrorServerErrorResponse1
AgoraChannelMediaRelayErrorServerNoResponse2
AgoraChannelMediaRelayErrorNoResourceAvailable3
AgoraChannelMediaRelayErrorFailedJoinSourceChannel4
AgoraChannelMediaRelayErrorFailedJoinDestinationChannel5
AgoraChannelMediaRelayErrorFailedPacketReceivedFromSource6
AgoraChannelMediaRelayErrorFailedPacketSentToDestination7
AgoraChannelMediaRelayErrorServerConnectionLost8
AgoraChannelMediaRelayErrorInternalError9
AgoraChannelMediaRelayErrorSourceTokenExpired10
AgoraChannelMediaRelayErrorDestinationTokenExpired11
AgoraChannelMediaRelayState 4 个成员
成员值
AgoraChannelMediaRelayStateIdle0
AgoraChannelMediaRelayStateConnecting1
AgoraChannelMediaRelayStateRunning2
AgoraChannelMediaRelayStateFailure3
AgoraChannelProfile 5 个成员
成员值
AgoraChannelProfileCommunication0
AgoraChannelProfileLiveBroadcasting1
AgoraChannelProfileGame2
AgoraChannelProfileCloudGaming3
AgoraChannelProfileCommunication_1v14
AgoraClientRole 2 个成员
成员值
AgoraClientRoleBroadcaster1
AgoraClientRoleAudience2
AgoraClientRoleChangeFailedReason 4 个成员
成员值
AgoraClientRoleChangeFailedTooManyBroadcasters1
AgoraClientRoleChangeFailedNotAuthorized2
AgoraClientRoleChangeFailedRequestTimeout3
AgoraClientRoleChangeFailedConnectionFailed4
AgoraCloudProxyType 3 个成员
成员值
AgoraNoneProxy0
AgoraUdpProxy1
AgoraTcpProxy2
AgoraCodecCapMask 5 个成员
成员值
AgoraCodecMaskNone0
AgoraCodecMaskHwDec1
AgoraCodecMaskHwEnc2
AgoraCodecMaskSwDec4
AgoraCodecMaskSwEnc8
AgoraCompressionPreference 3 个成员
成员值
AgoraCompressionAuto-1
AgoraCompressionLowLatency0
AgoraCompressionQuality1
AgoraConnectionChangedReason 23 个成员
成员值
AgoraConnectionChangedReasonConnecting0
AgoraConnectionChangedReasonJoinSuccess1
AgoraConnectionChangedReasonInterrupted2
AgoraConnectionChangedReasonBannedByServer3
AgoraConnectionChangedReasonJoinFailed4
AgoraConnectionChangedReasonLeaveChannel5
AgoraConnectionChangedReasonInvalidAppId6
AgoraConnectionChangedReasonInvalidChannelName7
AgoraConnectionChangedReasonInvalidToken8
AgoraConnectionChangedReasonTokenExpired9
AgoraConnectionChangedReasonRejectedByServer10
AgoraConnectionChangedReasonSettingProxyServer11
AgoraConnectionChangedReasonRenewToken12
AgoraConnectionChangedReasonClientIpAddressChanged13
AgoraConnectionChangedReasonKeepAliveTimeout14
AgoraConnectionChangedReasonRejoinSuccess15
AgoraConnectionChangedReasonLost16
AgoraConnectionChangedReasonEchoTest17
AgoraConnectionChangedClientIpAddressChangedByUser18
AgoraConnectionChangedSameUidLogin19
AgoraConnectionChangedTooManyBroadcasters20
AgoraConnectionChangedLicenseValidationFailure21
AgoraConnectionChangedCertificationVerifyFailure22
AgoraConnectionState 5 个成员
成员值
AgoraConnectionStateDisconnected1
AgoraConnectionStateConnecting2
AgoraConnectionStateConnected3
AgoraConnectionStateReconnecting4
AgoraConnectionStateFailed5
AgoraContentInspectType 4 个成员
成员值
AgoraContentInspectTypeInvalid0
AgoraContentInspectTypeModeration1
AgoraContentInspectTypeSupervise2
AgoraContentInspectTypeImageModeration3
AgoraDegradationPreference 6 个成员
成员值
AgoraDegradationMaintainAuto-1
AgoraDegradationMaintainQuality0
AgoraDegradationMaintainFramerate1
AgoraDegradationBalanced2
AgoraDegradationMaintainResolution3
AgoraDegradationDisable100
AgoraEarMonitoringFilterType 5 个成员
成员值
AgoraEarMonitoringFilterNonenull
AgoraEarMonitoringFilterBuiltInAudioFiltersnull
AgoraEarMonitoringFilterNoiseSuppressionnull
AgoraEarMonitoringFilterBuiltInAudioFiltersWithNoiseSuppression6
AgoraEarMonitoringFilterReusePostProcessingFilternull
AgoraEncodingPreference 3 个成员
成员值
AgoraEncodingPreferAuto-1
AgoraEncodingPrefersoftware0
AgoraEncodingPreferhardware1
AgoraEncryptionErrorType 5 个成员
成员值
ENCRYPTION_ERROR_INTERNAL_FAILURE0
ENCRYPTION_ERROR_DECRYPTION_FAILURE1
ENCRYPTION_ERROR_ENCRYPTION_FAILURE2
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE3
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE4
AgoraEncryptionMode 9 个成员
成员值
AgoraEncryptionModeAES128XTS1
AgoraEncryptionModeAES128ECB2
AgoraEncryptionModeAES256XTS3
AgoraEncryptionModeSM4128ECB4
AgoraEncryptionModeAES128GCM5
AgoraEncryptionModeAES256GCM6
AgoraEncryptionModeAES128GCM27
AgoraEncryptionModeAES256GCM28
AgoraEncryptionModeEnd9
AgoraErrorCode 70 个成员
成员值
AgoraErrorCodeNoError0
AgoraErrorCodeFailed1
AgoraErrorCodeInvalidArgument2
AgoraErrorCodeNotReady3
AgoraErrorCodeNotSupported4
AgoraErrorCodeBufferTooSmall6
AgoraErrorCodeNotInitialized7
AgoraErrorCodeInvalidState8
AgoraErrorCodeTimedOut10
AgoraErrorCodeJoinChannelRejected17
AgoraErrorCodeLeaveChannelRejected18
AgoraErrorCodeAlreadyInUse19
AgoraErrorCodeInitNetEngine21
AgoraErrorCodeResourceLimited22
AgoraErrorCodeInvalidAppId101
AgoraErrorCodeInvalidChannelId102
AgoraErrorCodeNoServerResources103
AgoraErrorCodeTokenExpired109
AgoraErrorCodeInvalidToken110
AgoraErrorCodeConnectionInterrupted111
AgoraErrorCodeConnectionLost112
AgoraErrorCodeNotInChannel113
AgoraErrorCodeSizeTooLarge114
AgoraErrorCodeBitrateLimit115
AgoraErrorCodeTooManyDataStreams116
AgoraErrorCodeDecryptionFailed120
AgoraErrorCodeEncryptedStreamNotAllowedPublish130
AgoraErrorCodeInvalidUserAccount134
AgoraErrorCodeWatermarkParam124
AgoraErrorCodeWatermarkPath125
AgoraErrorCodeWatermarkPng126
AgoraErrorCodeWatermarkInfo127
AgoraErrorCodeWatermarkAGRB128
AgoraErrorCodeWatermarkRead129
AgoraErrorCodePcmSendFormat200
AgoraErrorCodePcmSendBufferOverflow201
AgoraErrorCodeLoadMediaEngine1001
AgoraErrorCodeStartCall1002
AgoraErrorCodeStartCamera1003
AgoraErrorCodeStartVideoRender1004
AgoraErrorCodeAdmGeneralError1005
AgoraErrorCodeAdmJavaResource1006
AgoraErrorCodeAdmSampleRate1007
AgoraErrorCodeAdmInitPlayout1008
AgoraErrorCodeAdmStartPlayout1009
AgoraErrorCodeAdmStopPlayout1010
AgoraErrorCodeAdmInitRecording1011
AgoraErrorCodeAdmStartRecording1012
AgoraErrorCodeAdmStopRecording1013
AgoraErrorCodeAdmRuntimePlayoutError1015
AgoraErrorCodeAdmRuntimeRecordingError1017
AgoraErrorCodeAdmRecordAudioFailed1018
AgoraErrorCodeAdmPlayAbnormalFrequency1020
AgoraErrorCodeAdmRecordAbnormalFrequency1021
AgoraErrorCodeAdmInitLoopback1022
AgoraErrorCodeAdmStartLoopback1023
AgoraErrorCodeAdmNoRecordingDevice1359
AgoraErrorCodeAdmNoPlayoutDevice1360
AgoraErrorCodeVdmCameraNotAuthorized1501
AgoraErrorCodeVcmUnknownError1600
AgoraErrorCodeVcmEncoderInitError1601
AgoraErrorCodeVcmEncoderEncodeError1602
AgoraErrorCodeVcmEncoderSetError1603
AgoraErrorCodeVideoEffectAssetInvalid1700
AgoraErrorCodeVideoEffectSaveFailed1701
AgoraErrorCodeVideoEffectEngineInvalid1702
AgoraErrorCodeVideoEffectNodeNotActive1704
AgoraErrorCodeVideoEffectInvalidParam1705
AgoraErrorCodeVideoEffectNotSupported1706
AgoraErrorCodeVideoEffectInvalidBundlePath1707
AgoraExperiencePoorReason 5 个成员
成员值
AgoraExperiencePoorReasonNone0
AgoraExperiencePoorReasonRemoteNetworkQualityPoor1
AgoraExperiencePoorReasonLocalNetworkQualityPoor2
AgoraExperiencePoorReasonWirelessSignalPoor4
AgoraExperiencePoorReasonWifiBluetoothCoexist8
AgoraExperienceQuality 2 个成员
成员值
AgoraExperienceQualityGood0
AgoraExperienceQualityBad1
AgoraExternalVideoSourceType 2 个成员
成员值
AgoraExternalVideoSourceTypeVideoFrame0
AgoraExternalVideoSourceTypeEncodedVideoFrame1
AgoraFaceShapeArea 32 个成员
成员值
AgoraFaceShapeAreaNone-1
AgoraFaceShapeAreaHeadScale100
AgoraFaceShapeAreaForehead101
AgoraFaceShapeAreaFaceContour102
AgoraFaceShapeAreaFaceLength103
AgoraFaceShapeAreaFaceWidth104
AgoraFaceShapeAreaCheekbone105
AgoraFaceShapeAreaCheek106
AgoraFaceShapeAreaMandible107
AgoraFaceShapeAreaChin108
AgoraFaceShapeAreaFaceSmall109
AgoraFaceShapeAreaEyeScale200
AgoraFaceShapeAreaEyeDistance201
AgoraFaceShapeAreaEyePosition202
AgoraFaceShapeAreaLowerEyelid203
AgoraFaceShapeAreaEyePupils204
AgoraFaceShapeAreaEyeInnerCorner205
AgoraFaceShapeAreaEyeOuterCorner206
AgoraFaceShapeAreaEyeAngle207
AgoraFaceShapeAreaNoseLength300
AgoraFaceShapeAreaNoseWidth301
AgoraFaceShapeAreaNoseWing302
AgoraFaceShapeAreaNoseRoot303
AgoraFaceShapeAreaNoseBridge304
AgoraFaceShapeAreaNoseTip305
AgoraFaceShapeAreaNoseGeneral306
AgoraFaceShapeAreaMouthScale400
AgoraFaceShapeAreaMouthPosition401
AgoraFaceShapeAreaMouthSmile402
AgoraFaceShapeAreaMouthLip403
AgoraFaceShapeAreaEyebrowPosition500
AgoraFaceShapeAreaEyebrowThickness501
AgoraFaceShapeStyle 3 个成员
成员值
AgoraFaceShapeStyleFemale0
AgoraFaceShapeStyleMale1
AgoraFaceShapeStyleNatural2
AgoraFeatureType 2 个成员
成员值
AgoraVideoPreprocessVirtualBackground1
AgoraVideoPreprocessBeauty2
AgoraFocalLength 4 个成员
成员值
AgoraFocalLengthDefault0
AgoraFocalLengthWide1
AgoraFocalLengthUltraWide2
AgoraFocalLengthTelephoto3
AgoraHeadphoneEQPreset 3 个成员
成员值
AgoraAudioHeadphoneEQPresetOff0
AgoraAudioHeadphoneEQPresetOverear67108865
AgoraAudioHeadphoneEQPresetInear67108866
AgoraLastmileProbeResultState 3 个成员
成员值
AgoraLastmileProbeResultComplete1
AgoraLastmileProbeResultIncompleteNoBwe2
AgoraLastmileProbeResultUnavailable3
AgoraLighteningContrastLevel 3 个成员
成员值
AgoraLighteningContrastLow0
AgoraLighteningContrastNormal1
AgoraLighteningContrastHigh2
AgoraLocalProxyMode 2 个成员
成员值
AgoraConnectivityFirst0
AgoraLocalOnly1
AgoraLocalVideoStreamReason 16 个成员
成员值
AgoraLocalVideoStreamReasonOK0
AgoraLocalVideoStreamReasonFailure1
AgoraLocalVideoStreamReasonDeviceNoPermission2
AgoraLocalVideoStreamReasonDeviceBusy3
AgoraLocalVideoStreamReasonCaptureFailure4
AgoraLocalVideoStreamReasonCodecNotSupport5
AgoraLocalVideoStreamReasonCaptureInBackGround6
AgoraLocalVideoStreamReasonCaptureMultipleForegroundApps7
AgoraLocalVideoStreamReasonCaptureNoDeviceFound8
AgoraLocalVideoStreamReasonCaptureDeviceDisconnected9
AgoraLocalVideoStreamReasonCaptureDeviceInvalidId10
AgoraLocalVideoStreamReasonScreenCaptureWindowMinimized11
AgoraLocalVideoStreamReasonScreenCaptureWindowClosed12
AgoraLocalVideoStreamReasonScreenCaptureNoPermission22
AgoraLocalVideoStreamReasonScreenCaptureRecoverFromMinimized27
AgoraLocalVideoStreamReasonScreenCaptureDisplayDisconnected30
AgoraLogFilter 6 个成员
成员值
AgoraLogFilterOff0
AgoraLogFilterDebug2063
AgoraLogFilterInfo15
AgoraLogFilterWarning14
AgoraLogFilterError12
AgoraLogFilterCritical8
AgoraLogLevel 5 个成员
成员值
AgoraLogLevelNone0
AgoraLogLevelInfo1
AgoraLogLevelWarn2
AgoraLogLevelError4
AgoraLogLevelFatal8
AgoraLowlightEnhanceLevel 2 个成员
成员值
AgoraLowlightEnhanceLevelQuality0
AgoraLowlightEnhanceLevelFast1
AgoraLowlightEnhanceMode 2 个成员
成员值
AgoraLowlightEnhanceModeAuto0
AgoraLowlightEnhanceModeManual1
AgoraMediaPlayerEvent 17 个成员
成员值
AgoraMediaPlayerEventSeekBegin0
AgoraMediaPlayerEventSeekComplete1
AgoraMediaPlayerEventSeekError2
AgoraMediaPlayerEventAudioTrackChanged5
AgoraMediaPlayerEventBufferLow6
AgoraMediaPlayerEventBufferRecover7
AgoraMediaPlayerEventFreezeStart8
AgoraMediaPlayerEventFreezeStop9
AgoraMediaPlayerEventSwitchBegin10
AgoraMediaPlayerEventSwitchComplete11
AgoraMediaPlayerEventSwitchError12
AgoraMediaPlayerEventFirstDisplayed13
AgoraMediaPlayerEventReachCacheFileMaxCount14
AgoraMediaPlayerEventReachCacheFileMaxSize15
AgoraMediaPlayerEventTryOpenStart16
AgoraMediaPlayerEventTryOpenSucceed17
AgoraMediaPlayerEventTryOpenFailed18
AgoraMediaPlayerMetaDataType 2 个成员
成员值
AgoraMediaPlayerMetaDataTypeUnknown0
AgoraMediaPlayerMetaDataTypeSEI1
AgoraMediaPlayerPreloadEvent 3 个成员
成员值
AgoraMediaPlayerPreloadEventBegin0
AgoraMediaPlayerPreloadEventComplete1
AgoraMediaPlayerPreloadEventError2
AgoraMediaPlayerReason 18 个成员
成员值
AgoraMediaPlayerReasonNone0
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 个成员
成员值
AgoraMediaPlayerRenderModeHidden1
AgoraMediaPlayerRenderModeFit2
AgoraMediaPlayerState 9 个成员
成员值
AgoraMediaPlayerStateIdle0
AgoraMediaPlayerStateOpening1
AgoraMediaPlayerStateOpenCompleted2
AgoraMediaPlayerStatePlaying3
AgoraMediaPlayerStatePaused4
AgoraMediaPlayerStatePlayBackCompleted5
AgoraMediaPlayerStatePlayBackAllLoopsCompleted6
AgoraMediaPlayerStateStopped7
AgoraMediaPlayerStateFailed100
AgoraMediaRecorderContainerFormat 1 个成员
成员值
AgoraMediaRecorderContainerFormatMP41
AgoraMediaRecorderReasonCode 5 个成员
成员值
AgoraMediaRecorderReasonCodeNoError0
AgoraMediaRecorderReasonCodeWriteFailed1
AgoraMediaRecorderReasonCodeNoStream2
AgoraMediaRecorderReasonCodeOverMaxDuration3
AgoraMediaRecorderReasonCodeConfigChange4
AgoraMediaRecorderState 3 个成员
成员值
AgoraMediaRecorderStateError-1
AgoraMediaRecorderStateStarted2
AgoraMediaRecorderStateStopped3
AgoraMediaRecorderStreamType 3 个成员
成员值
AgoraMediaRecorderStreamTypeAudio1
AgoraMediaRecorderStreamTypeVideo2
AgoraMediaRecorderStreamTypeBoth3
AgoraMediaSourceType 15 个成员
成员值
AgoraMediaSourceTypeAudioPlayout0
AgoraMediaSourceTypeRecording1
AgoraMediaSourceTypePrimaryCamera2
AgoraMediaSourceTypeSecondaryCamera3
AgoraMediaSourceTypePrimaryScreen4
AgoraMediaSourceTypeSecondaryScreen5
AgoraMediaSourceTypeCustomVideo6
AgoraMediaSourceTypeMediaPlayer7
AgoraMediaSourceTypeRtcImagePng8
AgoraMediaSourceTypeRtcImageJpeg9
AgoraMediaSourceTypeRtcImageGif10
AgoraMediaSourceTypeRemoteVideo11
AgoraMediaSourceTypeTranscodedVideo12
AgoraMediaSourceTypeSpeechDriven13
AgoraMediaSourceTypeUnknown100
AgoraMediaStreamType 4 个成员
成员值
AgoraMediaStreamTypeUnknown0
AgoraMediaStreamTypeVideo1
AgoraMediaStreamTypeAudio2
AgoraMediaStreamTypeSubtitle3
AgoraMediaTraceEvent 2 个成员
成员值
AgoraMediaTraceEventVideoRendered0
AgoraMediaTraceEventVideoDecoded1
AgoraMetadataType 2 个成员
成员值
AgoraMetadataTypeUnknown-1
AgoraMetadataTypeVideo0
AgoraMultipathMode 1 个成员
成员值
AgoraMultipathModeDuplicate0
AgoraMultipathType 4 个成员
成员值
AgoraMultipathTypeLAN0
AgoraMultipathTypeWIFI1
AgoraMultipathTypeMobile2
AgoraMultipathTypeUnknown99
AgoraMusicCacheStatusType 2 个成员
成员值
AgoraMusicCacheStatusTypeCached0
AgoraMusicCacheStatusTypeCaching1
AgoraMusicContentCenterPreloadState 4 个成员
成员值
AgoraMusicContentCenterPreloadStateOK0
AgoraMusicContentCenterPreloadStateError1
AgoraMusicContentCenterPreloadStatePreloading2
AgoraMusicContentCenterPreloadStateRemoveCache3
AgoraMusicContentCenterStateReason 8 个成员
成员值
AgoraMusicContentCenterStateReasonOK0
AgoraMusicContentCenterStateReasonError1
AgoraMusicContentCenterStateReasonErrorGateway2
AgoraMusicContentCenterStateReasonErrorPermissionAndResource3
AgoraMusicContentCenterStateReasonErrorInternalDataParse4
AgoraMusicContentCenterStateReasonErrorMusicLoading5
AgoraMusicContentCenterStateReasonErrorMusicDecryption6
AgoraMusicContentCenterStateReasonErrorHttpInternalError7
AgoraMusicPlayMode 3 个成员
成员值
AgoraMusicPlayModeOriginal0
AgoraMusicPlayModeAccompany1
AgoraMusicPlayModeLeadsing2
AgoraNetworkQuality 9 个成员
成员值
AgoraNetworkQualityUnknown0
AgoraNetworkQualityExcellent1
AgoraNetworkQualityGood2
AgoraNetworkQualityPoor3
AgoraNetworkQualityBad4
AgoraNetworkQualityVBad5
AgoraNetworkQualityDown6
AgoraNetworkQualityUnsupported7
AgoraNetworkQualityDetecting8
AgoraNetworkType 8 个成员
成员值
AgoraNetworkTypeUnknown-1
AgoraNetworkTypeDisconnected0
AgoraNetworkTypeLAN1
AgoraNetworkTypeWIFI2
AgoraNetworkType2G3
AgoraNetworkType3G4
AgoraNetworkType4G5
AgoraNetworkType5G6
AgoraPermissionType 2 个成员
成员值
AgoraPermissionTypeRecordAudio0
AgoraPermissionTypeCamera1
AgoraProxyType 7 个成员
成员值
AgoraNoneProxyType0
AgoraUdpProxyType1
AgoraTcpProxyType2
AgoraLocalProxyType3
AgoraTcpProxyAutoFallbackType4
AgoraHttpProxyType5
AgoraHttpsProxyType6
AgoraRecorderStreamType 2 个成员
成员值
AgoraRecorderStreamTypeRtc0
AgoraRecorderStreamTypePreview1
AgoraRenewTokenErrorCode 7 个成员
成员值
AgoraRenewTokenSuccess0
AgoraRenewTokenFailure1
AgoraRenewTokenExpiredToken2
AgoraRenewTokenInvalidToken3
AgoraRenewTokenInvalidChannelName4
AgoraRenewTokenInconsistentAppId5
AgoraRenewTokenCanceledByNewRequest6
AgoraRhythmPlayerReason 5 个成员
成员值
AgoraRhythmPlayerReasonOK0
AgoraRhythmPlayerReasonFailed1
AgoraRhythmPlayerReasonCanNotOpen801
AgoraRhythmPlayerReasonCanNotPlay802
AgoraRhythmPlayerReasonFileOverDurationLimit803
AgoraRhythmPlayerState 5 个成员
成员值
AgoraRhythmPlayerStateIdle810
AgoraRhythmPlayerStateOpening811
AgoraRhythmPlayerStateDecoding812
AgoraRhythmPlayerStatePlaying813
AgoraRhythmPlayerStateFailed814
AgoraRteAbrFallbackLayer 9 个成员
成员值
AgoraRteAbrFallbackDisabled0
AgoraRteAbrFallbackLow1
AgoraRteAbrFallbackAudioOnly2
AgoraRteAbrFallbackLayer13
AgoraRteAbrFallbackLayer24
AgoraRteAbrFallbackLayer35
AgoraRteAbrFallbackLayer46
AgoraRteAbrFallbackLayer57
AgoraRteAbrFallbackLayer68
AgoraRteAbrSubscriptionLayer 8 个成员
成员值
AgoraRteAbrSubscriptionHigh0
AgoraRteAbrSubscriptionLow1
AgoraRteAbrSubscriptionLayer12
AgoraRteAbrSubscriptionLayer23
AgoraRteAbrSubscriptionLayer34
AgoraRteAbrSubscriptionLayer45
AgoraRteAbrSubscriptionLayer56
AgoraRteAbrSubscriptionLayer67
AgoraRteErrorCode 7 个成员
成员值
AgoraRteOk0
AgoraRteErrorDefault1
AgoraRteErrorInvalidArgument2
AgoraRteErrorInvalidOperation3
AgoraRteErrorNetworkError4
AgoraRteErrorAuthenticationFailed5
AgoraRteErrorStreamNotFound6
AgoraRtePlayerEvent 21 个成员
成员值
AgoraRtePlayerEventSeekBegin0
AgoraRtePlayerEventSeekComplete1
AgoraRtePlayerEventSeekError2
AgoraRtePlayerEventBufferLow3
AgoraRtePlayerEventBufferRecover4
AgoraRtePlayerEventFreezeStart5
AgoraRtePlayerEventFreezeStop6
AgoraRtePlayerEventOneLoopPlaybackCompleted7
AgoraRtePlayerEventAuthenticationWillExpire8
AgoraRtePlayerEventAbrFallbackToAudioOnlyLayer9
AgoraRtePlayerEventAbrRecoverFromAudioOnlyLayer10
AgoraRtePlayerEventSwitchBegin11
AgoraRtePlayerEventSwitchComplete12
AgoraRtePlayerEventSwitchError13
AgoraRtePlayerEventFirstDisplayed14
AgoraRtePlayerEventReachCacheFileMaxCount15
AgoraRtePlayerEventReachCacheFileMaxSize16
AgoraRtePlayerEventTryOpenStart17
AgoraRtePlayerEventTryOpenSucceed18
AgoraRtePlayerEventTryOpenFailed19
AgoraRtePlayerEventAudioTrackChanged20
AgoraRtePlayerMetadataType 1 个成员
成员值
AgoraRtePlayerMetadataTypeSei0
AgoraRtePlayerState 8 个成员
成员值
AgoraRtePlayerStateIdle0
AgoraRtePlayerStateOpening1
AgoraRtePlayerStateOpenCompleted2
AgoraRtePlayerStatePlaying3
AgoraRtePlayerStatePaused4
AgoraRtePlayerStatePlaybackCompleted5
AgoraRtePlayerStateStopped6
AgoraRtePlayerStateFailed7
AgoraRteVideoMirrorMode 3 个成员
成员值
AgoraRteVideoMirrorModeAuto0
AgoraRteVideoMirrorModeEnabled1
AgoraRteVideoMirrorModeDisabled2
AgoraRteVideoRenderMode 2 个成员
成员值
AgoraRteVideoRenderModeHidden0
AgoraRteVideoRenderModeFit1
AgoraRtmpStreamingEvent 4 个成员
成员值
AgoraRtmpStreamingEventFailedLoadImage1
AgoraRtmpStreamingEventUrlAlreadyInUse2
AgoraRtmpStreamingEventAdvancedFeatureNotSupport3
AgoraRtmpStreamingEventRequestTooOften4
AgoraRtmpStreamingReason 17 个成员
成员值
AgoraRtmpStreamingReasonOK0
AgoraRtmpStreamingReasonInvalidParameters1
AgoraRtmpStreamingReasonEncryptedStreamNotAllowed2
AgoraRtmpStreamingReasonConnectionTimeout3
AgoraRtmpStreamingReasonInternalServerError4
AgoraRtmpStreamingReasonRtmpServerError5
AgoraRtmpStreamingReasonTooOften6
AgoraRtmpStreamingReasonReachLimit7
AgoraRtmpStreamingReasonNotAuthorized8
AgoraRtmpStreamingReasonStreamNotFound9
AgoraRtmpStreamingReasonFormatNotSupported10
AgoraRtmpStreamingReasonNotBroadcaster11
AgoraRtmpStreamingReasonTranscodingNoMixStream13
AgoraRtmpStreamingReasonNetDown14
AgoraRtmpStreamingReasonInvalidAppId15
AgoraRtmpStreamingReasonInvalidPrivilege16
AgoraRtmpStreamingReasonUnpublishOK100
AgoraRtmpStreamingState 6 个成员
成员值
AgoraRtmpStreamingStateIdle0
AgoraRtmpStreamingStateConnecting1
AgoraRtmpStreamingStateRunning2
AgoraRtmpStreamingStateRecovering3
AgoraRtmpStreamingStateFailure4
AgoraRtmpStreamingStateDisconnecting5
AgoraRtmpStreamLifeCycle 2 个成员
成员值
AgoraRtmpStreamLifeCycleBindToChannel1
AgoraRtmpStreamLifeCycleBindToOwner2
AgoraScreenCaptureFrameRateCapability 4 个成员
成员值
AgoraScreenCaptureFrameRateUnKonw-1
AgoraScreenCaptureFrameRate15FPS0
AgoraScreenCaptureFrameRate30FPS1
AgoraScreenCaptureFrameRate60FPS2
AgoraScreenScenarioType 4 个成员
成员值
AgoraScreenScenarioDocument1
AgoraScreenScenarioGaming2
AgoraScreenScenarioVideo3
AgoraScreenScenarioRDC4
AgoraSimulcastStreamMode 3 个成员
成员值
AgoraAutoSimulcastStream-1
AgoraDisableSimulcastStream0
AgoraEnableSimulcastStream1
AgoraStreamFallbackOptions 9 个成员
成员值
AgoraStreamFallbackOptionDisabled0
AgoraStreamFallbackOptionVideoStreamLow1
AgoraStreamFallbackOptionAudioOnly2
AgoraStreamFallbackOptionVideoStreamLayer13
AgoraStreamFallbackOptionVideoStreamLayer24
AgoraStreamFallbackOptionVideoStreamLayer35
AgoraStreamFallbackOptionVideoStreamLayer46
AgoraStreamFallbackOptionVideoStreamLayer57
AgoraStreamFallbackOptionVideoStreamLayer68
AgoraStreamPublishState 4 个成员
成员值
AgoraStreamPublishStateIdle0
AgoraStreamPublishStateNoPublished1
AgoraStreamPublishStatePublishing2
AgoraStreamPublishStatePublished3
AgoraStreamSubscribeState 4 个成员
成员值
AgoraStreamSubscribeStateIdle0
AgoraStreamSubscribeStateNoSubscribed1
AgoraStreamSubscribeStateSubscribing2
AgoraStreamSubscribeStateSubscribed3
AgoraUserOfflineReason 3 个成员
成员值
AgoraUserOfflineReasonQuit0
AgoraUserOfflineReasonDropped1
AgoraUserOfflineReasonBecomeAudience2
AgoraVideoCodecCapabilityLevel 5 个成员
成员值
AgoraVideoCodecCapabilityLevelUnspecified-1
AgoraVideoCodecCapabilityLevelBasicSupport5
AgoraVideoCodecCapabilityLevel1080p30fps10
AgoraVideoCodecCapabilityLevel1080p60fps20
AgoraVideoCodecCapabilityLevel4k60fps30
AgoraVideoCodecProfileType 3 个成员
成员值
AgoraVideoCodecProfileTypeBaseLine66
AgoraVideoCodecProfileTypeMain77
AgoraVideoCodecProfileTypeHigh100
AgoraVideoCodecType 7 个成员
成员值
AgoraVideoCodecTypeNone0
AgoraVideoCodecTypeVP81
AgoraVideoCodecTypeH2642
AgoraVideoCodecTypeH2653
AgoraVideoCodecTypeGeneric6
AgoraVideoCodecTypeVP913
AgoraVideoCodecTypeGenericJpeg20
AgoraVideoCodecTypeForStream 2 个成员
成员值
AgoraVideoCodecTypeH264ForStream1
AgoraVideoCodecTypeH265ForStream2
AgoraVideoContentHint 3 个成员
成员值
AgoraVideoContentHintNone0
AgoraVideoContentHintMotion1
AgoraVideoContentHintDetails2
AgoraVideoDenoiserLevel 2 个成员
成员值
AgoraVideoDenoiserLevelHighQuality0
AgoraVideoDenoiserLevelFast1
AgoraVideoDenoiserMode 2 个成员
成员值
AgoraVideoDenoiserModeAutonull
AgoraVideoDenoiserModeManual1
AgoraVideoEffectAction 2 个成员
成员值
AgoraVideoEffectActionSave1
AgoraVideoEffectActionReset2
AgoraVideoEffectNodeId 4 个成员
成员值
AgoraVideoEffectNodeBeauty1
AgoraVideoEffectNodeStyleMakeup2
AgoraVideoEffectNodeFilter4
AgoraVideoEffectNodeSticker8
AgoraVideoFormat 12 个成员
成员值
AgoraVideoFormatI4201
AgoraVideoFormatBGRA2
AgoraVideoFormatNV213
AgoraVideoFormatRGBA4
AgoraVideoFormatNV128
AgoraVideoFormatCVPixelNV1212
AgoraVideoFormatCVPixelI42013
AgoraVideoFormatCVPixelBGRA14
AgoraVideoFormatCVPixelP01015
AgoraVideoFormatI42216
AgoraVideoFormatI01018
AgoraVideoFormatDefault0
AgoraVideoFrameOrientation 4 个成员
成员值
AgoraVideoFrameOrientation00
AgoraVideoFrameOrientation9090
AgoraVideoFrameOrientation180180
AgoraVideoFrameOrientation270270
AgoraVideoFramePosition 3 个成员
成员值
AgoraVideoFramePositionPostCapture1
AgoraVideoFramePositionPreRenderer2
AgoraVideoFramePositionPreEncoder4
AgoraVideoFrameProcessMode 2 个成员
成员值
AgoraVideoFrameProcessModeReadOnlynull
AgoraVideoFrameProcessModeReadWritenull
AgoraVideoFrameRate 7 个成员
成员值
AgoraVideoFrameRateFps11
AgoraVideoFrameRateFps77
AgoraVideoFrameRateFps1010
AgoraVideoFrameRateFps1515
AgoraVideoFrameRateFps2424
AgoraVideoFrameRateFps3030
AgoraVideoFrameRateFps6060
AgoraVideoFrameType 6 个成员
成员值
AgoraVideoFrameTypeBlankFrame0
AgoraVideoFrameTypeKeyFrame3
AgoraVideoFrameTypeDeltaFrame4
AgoraVideoFrameTypeBFrame5
AgoraVideoFrameTypeDroppableFrame6
AgoraVideoFrameTypeUnknownull
AgoraVideoHwEncoderAccelerating 2 个成员
成员值
AgoraVideoHwEncoderSoftware0
AgoraVideoHwEncoderHardware1
AgoraVideoLocalState 4 个成员
成员值
AgoraVideoLocalStateStopped0
AgoraVideoLocalStateCapturing1
AgoraVideoLocalStateEncoding2
AgoraVideoLocalStateFailed3
AgoraVideoMirrorMode 3 个成员
成员值
AgoraVideoMirrorModeAuto0
AgoraVideoMirrorModeEnabled1
AgoraVideoMirrorModeDisabled2
AgoraVideoModulePosition 4 个成员
成员值
AgoraVideoModulePositionPostCapture1
AgoraVideoModulePositionPreRenderer2
AgoraVideoModulePositionPreEncoder4
AgoraVideoModulePositionPostCaptureOrigin8
AgoraVideoOutputOrientationMode 3 个成员
成员值
AgoraVideoOutputOrientationModeAdaptative0
AgoraVideoOutputOrientationModeFixedLandscape1
AgoraVideoOutputOrientationModeFixedPortrait2
AgoraVideoQualityAdaptIndication 3 个成员
成员值
AgoraVideoQualityAdaptNone0
AgoraVideoQualityAdaptUpBandwidth1
AgoraVideoQualityAdaptDownBandwidth2
AgoraVideoRemoteReason 12 个成员
成员值
AgoraVideoRemoteReasonInternal0
AgoraVideoRemoteReasonCongestion1
AgoraVideoRemoteReasonRecovery2
AgoraVideoRemoteReasonLocalMuted3
AgoraVideoRemoteReasonLocalUnmuted4
AgoraVideoRemoteReasonRemoteMuted5
AgoraVideoRemoteReasonRemoteUnmuted6
AgoraVideoRemoteReasonRemoteOffline7
AgoraVideoRemoteReasonAudioFallback8
AgoraVideoRemoteReasonAudioFallbackRecovery9
AgoraVideoRemoteReasonSDKInBackground12
AgoraVideoRemoteReasonCodecNotSupport13
AgoraVideoRemoteState 5 个成员
成员值
AgoraVideoRemoteStateStopped0
AgoraVideoRemoteStateStarting1
AgoraVideoRemoteStateDecoding2
AgoraVideoRemoteStateFrozen3
AgoraVideoRemoteStateFailed4
AgoraVideoRenderMode 3 个成员
成员值
AgoraVideoRenderModeHidden1
AgoraVideoRenderModeFit2
AgoraVideoRenderModeAdaptive3
AgoraVideoSourceType 17 个成员
成员值
AgoraVideoSourceTypeCamera0
AgoraVideoSourceTypeCameraSecondary1
AgoraVideoSourceTypeScreen2
AgoraVideoSourceTypeScreenSecondary3
AgoraVideoSourceTypeCustom4
AgoraVideoSourceTypeMediaPlayer5
AgoraVideoSourceTypeImagePNG6
AgoraVideoSourceTypeImageJPEG7
AgoraVideoSourceTypeImageGIF8
AgoraVideoSourceTypeRemote9
AgoraVideoSourceTypeTransCoded10
AgoraVideoSourceTypeCameraThird11
AgoraVideoSourceTypeCameraFourth12
AgoraVideoSourceTypeScreenThird13
AgoraVideoSourceTypeScreenFourth14
AgoraVideoSourceTypeSpeechDriven15
AgoraVideoSourceTypeUnknown100
AgoraVideoStreamType 8 个成员
成员值
AgoraVideoStreamTypeHigh0
AgoraVideoStreamTypeLow1
AgoraVideoStreamTypeLayer14
AgoraVideoStreamTypeLayer25
AgoraVideoStreamTypeLayer36
AgoraVideoStreamTypeLayer47
AgoraVideoStreamTypeLayer58
AgoraVideoStreamTypeLayer69
AgoraVideoTranscoderError 7 个成员
成员值
AgoraVideoTranscoderErrorOK0
AgoraVideoTranscoderErrorVideoSourceNotReady1
AgoraVideoTranscoderErrorInvalidVideoSourceType2
AgoraVideoTranscoderErrorInvalidImagePath3
AgoraVideoTranscoderErrorUnsupportImageFormat4
AgoraVideoTranscoderErrorInvalidLayout5
AgoraVideoTranscoderErrorInternal20
AgoraVideoViewSetupMode 3 个成员
成员值
AgoraVideoViewSetupReplace0
AgoraVideoViewSetupAdd1
AgoraVideoViewSetupRemove2
AgoraVirtualBackgroundSourceType 5 个成员
成员值
AgoraVirtualBackgroundNone0
AgoraVirtualBackgroundColor1
AgoraVirtualBackgroundImg2
AgoraVirtualBackgroundBlur3
AgoraVirtualBackgroundVideo4
AgoraVoiceAITunerType 10 个成员
成员值
AgoraVoiceAITunerMatureMale0
AgoraVoiceAITunerFreshMale1
AgoraVoiceAITunerElegantFemale2
AgoraVoiceAITunerSweetFemale3
AgoraVoiceAITunerWarmMaleSinging4
AgoraVoiceAITunerGentleFemaleSinging5
AgoraVoiceAITunerHuskyMaleSinging6
AgoraVoiceAITunerWarmElegantFemaleSinging7
AgoraVoiceAITunerPowerfulMaleSinging8
AgoraVoiceAITunerDreamyFemaleSinging9
AgoraVoiceBeautifierPreset 14 个成员
成员值
AgoraVoiceBeautifierPresetOff0
AgoraVoiceBeautifierPresetChatBeautifierMagnetic16843008
AgoraVoiceBeautifierPresetChatBeautifierFresh16843264
AgoraVoiceBeautifierPresetChatBeautifierVitality16843520
AgoraVoiceBeautifierPresetSingingBeautifier16908544
AgoraVoiceBeautifierTimbreTransformationVigorous16974080
AgoraVoiceBeautifierTimbreTransformationDeep16974336
AgoraVoiceBeautifierTimbreTransformationMellow16974592
AgoraVoiceBeautifierTimbreTransformationFalsetto16974848
AgoraVoiceBeautifierTimbreTransformationFull16975104
AgoraVoiceBeautifierTimbreTransformationClear16975360
AgoraVoiceBeautifierTimbreTransformationResounding16975616
AgoraVoiceBeautifierTimbreTransformatRinging16975872
AgoraVoiceBeautifierUltraHighQuality17039616
AgoraVoiceConversionPreset 16 个成员
成员值
AgoraVoiceConversionPresetOff0
AgoraVoiceConversionPresetNeutral50397440
AgoraVoiceConversionPresetSweet50397696
AgoraVoiceConversionPresetChangerSolid50397952
AgoraVoiceConversionPresetChangerBass50398208
AgoraVoiceConversionPresetChangerCartoon50398464
AgoraVoiceConversionPresetChangerChildlike50398720
AgoraVoiceConversionPresetChangerPhoneOperator50398976
AgoraVoiceConversionPresetChangerMonster50399232
AgoraVoiceConversionPresetChangerTransformers50399488
AgoraVoiceConversionPresetChangerGroot50399744
AgoraVoiceConversionPresetChangerDarthVader50400000
AgoraVoiceConversionPresetChangerIronLady50400256
AgoraVoiceConversionPresetChangerShinchan50400512
AgoraVoiceConversionPresetChangerGirlishMan50400768
AgoraVoiceConversionPresetChangerChipmunk50401024
AUDIO_AINS_MODE 3 个成员
成员值
AINS_MODE_BALANCED0
AINS_MODE_AGGRESSIVE1
AINS_MODE_ULTRALOWLATENCY2
ScreenColorType 3 个成员
成员值
ScreenColorAuto0
ScreenColorGreen1
ScreenColorBlue2
SegModelType 2 个成员
成员值
SegModelAgoraAinull
SegModelAgoraGreen2
WatermarkBufferFormat 4 个成员
成员值
WatermarkBufferFormatI4201
WatermarkBufferFormatBGRA2
WatermarkBufferFormatNV213
WatermarkBufferFormatRGBA4
WatermarkType 2 个成员
成员值
WatermarkTypeImage0
WatermarkTypeBuffer1

错误码常量

常量值
AgoraErrorCodeAdmGeneralError1005
AgoraErrorCodeAdmInitLoopback1022
AgoraErrorCodeAdmInitPlayout1008
AgoraErrorCodeAdmInitRecording1011
AgoraErrorCodeAdmJavaResource1006
AgoraErrorCodeAdmNoPlayoutDevice1360
AgoraErrorCodeAdmNoRecordingDevice1359
AgoraErrorCodeAdmPlayAbnormalFrequency1020
AgoraErrorCodeAdmRecordAbnormalFrequency1021
AgoraErrorCodeAdmRecordAudioFailed1018
AgoraErrorCodeAdmRuntimePlayoutError1015
AgoraErrorCodeAdmRuntimeRecordingError1017
AgoraErrorCodeAdmSampleRate1007
AgoraErrorCodeAdmStartLoopback1023
AgoraErrorCodeAdmStartPlayout1009
AgoraErrorCodeAdmStartRecording1012
AgoraErrorCodeAdmStopPlayout1010
AgoraErrorCodeAdmStopRecording1013
AgoraErrorCodeAlreadyInUse19
AgoraErrorCodeBitrateLimit115
AgoraErrorCodeBufferTooSmall6
AgoraErrorCodeConnectionInterrupted111
AgoraErrorCodeConnectionLost112
AgoraErrorCodeDecryptionFailed120
AgoraErrorCodeEncryptedStreamNotAllowedPublish130
AgoraErrorCodeFailed1
AgoraErrorCodeInitNetEngine21
AgoraErrorCodeInvalidAppId101
AgoraErrorCodeInvalidArgument2
AgoraErrorCodeInvalidChannelId102
AgoraErrorCodeInvalidState8
AgoraErrorCodeInvalidToken110
AgoraErrorCodeInvalidUserAccount134
AgoraErrorCodeJoinChannelRejected17
AgoraErrorCodeLeaveChannelRejected18
AgoraErrorCodeLoadMediaEngine1001
AgoraErrorCodeNoError0
AgoraErrorCodeNoServerResources103
AgoraErrorCodeNotInChannel113
AgoraErrorCodeNotInitialized7
AgoraErrorCodeNotReady3
AgoraErrorCodeNotSupported4
AgoraErrorCodePcmSendBufferOverflow201
AgoraErrorCodePcmSendFormat200
AgoraErrorCodeResourceLimited22
AgoraErrorCodeSizeTooLarge114
AgoraErrorCodeStartCall1002
AgoraErrorCodeStartCamera1003
AgoraErrorCodeStartVideoRender1004
AgoraErrorCodeTimedOut10
AgoraErrorCodeTokenExpired109
AgoraErrorCodeTooManyDataStreams116
AgoraErrorCodeVcmEncoderEncodeError1602
AgoraErrorCodeVcmEncoderInitError1601
AgoraErrorCodeVcmEncoderSetError1603
AgoraErrorCodeVcmUnknownError1600
AgoraErrorCodeVdmCameraNotAuthorized1501
AgoraErrorCodeVideoEffectAssetInvalid1700
AgoraErrorCodeVideoEffectEngineInvalid1702
AgoraErrorCodeVideoEffectInvalidBundlePath1707
AgoraErrorCodeVideoEffectInvalidParam1705
AgoraErrorCodeVideoEffectNodeNotActive1704
AgoraErrorCodeVideoEffectNotSupported1706
AgoraErrorCodeVideoEffectSaveFailed1701
AgoraErrorCodeWatermarkAGRB128
AgoraErrorCodeWatermarkInfo127
AgoraErrorCodeWatermarkParam124
AgoraErrorCodeWatermarkPath125
AgoraErrorCodeWatermarkPng126
AgoraErrorCodeWatermarkRead129

已知限制

以下成员在当前版本暂不可用,调用时返回 -4(ERR_NOT_SUPPORTED)。接口定义中保留这些成员,便于跨端代码保持一致。

接口成员
AgoraAudioEncodedFrameDelegateonMixedEncodedAudioFrame
AgoraAudioEncodedFrameDelegateonPlaybackEncodedAudioFrame
AgoraAudioEncodedFrameDelegateonRecordEncodedAudioFrame
AgoraAudioFrameDelegategetEarMonitoringAudioParams
AgoraAudioFrameDelegategetMixedAudioParams
AgoraAudioFrameDelegategetObservedAudioFramePosition
AgoraAudioFrameDelegategetPlaybackAudioParams
AgoraAudioFrameDelegategetRecordAudioParams
AgoraAudioFrameDelegateonEarMonitoringAudioFrame
AgoraAudioFrameDelegateonMixedAudioFrame
AgoraAudioFrameDelegateonPlaybackAudioFrame
AgoraAudioFrameDelegateonPlaybackAudioFrameBeforeMixing
AgoraAudioFrameDelegateonRecordAudioFrame
AgoraAudioSpectrumDelegateonLocalAudioSpectrum
AgoraAudioSpectrumDelegateonRemoteAudioSpectrum
AgoraChannelMediaRelayConfigurationremoveDestinationInfoForChannelName
AgoraChannelMediaRelayConfigurationsetDestinationInfo
AgoraEncodedVideoFrameDelegateonEncodedVideoFrameReceived
AgoraLiveTranscodingaddUser
AgoraLiveTranscodingdefaultTranscoding
AgoraLiveTranscodinggetAdvancedFeatures
AgoraLiveTranscodingremoveUser
AgoraLiveTranscodingsetAdvancedFeatures
AgoraLocalSpatialAudioKitdestroy
AgoraLocalSpatialAudioKitremoveRemotePosition
AgoraLocalSpatialAudioKitsetRemoteAudioAttenuation
AgoraLocalSpatialAudioKitsharedLocalSpatialAudioWithConfig
AgoraLocalSpatialAudioKitupdateRemotePosition
AgoraMediaMetadataDataSourcemetadataMaxSize
AgoraMediaMetadataDataSourcereadyToSendMetadataAtTimestamp
AgoraMediaMetadataDelegatedidMetadataReceived
AgoraMediaRecorderenableMainQueueDispatch
AgoraMediaRecordersetMediaRecorderDelegate
AgoraMediaRecorderstartRecording
AgoraMediaRecorderstopRecording
AgoraMediaRecorderDelegatemediaRecorder
AgoraMusicContentCentercreateMusicPlayerWithDelegate
AgoraMusicContentCenterdestroy
AgoraMusicContentCenterdestroyMusicPlayer
AgoraMusicContentCenterenableMainQueueDispatch
AgoraMusicContentCentergetCaches
AgoraMusicContentCentergetInternalSongCode
AgoraMusicContentCentergetLyricWithSongCode
AgoraMusicContentCentergetMusicCharts
AgoraMusicContentCentergetMusicCollectionWithMusicChartId
AgoraMusicContentCentergetSongSimpleInfoWithSongCode
AgoraMusicContentCenterisPreloadedWithSongCode
AgoraMusicContentCenterpreloadWithSongCode
AgoraMusicContentCenterregisterEventDelegate
AgoraMusicContentCenterremoveCacheWithSongCode
AgoraMusicContentCenterrenewToken
AgoraMusicContentCentersearchMusicWithKeyWord
AgoraMusicContentCentersharedContentCenterWithConfig
AgoraMusicContentCenterEventDelegateonLyricResult
AgoraMusicContentCenterEventDelegateonMusicChartsResult
AgoraMusicContentCenterEventDelegateonMusicCollectionResult
AgoraMusicContentCenterEventDelegateonPreLoadEvent
AgoraMusicContentCenterEventDelegateonSongSimpleInfoResult
AgoraMusicPlayerProtocolopenMediaWithSongCode
AgoraMusicPlayerProtocolsetPlayMode
AgoraRtcEngineDelegateaudioQualityBlock
AgoraRtcEngineDelegateonEventWithContext
AgoraRtcEngineDelegateonExtensionErrorWithContext
AgoraRtcEngineDelegateonExtensionStartedWithContext
AgoraRtcEngineDelegateonExtensionStoppedWithContext
AgoraRtcEngineDelegatertcEngine
AgoraRtcEngineDelegatertcEngineCameraDidReady
AgoraRtcEngineDelegatertcEngineConnectionDidBanned
AgoraRtcEngineDelegatertcEngineConnectionDidInterrupted
AgoraRtcEngineDelegatertcEngineConnectionDidLost
AgoraRtcEngineDelegatertcEngineDidAudioEffectFinish
AgoraRtcEngineDelegatertcEngineLocalAudioMixingDidFinish
AgoraRtcEngineDelegatertcEngineRequestToken
AgoraRtcEngineDelegatertcEngineTranscodingUpdated
AgoraRtcEngineDelegatertcEngineVideoDidStop
AgoraRtcEngineKitadjustCustomAudioPlayoutVolume
AgoraRtcEngineKitadjustCustomAudioPublishVolume
AgoraRtcEngineKitcreateCustomAudioTrack
AgoraRtcEngineKitcreateCustomVideoTrack
AgoraRtcEngineKitcreateMediaPlayerWithDelegate
AgoraRtcEngineKitcreateMediaRecorder
AgoraRtcEngineKitcreateVideoEffectObjectWithBundlePath
AgoraRtcEngineKitdelegate
AgoraRtcEngineKitdestroyCustomAudioTrack
AgoraRtcEngineKitdestroyCustomVideoTrack
AgoraRtcEngineKitdestroyMediaPlayer
AgoraRtcEngineKitdestroyMediaRecorder
AgoraRtcEngineKitdestroyVideoEffectObject
AgoraRtcEngineKitenableContentInspect
AgoraRtcEngineKitenableCustomAudioLocalPlayback
AgoraRtcEngineKitenableExtensionWithVendor
AgoraRtcEngineKitgetExtensionPropertyWithVendor
AgoraRtcEngineKitpauseAllChannelMediaRelay
AgoraRtcEngineKitpullPlaybackAudioFrameRawData
AgoraRtcEngineKitpullPlaybackAudioFrameSampleBufferByLengthInByte
AgoraRtcEngineKitpushExternalAudioFrameRawData
AgoraRtcEngineKitpushExternalAudioFrameSampleBuffer
AgoraRtcEngineKitpushExternalVideoFrame
AgoraRtcEngineKitregisterAudioSpectrumDelegate
AgoraRtcEngineKitregisterExtensionWithVendor
AgoraRtcEngineKitresumeAllChannelMediaRelay
AgoraRtcEngineKitsetAVSyncSource
AgoraRtcEngineKitsetAudioEncodedFrameDelegate
AgoraRtcEngineKitsetAudioFrameDelegate
AgoraRtcEngineKitsetCloudProxy
AgoraRtcEngineKitsetEncodedVideoFrameDelegate
AgoraRtcEngineKitsetExtensionPropertyWithVendor
AgoraRtcEngineKitsetExtensionProviderPropertyWithVendor
AgoraRtcEngineKitsetExternalVideoSource
AgoraRtcEngineKitsetMediaMetadataDataSource
AgoraRtcEngineKitsetMediaMetadataDelegate
AgoraRtcEngineKitsetSubscribeAudioAllowlist
AgoraRtcEngineKitsetSubscribeAudioBlocklist
AgoraRtcEngineKitsetSubscribeVideoAllowlist
AgoraRtcEngineKitsetSubscribeVideoBlocklist
AgoraRtcEngineKitsetVideoFrameDelegate
AgoraRtcEngineKitstartLocalVideoTranscoder
AgoraRtcEngineKitstartOrUpdateChannelMediaRelay
AgoraRtcEngineKitstartRtmpStreamWithTranscoding
AgoraRtcEngineKitstartRtmpStreamWithoutTranscoding
AgoraRtcEngineKitstopChannelMediaRelay
AgoraRtcEngineKitstopLocalVideoTranscoder
AgoraRtcEngineKitstopRtmpStream
AgoraRtcEngineKitunregisterAudioSpectrumDelegate
AgoraRtcEngineKitupdateLocalTranscoderConfiguration
AgoraRtcEngineKitupdateRtmpTranscoding
AgoraRtcMediaPlayerAudioFrameDelegateAgoraRtcMediaPlayer
AgoraRtcMediaPlayerCacheManagerProtocolcacheDir
AgoraRtcMediaPlayerCacheManagerProtocolcacheFileCount
AgoraRtcMediaPlayerCacheManagerProtocolcreateMediaPlayerCacheManager
AgoraRtcMediaPlayerCacheManagerProtocolenableAutoRemoveCache
AgoraRtcMediaPlayerCacheManagerProtocolmaxCacheFileCount
AgoraRtcMediaPlayerCacheManagerProtocolmaxCacheFileSize
AgoraRtcMediaPlayerCacheManagerProtocolremoveAllCaches
AgoraRtcMediaPlayerCacheManagerProtocolremoveCacheByUri
AgoraRtcMediaPlayerCacheManagerProtocolremoveOldCache
AgoraRtcMediaPlayerCacheManagerProtocolsetCacheDir
AgoraRtcMediaPlayerCacheManagerProtocolsetMaxCacheFileCount
AgoraRtcMediaPlayerCacheManagerProtocolsetMaxCacheFileSize
AgoraRtcMediaPlayerCacheManagerProtocolsharedInstance
AgoraRtcMediaPlayerProtocoladjustPlayoutVolume
AgoraRtcMediaPlayerProtocoladjustPublishSignalVolume
AgoraRtcMediaPlayerProtocolgetAudioBufferDelay
AgoraRtcMediaPlayerProtocolgetDuration
AgoraRtcMediaPlayerProtocolgetMediaPlayerId
AgoraRtcMediaPlayerProtocolgetMute
AgoraRtcMediaPlayerProtocolgetPlaySrc
AgoraRtcMediaPlayerProtocolgetPlayerState
AgoraRtcMediaPlayerProtocolgetPlayoutVolume
AgoraRtcMediaPlayerProtocolgetPosition
AgoraRtcMediaPlayerProtocolgetPublishSignalVolume
AgoraRtcMediaPlayerProtocolgetStreamByIndex
AgoraRtcMediaPlayerProtocolgetStreamCount
AgoraRtcMediaPlayerProtocolmute
AgoraRtcMediaPlayerProtocolopen
AgoraRtcMediaPlayerProtocolopenWithMediaSource
AgoraRtcMediaPlayerProtocolpause
AgoraRtcMediaPlayerProtocolplay
AgoraRtcMediaPlayerProtocolplayPreloadedSrc
AgoraRtcMediaPlayerProtocolpreloadSrc
AgoraRtcMediaPlayerProtocolresume
AgoraRtcMediaPlayerProtocolseekToPosition
AgoraRtcMediaPlayerProtocolselectAudioTrack
AgoraRtcMediaPlayerProtocolselectMultiAudioTrack
AgoraRtcMediaPlayerProtocolsetAudioDualMonoMode
AgoraRtcMediaPlayerProtocolsetAudioPitch
AgoraRtcMediaPlayerProtocolsetLoopCount
AgoraRtcMediaPlayerProtocolsetPlaybackSpeed
AgoraRtcMediaPlayerProtocolsetPlayerOption
AgoraRtcMediaPlayerProtocolsetPlayerOptionString
AgoraRtcMediaPlayerProtocolsetRenderMode
AgoraRtcMediaPlayerProtocolsetSpatialAudioParams
AgoraRtcMediaPlayerProtocolsetVideoFrameDelegate
AgoraRtcMediaPlayerProtocolsetView
AgoraRtcMediaPlayerProtocolswitchSrc
AgoraRtcMediaPlayerProtocolunloadSrc
AgoraRtcMediaPlayerVideoFrameDelegateAgoraRtcMediaPlayerGetVideoPixelFormat
AgoraRtedestroy
AgoraRtegetConfigs
AgoraRtegetFromBridge
AgoraRteinitMediaEngine
AgoraRteinitWithInitialConfig
AgoraRtesetConfigs
AgoraRteCanvasaddView
AgoraRteCanvasgetConfigs
AgoraRteCanvasinitWithRte
AgoraRteCanvasremoveView
AgoraRteCanvassetConfigs
AgoraRteCanvasConfigsetVideoMirrorMode
AgoraRteCanvasConfigsetVideoRenderMode
AgoraRteCanvasConfigvideoMirrorMode
AgoraRteCanvasConfigvideoRenderMode
AgoraRteConfigappId
AgoraRteConfigjsonParameter
AgoraRteConfigsetAppId
AgoraRteConfigsetJsonParameter
AgoraRteErrorcode
AgoraRteErrormessage
AgoraRtePlayergetConfigs
AgoraRtePlayergetInfo
AgoraRtePlayergetPosition
AgoraRtePlayergetStats
AgoraRtePlayerinitWithRte
AgoraRtePlayermuteAudio
AgoraRtePlayermuteVideo
AgoraRtePlayeropenWithUrl
AgoraRtePlayerpause
AgoraRtePlayerplay
AgoraRtePlayerpreloadWithUrl
AgoraRtePlayerregisterObserver
AgoraRtePlayerseek
AgoraRtePlayersetCanvas
AgoraRtePlayersetConfigs
AgoraRtePlayerstop
AgoraRtePlayerswitchWithUrl
AgoraRtePlayerunregisterObserver
AgoraRtePlayerConfigabrFallbackLayer
AgoraRtePlayerConfigabrSubscriptionLayer
AgoraRtePlayerConfigautoPlay
AgoraRtePlayerConfigloopCount
AgoraRtePlayerConfigplaybackSpeed
AgoraRtePlayerConfigplayoutVolume
AgoraRtePlayerConfigsetAbrFallbackLayer
AgoraRtePlayerConfigsetAbrSubscriptionLayer
AgoraRtePlayerConfigsetAutoPlay
AgoraRtePlayerConfigsetLoopCount
AgoraRtePlayerConfigsetPlaybackSpeed
AgoraRtePlayerConfigsetPlayoutVolume
AgoraRtePlayerObserveronAudioVolumeIndication
AgoraRtePlayerObserveronEvent
AgoraRtePlayerObserveronMetadata
AgoraRtePlayerObserveronPlayerInfoUpdated
AgoraRtePlayerObserveronPositionChanged
AgoraRtePlayerObserveronResolutionChanged
AgoraRtePlayerObserveronStateChanged
AgoraSpatialAudioKitBasemuteAllRemoteAudioStreams
AgoraSpatialAudioKitBasemuteLocalAudioStream
AgoraSpatialAudioKitBasemuteRemoteAudioStream
AgoraSpatialAudioKitBasesetAudioRecvRange
AgoraSpatialAudioKitBasesetDistanceUnit
AgoraSpatialAudioKitBasesetMaxAudioRecvCount
AgoraSpatialAudioKitBasesetPlayerAttenuation
AgoraSpatialAudioKitBasesetZones
AgoraSpatialAudioKitBaseupdatePlayerPositionInfo
AgoraSpatialAudioKitBaseupdateSelfPosition
AgoraSpatialAudioKitBaseupdateSelfTransform
AgoraVideoEffectObjectaddOrUpdateVideoEffectWithNodeId
AgoraVideoEffectObjectgetVideoEffectBoolParamWithOption
AgoraVideoEffectObjectgetVideoEffectFloatParamWithOption
AgoraVideoEffectObjectgetVideoEffectIntParamWithOption
AgoraVideoEffectObjectperformVideoEffectActionWithNodeId
AgoraVideoEffectObjectremoveVideoEffectWithNodeId
AgoraVideoEffectObjectsetVideoEffectBoolParamWithOption
AgoraVideoEffectObjectsetVideoEffectFloatParamWithOption
AgoraVideoEffectObjectsetVideoEffectIntParamWithOption
AgoraVideoEffectObjectsetVideoEffectStringParamWithOption
AgoraVideoEncoderConfigurationinitWithSize
AgoraVideoEncoderConfigurationinitWithWidth
AgoraVideoFrameDelegategetMirrorApplied
AgoraVideoFrameDelegategetObservedFramePosition
AgoraVideoFrameDelegategetRotationApplied
AgoraVideoFrameDelegategetVideoFormatPreference
AgoraVideoFrameDelegategetVideoFrameProcessMode
AgoraVideoFrameDelegateonCaptureVideoFrame
AgoraVideoFrameDelegateonPreEncodeVideoFrame
AgoraVideoFrameDelegateonRenderVideoFrame
__unattributed__enableContentInspectEx
__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

本页由文档构建流水线生成 · 2026-10-31 01:24:02 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

ni-meet 是自建 RTC PaaS,媒体面基于 LiveKit(Apache-2.0),并与声网 API 兼容。