API 概览

agoraservice 包

方法	描述
Initialize	初始化 agoraservice 包。
Release	释放 agoraservice 包占用的资源。

RtcConnection 类

方法	描述
NewRtcConnection	创建一个 RTC 连接对象。
Connect	连接 RTC 频道。
Disconnect	与 RTC 频道断开连接。
RenewToken	更新 Token。
RegisterObserver	注册 RTC 连接 observer。
UnregisterObserver	销毁 RTC 连接 observer。
CreateDataStream	创建数据流。
SendStreamMessage	发送数据流消息。
GetAgoraParameter	获取 AgoraParameter 对象。
GetLocalUser	获取 LocalUser 对象。
Release	释放 RTC 连接。
EnableEncryption	开启加密功能。

RtcConnectionObserver 类

方法	描述
OnConnected	SDK 与频道的连接状态变更为 3 时触发。
OnDisconnected	SDK 与频道的连接状态变更为 1 时触发。
OnTokenPrivilegeWillExpire	Token 服务将在 30s 内过期回调。
OnTokenPrivilegeDidExpire	Token 已过期回调。
OnUserJoined	远端用户加入频道时触发。
OnUserLeft	远端用户离开频道时触发。
OnStreamMessageError	接收数据流消息发生错误的回调。
OnError	发生错误回调。
OnEncryptionError	加密功能发生错误回调。

LocalUser 类

方法	描述
SetUserRole	设置用户角色。
SetAudioEncoderConfiguration	设置音频编码。
PublishAudio	将本地音频轨道发送到频道。
UnpublishAudio	停止将本地音频轨道发送到频道。
PublishVideo	将本地视频轨道发送到频道。
UnpublishVideo	停止将本地视频轨道发送到频道。
SubscribeAudio	订阅频道中特定的远端用户发送的音频流。
SubscribeAllAudio	订阅频道中全部远端用户发送的音频流。
UnsubscribeAudio	停止订阅频道中特定的远端用户发送的音频流。
UnsubscribeAllAudio	停止订阅频道中全部远端用户发送的音频流。
SetPlaybackAudioFrameBeforeMixingParameters	设置播放的音频格式。
RegisterAudioFrameObserver	注册音频帧观测器。
UnregisterAudioFrameObserver	销毁 AudioFrameObserver 对象。
SubscribeVideo	订阅频道中指定远端用户发送的视频流。
SubscribeAllVideo	订阅频道中全部远端用户发送的视频流。
UnsubscribeVideo	停止订阅频道中指定远端用户发送的视频流。
UnsubscribeAllVideo	停止订阅频道中全部远端用户发送的视频流。
RegisterLocalUserObserver	注册本地用户观测器。
UnregisterLocalUserObserver	销毁本地用户观测器。
RegisterVideoFrameObserver	注册 VideoFrameObserver 对象。
UnregisterVideoFrameObserver	销毁 VideoFrameObserver 对象。
GetRtcConnection	获取 RtcConnection 对象。
SendAudioMetadata	发送音频 Metadata 数据。

LocalUserObserver 类

回调	描述
OnUserAudioTrackStateChanged	在远端音频轨道状态变化时触发。
OnStreamMessage	接收到数据流消息的回调。
OnUserInfoUpdated	用户媒体信息更新时触发。
OnAudioMetadataReceived	接收到对方音频 Metadata 数据的回调。

LocalAudioTrack 类

方法	描述
NewCustomAudioTrackPcm	创建一个自定义 PCM 数据轨道。
NewCustomAudioTrackEncoded	创建一个自定义编码数据轨道。
SetEnabled	开启或关闭本地音频轨道。
AdjustPublishVolume	调整音频发布音量。
SetMaxBufferedAudioFrameNumber	设置音频发送缓冲区的最大容量。
ClearSenderBuffer	清除当前音频发送缓冲区。
SetSendDelayMs	设置音频发送缓冲区允许发送的最小数据时长。
Release	释放本地音频轨道资源。

LocalVideoTrack 类

方法	描述
NewCustomVideoTrackFrame	创建本地视频轨道对象，包含一个发送 YUV 格式视频数据的视频源。
NewCustomVideoTrackEncoded	创建本地视频轨道对象，包含一个发送编码视频数据的视频源。
SetEnabled	开启或关闭本地视频轨道。
SetVideoEncoderConfiguration	设置视频编码属性。

MediaNodeFactory 类

方法	描述
NewMediaNodeFactory	创建一个媒体节点工厂对象。
Release	释放 MediaNodeFactory 对象。

AudioEncodedFrameSender 类

方法	描述
NewAudioEncodedFrameSender	创建一个已编码音频数据发送模块。
SendEncodedAudioFrame	将已编码的音频帧发送到本地音频轨道。
Release	释放 AudioEncodedFrameSender 对象。

AudioPcmDataSender 类

方法	描述
NewAudioPcmDataSender	创建一个 PCM 数据发送模块。
SendAudioPcmData	将 PCM 格式的音频数据发送到本地音频轨道。
Release	释放 AudioPcmDataSender 对象。

AudioFrameObserver 类

回调	描述
OnPlaybackAudioFrameBeforeMixing	获得播放声音混音前的数据。

VideoEncodedImageSender 类

方法	描述
NewVideoEncodedImageSender	创建一个已编码视频数据发送模块。
SendEncodedVideoImage	将已编码的视频帧发送到视频轨道。

VideoEncodedFrameObserver 类

回调	描述
OnEncodedVideoFrame	每次收到已编码视频帧时触发。

VideoFrameSender 类

方法	描述
NewVideoFrameSender	创建一个原始视频数据发送模块。
SendVideoFrame	将 YUV 格式的视频帧发送到视频轨道。

VideoFrameObserver 类

回调	描述
OnFrame	每次收到视频帧时触发。