Documentation ¶
Index ¶
- func CloudRTCClientBuilder() *http_client.HcHttpClientBuilder
- func GenReqDefForCreateApp() *def.HttpRequestDef
- func GenReqDefForCreateIndividualStreamJob() *def.HttpRequestDef
- func GenReqDefForCreateMixJob() *def.HttpRequestDef
- func GenReqDefForCreateRecordRule() *def.HttpRequestDef
- func GenReqDefForDeleteApp() *def.HttpRequestDef
- func GenReqDefForDeleteRecordRule() *def.HttpRequestDef
- func GenReqDefForListApps() *def.HttpRequestDef
- func GenReqDefForListRecordRules() *def.HttpRequestDef
- func GenReqDefForShowApp() *def.HttpRequestDef
- func GenReqDefForShowAutoRecord() *def.HttpRequestDef
- func GenReqDefForShowIndividualStreamJob() *def.HttpRequestDef
- func GenReqDefForShowMixJob() *def.HttpRequestDef
- func GenReqDefForShowRecordCallback() *def.HttpRequestDef
- func GenReqDefForShowRecordRule() *def.HttpRequestDef
- func GenReqDefForShowUrlAuth() *def.HttpRequestDef
- func GenReqDefForStartApp() *def.HttpRequestDef
- func GenReqDefForStopApp() *def.HttpRequestDef
- func GenReqDefForStopIndividualStreamJob() *def.HttpRequestDef
- func GenReqDefForStopMixJob() *def.HttpRequestDef
- func GenReqDefForUpdateAutoRecord() *def.HttpRequestDef
- func GenReqDefForUpdateMixJob() *def.HttpRequestDef
- func GenReqDefForUpdateRecordCallback() *def.HttpRequestDef
- func GenReqDefForUpdateRecordRule() *def.HttpRequestDef
- func GenReqDefForUpdateUrlAuth() *def.HttpRequestDef
- type CloudRTCClient
- func (c *CloudRTCClient) CreateApp(request *model.CreateAppRequest) (*model.CreateAppResponse, error)
- func (c *CloudRTCClient) CreateIndividualStreamJob(request *model.CreateIndividualStreamJobRequest) (*model.CreateIndividualStreamJobResponse, error)
- func (c *CloudRTCClient) CreateMixJob(request *model.CreateMixJobRequest) (*model.CreateMixJobResponse, error)
- func (c *CloudRTCClient) CreateRecordRule(request *model.CreateRecordRuleRequest) (*model.CreateRecordRuleResponse, error)
- func (c *CloudRTCClient) DeleteApp(request *model.DeleteAppRequest) (*model.DeleteAppResponse, error)
- func (c *CloudRTCClient) DeleteRecordRule(request *model.DeleteRecordRuleRequest) (*model.DeleteRecordRuleResponse, error)
- func (c *CloudRTCClient) ListApps(request *model.ListAppsRequest) (*model.ListAppsResponse, error)
- func (c *CloudRTCClient) ListRecordRules(request *model.ListRecordRulesRequest) (*model.ListRecordRulesResponse, error)
- func (c *CloudRTCClient) ShowApp(request *model.ShowAppRequest) (*model.ShowAppResponse, error)
- func (c *CloudRTCClient) ShowAutoRecord(request *model.ShowAutoRecordRequest) (*model.ShowAutoRecordResponse, error)
- func (c *CloudRTCClient) ShowIndividualStreamJob(request *model.ShowIndividualStreamJobRequest) (*model.ShowIndividualStreamJobResponse, error)
- func (c *CloudRTCClient) ShowMixJob(request *model.ShowMixJobRequest) (*model.ShowMixJobResponse, error)
- func (c *CloudRTCClient) ShowRecordCallback(request *model.ShowRecordCallbackRequest) (*model.ShowRecordCallbackResponse, error)
- func (c *CloudRTCClient) ShowRecordRule(request *model.ShowRecordRuleRequest) (*model.ShowRecordRuleResponse, error)
- func (c *CloudRTCClient) ShowUrlAuth(request *model.ShowUrlAuthRequest) (*model.ShowUrlAuthResponse, error)
- func (c *CloudRTCClient) StartApp(request *model.StartAppRequest) (*model.StartAppResponse, error)
- func (c *CloudRTCClient) StopApp(request *model.StopAppRequest) (*model.StopAppResponse, error)
- func (c *CloudRTCClient) StopIndividualStreamJob(request *model.StopIndividualStreamJobRequest) (*model.StopIndividualStreamJobResponse, error)
- func (c *CloudRTCClient) StopMixJob(request *model.StopMixJobRequest) (*model.StopMixJobResponse, error)
- func (c *CloudRTCClient) UpdateAutoRecord(request *model.UpdateAutoRecordRequest) (*model.UpdateAutoRecordResponse, error)
- func (c *CloudRTCClient) UpdateMixJob(request *model.UpdateMixJobRequest) (*model.UpdateMixJobResponse, error)
- func (c *CloudRTCClient) UpdateRecordCallback(request *model.UpdateRecordCallbackRequest) (*model.UpdateRecordCallbackResponse, error)
- func (c *CloudRTCClient) UpdateRecordRule(request *model.UpdateRecordRuleRequest) (*model.UpdateRecordRuleResponse, error)
- func (c *CloudRTCClient) UpdateUrlAuth(request *model.UpdateUrlAuthRequest) (*model.UpdateUrlAuthResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CloudRTCClientBuilder ¶
func CloudRTCClientBuilder() *http_client.HcHttpClientBuilder
func GenReqDefForCreateApp ¶ added in v0.0.53
func GenReqDefForCreateApp() *def.HttpRequestDef
func GenReqDefForCreateIndividualStreamJob ¶
func GenReqDefForCreateIndividualStreamJob() *def.HttpRequestDef
func GenReqDefForCreateMixJob ¶
func GenReqDefForCreateMixJob() *def.HttpRequestDef
func GenReqDefForCreateRecordRule ¶ added in v0.0.53
func GenReqDefForCreateRecordRule() *def.HttpRequestDef
func GenReqDefForDeleteApp ¶ added in v0.0.53
func GenReqDefForDeleteApp() *def.HttpRequestDef
func GenReqDefForDeleteRecordRule ¶ added in v0.0.53
func GenReqDefForDeleteRecordRule() *def.HttpRequestDef
func GenReqDefForListApps ¶ added in v0.0.53
func GenReqDefForListApps() *def.HttpRequestDef
func GenReqDefForListRecordRules ¶ added in v0.0.53
func GenReqDefForListRecordRules() *def.HttpRequestDef
func GenReqDefForShowApp ¶ added in v0.0.53
func GenReqDefForShowApp() *def.HttpRequestDef
func GenReqDefForShowAutoRecord ¶ added in v0.0.53
func GenReqDefForShowAutoRecord() *def.HttpRequestDef
func GenReqDefForShowIndividualStreamJob ¶
func GenReqDefForShowIndividualStreamJob() *def.HttpRequestDef
func GenReqDefForShowMixJob ¶
func GenReqDefForShowMixJob() *def.HttpRequestDef
func GenReqDefForShowRecordCallback ¶ added in v0.0.53
func GenReqDefForShowRecordCallback() *def.HttpRequestDef
func GenReqDefForShowRecordRule ¶ added in v0.0.53
func GenReqDefForShowRecordRule() *def.HttpRequestDef
func GenReqDefForShowUrlAuth ¶ added in v0.0.53
func GenReqDefForShowUrlAuth() *def.HttpRequestDef
func GenReqDefForStartApp ¶ added in v0.0.53
func GenReqDefForStartApp() *def.HttpRequestDef
func GenReqDefForStopApp ¶ added in v0.0.53
func GenReqDefForStopApp() *def.HttpRequestDef
func GenReqDefForStopIndividualStreamJob ¶
func GenReqDefForStopIndividualStreamJob() *def.HttpRequestDef
func GenReqDefForStopMixJob ¶
func GenReqDefForStopMixJob() *def.HttpRequestDef
func GenReqDefForUpdateAutoRecord ¶ added in v0.0.53
func GenReqDefForUpdateAutoRecord() *def.HttpRequestDef
func GenReqDefForUpdateMixJob ¶
func GenReqDefForUpdateMixJob() *def.HttpRequestDef
func GenReqDefForUpdateRecordCallback ¶ added in v0.0.53
func GenReqDefForUpdateRecordCallback() *def.HttpRequestDef
func GenReqDefForUpdateRecordRule ¶ added in v0.0.53
func GenReqDefForUpdateRecordRule() *def.HttpRequestDef
func GenReqDefForUpdateUrlAuth ¶ added in v0.0.53
func GenReqDefForUpdateUrlAuth() *def.HttpRequestDef
Types ¶
type CloudRTCClient ¶
type CloudRTCClient struct {
HcClient *http_client.HcHttpClient
}
func NewCloudRTCClient ¶
func NewCloudRTCClient(hcClient *http_client.HcHttpClient) *CloudRTCClient
func (*CloudRTCClient) CreateApp ¶ added in v0.0.53
func (c *CloudRTCClient) CreateApp(request *model.CreateAppRequest) (*model.CreateAppResponse, error)
调用此接口创建应用。
func (*CloudRTCClient) CreateIndividualStreamJob ¶
func (c *CloudRTCClient) CreateIndividualStreamJob(request *model.CreateIndividualStreamJobRequest) (*model.CreateIndividualStreamJobResponse, error)
调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}\\_{jobid}\\_{roomid}\\_{userid} jobtype取值为's'代表单流录制。
func (*CloudRTCClient) CreateMixJob ¶
func (c *CloudRTCClient) CreateMixJob(request *model.CreateMixJobRequest) (*model.CreateMixJobResponse, error)
调用此接口创建合流转码任务。 支持纯音频录制和音视频录制: - 纯音频录制 encode_template填audio_only,音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填,填就忽略。 - 音视频录制(包括共享桌面) encode_template非audio_only,layout_template、layout_panes必须非空。 音频合流会动态选择最大三方的声音。 API触发合流录制流名规则:{jobtype}\\_{jobid}\\_{roomid},其中jobtype取值为'm'代表合流录制。
func (*CloudRTCClient) CreateRecordRule ¶ added in v0.0.53
func (c *CloudRTCClient) CreateRecordRule(request *model.CreateRecordRuleRequest) (*model.CreateRecordRuleResponse, error)
调用此接口创建或更新录制规则。 - 若当前app在请求的location中无录制规则,则会创建新的录制规则 - 若当前app在请求的location中已有录制规则,则会更新原来的录制规则
func (*CloudRTCClient) DeleteApp ¶ added in v0.0.53
func (c *CloudRTCClient) DeleteApp(request *model.DeleteAppRequest) (*model.DeleteAppResponse, error)
调用此接口删除单个应用。
func (*CloudRTCClient) DeleteRecordRule ¶ added in v0.0.53
func (c *CloudRTCClient) DeleteRecordRule(request *model.DeleteRecordRuleRequest) (*model.DeleteRecordRuleResponse, error)
调用此接口删除录制规则,对于正在使用的录制规则,不允许删除。
func (*CloudRTCClient) ListApps ¶ added in v0.0.53
func (c *CloudRTCClient) ListApps(request *model.ListAppsRequest) (*model.ListAppsResponse, error)
调用此接口查询应用列表。
func (*CloudRTCClient) ListRecordRules ¶ added in v0.0.53
func (c *CloudRTCClient) ListRecordRules(request *model.ListRecordRulesRequest) (*model.ListRecordRulesResponse, error)
调用此接口查询录制规则列表。
func (*CloudRTCClient) ShowApp ¶ added in v0.0.53
func (c *CloudRTCClient) ShowApp(request *model.ShowAppRequest) (*model.ShowAppResponse, error)
调用此接口查询单个应用详情。
func (*CloudRTCClient) ShowAutoRecord ¶ added in v0.0.53
func (c *CloudRTCClient) ShowAutoRecord(request *model.ShowAutoRecordRequest) (*model.ShowAutoRecordResponse, error)
调用此接口查询自动录制配置
func (*CloudRTCClient) ShowIndividualStreamJob ¶
func (c *CloudRTCClient) ShowIndividualStreamJob(request *model.ShowIndividualStreamJobRequest) (*model.ShowIndividualStreamJobResponse, error)
调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。
func (*CloudRTCClient) ShowMixJob ¶
func (c *CloudRTCClient) ShowMixJob(request *model.ShowMixJobRequest) (*model.ShowMixJobResponse, error)
调用此接口查询合流转码任务状态。
func (*CloudRTCClient) ShowRecordCallback ¶ added in v0.0.53
func (c *CloudRTCClient) ShowRecordCallback(request *model.ShowRecordCallbackRequest) (*model.ShowRecordCallbackResponse, error)
调用此接口查询增值(录制)事件回调配置
func (*CloudRTCClient) ShowRecordRule ¶ added in v0.0.53
func (c *CloudRTCClient) ShowRecordRule(request *model.ShowRecordRuleRequest) (*model.ShowRecordRuleResponse, error)
调用此接口查询指定录制规则。
func (*CloudRTCClient) ShowUrlAuth ¶ added in v0.0.53
func (c *CloudRTCClient) ShowUrlAuth(request *model.ShowUrlAuthRequest) (*model.ShowUrlAuthResponse, error)
查询应用鉴权配置参数
func (*CloudRTCClient) StartApp ¶ added in v0.0.53
func (c *CloudRTCClient) StartApp(request *model.StartAppRequest) (*model.StartAppResponse, error)
调用此接口启用单个应用。
func (*CloudRTCClient) StopApp ¶ added in v0.0.53
func (c *CloudRTCClient) StopApp(request *model.StopAppRequest) (*model.StopAppResponse, error)
调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。
func (*CloudRTCClient) StopIndividualStreamJob ¶
func (c *CloudRTCClient) StopIndividualStreamJob(request *model.StopIndividualStreamJobRequest) (*model.StopIndividualStreamJobResponse, error)
调用此接口停止单流任务
func (*CloudRTCClient) StopMixJob ¶
func (c *CloudRTCClient) StopMixJob(request *model.StopMixJobRequest) (*model.StopMixJobResponse, error)
调用此接口停止已下发的合流转码任务。
func (*CloudRTCClient) UpdateAutoRecord ¶ added in v0.0.53
func (c *CloudRTCClient) UpdateAutoRecord(request *model.UpdateAutoRecordRequest) (*model.UpdateAutoRecordResponse, error)
更新自动录制配置,租户可以开启自动单流录制或者停用自动单流录制。
func (*CloudRTCClient) UpdateMixJob ¶
func (c *CloudRTCClient) UpdateMixJob(request *model.UpdateMixJobRequest) (*model.UpdateMixJobResponse, error)
调用此接口更新合流任务布局。
func (*CloudRTCClient) UpdateRecordCallback ¶ added in v0.0.53
func (c *CloudRTCClient) UpdateRecordCallback(request *model.UpdateRecordCallbackRequest) (*model.UpdateRecordCallbackResponse, error)
调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调格式参考/customer-record-notify-url定义。
func (*CloudRTCClient) UpdateRecordRule ¶ added in v0.0.53
func (c *CloudRTCClient) UpdateRecordRule(request *model.UpdateRecordRuleRequest) (*model.UpdateRecordRuleResponse, error)
调用此接口更新录制规则。
func (*CloudRTCClient) UpdateUrlAuth ¶ added in v0.0.53
func (c *CloudRTCClient) UpdateUrlAuth(request *model.UpdateUrlAuthRequest) (*model.UpdateUrlAuthResponse, error)
调用此接口开启或关闭URL鉴权。