Full SDK API 列表

本页列出 iOS 所有的接口类以及其中包含的 API。

AgoraMediaFilterExtensionDelegate

实现扩展插件的委托方法，用于管理媒体插件。

AgoraMediaMetadataDataSource

AgoraMediaMetadataDataSource 协议用于提供媒体元数据的数据源。

信息

请在关键线程中实现该协议中的所有回调。建议避免在关键线程中执行任何耗时操作。

相关参考

• metadataMaxSize

• readyToSendMetadataAtTimestamp:sourceType:

AgoraRtcMediaPlayerVideoFrameDelegate

用于接收媒体播放器的视频帧回调。

相关参考

• AgoraRtcMediaPlayerGetVideoPixelFormat

• AgoraRtcMediaPlayer:didReceivePixelBuffer:

• AgoraRtcMediaPlayer:didReceiveVideoFrame:

AgoraRteCanvas

用于设置视频渲染视图。

自从

自 v4.4.0 版本新增。

相关参考

• addView:config:error:

• initWithRte:initialConfig:

• getConfigs:error:

• removeView:config:error:

• setConfigs:error:

AgoraRteCanvasConfig

AgoraRteCanvasConfig 用于配置播放器的视频渲染。

自从

自 v4.4.0 版本新增。

相关参考

• videoMirrorMode:

• videoRenderMode:

• setVideoMirrorMode:error:

• setVideoRenderMode:error:

AgoraRteError

用于获取错误码和错误信息。

自从

自 v4.4.0 版本新增。

相关参考

• code

• message

AgoraAudioEncodedFrameDelegate

编码后音频帧事件的代理。

该接口用于接收编码后的音频帧事件回调。

相关参考

• onMixedEncodedAudioFrame:info:

• onPlaybackEncodedAudioFrame:info:

• onRecordEncodedAudioFrame:info:

AgoraAudioFrameDelegate

启用音频帧回调事件通知。

将音频帧数据传递给你的应用程序。

相关参考

• getEarMonitoringAudioParams

• getMixedAudioParams

• getObservedAudioFramePosition

• getPlaybackAudioParams

• getRecordAudioParams

• onEarMonitoringAudioFrame:

• onMixedAudioFrame:channelId:

• onPlaybackAudioFrame:channelId:

• onPlaybackAudioFrameBeforeMixing:channelId:uid:

• onRecordAudioFrame:channelId:

AgoraRtcMediaPlayerAudioFrameDelegate

用于处理媒体播放器音频帧的代理协议。

该协议用于接收和处理来自媒体播放器的音频帧数据回调。

相关参考

• AgoraRtcMediaPlayer:didReceiveAudioFrame:

AgoraAudioSpectrumDelegate

处理音频频谱事件的代理。

相关参考

• onLocalAudioSpectrum:

• onRemoteAudioSpectrum:

AgoraSpatialAudioKitBase

空间音效功能的基础类。

相关参考

• clearRemotePositions:

• muteAllRemoteAudioStreams:

• muteLocalAudioStream:

• muteRemoteAudioStream:mute:

• setAudioRecvRange:

• setDistanceUnit:

• setMaxAudioRecvCount:

• setPlayerAttenuation:playerId:forceSet:

• setZones:

• updatePlayerPositionInfo:positionInfo:

• updateSelfPosition:axisForward:axisRight:axisUp:

• updateSelfTransform:

AgoraDirectCdnStreamingEventDelegate

CDN 推流的事件处理器。

废弃

自 v4.6.0 版本废弃。

相关参考

• onDirectCdnStreamingStateChanged:reason:message:

• onDirectCdnStreamingStats:

AgoraLocalSpatialAudioKit

用于实现本地空间音效功能的引擎类。

相关参考

• sharedLocalSpatialAudioWithConfig:

• destroy

• removeRemotePosition:

• setRemoteAudioAttenuation:uid:forceSet:

• updateRemotePosition:positionInfo:

AgoraMediaFilterEventDelegate

