API 列表
本页列出 macOS 所有的接口类以及其中包含的 API。
AgoraMediaFilterExtensionDelegate
用于管理媒体插件。
@protocol AgoraMediaFilterExtensionDelegate <NSObject>
- (NSString * _Nonnull)vendor;
@end
vendor
AgoraMediaMetadataDataSource
AgoraMediaMetadataDataSource 协议。
该类包含的所有回调均需要在引擎的关键线程中实现。因此建议你在关键线程中避免耗时操作。
相关参考AgoraRtcMediaPlayerVideoFrameDelegate
媒体播放器所播放的视频的观测器。
你可以调用 setVideoFrameDelegate: 注册或取消注册媒体播放器的视频观测器。成功注册后,你可以通过 AgoraRtcMediaPlayerVideoFrameDelegate 下的回调来获取视频帧的详细信息。
相关参考AgoraRteCanvas
该类提供设置播放器视频渲染的方法。
@interface AgoraRteCanvas : NSObject
- (instancetype _Nonnull)initWithRte:(AgoraRte* _Nonnull)rte initialConfig:(AgoraRteCanvasInitialConfig * _Nullable)config;
- (BOOL)getConfigs:(AgoraRteCanvasConfig* _Nonnull)config error:(AgoraRteError* _Nullable)error;
- (BOOL)setConfigs:(AgoraRteCanvasConfig* _Nonnull)config error:(AgoraRteError* _Nullable)error;
- (BOOL)addView:(AgoraRteView * _Nonnull)view config:(AgoraRteViewConfig* _Nullable)config error:(AgoraRteError* _Nullable)error;
- (BOOL)removeView:(AgoraRteView * _Nonnull)view config:(AgoraRteViewConfig* _Nullable)config error:(AgoraRteError* _Nullable)error;
@end
方法
initWithRte:initialConfig:
setConfigs:error:
getConfigs:error:
addView:config:error:
removeView:config:error:
AgoraAudioEncodedFrameDelegate
编码后音频的观测器。
相关参考AgoraAudioFrameDelegate
音频观测器。
你可以调用 setAudioFrameDelegate: 注册或取消注册 AgoraAudioFrameDelegate 音频观测器。
AgoraRtcMediaPlayerAudioFrameDelegate
该协议用于获取原始音频数据。
你可以通过该协议下的 AgoraRtcMediaPlayer:didReceiveAudioFrame: 回调来获取原始音频数据。
相关参考AgoraAudioSpectrumDelegate
音频频谱观测器。
相关参考AgoraSpatialAudioKitBase
该类包含 AgoraLocalSpatialAudioKit
类中的部分 API。
AgoraLocalSpatialAudioKit 类继承自 AgoraSpatialAudioKitBase。
相关参考AgoraDirectCdnStreamingEventDelegate
AgoraDirectCdnStreamingEventDelegate
接口类用于 SDK 向 App 发送 CDN 推流的事件通知,App 通过继承该接口类的方法获取 SDK 的事件通知。
AgoraLocalSpatialAudioKit
该类通过 SDK 计算用户坐标,实现空间音频。
该类继承自 AgoraSpatialAudioKitBase。调用该类下其他 API 前,你需要调用 sharedLocalSpatialAudioWithConfig: 方法初始化该类。
相关参考AgoraMediaFilterEventDelegate
插件事件回调接口类。
相关参考AgoraRtcMediaPlayerProtocol
提供媒体播放器功能的类,支持多实例。
相关参考AgoraRtcMediaPlayerCacheManagerProtocol
该类提供管理媒体播放器中缓存媒体文件的方法。
相关参考AgoraRtcMediaPlayerDelegate
提供媒体播放器的回调。
相关参考AgoraMediaRecorder
提供本地及远端音视频录制功能的类。
相关参考AgoraMediaRecorderDelegate
包含音视频录制的事件。
相关参考AgoraMediaMetadataDelegate
Metadata 观测器。
相关参考AgoraRtcEngineKit
RTC SDK 的基础接口类,实现实时音视频的主要功能。
AgoraRtcEngineKit 提供了 App 调用的主要方法。
相关参考-
getScreenCaptureSourcesWithThumbSize:iconSize:includeScreen:
-
joinChannelByToken:channelId:userAccount:mediaOptions:joinSuccess:
-
playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:
-
pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:
-
pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:
-
setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
-
setExternalAudioSource:sampleRate:channels:localPlayback:publish:
-
setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:
-
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:
-
setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
-
setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
AgoraRtcEngineDelegate
接口类 AgoraRtcEngineDelegate
用于 SDK 向 App 发送事件通知,App 通过继承该接口类的方法获取 SDK 的事件通知。
该接口类的所有方法都有缺省(空)实现, App 可以根据需要只继承关心的事件。
- 在回调方法中,App 不应该做耗时或者调用可能会引起阻塞的 API(如
sendMessage
),否则可能影响 SDK 的运行。 - SDK 不再捕获开发者在 AgoraRtcEngineDelegate 类回调中自行实现的代码逻辑中的异常。你需要自行处理该异常,否则异常出现时可能引起 App 崩溃。
-
rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:
-
rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:
-
rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:
-
rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:
-
rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:
-
rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:
-
rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:
-
rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:
-
rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:
-
rtcEngine:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:
AgoraRtcEngineKitEx
提供多频道方法的接口类。
继承自 AgoraRtcEngineKit。
相关参考-
getUserInfoWithUserAccount:userInfo:channelId:localUserAccount:
-
joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:
-
joinChannelExByToken:channelId:userAccount:delegate:mediaOptions:joinSuccess:
-
sendCustomReportMessageEx:category:event:label:value:connection:
AgoraEncodedVideoFrameDelegate
用于接收编码后的视频图像的类。
相关参考AgoraVideoFrameDelegate
视频观测器。
你可以调用 setVideoFrameDelegate: 注册或取消注册 AgoraVideoFrameDelegate 视频观测器。
相关参考AgoraRtePlayerConfig
RTE 播放器的基础接口类,实现媒体播放的主要功能。
相关参考AgoraRtePlayerConfig
该类提供播放器设置的相关方法。
@interface AgoraRtePlayerConfig : NSObject
- (void)setAutoPlay:(BOOL)autoPlay error:(AgoraRteError * _Nullable)error;
- (BOOL)autoPlay:(AgoraRteError * _Nullable)error;
- (void)setAbrSubscriptionLayer:(AgoraRteAbrSubscriptionLayer)layer error:(AgoraRteError * _Nullable)error;
- (AgoraRteAbrSubscriptionLayer)abrSubscriptionLayer:(AgoraRteError * _Nullable)error;
- (void)setAbrFallbackLayer:(AgoraRteAbrFallbackLayer)layer error:(AgoraRteError * _Nullable)error;
- (AgoraRteAbrFallbackLayer)abrFallbackLayer:(AgoraRteError * _Nullable)error;
@end
方法
setAutoPlay:error:
autoPlay:
setAbrSubscriptionLayer:error:
abrSubscriptionLayer:
setAbrFallbackLayer:error:
abrFallbackLayer:
AgoraRtePlayerObserver
提供播放器回调的接口类。
相关参考AgoraRte
RTE API 的基础接口类,提供了实现实时音视频的主要方法。
相关参考