配置直播旁路推流
DEPRECATED
该方法已废弃,Agora 推荐你使用以下方法设置直播推流:
该方法在加入频道前配置旁路直播推流服务。
Note:
设置旁路直播的输出码流的宽度。默认值为 360
设置旁路直播的输出码流的高度。默认值为 640
设置旁路直播的输出码流的帧率。默认值为 15 fps
设置旁路直播的输出码流的码率。默认值为 500 Kbps
设置合图的推流地址,默认为 null
关闭双流模式
该方法关闭双流模式。
方法调用成功时执行的回调函数
方法调用失败时执行的回调函数
启用说话者音量提示
该方法允许 SDK 定期向 App 反馈当前谁在说话以及说话者的音量。
启用该方法后,无论频道中有没有人说话,SDK 都会每两秒返回音量提示。
Note:
开启双流模式
该方法在 Publish 端,即推流端,开启双流模式。
双流为视频大流和视频小流,其中视频大流指高分辨率、高码率的视频流,视频小流指低分辨率、低码率的视频流。
方法调用成功时执行的回调函数
方法调用失败时执行的回调函数
初始化客户端对象
使用该方法初始化客户端对象。
传入你的项目的 App ID。关于如何获取 App ID,请参考创建 Agora 账号并获取 App ID。
方法调用成功时执行的回调函数
方法调用失败时执行的回调函数
加入 AgoraRTC 频道
该方法让用户加入 AgoraRTC 频道。
null
。标识通话频道的字符串,长度在 64 字节以内的字符串。以下为支持的字符集范围(共89个字符): a-z,A-Z,0-9,space,! #$%&,()+, -,:;<=.#$%&,()+,-,:;<=.,>?@[],^_,{|},~
指定用户的 ID。整数,需保证唯一性。如果不指定(即设为 null
),服务器会自动分配一个,并在 onSuccess
回调方法中返回。
方法调用成功时执行的回调函数,返回值代表用户身份的 uid
方法调用失败时执行的回调函数
离开 AgoraRTC 频道
该方法让用户离开 AgoraRTC 频道。
方法调用成功时执行的回调函数
方法调用失败时执行的回调函数
该回调通知 App 本地音视频流已发布。
该回调通知 App 远程音视频流已添加。
该回调通知 App 已删除远程音视频流,即对方调用了 Client.unpublish。
该回调通知 App 已接收远程音视频流。
该回调通知 App 对方用户已离开频道,即对方调用了 Client.leave。
该回调通知 App 对方用户在语音通话中将自己的声音关掉。
该回调通知 App 对方用户在语音通话中将自己的声音打开。
该回调通知 App 对方用户在视频通话中将自己的视频关掉。
该回调通知 App 对方用户在视频通话中将自己的视频打开。
该回调通知用户已经在聊天过程中被踢,或没有进入频道就被封禁。当前只有被踢的用户会收到这个回调。
该回调通知 App 频道内谁在说话(音量最大的用户)。
该回调提示频道内谁在说话以及说话者的音量。
默认禁用。可以通过 enableAudioVolumeIndicator 方法开启;开启后,无论频道内是否有人说话,都会每两秒返回提示音量。
音量范围为 0 到 100 之间的整数。通常在列表中音量大于 5 的用户为持续说话的人。
该回调通知 App 直播推流成功。
该回调通知 App 直播推流失败。
该方法通知 App 直播推流已停止。
该方法通知 App 主播转码已更新。
在 Token 过期前 30 秒,会收到该事件通知。
一般情况下,在收到该消息之后,应向服务端重新申请 Token,并调用 Client.renewToken 方法。
在 Token 过期后,会收到该事件通知。
一般情况下,在收到该消息之后,应向服务端重新申请 Token,并调用 Client.renewToken 方法。
该回调通知 App 有出错信息,需要进行处理。
发布本地音视频流
该方法将本地音视频流发布至 SD-RTN。
Note:
在直播场景里,调用该方法的用户即为主播。
本地音视频流对象
方法调用失败时执行的回调函数
更新 Channel Key
该方法更新 Channel Key。如果启用了 Channel Key 机制,过一段时间后密钥会失效。 当 onFailure
回调报告 DYNAMIC_KEY_TIMEOUT
时,调用该 API 以更新 Channel Key,否则 SDK 会无法和服务器建立连接。
指定新的 Channel Key
方法调用成功时执行的回调函数
方法调用失败时执行的回调函数
更新 Token
该方法更新 Token。如果启用了 Token 机制,过一段时间后密钥会失效。 当收到 onTokenPrivilegeWillExpire
或 onTokenPrivilegeDidExpire
消息时,调用该 API 以更新 Token,否则 SDK 会无法和服务器建立连接。
指定新的 Token
加密方案,包含以下几种:
加密密码
设置直播转码
该方法设置直播转码。
直播转码的设置,详见 LiveTranscoding。
设置小流视频参数
如果你调用 Client.enableDualStream 开启了双流模式,该方法设置小流的视频参数。
如果你不设置小流的视频参数,SDK 会根据你的视频流属性自动适配小流的视频属性。
Note:
设置小流的视频属性。
小流视频帧的码率,单位为 Kbps。如果不填,SDK 会自动适配。
小流视频帧的帧率,单位为 fps。如果不填,SDK 会自动适配。
小流视频帧的高度。width 和 height 参数互相绑定,只有两个都填才有效,否则视为缺省,SDK 会自动适配。
小流视频帧的宽度。width 和 height 参数互相绑定,只有两个都填才有效,否则视为缺省,SDK 会自动适配。
部署 Nginx 服务器
Note:
你的 Nginx 服务器域名
设置视频大小流
如果发送端选择发送视频双流 (大流或小流),该方法可以在订阅端选择接收大流还是小流。如果不设置,订阅端默认接收大流。
远端视频流对象
设置远端视频流大小。视频流类型如下:
设置音视频流回退策略
该方法用于设置订阅端在弱网情况下音视频流的回退策略。网络不理想的情况下,为保证通话质量,可以选择自动订阅视频小流(低分辨率、低码率视频流)或者仅订阅音频流。
Note:
该方法只可在发送端通过 enableDualStream 开启双流模式的情况下使用。
远端音视频流对象
回退选项:
TURN 服务器配置
是否启用强制中转:
你在 TURN 服务器上使用的密码
你想要添加的 TCP 端口
你的 TURN 服务器 URL 地址
你想要添加的 UDP 端口
你在 TURN 服务器上注册并使用的用户名
新建直播流
该方法新建直播流。
(必选项)直播推流的地址
(非必选项) 是否启用直播转码。如果设为 true
(启用转码),需先调用 setLiveTranscoding。
删除直播流
该方法停止并删除直播流。
直播推流的地址
订阅远程音视频流
该方法从服务器端接收远程音视频流。
远端音视频流对象
方法调用失败时执行的回调函数
取消发布本地音视频流
该方法取消发布本地音视频流。
本地音视频流对象
方法调用失败时执行的回调函数
取消订阅远程音视频流
该方法取消接收远程音视频流。
远端音视频流对象
方法调用失败时执行的回调函数
通过 createClient 创建的客户端对象。
客户端对象提供 AgoraRTC 的核心功能。