核心方法和回调
介绍 RTC SDK 中的核心方法以及对应的回调。
sharedEngineWithAppId
创建并初始化 AgoraRtcEngineKit。
+ (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate;
详情
AgoraRtcEngineKit 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。
- 请确保在调用其他 API 前先调用该方法创建并初始化 AgoraRtcEngineKit。
- 调用该方法和 sharedEngineWithConfig 均能创建 AgoraRtcEngineKit 实例。该方法与 sharedEngineWithConfig 的区别在于,sharedEngineWithConfig 支持在创建 AgoraRtcEngineKit 实例时进行更多配置,如指定访问区域、设置日志文件等。
- SDK 只支持每个 app 创建一个 AgoraRtcEngineKit 实例。
参数
- appId
- 声网为 app 开发者签发的 App ID。 使用同一个 App ID 的 app 才能进入同一个频道进行通话或直播。一个 App ID 只能用于创建一个 AgoraRtcEngineKit。如需更换 App ID,必须先调用 destroy 销毁当前 AgoraRtcEngineKit 再重新创建。
- delegate
- AgoraRtcEngineKit 的事件句柄,详见 AgoraRtcEngineDelegate。
返回值
- 方法调用成功,返回一个 AgoraRtcEngineKit 对象。
- 方法调用失败,返回错误码:
- -1: 一般性的错误(未明确归类)。
- -2: 设置了无效的参数。
- -7: SDK 初始化失败。
- -22: 资源申请失败。当 app 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。
- -101: App ID 无效。
delegate
设置并获得 AgoraRtcEngineDelegate。
@property(nonatomic, weak) id<AgoraRtcEngineDelegate> _Nullable delegate;
详情
SDK 通过 AgoraRtcEngineDelegate 类向 app 报告 SDK 运行时的各种事件。该类中定义的所有方法都是可选的实现方法。
enableInstantMediaRendering
开启音视频帧加速渲染。
- (int)enableInstantMediaRendering NS_SWIFT_NAME(enableInstantMediaRendering());
详情
- 自从
- v4.1.1
- 一旦开启快速渲染功能,只能通过调用 destroy 方法销毁 AgoraRtcEngineKit 对象来取消。
- 在该模式下,SDK 启用声网自定义加密算法来缩短建立传输链路的耗时,安全性相对于标准 DTLS (Datagram Transport Layer Security) 有所降低。如果业务场景对安全标准要求较高,请谨慎调用该方法。
适用场景
声网推荐在直播场景下,对观众开启该模式。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -7: AgoraRtcEngineKit 尚未初始化就调用方法。
enableMainQueueDispatch
是否分发回调至主队列。
- (int)enableMainQueueDispatch:(BOOL)enabled;
详情
如果不分发回调方法到主队列,app 应将 UI 操作分发到主队列。
参数
- enabled
-
YES
:分发回调方法到主队列。NO
:不分发回调方法到主队列。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
getConnectionState
获取当前网络连接状态。
- (AgoraConnectionState)getConnectionState;
详情
该方法在加入频道前后都能调用。
返回值
当前网络连接状态。详见 AgoraConnectionState。
sharedEngineWithConfig
创建并初始化 AgoraRtcEngineKit。
+ (instancetype _Nonnull)sharedEngineWithConfig:(AgoraRtcEngineConfig * _Nonnull)config delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate;
详情
AgoraRtcEngineKit 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。
- 请确保在调用其他 API 前先调用该方法创建并初始化 AgoraRtcEngineKit。
- 调用该方法和 sharedEngineWithAppId 均能创建 AgoraRtcEngineKit 实例。该方法与 sharedEngineWithAppId 的 区别在于,该方法支持在创建 AgoraRtcEngineKit 实例时进行更多配置,如指定访问区域、设置日志文件等。
- SDK 只支持每个 app 创建一个 AgoraRtcEngineKit 实例。
参数
- config
-
AgoraRtcEngineKit 实例的配置。详见 AgoraRtcEngineConfig。
- delegate
- AgoraRtcEngineKit 的事件句柄,详见 AgoraRtcEngineDelegate。
返回值
- 方法调用成功,返回一个 AgoraRtcEngineKit 对象。
- < 0:方法调用失败。
- -1: 一般性的错误(未明确归类)。
- -2: 设置了无效的参数。
- -7: SDK 初始化失败。
- -22: 资源申请失败。当 app 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。
- -101: App ID 无效。
joinChannelByToken [1/4]
加入频道。
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId info:(NSString * _Nullable)info uid:(NSUInteger)uid joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
详情
该方法让用户加入通话频道,在同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。 使用不同 App ID 的 app 不能互通。
- 本地会触发 didJoinChannel 和 connectionChangedToState 回调。
- 通信场景下的用户和直播场景下的主播加入频道后,远端会触发 didJoinedOfUid 回调。
在网络状况不理想的情况下,客户端可能会与声网服务器失去连接;SDK 会自动尝试重连,重连成功后,本地会触发 didRejoinChannel 回调。
参数
- token
- 在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
注: 如果你需要同时加入多个频道或在频道间频繁切换,声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token,详见 使用通配 Token。
- channelId
-
频道名。该参数标识用户进行实时音视频互动的频道。App ID 一致的前提下,填入相同频道名的用户会进入同一个频道进行音视频互动。该参数为长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0~9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- info
- (非必选项) 预留参数。
- uid
- 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 didJoinChannel 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。
- joinSuccessBlock
- 成功加入频道回调。
joinSuccessBlock
优先级高于 didJoinChannel,两个同时存在时,didJoinChannel 会被忽略。需要有 didJoinChannel 回调时,请将joinSuccessBlock
设置为nil
。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
- -2:传入的参数无效。例如,使用了不合法的 Token,uid 参数未设置为整型,AgoraRtcChannelMediaOptions 结构体成员值不合法。你需要填入有效的参数,重新加入频道。
- -3:AgoraRtcEngineKit 对象初始化失败。你需要重新初始化 AgoraRtcEngineKit 对象。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
- -8:AgoraRtcEngineKit 对象内部状态错误。可能的原因是:调用 startEchoTestWithConfig 开始通话回路测试后,未调用 stopEchoTest 停止测试就调用该方法加入频道。你需要在该方法前调用 stopEchoTest。
- -17:加入频道被拒绝。可能的原因是用户已经在频道中。建议通过 connectionChangedToState 回调判断用户是否在频道中。除收到 AgoraConnectionStateDisconnected(1) 状态外,不要再次调用该方法加入频道。
- -102:频道名无效。你需要在 channelId 中填入有效的频道名,重新加入频道。
- -121:用户 ID 无效。你需要在 uid 中填入有效的用户 ID,重新加入频道。
joinChannelByToken [2/4]
设置媒体选项并加入频道。
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId uid:(NSUInteger)uid mediaOptions:(AgoraRtcChannelMediaOptions * _Nonnull)mediaOptions joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
详情
该方法让用户加入通话频道,在同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。 使用不同 App ID 的 app 不能互通。
- 本地会触发 didJoinChannel 和 connectionChangedToState 回调。
- 通信场景下的用户和直播场景下的主播加入频道后,远端会触发 didJoinedOfUid 回调。
在网络状况不理想的情况下,客户端可能会与声网服务器失去连接;SDK 会自动尝试重连,重连成功后,本地会触发 didRejoinChannel 回调。
相比 joinChannelByToken [1/4],该方法增加了 options 参数,用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下,用户订阅频道内所有其他用户的音频流和视频流,因此会产生用量并影响计费。如果想取消订阅,可以通过设置 options 参数或相应的 mute 方法实现。
- 该方法允许用户一次加入仅一个频道。
- 请务必确保用于生成 Token 的 App ID 和 sharedEngineWithConfig 方法初始化引擎时用的是同一个 App ID,否则使用 Token 加入频道失败。
参数
- token
- 在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
注: 如果你需要同时加入多个频道或在频道间频繁切换,声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token,详见 使用通配 Token。
- channelId
-
频道名。该参数标识用户进行实时音视频互动的频道。App ID 一致的前提下,填入相同频道名的用户会进入同一个频道进行音视频互动。该参数为长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0~9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- uid
- 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 didJoinChannel 回调中返回, app 层必须记住该返回值并维护,SDK 不对该返回值进行维护。
- mediaOptions
- 频道媒体设置选项。详见 AgoraRtcChannelMediaOptions。
- joinSuccessBlock
- 成功加入频道回调。
joinSuccessBlock
优先级高于 didJoinChannel,两个同时存在时,didJoinChannel 会被忽略。需要有 didJoinChannel 回调时,请将joinSuccessBlock
设置为nil
。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
- -2:传入的参数无效。例如,使用了不合法的 Token,uid 参数未设置为整型,AgoraRtcChannelMediaOptions 结构体成员值不合法。你需要填入有效的参数,重新加入频道。
- -3:AgoraRtcEngineKit 对象初始化失败。你需要重新初始化 AgoraRtcEngineKit 对象。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
- -8:AgoraRtcEngineKit 对象内部状态错误。可能的原因是:调用 startEchoTestWithConfig 开始通话回路测试后,未调用 stopEchoTest 停止测试就调用该方法加入频道。你需要在该方法前调用 stopEchoTest。
- -17:加入频道被拒绝。可能的原因是用户已经在频道中。建议通过 connectionChangedToState 回调判断用户是否在频道中。除收到 AgoraConnectionStateDisconnected(1) 状态外,不要再次调用该方法加入频道。
- -102:频道名无效。你需要在 channelId 中填入有效的频道名,重新加入频道。
- -121:用户 ID 无效。你需要在 uid 中填入有效的用户 ID,重新加入频道。
joinChannelByToken [3/4]
使用 User Account 和 Token 加入频道。
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId userAccount:(NSString * _Nonnull)userAccount joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
详情
- 本地:didLocalUserRegisteredWithUserId、didJoinChannel 和 connectionChangedToState 回调。
- 通信场景下的用户和直播场景下的主播加入频道后,远端会依次触发 didJoinedOfUid 和 didUserInfoUpdatedWithUserId 回调。
用户成功加入频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute 方法实现。
参数
- token
- 在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
注: 如果你需要同时加入多个频道或在频道间频繁切换,声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token,详见 使用通配 Token。
- channelId
-
频道名。该参数标识用户进行实时音视频互动的频道。App ID 一致的前提下,填入相同频道名的用户会进入同一个频道进行音视频互动。该参数为长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0~9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- userAccount
-
用户 User Account。该参数用于标识实时音视频互动频道中的用户。你需要自行设置和管理用户的 User Account,并确保同一频道中每个用户的 User Account 是唯一的。 该参数为必填,最大不超过 255 字节,不可填 nil。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a-z
- 26 个大写英文字母 A-Z
- 10 个数字 0-9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- joinSuccessBlock
- 成功加入频道回调。
joinSuccessBlock
优先级高于 didJoinChannel,两个同时存在时,didJoinChannel 会被忽略。需要有 didJoinChannel 回调时,请将joinSuccessBlock
设置为nil
。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2: 参数无效。
- -3: SDK 初始化失败,请尝试重新初始化 SDK。
- -5: 调用被拒绝。
- -17: 加入频道被拒绝。由于 SDK 仅支持用户同一时间加入一个 AgoraRtcEngineKit 频道,当已经加入 AgoraRtcEngineKit 频道的用户使用有效的频道名再次调用 AgoraRtcEngineKit 类中的加入频道方法时,会返回此错误码。
joinChannelByToken [4/4]
使用 User Account 和 Token 加入频道,并设置是否自动订阅音频或视频流。
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId userAccount:(NSString * _Nonnull)userAccount mediaOptions:(AgoraRtcChannelMediaOptions * _Nonnull)mediaOptions joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
详情
- 本地:didLocalUserRegisteredWithUserId、didJoinChannel 和 connectionChangedToState 回调。
- 远端:通信场景下的用户和直播场景下的主播加入频道后,远端会分别触发 didJoinedOfUid 和 didUserInfoUpdatedWithUserId 回调。
用户成功加入频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute 方法实现。
相比 joinChannelByToken [3/4],该方法加了 options 参数,用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下,用户订阅频道内所有其他用户的音频流和视频流,因此会产生用量并影响计费。如果想取消订阅,可以通过设置 options 参数或相应的 mute 方法实现。
参数
- token
- 在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
注: 如果你需要同时加入多个频道或在频道间频繁切换,声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token,详见 使用通配 Token。
- channelId
-
频道名。该参数标识用户进行实时音视频互动的频道。App ID 一致的前提下,填入相同频道名的用户会进入同一个频道进行音视频互动。该参数为长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0~9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- userAccount
-
用户 User Account。该参数用于标识实时音视频互动频道中的用户。你需要自行设置和管理用户的 User Account,并确保同一频道中每个用户的 User Account 是唯一的。 该参数为必填,最大不超过 255 字节,不可填 nil。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a-z
- 26 个大写英文字母 A-Z
- 10 个数字 0-9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- mediaOptions
- 频道媒体设置选项。详见 AgoraRtcChannelMediaOptions。
- joinSuccessBlock
- 成功加入频道回调。
joinSuccessBlock
优先级高于 didJoinChannel,两个同时存在时,didJoinChannel 会被忽略。需要有 didJoinChannel 回调时,请将joinSuccessBlock
设置为nil
。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
- -2:传入的参数无效。例如,使用了不合法的 Token,uid 参数未设置为整型,AgoraRtcChannelMediaOptions 结构体成员值不合法。你需要填入有效的参数,重新加入频道。
- -3:AgoraRtcEngineKit 对象初始化失败。你需要重新初始化 AgoraRtcEngineKit 对象。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
- -8:AgoraRtcEngineKit 对象内部状态错误。可能的原因是:调用 startEchoTestWithConfig 开始通话回路测试后,未调用 stopEchoTest 停止测试就调用该方法加入频道。你需要在该方法前调用 stopEchoTest。
- -17:加入频道被拒绝。可能的原因是用户已经在频道中。建议通过 connectionChangedToState 回调判断用户是否在频道中。除收到 AgoraConnectionStateDisconnected(1) 状态外,不要再次调用该方法加入频道。
- -102:频道名无效。你需要在 channelId 中填入有效的频道名,重新加入频道。
- -121:用户 ID 无效。你需要在 uid 中填入有效的用户 ID,重新加入频道。
leaveChannel [1/2]
离开频道。
- (int)leaveChannel:(void(^ _Nullable)(AgoraChannelStats * _Nonnull stat))leaveChannelBlock;
详情
该方法会把会话相关的所有资源释放掉。
该方法是异步操作,调用返回时并没有真正退出频道。
成功加入频道后,必须调用本方法或者 leaveChannel [2/2] 结束通话,否则无法开始下一次通话。
- 本地:didLeaveChannelWithStats 回调。
- 远端:通信场景下的用户和直播场景下的主播离开频道后,远端会触发 didOfflineOfUid 回调。
- 如果你调用了本方法后立即调用 destroy 方法,SDK 将无法触发 didLeaveChannelWithStats 回调。
- 如果你已调用 joinChannelExByToken [1/2] 加入多频道,调用本方法后会同时离开 joinChannelByToken [2/4] 和 joinChannelExByToken [1/2] 加入的频道。
参数
- leaveChannelBlock
-
成功离开频道的回调,提供通话相关的统计信息,详见 AgoraChannelStats。
返回值
- 0(ERR_OK): 方法调用成功。
- < 0: 方法调用失败。
- -1: 一般性的错误(未明确归类)。
- -2: 参数无效。
- -7: SDK 尚未初始化。
leaveChannel [2/2]
设置频道选项并离开频道。
- (int)leaveChannel:(AgoraLeaveChannelOptions * _Nonnull)options leaveChannelBlock:(void (^ _Nullable)(AgoraChannelStats * _Nonnull))leaveChannelBlock;
详情
该方法会把会话相关的所有资源释放掉,离开频道,即挂断或退出通话。不管当前是否在通话中均可以调用该方法。
加入频道后,必须调用本方法结束通话,才能开始下一次通话。
该方法是异步操作,调用返回时并没有真正退出频道。在真正退出频道后,本地会触发 didLeaveChannelWithStats 回调;通信场景下的用户和直播场景下的主播离开频道后,远端会触发 didOfflineOfUid 回调。
- 如果你调用了本方法后立即调用 destroy 方法,SDK 将无法触发 didLeaveChannelWithStats 回调。
- 如果你已调用 joinChannelExByToken [1/2] 加入多频道,调用本方法后会同时离开 joinChannelByToken [2/4] 和 joinChannelExByToken [1/2] 加入的频道。
参数
- options
- 离开频道的选项,详见 AgoraLeaveChannelOptions。
- leaveChannelBlock
-
成功离开频道的回调,提供通话相关的统计信息,详见 AgoraChannelStats。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
preloadChannelByToken [1/2]
使用 token、channelId、uid 预加载频道。
- (int)preloadChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId uid:(NSUInteger)uid NS_SWIFT_NAME(preloadChannel(byToken:channelId:uid:));
详情
- 自从
- v4.2.2
调用该方法可以减少观众频繁切换频道时加入频道的时间,从而缩短观众听到主播首帧音频以及看到首帧画面的耗时,提升观众端的视频体验。由于 SDK 预加载频道需要一定的时间,因此声网推荐你在确认频道信息和用户信息后、加入频道前,尽早调用该方法。
- 调用该方法时,请确保用户角色设为观众、音频应用场景设为非合唱场景(AgoraAudioScenarioChorus),否则预加载不生效。
- 请确保预加载频道时传入的频道名、用户 ID、Token 和后续加入频道时传入的值相同,否则预加载不生效。
- 目前一个 AgoraRtcEngineKit 实例最多支持预加载 20 个频道,如超出限制,仅最新预加载的 20 频道个生效。
- 预加载不生效不会影响后续正常加入频道,也不会增加加入频道的耗时。
如果当前频道已经成功预加载,观众加入、离开频道后如需再次加入该频道,只要预加载时传入的 Token 仍在有效期内,则无需重新预加载。
参数
- token
- 在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
Token 过期后,根据预加载频道的数量,你可以通过不同方式来传入用于预加载频道的新 Token:
- 预加载一个频道时:调用此方法来传入新的 Token。
- 预加载多个频道时:
- 如果你使用了通配的 Token,调用 updatePreloadChannelToken 来更新所有预加载频道的 Token。
注: 生成通配 Token 时,用户 ID 不得设为 0。详见 使用通配 Token。
- 如果你使用了不同的 Token:调用此方法并传入你的用户 ID、对应的频道名和更新后的 Token。
- 如果你使用了通配的 Token,调用 updatePreloadChannelToken 来更新所有预加载频道的 Token。
- channelId
- 待预加载的频道名。该参数标识用户进行实时音视频互动的频道。App ID 一致的前提下,填入相同频道名的用户会进入同一个频道进行音视频互动。 该参数为长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0~9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- uid
- 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 didJoinChannel 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
- -102:频道名无效。你需要填入有效的频道名,重新加入频道。
preloadChannelByToken [2/2]
使用 token、channelId、userAccount 预加载频道。
- (int)preloadChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId userAccount:(NSString * _Nonnull)uid NS_SWIFT_NAME(preloadChannel(byToken:channelId:userAccount:));
详情
- 自从
- v4.2.2
调用该方法可以减少观众频繁切换频道时加入频道的时间,从而缩短观众听到主播首帧音频以及看到首帧画面的耗时,提升观众端的视频体验。由于 SDK 预加载频道需要一定的时间,因此声网推荐你在确认频道信息和用户信息后、加入频道前,尽早调用该方法。
- 调用该方法时,请确保用户角色设为观众、音频应用场景设为非合唱场景(AgoraAudioScenarioChorus),否则预加载不生效。
- 请确保预加载频道时传入的频道名、用户 User Account、Token 和后续加入频道时传入的值相同,否则预加载不生效。
- 目前一个 AgoraRtcEngineKit 实例最多支持预加载 20 个频道,如超出限制,仅最新预加载的 20 频道个生效。
- 预加载不生效不会影响后续正常加入频道,也不会增加加入频道的耗时。
如果当前频道已经成功预加载,观众加入、离开频道后如需再次加入该频道,只要预加载时传入的 Token 仍在有效期内,则无需重新预加载。
参数
- token
- 在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
Token 过期后,根据预加载频道的数量,你可以通过不同方式来传入用于预加载频道的新 Token:
- 预加载一个频道时:调用此方法来传入新的 Token。
- 预加载多个频道时:
- 如果你使用了通配的 Token,调用 updatePreloadChannelToken 来更新所有预加载频道的 Token。
注: 生成通配 Token 时,用户 ID 不得设为 0。详见 使用通配 Token。
- 如果你使用了不同的 Token:调用此方法并传入你的用户 ID、对应的频道名和更新后的 Token。
- 如果你使用了通配的 Token,调用 updatePreloadChannelToken 来更新所有预加载频道的 Token。
- channelId
- 待预加载的频道名。该参数标识用户进行实时音视频互动的频道。App ID 一致的前提下,填入相同频道名的用户会进入同一个频道进行音视频互动。 该参数为长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a~z
- 26 个大写英文字母 A~Z
- 10 个数字 0~9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
- userAccount
-
用户 User Account。该参数用于标识实时音视频互动频道中的用户。你需要自行设置和管理用户的 User Account,并确保同一频道中每个用户的 User Account 是唯一的。 该参数为必填,最大不超过 255 字节,不可填 nil。以下为支持的字符集范围(共 89 个字符):
- 26 个小写英文字母 a-z
- 26 个大写英文字母 A-Z
- 10 个数字 0-9
- 空格
- "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、"{"、"}"、"|"、"~"、","
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
- -2:传入的参数无效。例如,User Account 为空。你需要填入有效的参数,重新加入频道。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
- -102:频道名无效。你需要填入有效的频道名,重新加入频道。
destroy
销毁 AgoraRtcEngineKit 对象。
+ (void)destroy;
详情
该方法释放 SDK 使用的所有资源。有些 app 只在用户需要时才进行实时音视频通信,不需要时则将资源释放出来用于其他操作,该方法适用于此类情况。
调用该方法后,你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能,你必须依次重新调用 sharedEngineWithConfig 方法创建一个新的 AgoraRtcEngineKit 对象。
- 该方法为同步调用。需要等待 AgoraRtcEngineKit 资源释放后才能执行其他操作(例如:创建一个新的 AgoraRtcEngineKit 对象),因此建议在子线程中调用该方法,避免主线程阻塞。
- 不建议在 SDK 的回调中调用 destroy,否则由于 SDK 要等待回调返回才能回收相关的对象资源,会造成死锁。
renewToken
更新 Token。
- (int)renewToken:(NSString * _Nonnull)token;
详情
该方法用于更新 Token。Token 会在一定时间后失效。在以下两种情况下,app 应重新获取 Token,然后调用该方法传入新的 Token,否则 SDK 无法和服务器建立连接:- 发生 tokenPrivilegeWillExpire 回调时。
- connectionChangedToState 回调报告 AgoraConnectionChangedReasonTokenExpired(9) 时。
参数
- token
- 新的 Token。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:传入的参数无效。例如,使用了不合法的 Token。你需要填入有效的参数。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
setChannelProfile
设置频道场景。
- (int)setChannelProfile:(AgoraChannelProfile)profile;
详情
SDK 初始化后默认的频道场景为直播场景。你可以调用该方法设置频道的使用场景。SDK 会针对不同的使用场景采用不同的优化策略,如通信场景偏好流畅,直播场景偏好画质。
- 为保证实时音视频质量,相同频道内的用户必须使用同一种频道场景。
- 该方法必须在 joinChannelByToken [2/4] 前调用和进行设置,进入频道后无法再设置。
参数
- profile
-
频道使用场景。详见 AgoraChannelProfile。
返回值
- 0(ERR_OK) 方法调用成功。
- < 0 方法调用失败。
- -2: 参数无效。
- -7: SDK 尚未初始化。
setClientRole [1/2]
设置用户角色。
- (int)setClientRole:(AgoraClientRole)role;
详情
在加入频道前和加入频道后均可调用该方法设置用户角色。
如果你在加入频道前调用该方法设置用户角色为主播、并且通过 setupLocalVideo 方法设置了本地视频属性,则用户加入频道时会自动开启本地视频预览。
- 本地会触发 didClientRoleChanged 回调。
- 远端会触发 didJoinedOfUid 或
didOfflineOfUid(AgoraUserOfflineReasonBecomeAudience)
回调。
参数
- role
-
用户角色。详见 AgoraClientRole。
注: 角色为观众的用户无法在频道内发布音视频流。在直播场景下发流时,请确保你的用户角色已切换为主播。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -1: 一般性的错误(未明确归类)。
- -2: 参数无效。
- -7: SDK 尚未初始化。
setClientRole [2/2]
设置直播场景下的用户角色和级别。
- (int)setClientRole:(AgoraClientRole)role options:(AgoraClientRoleOptions * _Nullable)options;
详情
直播场景下,SDK 会默认设置用户角色为观众,你可以调用该方法设置用户角色为主播。
该方法在加入频道前后均可调用。
如果你在加入频道前调用该方法设置用户角色为主播、并且通过 setupLocalVideo 方法设置了本地视频属性,则用户加入频道时会自动开启本地视频预览。
- 调用 muteLocalAudioStream 和 muteLocalVideoStream 修改发布状态。
- 本地触发 didClientRoleChanged 回调。
- 远端触发 didJoinedOfUid 或 didOfflineOfUid 回调。
- 用户角色(role)确定用户在 SDK 层的权限,包含是否可以发送流、是否可以接收流、是否可以旁路推流等。
- 用户级别(level)需要与角色结合使用,确定用户在其权限范围内可以享受到的服务。例如对于观众,选择接收低延时还是超低延时的视频流。不同的级别会影响计费。
参数
- role
- 直播场景中的用户角色。详见 AgoraClientRole。
- options
- 用户具体设置,包含用户级别。详见 AgoraClientRoleOptions。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -1: 一般性的错误(未明确归类)。
- -2: 参数无效。
- -5: 调用被拒绝。
- -7: SDK 尚未初始化。
setVideoProfile [1/2]
设置视频编码配置。
- (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight
详情
- 弃用:
- 该方法已废弃。请改用 setVideoEncoderConfiguration 方法。
该方法设置视频的编码属性。该方法在加入频道前后都能调用。 如果用户加入频道后不需要重新设置视频编码属性,则建议在 enableVideo 前调用该方法,可以加快首帧出图的时间。
参数
- profile
-
视频属性。详见 AgoraVideoProfile。
- swapWidthAndHeight
-
SDK 会按照你选择的视频属性 (profile) 输出固定宽高的视频。该参数设置是否交换宽和高:
YES
: 交换宽和高NO
: 不交换宽和高(默认)
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setVideoProfile [2/2]
手动设置视频编码配置。
- (int)setVideoResolution:(CGSize)size andFrameRate:(NSInteger)frameRate bitrate:(NSInteger)bitrate;
详情
- 弃用:
- 该方法已废弃。请改用 setVideoEncoderConfiguration 方法。
该方法手动设置视频的编码属性。该方法在加入频道前后都能调用。 如果用户加入频道后不需要重新设置视频编码属性,则建议在 enableVideo 前调用该方法,可以加快首帧出图的时间。
参数
- width
- 你想要设置的视频宽度,宽 × 高的最大值不超过 1280 × 720。
- height
- 你想要设置的视频高度,宽 × 高的最大值不超过 1280 × 720。
- frameRate
- 你想要设置的视频帧率,最高值不超过 30,如: 5、10、15、24、30 等。
- bitrate
- 你想要设置的视频码率,需要开发者根据想要设置的视频的宽、高和帧率,根据 Bitrate 中的码率参考表,手动推算出合适值。宽和高固定的情况下,码率随帧率的变化而变化:
- 如选取的帧率为 5 FPS,则推算码率为上表推荐码率除以 2。
- 如选取的帧率为 15 FPS,则推算码率为上表推荐码率。
- 如选取的帧率为 30 FPS,则推算码率为上表码率乘以 1.5。
- 如选取其余帧率,等比例推算即可。
- 如设置的视频码率超出合理范围,SDK 会自动按照合理区间处理码率。
startMediaRenderingTracing
开启视频帧渲染数据打点。
- (int)startMediaRenderingTracing NS_SWIFT_NAME(startMediaRenderingTracing());
详情
- 自从
- v4.1.1
成功调用该方法后,SDK 会以调用该方法的时刻作为起点,并通过 videoRenderingTracingResultOfUid 回调报告视频帧渲染的相关信息。
- SDK 默认在成功加入频道的时刻起打点,自动开始跟踪视频频的渲染事件。你可以根据实际业务场景,在合适的时机调用该方法,进行自定义打点。
- 离开当前频道后,SDK 会自动重置该时间点为下一次成功加入频道的时刻。
适用场景
声网推荐你将该方法和 app 中的 UI 设置(按钮、滑动条等)结合使用,用于针对终端用户的体验改进。例如:在终端用户在点击 加入频道
按钮的时刻调用该方法进行打点,然后通过 videoRenderingTracingResultOfUid 回调获取视频帧渲染过程中的指标,从而针对指标进行专项优化。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -7: AgoraRtcEngineKit 尚未初始化就调用方法。
updateChannelWithMediaOptions
加入频道后更新频道媒体选项。
- (int)updateChannelWithMediaOptions:(AgoraRtcChannelMediaOptions* _Nonnull)mediaOptions;
参数
- mediaOptions
- 频道媒体选项,详见 AgoraRtcChannelMediaOptions。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:AgoraRtcChannelMediaOptions 结构体成员值设置无效。例如,使用了不合法的 Token,设置了无效的用户角色。你需要填入有效的参数。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
- -8:AgoraRtcEngineKit 对象内部状态错误。可能的原因是用户不在频道中。建议通过 connectionChangedToState 回调判断用户是否在频道中。如果收到 AgoraConnectionStateDisconnected(1) 或 AgoraConnectionStateFailed(5),则表示用户不在频道中。你需要在调用该方法前调用 joinChannelByToken [2/4] 加入频道。
updatePreloadChannelToken
更新预加载频道的通配 Token。
- (int)updatePreloadChannelToken:(NSString * _Nonnull)token NS_SWIFT_NAME(updatePreloadChannelToken(_:));
详情
- 自从
- v4.2.2
你需要自行维护通配 Token 的生命周期。当通配 Token 过期后,你需要在你的服务端生成新的通配 Token,然后通过此方法来传入新的 Token。
适用场景
在需要频繁切换频道及多频道场景下,使用通配 Token 可以避免观众在切换不同频道时需多次申请 Token 从而导致切换频道时间增长,可以进一步加快切换频道的速度,同时减少你的 Token 服务端的压力。
参数
- token
- 新的 Token。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2:传入的参数无效。例如,使用了不合法的 Token。你需要填入有效的参数,重新加入频道。
- -7:AgoraRtcEngineKit 对象尚未初始化。你需要在调用该方法前成功初始化 AgoraRtcEngineKit 对象。
didClientRoleChanged
直播场景下用户角色已切换回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChanged:(AgoraClientRole)oldRole newRole:(AgoraClientRole)newRole newRoleOptions:(AgoraClientRoleOptions * _Nullable)newRoleOptions NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));
该回调是由本地用户在加入频道后调用 setClientRole [2/2] 改变用户角色触发的。
参数
- engine
- AgoraRtcEngineKit 对象。
- oldRole
- 切换前的角色:AgoraClientRole。
- newRole
- 切换后的角色:AgoraClientRole。
- newRoleOptions
-
- 自从
- v4.1.0
切换后的角色属性。详见 AgoraClientRoleOptions。
didClientRoleChangeFailed
直播场景下切换用户角色失败回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChangeFailed:(AgoraClientRoleChangeFailedReason)reason currentRole:(AgoraClientRole)currentRole;
直播场景下,本地用户加入频道后调用 setClientRole [2/2] 切换用户角色失败时,SDK 会触发该回调,报告切换失败的原因和当前的用户角色。
参数
- reason
- 切换用户角色失败的原因。详见 AgoraClientRoleChangeFailedReason。
- currentRole
- 当前用户角色。详见 AgoraClientRole。
didOccurError
发生错误回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurError:(AgoraErrorCode)errorCode;
该回调方法表示 SDK 运行时出现了网络或媒体相关的错误。通常情况下,SDK 上报的错误意味着 SDK 无法自动恢复,需要 app 干预或提示用户。
参数
- engine
- AgoraRtcEngineKit 对象。
- errorCode
- 错误码。详见 AgoraErrorCode。
didJoinChannel
成功加入频道回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed;
该回调方法表示该客户端成功加入了指定的频道。
参数
- engine
- AgoraRtcEngineKit 对象。
- channel
- 频道名。
- uid
- 加入频道的用户 ID。
- elapsed
- 从本地调用 joinChannelByToken [2/4] 开始到发生此事件过去的时间(毫秒)。
didLeaveChannelWithStats
离开频道回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLeaveChannelWithStats:(AgoraChannelStats * _Nonnull)stats;
App 调用 leaveChannel [2/2] 方法时,SDK 提示 app 离开频道成功。在该回调方法中,app 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。
参数
- engine
- AgoraRtcEngineKit 对象。
- stats
- 通话的统计数据: AgoraChannelStats。
didRejoinChannel
成功重新加入频道回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRejoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed;
有时候由于网络原因,客户端可能会和服务器失去连接,SDK 会进行自动重连,自动重连成功后触发此回调方法。
参数
- engine
- AgoraRtcEngineKit 对象。
- channel
- 频道名。
- uid
- 重新加入频道的用户 ID。
- elapsed
- 从调用 joinChannelByToken [2/4] 方法到触发该回调的时间间隔(毫秒)。
rtcEngineRequestToken
Token 已过期回调。
- (void)rtcEngineRequestToken:(AgoraRtcEngineKit * _Nonnull)engine;
在通话过程中如果 Token 已失效,SDK 会触发该回调,提醒 app 更新 Token。
- 调用 renewToken 来传入新的 Token。
- 调用 leaveChannel [2/2] 离开当前频道,然后在调用 joinChannelByToken [2/4] 时传入新的 Token 重新加入频道。
参数
- engine
- AgoraRtcEngineKit 对象。
reportRtcStats
当前通话统计信息回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportRtcStats:(AgoraChannelStats * _Nonnull)stats;
SDK 定期向 App 报告当前通话的统计信息,每两秒触发一次。
参数
- engine
- AgoraRtcEngineKit 对象。
- stats
-
RTC 引擎统计数据,详见 AgoraChannelStats。
tokenPrivilegeWillExpire
Token 服务将在30s内过期回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine tokenPrivilegeWillExpire:(NSString *_Nonnull)token;
在通话过程中如果 Token 即将失效,SDK 会提前 30 秒触发该回调,提醒 app 更新 Token。
当收到该回调时,你需要重新在服务端生成新的 Token,然后调用 renewToken 将新生成的 Token 传给 SDK。在多频道场景下,你需要调用 updateChannelExWithMediaOptions 来传入新的 Token。
参数
- engine
- AgoraRtcEngineKit 对象。
- token
- 即将服务失效的 Token。
didUserInfoUpdatedWithUserId
远端用户信息已更新回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didUserInfoUpdatedWithUserId:(NSUInteger)uid userInfo:(AgoraUserInfo* _Nonnull)userInfo;
远端用户加入频道后,SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表,并在本地触发该回调。
参数
- engine
- AgoraRtcEngineKit 对象。
- uid
- 远端用户 ID。
- userInfo
- 标识用户信息的 UserInfo 对象,包含用户 UID 和 User Account。详见 AgoraUserInfo 类。
didJoinedOfUid
远端用户(通信场景)/主播(直播场景)加入当前频道回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed;
- 通信场景下,该回调提示有远端用户加入了频道。如果加入之前,已经有其他用户在频道中了,新加入的用户也会收到这些已有用户加入频道的回调。
- 直播场景下,该回调提示有主播加入了频道。如果加入之前,已经有主播在频道中了,新加入的用户也会收到已有主播加入频道的回调。建议连麦主播不超过 17 人。
- 远端用户/主播加入频道。
- 远端用户加入频道后将用户角色改变为主播。
- 远端用户/主播网络中断后重新加入频道。
参数
- engine
- AgoraRtcEngineKit 对象。
- uid
- 新加入频道的远端用户/主播 ID。
- elapsed
- 从本地用户调用 joinChannelByToken [2/4] 到该回调触发的延迟(毫秒)。
didOfflineOfUid
远端用户(通信场景)/主播(直播场景)离开当前频道回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOfflineOfUid:(NSUInteger)uid reason:(AgoraUserOfflineReason)reason;
- 正常离开:远端用户/主播会发送类似“再见”的消息。接收此消息后,判断用户离开频道。
- 超时掉线:在一定时间内(通信场景为 20 秒,直播场景稍有延时),用户没有收到对方的任何数据包,则判定为对方掉线。在网络较差的情况下,有可能会误报。建议使用云信令 SDK 来做可靠的掉线检测。
参数
- engine
- AgoraRtcEngineKit 对象。
- uid
- 离线用户或主播的用户 ID。
- reason
-
离线原因: AgoraUserOfflineReason。
videoRenderingTracingResultOfUid
视频帧渲染事件回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine videoRenderingTracingResultOfUid:(NSUInteger)uid currentEvent:(AgoraMediaRenderTraceEvent)currentEvent tracingInfo:(AgoraVideoRenderingTracingInfo * _Nonnull)tracingInfo NS_SWIFT_NAME(rtcEngine(_:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:));
- 自从
- v4.1.1
调用 startMediaRenderingTracing 方法或加入频道后,SDK 会触发该回调,报告视频帧渲染的事件和渲染过程中的指标。开发者可以针对指标进行专项优化,以提高出图效率。
参数
- uid
- 用户 ID。
- currentEvent
- 当前视频帧渲染事件。详见 AgoraMediaTraceEvent。
- tracingInfo
- 视频帧渲染过程中的指标。开发者需要尽可能降低指标值,以提高出图效率。详见 AgoraVideoRenderingTracingInfo。