MixRecording 类

Acquire

Go

func (m *MixRecording) Acquire(ctx context.Context, cname string, uid string, clientRequest *req.AcquireMixRecodingClientRequest) (*api.AcquireResp, error)

获取合流云端录制的资源 ID。

信息

自 v0.8.0 版本新增。

获取资源 ID 后，需调用 Start 方法启动云端录制。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文对象。
cname	string	待录制的频道名。
uid	string	云端录制服务在 RTC 频道中使用的用户 ID，用于标识录制服务。
clientRequest	*AcquireMixRecodingClientRequest	请求体参数，详见 AcquireMixRecodingClientRequest。

返回值

• *AcquireResp：方法调用成功时返回的响应，详见 AcquireResp。
• error：方法调用失败时返回的错误信息，成功时为 nil。

Start

Go

func (m *MixRecording) Start(ctx context.Context, resourceId string, cname string, uid string, clientRequest *req.StartMixRecordingClientRequest) (*api.StartResp, error)

启动合流云端录制。

信息

自 v0.8.0 版本新增。

该方法通过指定频道名、用户 ID 和录制参数来发起录制请求。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文对象。
resourceId	string	资源 ID。
cname	string	频道名。
uid	string	用户 ID。
clientRequest	*StartMixRecordingClientRequest	请求体参数，详见 StartMixRecordingClientRequest。

返回值

• *StartResp：方法调用成功时返回的响应对象，详见 StartResp。
• error：方法调用失败时返回的错误信息，成功时返回 nil。

QueryHLS

Go

func (m *MixRecording) QueryHLS(ctx context.Context, resourceId string, sid string) (*resp.QueryMixRecordingHLSResp, error)

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

信息

自 v0.8.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文对象。
resourceId	string	资源 ID。
sid	string	录制 ID，用于标识一次录制周期。

返回值

• *QueryMixRecordingHLSResp：方法调用成功时返回响应，详见 QueryMixRecordingHLSResp。
• error：方法调用失败时返回错误信息，详见 error。

QueryHLSAndMP4

Go

func (m *MixRecording) QueryHLSAndMP4(ctx context.Context, resourceId string, sid string) (*resp.QueryMixRecordingHLSAndMP4Resp, error)

查询 HLS 和 MP4 格式的合流云端录制状态。

信息

自 v0.8.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文对象。
resourceId	string	资源 ID。
sid	string	录制 ID，用于标识一次录制周期。

返回值

• *QueryMixRecordingHLSAndMP4Resp：方法调用成功时返回的响应对象，详见 QueryMixRecordingHLSAndMP4Resp。
• error：方法调用失败时返回的错误信息，成功时为 nil。

Update

Go

func (m *MixRecording) Update(ctx context.Context, resourceId string, sid string, cname string, uid string, clientRequest *req.UpdateMixRecordingClientRequest) (*api.UpdateResp, error)

更新合流录制配置。

信息

自 v0.8.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
resourceId	string	资源 ID。
sid	string	录制 ID，用于标识一次录制周期。
cname	string	待录制的频道名。
uid	string	云端录制服务在 RTC 频道中使用的用户 ID，用于标识频道中的录制服务。
clientRequest	*UpdateMixRecordingClientRequest	请求体，详见 UpdateMixRecordingClientRequest。

返回值

• *UpdateResp：方法调用成功时返回的响应，详见 UpdateResp。
• error：状态或错误信息，详见 error。方法调用失败时返回错误对象。

UpdateLayout

Go

func (m *MixRecording) UpdateLayout(ctx context.Context, resourceId string, sid string, cname string, uid string, clientRequest *req.UpdateLayoutUpdateMixRecordingClientRequest) (*api.UpdateLayoutResp, error)

更新合流云端录制布局。

信息

自 v0.8.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文对象。
resourceId	string	资源 ID。
sid	string	录制 ID，用于标识一次录制周期。
cname	string	频道名。
uid	string	云端录制服务在 RTC 频道中使用的用户 ID，用于标识频道中的录制服务。
clientRequest	UpdateLayoutUpdateMixRecordingClientRequest	请求体，详见 UpdateLayoutUpdateMixRecordingClientRequest。

返回值

• *UpdateLayoutResp：方法调用成功时返回响应，详见 UpdateLayoutResp。
• error：方法调用失败时返回错误信息，成功时返回 nil。

Stop

Go

func (m *MixRecording) Stop(ctx context.Context, resourceId string, sid string, cname string, uid string, asyncStop bool) (*api.StopResp, error)

停止合流云端录制。

信息

自 v0.8.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
resourceId	string	资源 ID。
sid	string	录制 ID，用于标识一次录制周期。
cname	string	待录制频道的名称。
uid	string	云端录制服务在 RTC 频道中使用的用户 ID，用于标识频道中的录制服务。
asyncStop	bool	是否异步停止录制： true：异步停止录制。 false：同步停止录制。

返回值

• *StopResp：方法调用成功时返回响应，详见 StopResp。
• error：方法调用失败时返回错误对象，包含错误信息；调用成功时返回 nil。