MixScenario 类

acquire

Java

public abstract Mono<AcquireResourceRes> acquire(String cname, String uid, AcquireMixRecordingResourceClientReq clientRequest);

获取合流录制资源 ID。

信息

自 v0.4.0 版本新增。

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

参数

参数	数据类型	描述
cname	String	待录制的频道名称。
uid	String	云端录制服务在 RTC 频道中使用的用户 ID，用于标识录制服务。
clientRequest	AcquireMixRecordingResourceClientReq	请求体参数，详见 AcquireMixRecordingResourceClientReq。

返回值

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

start

Java

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

启动合流录制。

信息

自 v0.4.0 版本新增。

参数

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

返回值

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

queryHLS

Java

public abstract Mono<QueryMixHLSRecordingResourceRes> queryHLS(String resourceId, String sid);

查询视频文件格式为 HLS 时的合流录制状态。

信息

自 v0.4.0 版本新增。

参数

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

返回值

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

queryHLSAndMP4

Java

public abstract Mono<QueryMixHLSAndMP4RecordingResourceRes> queryHLSAndMP4(String resourceId, String sid);

查询当视频文件格式为 HLS 和 MP4 时的合流云端录制状态。

信息

自 v0.4.0 版本新增。

参数

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

返回值

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

updateLayout

Java

public abstract Mono<UpdateLayoutResourceRes> updateLayout(String cname, String uid, String resourceId, String sid, UpdateLayoutMixRecordingResourceClientReq clientRequest);

更新合流云端录制的布局。

信息

自 v0.4.0 版本新增。

参数

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

返回值

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

update

Java

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

更新合流录制配置。

信息

自 v0.4.0 版本新增。

参数

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

返回值

方法调用成功，返回 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 对象。