WebScenario 类
- Java
更新时间不可用
acquire
public abstract Mono<AcquireResourceRes> acquire(String cname, String uid, AcquireWebRecordingResourceClientReq clientRequest);获取页面录制资源 ID。
信息
自 v0.4.0 版本新增。
获取资源 ID 后，需调用 start API 启动云端录制。
参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
cname | String | 频道名。 |
uid | String | 用于标识录制服务在 RTC 频道中的用户 ID。 |
clientRequest | AcquireWebRecordingResourceClientReq | 请求体参数，详见 AcquireWebRecordingResourceClientReq。 |
返回值
方法调用成功，返回 AcquireResourceRes 对象。
start
public abstract Mono<StartResourceRes> start(String cname, String uid, String resourceId, StartWebRecordingResourceClientReq clientRequest);启动 Web 录制。
信息
自 v0.4.0 版本新增。
参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
cname | String | 待录制的频道名称。 |
uid | String | 用于标识录制服务在 RTC 频道中的用户 ID。 |
resourceId | String | 资源 ID。 |
clientRequest | StartWebRecordingResourceClientReq | 请求体参数，详见 StartWebRecordingResourceClientReq。 |
返回值
方法调用成功，返回 StartResourceRes 对象。
query
public abstract Mono<QueryWebRecordingResourceRes> query(String resourceId, String sid);查询页面录制状态。
信息
自 v0.4.0 版本新增。
参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
resourceId | String | 资源 ID。 |
sid | String | 录制 ID，用于标识一次录制周期。 |
返回值
方法调用成功，返回 QueryWebRecordingResourceRes 对象。
queryRtmpPublish
public abstract Mono<QueryWebRecordingRtmpPublishResourceRes> queryRtmpPublish(String resourceId, String sid);查询网页录制的 CDN 推流状态。
信息
自 v0.4.0 版本新增。
参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
resourceId | String | 资源 ID。 |
sid | String | 录制 ID，用于标识一次录制周期。 |
返回值
方法调用成功，返回 QueryWebRecordingRtmpPublishResourceRes 对象。
update
public abstract Mono<UpdateResourceRes> update(String cname, String uid, String resourceId, String sid, UpdateWebRecordingResourceClientReq clientRequest);更新页面录制配置。
信息
自 v0.4.0 版本新增。
参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
cname | String | 频道名称。 |
uid | String | 云端录制服务在 RTC 频道中使用的用户 ID，用于标识录制服务。 |
resourceId | String | 资源 ID。 |
sid | String | 录制 ID，用于标识一次录制周期。 |
clientRequest | UpdateWebRecordingResourceClientReq | 请求体，详见 UpdateWebRecordingResourceClientReq。 |
返回值
方法调用成功，返回 UpdateResourceRes 对象。
stop
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 |
|
返回值
方法调用成功，返回 StopResourceRes 对象。