媒体滤镜事件代理协议。

AgoraRtcMediaPlayerProtocol

媒体播放器的代理协议。

相关参考

• adjustPlayoutVolume:

• adjustPublishSignalVolume:

• getDuration

• getMediaPlayerId

• getMute

• getPlayoutVolume

• getPosition

• getPlaySrc

• getPublishSignalVolume

• getPlayerState

• getStreamCount

• getStreamByIndex:

• mute:

• open:startPos:

• openWithMediaSource:

• pause

• play

• playPreloadedSrc:

• preloadSrc:startPos:

• resume

• seekToPosition:

• selectAudioTrack:

• selectMultiAudioTrack:publishTrackIndex:

• setAudioDualMonoMode:

• setAudioPitch:

• setLoopCount:

• setPlaybackSpeed:

• setPlayerOption:value:

• setPlayerOptionString:value:

• setRenderMode:

• setSpatialAudioParams:

• setVideoFrameDelegate:

• setView:

• stop:

• switchSrc:syncPts:

• unloadSrc:

AgoraRtcMediaPlayerCacheManagerProtocol

用于管理媒体播放器缓存文件的协议。

你可以使用该协议提供的方法设置缓存参数、删除缓存文件以及获取缓存信息。

相关参考

• enableAutoRemoveCache:

• cacheDir

• cacheFileCount

• maxCacheFileCount

• maxCacheFileSize

• createMediaPlayerCacheManager

• removeAllCaches

• removeCacheByUri:

• removeOldCache

• setCacheDir:

• setMaxCacheFileCount:

• setMaxCacheFileSize:

• sharedInstance

AgoraRtcMediaPlayerDelegate

AgoraRtcMediaPlayerDelegate 协议，用于接收媒体播放器的回调事件。

你可以通过实现 AgoraRtcMediaPlayerDelegate 协议中的方法，处理媒体播放过程中的相关事件。

相关参考

• AgoraRtcMediaPlayer:volumeIndicationDidReceive:

• AgoraRtcMediaPlayer:didReceiveData:length:

• AgoraRtcMediaPlayer:didPlayBufferUpdated:

• AgoraRtcMediaPlayer:cacheStats:

• AgoraRtcMediaPlayer:didOccurEvent:elapsedTime:message:

• AgoraRtcMediaPlayer:infoUpdated:

• AgoraRtcMediaPlayer:playbackStats:

• AgoraRtcMediaPlayer:didChangedToState:reason:

• AgoraRtcMediaPlayer:playerSrcInfoDidChange:from:

• AgoraRtcMediaPlayer:didChangedToPosition:atTimestamp:

• AgoraRtcMediaPlayer:didPreloadEvent:

AgoraMediaRecorder

AgoraMediaRecorder 类用于音视频流录制。

你可以使用 AgoraMediaRecorder 开始和停止录制、设置录制配置，并注册录制观察者以监听录制相关的回调。

相关参考

• enableMainQueueDispatch:

• setMediaRecorderDelegate:

• startRecording:

• stopRecording

AgoraMediaRecorderDelegate

音视频录制的回调协议。

你可以通过实现该协议，在音频或视频录制过程中接收录制状态更新和相关信息。

相关参考

• mediaRecorder:informationDidUpdated:uid:info:

• mediaRecorder:stateDidChanged:uid:state:reason:

AgoraMediaMetadataDelegate

AgoraMediaMetadataDelegate 协议，用于在关键线程中处理回调。

建议避免在关键线程中执行耗时操作。

相关参考

• didMetadataReceived:

AgoraMusicContentCenter

管理音乐内容的中心类。

该类用于管理声网提供的音乐内容资源，支持音乐内容的搜索、加载、播放等功能。

相关参考

• createMusicPlayerWithDelegate:

• destroy

• destroyMusicPlayer:

• enableMainQueueDispatch:

• getCaches

• getInternalSongCode:jsonOption:

• getLyricWithSongCode:lyricType:

• getMusicCharts

