Public 成员函数 | |
virtual | ~IRecordingEngine () |
virtual int | joinChannel (const char *channelKey, const char *channelId, uid_t uid, const RecordingConfig &config)=0 |
virtual int | joinChannelWithUserAccount (const char *token, const char *channelId, const char *userAccount, const RecordingConfig &config)=0 |
virtual int | getUserInfoByUserAccount (const char *userAccount, agora::linuxsdk::UserInfo *userinfo)=0 |
virtual int | getUserInfoByUid (uid_t uid, agora::linuxsdk::UserInfo *userInfo)=0 |
virtual int | setVideoMixingLayout (const agora::linuxsdk::VideoMixingLayout &layout)=0 |
virtual int | stoppedOnError ()=0 |
virtual int | leaveChannel ()=0 |
virtual int | release ()=0 |
virtual const RecordingEngineProperties * | getProperties ()=0 |
virtual int | startService ()=0 |
virtual int | stopService ()=0 |
virtual int | setUserBackground (uid_t uid, const char *img_path)=0 |
virtual int | setLogLevel (agora::linuxsdk::agora_log_level level)=0 |
virtual int | updateSubscribeVideoUids (uid_t *uids, uint32_t num)=0 |
virtual int | updateSubscribeAudioUids (uid_t *uids, uint32_t num)=0 |
virtual int | updateWatermarkConfigs (uint32_t wm_num, linuxsdk::WatermarkConfig *config)=0 |
静态 Public 成员函数 | |
static IRecordingEngine * | createAgoraRecordingEngine (const char *appId, IRecordingEngineEventHandler *eventHandler) |
该类包含应用程序调用的主要方法。
|
inlinevirtual |
|
static |
该方法创建 IRecordingEngine 实例。
appId | 希望录制的音视频通话中使用的 App ID,详见 获取 App ID。 |
eventHandler | 录制 SDK 所触发的事件通过 IRecordingEngineEventHandler 类回调通知应用程序。 |
|
pure virtual |
该方法让录制端加入频道,并开始录制。
channelKey | 用于鉴权的动态密钥。录制端的 channelKey 与 Native/Web SDK 保持一致。如果 Native/Web SDK 用了 token,该参数必须设为 token。详见校验用户权限。 |
channelId | 希望录制的音视频通话的频道名称。 |
uid | 录制使用的 UID。有两种设置方法:
|
config | 录制的详细设置,详见 RecordingConfig。 |
|
pure virtual |
该方法允许录制端使用 User Account 加入频道。
录制端成功加入频道后,会在本地触发 onLocalUserRegistered 和 onJoinChannelSuccess 回调。
token | 用于鉴权的动态密钥。录制端的动态密钥必须与 Native/Web SDK 保持一致。如果 Native/Web SDK 用了 token,该参数必须设为 token。详见校验用户权限。 |
channelId | 待录制频道的频道名。 |
userAccount | 用户的 User Account。该参数为必填,最大不超过 255 字节,不可填 null。请确保加入频道的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
config | 录制的详细设置,详见 RecordingConfig。 |
|
pure virtual |
该方法通过 User Account 获取远端用户信息。
远端用户加入频道后,SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表,并在本地触发 onUserInfoUpdated 回调。
收到 onUserInfoUpdated 回调后,你可以调用 getUserInfoByUserAccount
方法,通过传入 User Account 获取包含了指定用户 UID 的 UserInfo 对象。
userAccount | 用户 User Account,必填。 |
userinfo | [in/out] 标识用户信息的 UserInfo 对象。 |
|
pure virtual |
该方法通过 UID 获取远端用户信息。
远端用户加入频道后, SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表,并在本地触发 onUserInfoUpdated 回调。
收到 onUserInfoUpdated 回调后,你可以调用 getUserInfoByUid
方法,通过传入 UID 获取包含了指定用户 User Account 的 UserInfo 对象。
uid | 用户 UID,必填。 |
userInfo | [in/out] 标识用户信息的 UserInfo 对象。 |
|
pure virtual |
该方法设置视频合流布局。
合流模式下如果有视频,必须调用该方法设置布局。
layout | 视频合流布局的设定,详见 VideoMixingLayout。 |
|
pure virtual |
|
pure virtual |
该方法让录制端退出频道,并释放占用的线程资源。
|
pure virtual |
该方法销毁 IRecordingEngine 实例。
|
pure virtual |
该方法获取录制属性。
|
pure virtual |
|
pure virtual |
|
pure virtual |
该方法设置指定 UID 用户的背景图片。当指定 UID 用户在线且没有发送视频流时,会显示该背景图片。
uid | 该用户的 UID。 |
img_path | 背景图片路径。仅支持本地 JPEG 文件。 |
|
pure virtual |
该方法设置 log 过滤等级。设置完成后,只有等级低于和等于所设 level 的 log 才会被生成。默认值为 5。
level | 详见 agora_log_level。 |
|
pure virtual |
该方法允许录制 SDK 只录制指定 UID 的视频。
uids | UID 数组,为用逗号隔开的字符串,例如 "1","2","3"。 |
num | UID 的个数。 |
|
pure virtual |
该方法允许录制 SDK 只录制指定 UID 的音频。
uids | UID 组成的数组,为用逗号隔开的字符串,例如 "1","2","3"。 |
num | UID 的个数。 |
|
pure virtual |
该方法添加、更新或删除水印设置。
录制 SDK 支持三种水印:文字水印、时间戳水印和图片水印。
有以下情况:
wm_num
和 wm_configs
参数,你可直接调用 updateWatermarkConfigs
方法添加水印。wm_num
和 wm_configs
参数添加了水印,你可调用 updateWatermarkConfigs
方法修改水印个数和具体设置,从而增加、更新或删除水印;传值为空则删除全部已添加的水印。wm_num | 水印的个数。录制 SDK 最多支持 15 个水印,其中文字水印最多 10 个,时间戳水印最多 1 个,图片水印最多 4 个。 |
config | 水印的具体设置。WatermarkConfig 组成的数组。一个水印对应一个 WatermarkConfig。 |