All Products
Search

This Product

    Intelligent Media Services:SubmitIProductionJob

    Document Center

    Intelligent Media Services:SubmitIProductionJob

    Last Updated:Dec 16, 2024

    Submits an intelligent production job.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ice:SubmitIProductionJobcreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    NamestringNo

    The name of the intelligent production job. The name can be up to 100 characters in length.

    FunctionNamestringYes

    The name of the algorithm that you want to use for the job. Valid values:

    • Cover: This algorithm intelligently generates a thumbnail image for a video.
    • VideoClip: This algorithm intelligently generates a summary for a video.
    • VideoDelogo: This algorithm removes logos from a video.
    • VideoDetext: This algorithm removes captions from a video.
    • CaptionExtraction: This algorithm extracts captions from a video and generates the caption file.
    • VideoGreenScreenMatting: This algorithm performs green-screen image matting on a video and generates a new video.
    • FaceBeauty: This algorithm performs video retouching.
    • VideoH2V: This algorithm transforms a video from the landscape mode to the portrait mode.
    • MusicSegmentDetect: This algorithm detects the chorus of a song.
    • AudioBeatDetection: This algorithm detects rhythms.
    • AudioQualityAssessment: This algorithm assesses the audio quality.
    • SpeechDenoise: This algorithm performs noise reduction.
    • AudioMixing: This algorithm mixes audio streams.
    		Cover
    InputobjectYes

    The input file. The file can be an Object Storage Service (OSS) object or a media asset.

    TypestringYes

    The media type. Valid values:

    • OSS: OSS object
    • Media: media asset
    		OSS
    MediastringYes

    The input file. The file can be an OSS object or a media asset. You can specify the path of an OSS object in one of the following formats:

    1. oss://bucket/object
    2. http(s)://bucket.oss-[regionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.
    		oss://bucket/object
    OutputobjectYes

    The output file. The file can be an OSS object or a media asset.

    TypestringYes

    The media type. Valid values:

    • OSS: OSS object
    • Media: media asset
    		OSS
    MediastringYes

    The output file. If Type is set to OSS, set this parameter to the path of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. You can specify the path of an OSS object in one of the following formats:

    1. oss://bucket/object
    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.
    		oss://bucket/object
    TemplateIdstringNo

    The template ID.

    		****20b48fb04483915d4f2cd8ac****
    JobParamsstringNo

    The algorithm-specific parameters. The parameters are specified as JSON objects and vary based on the algorithm. For more information, see the "Parameters of JobParams" section of this topic.

    		{"Model":"gif"}
    ScheduleConfigobjectNo

    The scheduling configuration.

    PipelineIdstringNo

    The ID of the ApsaraVideo Media Processing (MPS) queue.

    		5246b8d12a62433ab77845074039c3dc
    PriorityintegerNo

    The priority of the job. Valid values: 1 to 10. A smaller value indicates a higher priority.

    		6
    UserDatastringNo

    The user-defined data that is returned in the response. The value can be up to 1,024 bytes in length.

    		{"test":1}

    Parameters of JobParams

    Cover

    • Model: specifies the intelligent thumbnail model. The value is of the STRING type. If you leave this parameter empty, a still thumbnail is generated. If you set this parameter to gif, an animated thumbnail is generated.
    • LogoModel: specifies the type of a logo that you want to remove. The value is of the STRING type. Valid values: tv and internet. You can select multiple logo types and separate them with commas (,).
    • Boxes: specifies the position of a logo that you want to remove. The value is of the STRING type and is the normalized coordinate of the upper-left corner. You can set the value in the format of [xmin, ymin, width, height]. You can remove up to two logos at a time. Example: [[0, 0, 0.3, 0.3], [0.7, 0, 0.3, 0.3]].

    VideoDetext

    • LimitRegion: specifies the area within which you want to detect captions. The value is of the LIST type and is the normalized coordinate of the upper-left corner. You can set the value in the format of [xmin, ymin, width, height]. You can specify multiple coordinates at a time. Example: [[0, 0, 0.3, 0.3], [0.7, 0, 0.3, 0.3]]. Note: If you do not specify this parameter, the system detects the captions within the bottom 30% of the video image by default.
    • Time: specifies the time range within which captions are removed. The value is of the LIST type. You can set the value in the format of [start_time, end_time]. For example, a value of [5, 20] indicates that only the captions between the 5th and 20th seconds of the video are removed.

    CaptionExtraction

    • fps: specifies the sampling frame rate. This parameter is optional. The value is an integer. Valid values: [2,10]. Default value: 5.
    • roi: specifies the area of interest. If you specify this parameter, only the captions within the specified area are extracted. You can set the normalized value in the following format: [[top, bottom], [left, right]]. Example: [[0.5, 1], [0, 1]]. By default, if you do not specify this parameter, the captions within the bottom quarter of the video image are extracted.
    • lang: specifies the language to be detected. Valid values: ch, en, and ch_ml. Default value: ch.
    • track: specifies the captions that you want to extract. If you set this parameter to main, only the captions of the main track are extracted. If you do not specify this parameter, all captions in the specified area are extracted by default.

    VideoGreenScreenMatting

    • bgimage: specifies the background image for replacement. Example: http://example-image-****.example-location.aliyuncs.com/example/example.jpg. If you do not specify this parameter, a WebM video with alpha channels is returned.

    FaceBeauty

    VideoH2V

    None

    MusicSegmentDetect

    None

    AudioBeatDetection

    None

    AudioQualityAssessment

    None

    SpeechDenoise

    The input audio file must be in the WAV format with a sampling rate of 16,000 Hz or 48,000 Hz.

    AudioMixing

    • inputs: specifies the list of URLs of the audio track files to be mixed. You can specify only one URL. Example: {"file":"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/2.mp4"}.

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		C1849434-FC47-5DC1-92B6-F7EAAFE3851E
    JobIdstring

    The ID of the intelligent production job.

    		****20b48fb04483915d4f2cd8ac****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "C1849434-FC47-5DC1-92B6-F7EAAFE3851E",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-07-13Add OperationView Change Details