• getMusicCollectionWithMusicChartId:page:pageSize:jsonOption:

• getSongSimpleInfoWithSongCode:

• sharedContentCenterWithConfig:

• isPreloadedWithSongCode:

• preloadWithSongCode:jsonOption:

• preloadWithSongCode:

• registerEventDelegate:

• removeCacheWithSongCode:

• renewToken:

• searchMusicWithKeyWord:page:pageSize:jsonOption:

AgoraMusicContentCenterEventDelegate

音乐内容中心事件代理。

相关参考

• onLyricResult:songCode:lyricUrl:reason:

• onMusicChartsResult:result:reason:

• onMusicCollectionResult:result:reason:

• onPreLoadEvent:songCode:percent:lyricUrl:state:reason:

• onSongSimpleInfoResult:songCode:simpleInfo:reason:

AgoraMusicPlayerProtocol

音乐播放器协议。

相关参考

• openMediaWithSongCode:startPos:

• setPlayMode:

AgoraRtcEngineKit

提供所有可供应用调用的方法。

AgoraRtcEngineKit 是声网 Native SDK 的基础类。你可以通过创建 AgoraRtcEngineKit 对象并调用其方法，使用声网提供的实时音视频通信功能。声网通过专为实时 Web 和移动端应用优化的虚拟全球网络，保障全球范围内基于互联网的音视频通信体验质量（QoE）。

相关参考

• addVideoWatermark:

• addVideoWatermark:options:

• addVideoWatermarkWithConfig:

• adjustAudioMixingPlayoutVolume:

• adjustAudioMixingPublishVolume:

• adjustAudioMixingVolume:

• adjustCustomAudioPlayoutVolume:volume:

• adjustCustomAudioPublishVolume:volume:

• adjustPlaybackSignalVolume:

• adjustRecordingSignalVolume:

• adjustUserPlaybackSignalVolume:volume:

• clearVideoWatermarks

• complain:description:

• configRhythmPlayer:

• sharedEngineWithAppId:delegate:

• createCustomAudioTrack:config:

• createCustomVideoTrack

• createDataStream:reliable:ordered:

• createDataStream:config:

• createMediaPlayerWithDelegate:

• createMediaRecorder:

• createVideoEffectObjectWithBundlePath:sourceType:

• delegate

• destroy:

• destroyCustomAudioTrack:

• destroyCustomVideoTrack:

• destroyMediaPlayer:

• destroyMediaRecorder:

• destroyVideoEffectObject:

• disableAudio

• disableAudioSpectrumMonitor

• disableVideo

• enableAudio

• enableAudioSpectrumMonitor:

• enableAudioVolumeIndication:smooth:reportVad:

• enableCameraCenterStage:

• enableContentInspect:config:

• enableCustomAudioLocalPlayback:enabled:

• enableDualStreamMode:

• enableDualStreamMode:streamConfig:

• enableEncryption:encryptionConfig:

• enableExtensionWithVendor:extension:enabled:sourceType:

• enableFaceDetection:

• enableInEarMonitoring:

• enableInEarMonitoring:includeAudioFilters:

• enableInstantMediaRendering

• enableLocalAudio:

• enableLocalVideo:

• enableMainQueueDispatch:

• enableMultiCamera:config:

• enableSoundPositionIndication:

• enableSpatialAudio:

• enableVideo

• enableVideoImageSource:options:

• enableVirtualBackground:backData:segData:

• enableVirtualBackground:backData:segData:sourceType:

• enableVoiceAITuner:type:

• enableWebSdkInteroperability:

• getAudioMixingCurrentPosition

• getAudioMixingDuration

• getAudioMixingPlayoutVolume

• getAudioMixingPublishVolume

• getAudioTrackCount

• getCallId

• cameraMaxZoomFactor

• getConnectionState

• getCurrentMonotonicTimeInMs

• getEffectCurrentPosition:

• getEffectDuration:

• getEffectsVolume

• getErrorDescription:

