MixScenario 类

  • Java

更新时间不可用

acquire

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

获取合流录制资源 ID。

信息

自 v0.4.0 版本新增。

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

参数

参数数据类型描述
cnameString待录制的频道名称。
uidString云端录制服务在 RTC 频道中使用的用户 ID,用于标识录制服务。
clientRequestAcquireMixRecordingResourceClientReq请求体参数,详见 AcquireMixRecordingResourceClientReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

start

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

启动合流录制。

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
cnameString待录制的频道名称。
uidString用于标识录制服务在 RTC 频道中的用户 ID。
resourceIdString资源 ID。
clientRequestStartMixRecordingResourceClientReq请求体参数,详见 StartMixRecordingResourceClientReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

queryHLS

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

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

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
resourceIdString资源 ID。
sidString录制 ID,用于标识一次录制周期。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

queryHLSAndMP4

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

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

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
resourceIdString资源 ID。
sidString录制 ID,用于标识一次录制周期。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

updateLayout

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

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

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
cnameString待录制的频道名称。
uidString云端录制服务在 RTC 频道中使用的用户 ID,用于标识录制服务。
resourceIdString资源 ID。
sidString录制 ID,用于标识一次录制周期。
clientRequestUpdateLayoutMixRecordingResourceClientReq请求体,详见 UpdateLayoutMixRecordingResourceClientReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

update

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

更新合流录制配置。

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
cnameString频道名称。
uidString云端录制服务在 RTC 频道中使用的用户 ID,用于标识录制服务。
resourceIdString资源 ID。
sidString录制 ID,用于标识一次录制周期。
clientRequestUpdateMixRecordingResourceClientReq请求体,详见 UpdateMixRecordingResourceClientReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

stop

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

停止合流录制。

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
cnameString频道名称。
uidString云端录制服务在 RTC 频道中使用的用户 ID,用于标识录制服务。
resourceIdString资源 ID。
sidString录制 ID,用于标识一次录制周期。
asyncStopboolean
  • true:异步停止录制。
  • false:同步停止录制。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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