IndividualScenario 类

acquire

Java

public abstract Mono<AcquireResourceRes> acquire(String cname, String uid, boolean enablePostpone, AcquireIndividualResourceClientReq clientRequest);

获取单流录制的资源 ID。

信息

自 v0.4.0 版本新增。

获取资源 ID 后，需调用 start API 启动云端录制。

参数

参数	数据类型	描述
cname	String	待录制的频道名称。
uid	String	云录制服务在 RTC 频道中使用的用户 ID，用于标识录制服务。
enablePostpone	boolean	true：延迟开始录制。 false：立即开始录制。
clientRequest	AcquireIndividualResourceClientReq	请求体参数，详见 AcquireIndividualResourceClientReq。

返回值

方法调用成功，返回 AcquireResourceRes 对象。

start

Java

public abstract Mono<StartResourceRes> start(String cname, String uid, String resourceId, StartIndividualRecordingClientReq clientRequest);

启动单流云端录制。

信息

自 v0.4.0 版本新增。

参数

参数	数据类型	描述
cname	String	频道名称。
uid	String	用户 ID。
resourceId	String	资源 ID。
clientRequest	StartIndividualRecordingClientReq	请求体参数，详见 StartIndividualRecordingClientReq。

返回值

方法调用成功，返回 StartResourceRes 对象。

query

Java

public abstract Mono<QueryIndividualRecordingResourceRes> query(String resourceId, String sid);

查询关闭视频截图采集时的单路云端录制状态。

信息

自 v0.4.0 版本新增。

参数

参数	数据类型	描述
resourceId	String	资源 ID。
sid	String	录制 ID，用于标识一次录制周期。

返回值

方法调用成功，返回 QueryIndividualRecordingResourceRes 对象。

queryVideoScreenshot

Java

public abstract Mono<QueryIndividualRecordingVideoScreenshotResourceRes> queryVideoScreenshot(String resourceId, String sid);

查询开启视频截图时单路云端录制的状态。

信息

自 v0.4.0 版本新增。

参数

参数	数据类型	描述
resourceId	String	资源 ID。
sid	String	录制 ID，用于标识一次录制周期。

返回值

方法调用成功时，返回 QueryIndividualRecordingVideoScreenshotResourceRes 对象。

update

Java

public abstract Mono<UpdateResourceRes> update(String cname, String uid, String resourceId, String sid, UpdateIndividualRecordingResourceClientReq clientRequest);

更新单流录制配置。

信息

自 v0.4.0 版本新增。

参数

参数	数据类型	描述
cname	String	频道名称。
uid	String	用于标识录制服务在 RTC 频道中的用户 ID。
resourceId	String	资源 ID。
sid	String	录制 ID，用于标识一次录制周期。
clientRequest	UpdateIndividualRecordingResourceClientReq	请求体，详见 UpdateIndividualRecordingResourceClientReq。

返回值

方法调用成功，返回 UpdateResourceRes 对象。

stop

Java

public abstract Mono<StopResourceRes> stop(String cname, String uid, String resourceId, String sid, boolean asyncStop);

停止单流录制。

信息

自 v0.4.0 版本新增。

参数

参数	数据类型	描述
cname	String	频道名称。
uid	String	云端录制服务在 RTC 频道中使用的用户 ID，用于标识录制服务。
resourceId	String	资源 ID。
sid	String	录制 ID，用于标识一次录制周期。
asyncStop	boolean	true：异步停止录制。 false：同步停止录制。

返回值

方法调用成功，返回 StopResourceRes 对象。