• getExtensionPropertyWithVendor:extension:key:

• getExtensionPropertyWithVendor:extension:key:sourceType:

• getFaceShapeAreaOptions:sourceType:

• getFaceShapeAreaOptions:

• getFaceShapeBeautyOptions:

• getFaceShapeBeautyOptions

• getNativeHandle

• getNetworkType

• getNtpWallTimeInMs

• getUserInfoByUid:withError:

• getUserInfoByUserAccount:withError:

• getSdkVersion

• getVolumeOfEffect:

• sharedEngineWithConfig:delegate:

• isCameraAutoExposureFaceModeSupported

• isCameraAutoFocusFaceModeSupported

• isCameraCenterStageSupported

• isCameraExposurePositionSupported

• isCameraExposureSupported

• isCameraFocusPositionInPreviewSupported

• isCameraTorchSupported

• isCameraZoomSupported

• isFeatureAvailableOnDevice:

• isSpeakerphoneEnabled

• joinChannelByToken:channelId:info:uid:joinSuccess:

• joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:

• joinChannelByToken:channelId:userAccount:joinSuccess:

• joinChannelByToken:channelId:userAccount:mediaOptions:joinSuccess:

• leaveChannel:

• leaveChannel:leaveChannelBlock:

• muteAllRemoteAudioStreams:

• muteAllRemoteVideoStreams:

• muteLocalAudioStream:

• muteLocalVideoStream:

• muteRecordingSignal:

• muteRemoteAudioStream:mute:

• muteRemoteVideoStream:mute:

• pauseAllChannelMediaRelay

• pauseAllEffects

• pauseAudioMixing

• pauseEffect:

• playAllEffectsWithLoopCount:pitch:pan:gain:publish:

• playEffect:filePath:loopCount:pitch:pan:gain:

• playEffect:filePath:loopCount:pitch:pan:gain:publish:

• playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:

• preloadChannelByToken:channelId:uid:

• preloadChannelByTokenWithUserAccount:channelId:userAccount:

• preloadEffect:filePath:startPos:

• preloadEffect:filePath:

• pullPlaybackAudioFrameRawData:lengthInByte:

• pullPlaybackAudioFrameSampleBufferByLengthInByte:

• pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:

• pushExternalAudioFrameSampleBuffer:

• pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:

• pushExternalVideoFrame:videoTrackId:

• pushExternalVideoFrame:

• queryCameraFocalLengthCapability

• queryCodecCapability

• queryDeviceScore

• queryScreenCaptureCapability

• rate:rating:description:

• setAudioEncodedFrameDelegate:config:

• setAudioFrameDelegate:

• registerAudioSpectrumDelegate:

• registerExtensionWithVendor:extension:sourceType:

• registerLocalUserAccount:appId:

• setMediaMetadataDelegate:withType:

• setEncodedVideoFrameDelegate:

• setVideoFrameDelegate:

• destroy

• removeVideoWatermark:

• renewToken:

• resumeAllChannelMediaRelay

• resumeAllEffects

• resumeAudioMixing

• resumeEffect:

• selectAudioTrack:

• sendCustomReportMessage:category:event:label:value:

• sendStreamMessage:data:

• setAdvancedAudioOptions:

• setAINSMode:mode:

• setAudioEffectParameters:param1:param2:

• setAudioEffectPreset:

• setAudioMixingDualMonoMode:

• setAudioMixingPitch:

• setAudioMixingPlaybackSpeed:

• setAudioMixingPosition:

• setAudioProfile:scenario:

• setAudioProfile:

• setAudioScenario:

• setAudioSessionOperationRestriction:

• setAVSyncSource:uid:

• setBeautyEffectOptions:options:

• setBeautyEffectOptions:options:sourceType:

• setCameraAutoExposureFaceModeEnabled:

• setCameraAutoFocusFaceModeEnabled:

• setCameraCapturerConfiguration:

• setCameraExposureFactor:

• setCameraExposurePosition:

• setCameraFocusPositionInPreview:

