tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
互动白板
    文档
    Download PDF

    CreateVideoGenerationTask

    最后更新时间：2023-12-07 10:46:29
    下载PDF

      1. API Description

      Domain name for API request: tiw.tencentcloudapi.com.

      This API is used to create a recording video generation task.

      A maximum of 20 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: CreateVideoGenerationTask.
      Version Yes String Common Params. The value used for this API: 2019-09-19.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
      OnlineRecordTaskId Yes String ID of the recording task.
      SdkAppId Yes Integer SdkAppId of the whiteboard application.
      Whiteboard No Whiteboard Whiteboard parameters of the recording video generation task, such as the width and height of the whiteboard.

      This parameter conflicts with the Whiteboard parameter in the API for starting a recording task. If the two Whiteboard parameters are both specified, the Whiteboard parameter in this API takes priority for recording video generation. If the Whiteboard parameter in this API is not specified, the Whiteboard parameter specified in the API for starting a recording task is used for recording video generation.
      Concat No Concat Video splicing parameters.

      This parameter conflicts with the Concat parameter in the API for starting a recording task. If the two Concat parameters are both specified, the Concat parameter in this API takes priority for video splicing. If the Concat parameter in this API is not specified, the Concat parameter specified in the API for starting a recording task is used for video splicing.
      MixStream No MixStream Video stream mixing parameters.

      This parameter conflicts with the MixStream parameter in the API for starting a recording task. If the two MixStream parameters are both specified, the MixStream parameter in this API takes priority for video stream mixing. If the MixStream parameter in this API is not specified, the MixStream parameter specified in the API for starting a recording task is used for video stream mixing.
      RecordControl No RecordControl A group of video generation parameters. It specifies the streams to be generated, whether to disable audio recording for a stream, and whether to record only low-resolution videos, etc.

      This parameter conflicts with the RecordControl parameter in the API for starting a recording task. If the two RecordControl parameters are both specified, the RecordControl parameter in this API takes priority for video generation control. If the RecordControl parameter in this API is not specified, the RecordControl parameter specified in the API for starting a recording task is used for video generation control.
      ExtraData No String Internal parameter.

      3. Output Parameters

      Parameter Name Type Description
      TaskId String ID of the video generation task.
      RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

      4. Example

      Example1 Starting a recording video generation task

      Input Example

      https://tiw.tencentcloudapi.com/?Action=CreateVideoGenerationTask
&SdkAppId=1400000001
&OnlineRecordTaskId=xxxxx
&<Common request parameters>

      Output Example

      {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "TaskId": "g7khk7f809vterp942mb"
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      AuthFailure
      FailedOperation Operation failed.
      InvalidParameter.BodyParameterTypeUnmatched The parameter type does not match.
      InvalidParameter.InvalidExtra The specified special feature does not exist.
      InvalidParameter.RecordParameter The format of the real-time recording parameter is invalid.
      InvalidParameter.SdkAppIdNotFound The SdkAppId does not exist or is invalid.
      LimitExceeded.TaskConcurrency The number of concurrent transcoding or recording tasks exceeds the limit. For more information, see the error description or try again later.
      ResourceInUse.RecordUserId The recording user account for real-time recording has started another recording task.
      ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
      UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款