• setCameraStabilizationMode:

• setCameraTorchOn:

• setCameraZoomFactor:

• setChannelProfile:

• setClientRole:

• setClientRole:options:

• setCloudProxy:

• setColorEnhanceOptions:options:

• setColorEnhanceOptions:options:sourceType:

• setDefaultAudioRouteToSpeakerphone:

• setDirectCdnStreamingAudioConfiguration:

• setDirectCdnStreamingVideoConfiguration:

• setDualStreamMode:

• setDualStreamMode:streamConfig:

• setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:

• setEffectPosition:pos:

• setEffectsVolume:

• setEnableSpeakerphone:

• setExtensionPropertyWithVendor:extension:key:value:

• setExtensionProviderPropertyWithVendor:key:value:

• enableExternalAudioSink:sampleRate:channels:

• setExternalAudioSource:sampleRate:channels:

• setExternalAudioSource:sampleRate:channels:localPlayback:publish:

• setExternalVideoSource:useTexture:sourceType:

• setFaceShapeAreaOptions:sourceType:

• setFaceShapeAreaOptions:

• setFaceShapeBeautyOptions:options:sourceType:

• setFaceShapeBeautyOptions:options:

• setFilterEffectOptions:options:sourceType:

• setFilterEffectOptions:options:

• setHeadphoneEQParameters:highGain:

• setHeadphoneEQPreset:

• setInEarMonitoringVolume:

• setLocalAccessPoint:

• setLocalRenderMode:mode:

• setLocalRenderMode:mirror:

• setLocalRenderTargetFps:targetFps:

• setLocalVideoMirrorMode:

• setLocalVoiceEqualizationOfBandFrequency:withGain:

• setLocalVoiceFormant:

• setLocalVoicePitch:

• setLocalVoiceReverbOfType:withValue:

• setLogFile:

• setLogFileSize:

• setLogFilter:

• setLogLevel:

• setLowlightEnhanceOptions:options:

• setLowlightEnhanceOptions:options:sourceType:

• setMediaMetadataDataSource:withType:

• setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:

• setParameters:

• setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:

• setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:samplesPerCall:

• setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:

• setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:

• setRemoteDefaultVideoStreamType:

• setRemoteRenderMode:mode:mirror:

• setRemoteRenderTargetFps:

• setRemoteSubscribeFallbackOption:

• setRemoteUserSpatialAudioParams:params:

• setRemoteVideoStream:type:

• setRemoteVideoSubscriptionOptions:options:

• setRemoteVoicePosition:pan:gain:

• setScreenCaptureScenario:

• setSubscribeAudioAllowlist:

• setSubscribeAudioBlocklist:

• setSubscribeVideoAllowlist:

• setSubscribeVideoBlocklist:

• setupLocalVideo:

• setupRemoteVideo:

• setVideoDenoiserOptions:options:

• setVideoDenoiserOptions:options:sourceType:

• setVideoEncoderConfiguration:

• setVideoResolution:andFrameRate:bitrate:

• setVideoScenario:

• setVoiceBeautifierParameters:param1:param2:

• setVoiceBeautifierPreset:

• setVoiceConversionPreset:

• setVolumeOfEffect:withVolume:

• startAudioMixing:loopback:cycle:

• startAudioMixing:loopback:cycle:startPos:

• startAudioRecording:quality:

• startAudioRecordingWithConfig:

• startCameraCapture:config:

• startDirectCdnStreaming:publishUrl:mediaOptions:

• startEchoTestWithConfig:

• startLastmileProbeTest:

• startLocalAudioMixer:

• startLocalVideoTranscoder:

• startMediaRenderingTracing

• startOrUpdateChannelMediaRelay:

• startPlaybackDeviceTest:

• startPreview

• startPreview:

• startRecordingDeviceTest:

• startRhythmPlayer:sound2:config:

• startRtmpStreamWithoutTranscoding:

• startRtmpStreamWithTranscoding:transcoding:

• startScreenCapture:

• stopAllEffects

• stopAudioMixing

• stopAudioRecording

• stopCameraCapture:

• stopChannelMediaRelay

• stopDirectCdnStreaming

• stopEchoTest

• stopEffect:

• stopLastmileProbeTest

• stopLocalAudioMixer

• stopLocalVideoTranscoder

• stopPlaybackDeviceTest

• stopPreview

• stopPreview:

• stopRecordingDeviceTest

• stopRhythmPlayer

• stopRtmpStream:

• stopScreenCapture

• switchCamera

• takeSnapshot:filePath:

• takeSnapshotWithConfig:config:

• unloadEffect:

• unregisterAudioSpectrumDelegate:

• updateChannelWithMediaOptions:

• updateLocalAudioMixerConfiguration:

• updateLocalTranscoderConfiguration:

• updatePreloadChannelToken:

• updateRtmpTranscoding:

• updateScreenCapture:

AgoraRtcEngineDelegate

启用应用程序的回调事件通知。

自从

自 v1.1 版本新增。

SDK 通过 AgoraRtcEngineDelegate 协议中的代理回调向应用报告运行时事件。从 v1.1 版本起，SDK 中部分 block 回调被代理回调替代。旧的 block 回调虽已废弃，但当前版本仍支持使用。声网建议你将 block 回调替换为代理回调。如果同时定义了 block 和代理回调，SDK 将优先调用 block 回调。

相关参考

• rtcEngine:activeSpeaker:

• rtcEngineDidAudioEffectFinish:soundId:

• rtcEngineLocalAudioMixingDidFinish:

• rtcEngine:audioMixingPositionChanged:

• rtcEngine:audioMixingStateChanged:reasonCode:

• rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:

• audioQualityBlock:

• rtcEngine:didAudioRouteChanged:

• rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:

• rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:

• rtcEngine:cameraExposureDidChangedToRect:

• rtcEngine:cameraFocusDidChangedToRect:

• rtcEngineCameraDidReady:

• rtcEngine:channelMediaRelayStateDidChange:error:

• rtcEngine:didClientRoleChanged:newRole:newRoleOptions:

• rtcEngine:didClientRoleChangeFailed:currentRole:

• rtcEngineConnectionDidBanned:

• rtcEngineConnectionDidInterrupted:

• rtcEngineConnectionDidLost:

• rtcEngine:connectionChangedToState:reason:

• rtcEngine:didOccurEncryptionError:

• rtcEngine:didOccurError:

• onExtensionErrorWithContext:error:message:

• onEventWithContext:key:value:

• onExtensionStartedWithContext:

• onExtensionStoppedWithContext:

• rtcEngine:facePositionDidChangeWidth:previewHeight:faces:

• rtcEngine:firstLocalAudioFramePublished:

• rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:

• rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:

• rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:

• rtcEngine:firstRemoteAudioFrameOfUid:elapsed:

• rtcEngine:firstRemoteVideoDecodedOfUid:size:elapsed:

• rtcEngine:firstRemoteVideoFrameOfUid:size:elapsed:

• rtcEngine:didJoinChannel:withUid:elapsed:

• rtcEngine:lastmileProbeTestResult:

• rtcEngine:lastmileQuality:

• rtcEngine:didLeaveChannelWithStats:

• rtcEngine:localAudioStateChanged:reason:

• rtcEngine:localAudioStats:

• rtcEngine:didLocalUserRegisteredWithUserId:userAccount:

• rtcEngine:localVideoStateChangedOfState:reason:sourceType:

• rtcEngine:localVideoStats:sourceType:

• rtcEngine:didLocalVideoTranscoderErrorWithStream:errorCode:

• rtcEngine:multiPathStats:

• rtcEngine:networkQuality:txQuality:rxQuality:

• rtcEngine:networkTypeChanged:

• rtcEngine:permissionError:

• rtcEngine:didProxyConnected:withUid:proxyType:localProxyIp:elapsed:

• rtcEngine:didRejoinChannel:withUid:elapsed:

• rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:

• rtcEngine:remoteAudioStats:

• rtcEngine:audioTransportStatsOfUid:delay:lost:rxKBitRate:

• rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:

• rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:

• rtcEngine:remoteVideoStats:

• rtcEngine:videoTransportStatsOfUid:delay:lost:rxKBitRate:

• rtcEngine:renewTokenResult:code:

• rtcEngineRequestToken:

• rtcEngine:didRhythmPlayerStateChanged:reason:

• rtcEngine:reportRtcStats:

• rtcEngine:rtmpStreamingEventWithUrl:eventCode:

• rtcEngine:rtmpStreamingChangedToState:state:reason:

• rtcEngine:snapshotTaken:filePath:width:height:errCode:

• rtcEngine:receiveStreamMessageFromUid:streamId:data:

• rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:

• rtcEngine:tokenPrivilegeWillExpire:

• rtcEngine:didTranscodedStreamLayoutInfoUpdatedWithUserId:videoLayoutInfo:

• rtcEngineTranscodingUpdated:

• rtcEngine:uplinkNetworkInfoUpdate:

• rtcEngine:didLocalVideoEnabled:byUid:

• rtcEngine:didVideoEnabled:byUid:

• rtcEngine:didUserInfoUpdatedWithUserId:userInfo:

• rtcEngine:didJoinedOfUid:elapsed:

• rtcEngine:didAudioMuted:byUid:

• rtcEngine:didVideoMuted:byUid:

• rtcEngine:didOfflineOfUid:reason:

• rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:

• rtcEngine:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:

• rtcEngine:videoSizeChangedOfSourceType:uid:size:rotation:

• rtcEngineVideoDidStop:

• rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:

AgoraRtcEngineKit(Ex)

AgoraRtcEngineKitEx 接口，扩展了 AgoraRtcEngineKit 的功能。

扩展了 AgoraRtcEngineKit 的功能。

相关参考

• addVideoWatermarkEx:options:connection:

• addVideoWatermarkEx:connection:

• adjustUserPlaybackSignalVolumeEx:volume:connection:

• clearVideoWatermarkEx:

• createDataStreamEx:reliable:ordered:connection:

• createDataStreamEx:config:connection:

• enableAudioVolumeIndicationEx:smooth:reportVad:connection:

• enableContentInspectEx:config:connection:

• enableDualStreamModeEx:streamConfig:connection:

• enableEncryptionEx:encryptionConfig:connection:

• getCallIdEx:

• getConnectionStateEx:

• getUserInfoByUidEx:connection:withError:

• getUserInfoByUserAccountEx:connection:withError:

• joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:

• joinChannelExByToken:channelId:userAccount:delegate:mediaOptions:joinSuccess:

• leaveChannelEx:leaveChannelBlock:

• leaveChannelEx:options:leaveChannelBlock:

• muteAllRemoteAudioStreamsEx:connection:

• muteAllRemoteVideoStreamsEx:connection:

• muteLocalAudioStreamEx:connection:

• muteLocalVideoStreamEx:connection:

• muteRemoteAudioStreamEx:mute:connection:

• muteRemoteVideoStreamEx:mute:connection:

• pauseAllChannelMediaRelayEx:

• playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:startPos:

• playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:

• playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:startPos:

• playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:

• preloadEffectEx:soundId:filePath:startPos:

• preloadEffectEx:soundId:filePath:

• removeVideoWatermarkEx:connection:

• resumeAllChannelMediaRelayEx:

• sendCustomReportMessageEx:category:event:label:value:connection:

• setDualStreamModeEx:streamConfig:connection:

• setRemoteRenderModeEx:mode:mirror:connection:

• setRemoteVideoStreamEx:type:connection:

• setRemoteVideoSubscriptionOptionsEx:options:connection:

• setRemoteVoicePositionEx:pan:gain:connection:

• setSubscribeAudioAllowlistEx:connection:

• setSubscribeAudioBlocklistEx:connection:

• setSubscribeVideoAllowlistEx:connection:

• setSubscribeVideoBlocklistEx:connection:

• setupRemoteVideoEx:connection:

• setVideoEncoderConfigurationEx:connection:

• startMediaRenderingTracingEx:

• startOrUpdateChannelMediaRelayEx:connection:

• startRtmpStreamWithoutTranscodingEx:connection:

• startRtmpStreamWithTranscodingEx:transcoding:connection:

• stopChannelMediaRelayEx:

• stopRtmpStreamEx:connection:

• takeSnapshotEx:uid:filePath:

• takeSnapshotExWithConfig:uid:config:

• updateChannelExWithMediaOptions:connection:

• updateRtmpTranscodingEx:connection:

AgoraVideoEffectObject

用于视频特效操作的协议。

自从

自 v4.6.0 版本新增。

相关参考

• addOrUpdateVideoEffectWithNodeId:templateName:

• getVideoEffectBoolParamWithOption:key:

• getVideoEffectFloatParamWithOption:key:

• getVideoEffectIntParamWithOption:key:

• performVideoEffectActionWithNodeId:actionId:

• removeVideoEffectWithNodeId:

• setVideoEffectBoolParamWithOption:key:boolValue:

• setVideoEffectFloatParamWithOption:key:floatValue:

• setVideoEffectIntParamWithOption:key:intValue:

AgoraEncodedVideoFrameDelegate

用于接收远端编码后视频帧的回调协议。

你可以实现该协议中的方法以按需处理接收到的编码后视频帧。

相关参考

• onEncodedVideoFrameReceived:length:info:channelId:uid:

AgoraVideoFrameDelegate

处理视频帧的回调协议。

你可以通过实现该协议中的方法，接收并处理本地设备采集或远端用户发送的视频帧。

相关参考

• getMirrorApplied

• getObservedFramePosition

• getRotationApplied

• getVideoFormatPreference

• getVideoFrameProcessMode

• onCaptureVideoFrame:sourceType:

• onPreEncodeVideoFrame:sourceType:

• onRenderVideoFrame:uid:channelId:

AgoraRtePlayer

AgoraRtePlayer 类用于播放 URL 资源。

自从

自 v4.4.0 版本新增。

相关参考

• getConfigs:error:

• getInfo:error:

• getPosition:

• getStats:

• muteAudio:error:

• muteVideo:error:

• openWithUrl:startTime:cb:

• pause:

• play:

• initWithRte:initialConfig:

• preloadWithUrl:error:

• registerObserver:error:

• seek:error:

• setCanvas:error:

• setConfigs:error:

• stop:

• switchWithUrl:syncPts:cb:

• unregisterObserver:error:

AgoraRtePlayerConfig

提供媒体播放器选项相关的方法。

自从

自 v4.4.0 版本新增。

相关参考

• abrFallbackLayer:

• abrSubscriptionLayer:

• autoPlay:

• loopCount:

• playbackSpeed:

• playoutVolume:

• setAbrFallbackLayer:error:

• setAbrSubscriptionLayer:error:

• setAutoPlay:error:

• setLoopCount:error:

• setPlaybackSpeed:error:

• setPlayoutVolume:error:

AgoraRtePlayerObserver

接收播放器事件回调的接口。

自从

自 v4.4.0 版本新增。

相关参考

• onAudioVolumeIndication:

• onEvent:

• onMetadata:data:

• onPlayerInfoUpdated:

• onPositionChanged:utcTime:

• onResolutionChanged:height:

• onStateChanged:newState:error:

AgoraRte

AgoraRte 是声网实时互动 SDK 的基础接口。

自从

自 v4.4.0 版本新增。

相关参考

• destroy:

• getConfigs:error:

• getFromBridge:

• initMediaEngine:error:

• initWithInitialConfig:

• setConfigs:error:

AgoraRtePlayerInfo

播放器和媒体流的信息。

自从

自 v4.4.0 版本新增。