diff options
Diffstat (limited to 'data/en_us/mts/2014-06-18')
| -rw-r--r-- | data/en_us/mts/2014-06-18/api-docs.php | 25873 |
1 files changed, 25873 insertions, 0 deletions
diff --git a/data/en_us/mts/2014-06-18/api-docs.php b/data/en_us/mts/2014-06-18/api-docs.php new file mode 100644 index 0000000..60d8490 --- /dev/null +++ b/data/en_us/mts/2014-06-18/api-docs.php @@ -0,0 +1,25873 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Mts', + 'version' => '2014-06-18', + ], + 'directories' => [ + [ + 'id' => 122500, + 'title' => 'Media information analysis', + 'type' => 'directory', + 'children' => [ + 'SubmitMediaInfoJob', + 'QueryMediaInfoJobList', + ], + ], + [ + 'id' => 179157, + 'title' => 'Transcoding job management', + 'type' => 'directory', + 'children' => [ + 'SubmitJobs', + 'CancelJob', + 'QueryJobList', + 'ListJob', + ], + ], + [ + 'id' => 179156, + 'title' => 'Intelligent preset template recommendation', + 'type' => 'directory', + 'children' => [ + 'SubmitAnalysisJob', + 'QueryAnalysisJobList', + ], + ], + [ + 'id' => 122569, + 'title' => 'Custom transcoding template management', + 'type' => 'directory', + 'children' => [ + 'AddTemplate', + 'UpdateTemplate', + 'QueryTemplateList', + 'SearchTemplate', + 'DeleteTemplate', + ], + ], + [ + 'id' => 122563, + 'title' => 'Watermark template management', + 'type' => 'directory', + 'children' => [ + 'AddWaterMarkTemplate', + 'DeleteWaterMarkTemplate', + 'UpdateWaterMarkTemplate', + 'SearchWaterMarkTemplate', + 'QueryWaterMarkTemplateList', + ], + ], + [ + 'id' => 122553, + 'title' => 'Video snapshot job management', + 'type' => 'directory', + 'children' => [ + 'SubmitSnapshotJob', + 'QuerySnapshotJobList', + ], + ], + [ + 'id' => 122517, + 'title' => 'MPS queue management', + 'type' => 'directory', + 'children' => [ + 'UpdatePipeline', + 'QueryPipelineList', + 'SearchPipeline', + 'AddPipeline', + 'DeletePipeline', + ], + ], + [ + 'id' => 122542, + 'title' => 'Media workflow management', + 'type' => 'directory', + 'children' => [ + 'AddMediaWorkflow', + 'ActivateMediaWorkflow', + 'DeactivateMediaWorkflow', + 'DeleteMediaWorkflow', + 'UpdateMediaWorkflow', + 'QueryMediaWorkflowList', + 'SearchMediaWorkflow', + 'UpdateMediaWorkflowTriggerMode', + ], + ], + [ + 'id' => 179221, + 'title' => 'Media workflow execution instance management', + 'type' => 'directory', + 'children' => [ + 'QueryMediaWorkflowExecutionList', + 'ListMediaWorkflowExecutions', + ], + ], + [ + 'id' => 122587, + 'title' => 'Media bucket management', + 'type' => 'directory', + 'children' => [ + 'BindInputBucket', + 'BindOutputBucket', + 'UnbindInputBucket', + 'UnbindOutputBucket', + 'ListAllMediaBucket', + ], + ], + [ + 'id' => 179158, + 'title' => 'Media management', + 'type' => 'directory', + 'children' => [ + 'AddMedia', + 'DeleteMedia', + 'UpdateMedia', + 'UpdateMediaCategory', + 'UpdateMediaCover', + 'AddMediaTag', + 'DeleteMediaTag', + 'UpdateMediaPublishState', + 'QueryMediaList', + 'QueryMediaListByURL', + ], + ], + [ + 'id' => 179196, + 'title' => 'Smart production', + 'type' => 'directory', + 'children' => [ + 'QueryIProductionJob', + 'SubmitIProductionJob', + ], + ], + [ + 'id' => 122528, + 'title' => 'Smart Label Interface', + 'type' => 'directory', + 'children' => [ + 'SubmitSmarttagJob', + 'QuerySmarttagJob', + 'AddSmarttagTemplate', + 'QuerySmarttagTemplateList', + 'UpdateSmarttagTemplate', + 'DeleteSmarttagTemplate', + 'RegisterCustomFace', + 'UnregisterCustomFace', + 'TagCustomPerson', + 'ListCustomPersons', + 'CreateCustomGroup', + 'CreateCustomEntity', + 'RegisterCustomView', + 'DeleteCustomEntity', + 'DeleteCustomGroup', + 'DeleteCustomView', + 'ListCustomViews', + 'ListCustomEntities', + 'ListCustomGroups', + ], + ], + [ + 'id' => 122592, + 'title' => 'Media review', + 'type' => 'directory', + 'children' => [ + 'SubmitMediaCensorJob', + 'QueryMediaCensorJobDetail', + 'QueryMediaCensorJobList', + 'ImAudit', + ], + ], + [ + 'id' => 122493, + 'title' => 'Media fingerprint analysis', + 'type' => 'directory', + 'children' => [ + 'SubmitFpShotJob', + 'QueryFpShotJobList', + 'CreateFpShotDB', + 'ListFpShotDB', + 'ImportFpShotJob', + 'ListFpShotFiles', + 'SubmitFpFileDeleteJob', + 'QueryFpFileDeleteJobList', + 'SubmitFpDBDeleteJob', + 'QueryFpDBDeleteJobList', + 'ListFpShotImportJob', + ], + ], + [ + 'id' => 193954, + 'title' => 'digital watermark interface', + 'type' => 'directory', + 'children' => [ + 'SubmitCopyrightJob', + 'QueryCopyrightJob', + 'SubmitTraceAbJob', + 'QueryTraceAbJob', + 'SubmitTraceM3u8Job', + 'QueryTraceM3u8Job', + 'SubmitCopyrightExtractJob', + 'QueryCopyrightExtractJob', + 'SubmitTraceExtractJob', + 'QueryTraceExtractJob', + 'SubmitImageCopyright', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SubmitMediaInfoJob' => [ + 'summary' => 'Submits a media information analysis job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '23180', + 'abilityTreeNodes' => [ + 'FEATUREmtsZWMPKM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about the input media file. The value is a JSON string. You must perform the following operations to add the OSS bucket in which the input media file is stored as a media bucket: Log on to the **MPS console**, choose **Workflows** > **Media Buckets** in the left-side navigation pane, and then click **Add Bucket**. After you add the OSS bucket as a media bucket, you must perform URL encoding for the OSS object. For example, `{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Fexample.flv"}` indicates the `example-bucket.example-location.aliyuncs.com/example/example.flv` file.'."\n" + ."\n" + .'> The OSS bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Fexample.flv"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The custom data can contain letters, digits, and hyphens (-), and can be up to 1,024 bytes in length. The custom data cannot start with a special character.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testid-001', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue to which the job was submitted. For more information, see [Terms](~~29197~~).'."\n" + ."\n" + .'* To view the ID of the MPS queue, log on to the [MPS console](https://mps.console.aliyun.com/overview) and choose **Global Settings** > **MPS queue and Callback** in the left-side navigation pane. On the MPS queue and Callback page, you can view the ID of an MPS queue or create an MPS queue.'."\n" + .'* If you want to receive asynchronous message notifications, associate an MNS queue or topic with the MPS queue. For more information, see [Receive message notifications](https://www.alibabacloud.com/help/en/mps/receive-message-notifications/?spm=a2c63.p38356.0.0.b48576d2jxNSca).', + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e432bbf5b665e2a15****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the asynchronous mode for the job. We recommend that you set this parameter to true. Valid values:'."\n" + ."\n" + .'* **true**: enables the asynchronous mode.'."\n" + .'* **false**: does not enable the asynchronous mode.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaInfoJob' => [ + 'description' => 'The details of the media information analysis job.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'State' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n" + .'* **Analyzing**: The job is being run.'."\n", + 'type' => 'string', + 'example' => 'Analyzing', + ], + 'JobId' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '23ca1d184c0e4341e5b665e2a12****', + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.JsonObjectFormatInvalid', + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'The parameter ”*” does not conform to the JSON Object specification', + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue to which the analysis job is submitted.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e432bbf5b665e2a15****', + ], + 'Async' => [ + 'description' => 'Indicates whether the job is run in asynchronous mode.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Input' => [ + 'description' => 'The information about the input media file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input media file.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The region in which the OSS bucket that stores the input media file resides.'."\n", + 'type' => 'string', + 'example' => 'example-location', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input media file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by Message Service (MNS) to notify users of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message that is returned if the job is successful. This parameter is not returned if the job fails.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + 'ErrorMessage' => [ + 'description' => 'The error message that is returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.JsonObjectFormatInvalid', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The parameter \\"Input\\" does not conform to the JSON Object specification', + ], + ], + ], + 'Properties' => [ + 'description' => 'The properties of the input media file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => 'The width of the video. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'description' => 'The height of the video. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + 'Duration' => [ + 'description' => 'The duration of the input media file. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '17.226000', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Bitrate' => [ + 'description' => 'The bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1630.045', + ], + 'FileFormat' => [ + 'description' => 'The format of the input media file.'."\n", + 'type' => 'string', + 'example' => 'QuickTime/MOV', + ], + 'Streams' => [ + 'description' => 'The media streams that are contained in the input media file.'."\n", + 'type' => 'object', + 'properties' => [ + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The video streams. A media file can contain up to four video streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR).'."\n", + 'type' => 'string', + 'example' => '1:1', + ], + 'Height' => [ + 'description' => 'The height of the video. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'avc1', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth that is consumed.'."\n", + 'type' => 'object', + 'properties' => [ + 'PreloadTime' => [ + 'description' => 'The time consumed to preload the video.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'AvgBitrate' => [ + 'description' => 'The average bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '300.34', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that is consumed.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Width' => [ + 'description' => 'The width of the video. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '1920', + ], + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams. The sequence number of the first video stream to be played can be specified in some players. Default value: 1.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Timebase' => [ + 'description' => 'The time base.'."\n", + 'type' => 'string', + 'example' => '1/24000', + ], + 'AvgFPS' => [ + 'description' => 'The average frame rate.'."\n", + 'type' => 'string', + 'example' => '23.976025', + ], + 'PixFmt' => [ + 'description' => 'The pixel format.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Lang' => [ + 'description' => 'The language.'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Rotate' => [ + 'description' => 'The rotation angle of the video.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'Bitrate' => [ + 'description' => 'The bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1496.46', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). A value of 1 indicates that the video stream contains B-frames. A value of 0 indicates that the video stream does not contain B-frames.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Profile' => [ + 'description' => 'The codec profile.'."\n", + 'type' => 'string', + 'example' => 'High', + ], + 'StartTime' => [ + 'description' => 'The start time of the video stream.'."\n", + 'type' => 'string', + 'example' => '0.042000', + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR). DAR is the proportional relationship between the width and the height of a video. The value is used to determine whether the video is in portrait mode or landscape mode.'."\n", + 'type' => 'string', + 'example' => '16:9', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values:'."\n" + ."\n" + .'* **h264**'."\n" + .'* **h265**'."\n" + .'* **gif**'."\n" + .'* **webp**'."\n", + 'type' => 'string', + 'example' => 'h264', + ], + 'Duration' => [ + 'description' => 'The duration of the video stream. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '17.225542', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.'."\n", + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1001/48000', + ], + 'Level' => [ + 'description' => 'The codec level.'."\n", + 'type' => 'string', + 'example' => '41', + ], + 'ColorRange' => [ + 'description' => 'The color range.'."\n", + 'type' => 'string', + 'example' => '700', + ], + 'ColorTransfer' => [ + 'description' => 'The color channel.'."\n", + 'type' => 'string', + 'example' => 'R255 G83 B170', + ], + 'ColorPrimaries' => [ + 'description' => 'The level of color reconstruction.'."\n", + 'type' => 'string', + 'example' => '700', + ], + 'DurationInaccurate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The audio streams. A media file can contain up to four audio streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base.'."\n", + 'type' => 'string', + 'example' => '1/44100', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.'."\n", + 'type' => 'string', + 'example' => 'fltp', + ], + 'ChannelLayout' => [ + 'description' => 'The output layout of the sound channels.'."\n", + 'type' => 'string', + 'example' => 'stereo', + ], + 'Lang' => [ + 'description' => 'The language.'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate. Unit: Hz.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'Bitrate' => [ + 'description' => 'The bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '128.806', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'mp4a', + ], + 'StartTime' => [ + 'description' => 'The start time of the audio stream.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Default value: acc. Valid values:'."\n" + ."\n" + .'* **acc**'."\n" + .'* **mp3**'."\n" + .'* **mp4**'."\n" + .'* **ogg**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => 'The duration of the audio stream. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '17.159546', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.'."\n", + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/44100', + ], + 'DurationInaccurate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The subtitle streams. A media file can contain up to four subtitle streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base.'."\n", + 'type' => 'string', + 'example' => '1/1000', + ], + 'Index' => [ + 'description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'StartTime' => [ + 'description' => 'The start time of the subtitle stream.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values:'."\n" + ."\n" + .'* **srt**'."\n" + .'* **ass**'."\n", + 'type' => 'string', + 'example' => 'ass', + ], + 'Lang' => [ + 'description' => 'The language.'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'ASS (Advanced SSA) subtitle', + ], + 'Duration' => [ + 'description' => 'The duration of the audio stream. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '1370.116000', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.'."\n", + 'type' => 'string', + 'example' => '0x0000', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '0/1', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.'."\n", + 'type' => 'string', + 'example' => '[0][0][0][0]', + ], + ], + ], + ], + ], + ], + ], + ], + 'Format' => [ + 'description' => 'The format information.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Size' => [ + 'description' => 'The size of the file. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '3509895', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the container format.'."\n", + 'type' => 'string', + 'example' => 'QuickTime/MOV', + ], + 'Duration' => [ + 'description' => 'The duration of the input media file. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '17.226000', + ], + 'Bitrate' => [ + 'description' => 'The total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1630.045', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format. For more information about the parameters, see [Parameter details](~~29253~~).', + 'type' => 'string', + 'example' => 'mov', + ], + ], + ], + 'FileSize' => [ + 'description' => 'The size of the file. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '3509895', + ], + 'MD5' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '62D9BE16-B7D5-550C-A482-7A0F60E09877', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaInfoJob\\": {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"State\\": \\"Analyzing\\",\\n \\"JobId\\": \\"23ca1d184c0e4341e5b665e2a12****\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.JsonObjectFormatInvalid\\",\\n \\"Message\\": \\"The parameter ”*” does not conform to the JSON Object specification\\",\\n \\"PipelineId\\": \\"88c6ca184c0e432bbf5b665e2a15****\\",\\n \\"Async\\": true,\\n \\"Input\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"ErrorMessage\\": \\"InvalidParameter.JsonObjectFormatInvalid\\",\\n \\"ErrorCode\\": \\"The parameter \\\\\\\\\\\\\\"Input\\\\\\\\\\\\\\" does not conform to the JSON Object specification\\"\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Fps\\": \\"25\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FileFormat\\": \\"QuickTime/MOV\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"1080\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300.34\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Width\\": \\"1920\\",\\n \\"Index\\": \\"1\\",\\n \\"Timebase\\": \\"1/24000\\",\\n \\"AvgFPS\\": \\"23.976025\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Rotate\\": \\"90\\",\\n \\"Bitrate\\": \\"1496.46\\",\\n \\"HasBFrames\\": \\"0\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.042000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Duration\\": \\"17.225542\\",\\n \\"Fps\\": \\"25\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1001/48000\\",\\n \\"Level\\": \\"41\\",\\n \\"ColorRange\\": \\"700\\",\\n \\"ColorTransfer\\": \\"R255 G83 B170\\",\\n \\"ColorPrimaries\\": \\"700\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/44100\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Lang\\": \\"eng\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"123\\",\\n \\"Bitrate\\": \\"128.806\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"17.159546\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Timebase\\": \\"1/1000\\",\\n \\"Index\\": \\"3\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"ass\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"ASS (Advanced SSA) subtitle\\",\\n \\"Duration\\": \\"1370.116000\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"0/1\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"3509895\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"3509895\\",\\n \\"MD5\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"62D9BE16-B7D5-550C-A482-7A0F60E09877\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitMediaInfoJobResponse>\\n <MediaInfoJob>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <State>Analyzing</State>\\n <JobId>23ca1d184c0e4341e5b665e2a12****</JobId>\\n <UserData>testid-001</UserData>\\n <PipelineId>88c6ca184c0e432bbf5b665e2a15****</PipelineId>\\n <Async>true</Async>\\n <Input>\\n <Object>example.flv</Object>\\n <Location>example-location</Location>\\n <Bucket>example-bucket</Bucket>\\n </Input>\\n <MNSMessageResult>\\n <MessageId>16f01ad6175e4230ac42bb5182cd****</MessageId>\\n </MNSMessageResult>\\n <Properties>\\n <Width>1920</Width>\\n <Height>1080</Height>\\n <Duration>17.226000</Duration>\\n <Fps>25</Fps>\\n <Bitrate>1630.045</Bitrate>\\n <FileFormat>QuickTime/MOV</FileFormat>\\n <Streams>\\n <VideoStreamList>\\n <Sar>1:1</Sar>\\n <Height>1080</Height>\\n <CodecTagString>avc1</CodecTagString>\\n <NetworkCost>\\n <PreloadTime>8</PreloadTime>\\n <AvgBitrate>300.34</AvgBitrate>\\n <CostBandwidth>10</CostBandwidth>\\n </NetworkCost>\\n <Width>1920</Width>\\n <Index>1</Index>\\n <Timebase>1/24000</Timebase>\\n <AvgFPS>23.976025</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Lang>eng</Lang>\\n <CodecLongName>H.264/AVC/MPEG-4 AVC/MPEG-4 part 10</CodecLongName>\\n <NumFrames>100</NumFrames>\\n <Rotate>90</Rotate>\\n <Bitrate>1496.46</Bitrate>\\n <HasBFrames>0</HasBFrames>\\n <Profile>High</Profile>\\n <StartTime>0.042000</StartTime>\\n <Dar>16:9</Dar>\\n <CodecName>h264</CodecName>\\n <Duration>17.225542</Duration>\\n <Fps>25</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1001/48000</CodecTimeBase>\\n <Level>41</Level>\\n <ColorRange>700</ColorRange>\\n <ColorTransfer>R255 G83 B170</ColorTransfer>\\n <ColorPrimaries>700</ColorPrimaries>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/44100</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>stereo</ChannelLayout>\\n <Lang>eng</Lang>\\n <Samplerate>44100</Samplerate>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <Channels>2</Channels>\\n <NumFrames>123</NumFrames>\\n <Bitrate>128.806</Bitrate>\\n <CodecTagString>mp4a</CodecTagString>\\n <StartTime>0.000000</StartTime>\\n <CodecName>aac</CodecName>\\n <Duration>17.159546</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Timebase>1/1000</Timebase>\\n <Index>3</Index>\\n <StartTime>0.000000</StartTime>\\n <CodecName>ass</CodecName>\\n <Lang>eng</Lang>\\n <CodecLongName>ASS (Advanced SSA) subtitle</CodecLongName>\\n <Duration>1370.116000</Duration>\\n <CodecTag>0x0000</CodecTag>\\n <CodecTimeBase>0/1</CodecTimeBase>\\n <CodecTagString>[0][0][0][0]</CodecTagString>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>0.000000</StartTime>\\n <NumPrograms>0</NumPrograms>\\n <Size>3509895</Size>\\n <NumStreams>2</NumStreams>\\n <FormatLongName>QuickTime/MOV</FormatLongName>\\n <Duration>17.226000</Duration>\\n <Bitrate>1630.045</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n <FileSize>3509895</FileSize>\\n </Properties>\\n </MediaInfoJob>\\n <RequestId>62D9BE16-B7D5-550C-A482-7A0F60E09877</RequestId>\\n</SubmitMediaInfoJobResponse>","errorExample":""}]', + 'title' => 'SubmitMediaInfoJob', + 'description' => '* Before you submit a media information analysis job, make sure that the input file is uploaded to an Object Storage Service (OSS) bucket. Otherwise, the job fails. You can configure upload callbacks to be notified of the upload status of files.****'."\n" + .'* A media information analysis job can be run in synchronous or asynchronous mode.'."\n" + .'* In asynchronous mode, the media information analysis job is submitted to and scheduled in an ApsaraVideo Media Processing (MPS) queue. In this case, the media information analysis job may be queued. The media information analysis job may not be generated when the response to the SubmitMediaInfoJob operation is returned. After the execution is complete, you can call the [QueryMediaInfoJobList](~~602828~~) operation to poll the execution results, or associate a Message Service (MNS) queue or topic with the MPS queue to receive the execution results. For more information, see [Receive message notifications](https://www.alibabacloud.com/help/en/mps/receive-message-notifications/?spm=a2c63.p38356.0.0.b48576d2jxNSca).'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. If the number of requests that you send to call this operation within one second reaches the request limit of this operation, new requests fail and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMediaInfoJobList' => [ + 'summary' => 'Queries the results of media information analysis jobs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '23101', + 'abilityTreeNodes' => [ + 'FEATUREmtsZWMPKM', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'MediaInfoJobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the media information analysis jobs.'."\n" + ."\n" + .'* You can query up to 10 jobs at a time. Separate multiple IDs with commas (,).'."\n" + .'* You can obtain the details from the response parameters of the [SubmitMediaInfoJob](~~602827~~) operation.'."\n" + ."\n" + .'> If you do not specify the JobIds parameter, the **InvalidParameter** error code is returned.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '23ca1d184c0e4341e5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NonExistMediaInfoJobIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'Nonexistent media information analysis jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the media information analysis jobs that do not exist. If all specified jobs exist, the response does not contain this parameter.'."\n", + 'type' => 'string', + 'example' => '11ce1d184c0e4341e5b665e2a12****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '46A04AA5-B119-41BB-B750-7C5327AC3E7A', + ], + 'MediaInfoJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaInfoJob' => [ + 'description' => 'The details of each returned media information analysis job.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'State' => [ + 'description' => 'The status of the job.'."\n" + ."\n" + .'* **Analyzing**: The job is being run.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'JobId' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '23ca1d184c0e4341e5b665e2a12****', + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.JsonObjectFormatInvalid', + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'The parameter ”*” does not conform to the JSON Object specification', + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e432bbf5b665e2a15****', + ], + 'Async' => [ + 'description' => 'Indicates whether the job is in asynchronous mode.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the Object Storage Service (OSS) object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by MNS to notify you of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message returned if the job was successful. This parameter is not returned if the job fails.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The parameter \\"Input\\" does not conform to the JSON Object specification', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.JsonObjectFormatInvalid', + ], + ], + ], + 'Properties' => [ + 'description' => 'The information about the input file. For more information, see [AliyunProperties](~~29251~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => 'The width of the video. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'Height' => [ + 'description' => 'The height of the video. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Duration' => [ + 'description' => 'The duration of the media file.'."\n", + 'type' => 'string', + 'example' => '17.226000', + ], + 'Fps' => [ + 'description' => 'The frame rate of the media file.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the media file.'."\n", + 'type' => 'string', + 'example' => '1630.045', + ], + 'FileFormat' => [ + 'description' => 'The format of the input media file.'."\n", + 'type' => 'string', + 'example' => 'QuickTime/MOV', + ], + 'Streams' => [ + 'description' => 'The media streams that are contained in the input media file.'."\n", + 'type' => 'object', + 'properties' => [ + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The information about each video stream.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR).'."\n", + 'type' => 'string', + 'example' => '1:1', + ], + 'Height' => [ + 'description' => 'The height of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.'."\n", + 'type' => 'string', + 'example' => '[0][0][0][0]', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth that is consumed.'."\n", + 'type' => 'object', + 'properties' => [ + 'PreloadTime' => [ + 'description' => 'The time consumed to preload the video.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'AvgBitrate' => [ + 'description' => 'The average bitrate of the video stream.'."\n", + 'type' => 'string', + 'example' => '300.34', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that is consumed.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Width' => [ + 'description' => 'The width of the video in pixels.'."\n", + 'type' => 'string', + 'example' => '1920', + ], + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Timebase' => [ + 'description' => 'The time base.'."\n", + 'type' => 'string', + 'example' => '1/1000', + ], + 'AvgFPS' => [ + 'description' => 'The average frame rate.'."\n", + 'type' => 'string', + 'example' => '24000/1001', + ], + 'PixFmt' => [ + 'description' => 'The pixel format.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Lang' => [ + 'description' => 'The language.'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Rotate' => [ + 'description' => 'The rotation angle of the video.'."\n", + 'type' => 'string', + 'example' => '180', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the media file.'."\n", + 'type' => 'string', + 'example' => '30541090', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). A value of 1 indicates that the video stream contains B-frames. A value of 0 indicates that the video stream does not contain B-frames.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Profile' => [ + 'description' => 'The codec profile.'."\n", + 'type' => 'string', + 'example' => 'High', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.042000', + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR).'."\n", + 'type' => 'string', + 'example' => '16:9', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values:'."\n" + ."\n" + .'* **h264**'."\n" + .'* **h265**'."\n" + .'* **gif**'."\n" + .'* **webp**'."\n", + 'type' => 'string', + 'example' => 'h264', + ], + 'Duration' => [ + 'description' => 'The duration of the media file.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Fps' => [ + 'description' => 'The frame rate of the media file.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.'."\n", + 'type' => 'string', + 'example' => '0x0000', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1001/48000', + ], + 'Level' => [ + 'description' => 'The codec level.'."\n", + 'type' => 'string', + 'example' => '41', + ], + 'ColorRange' => [ + 'description' => 'The color range.'."\n", + 'type' => 'string', + 'example' => '700', + ], + 'ColorTransfer' => [ + 'description' => 'The color channel.'."\n", + 'type' => 'string', + 'example' => 'R255 G83 B170', + ], + 'ColorPrimaries' => [ + 'description' => 'The level of color reconstruction.'."\n", + 'type' => 'string', + 'example' => '700', + ], + 'DurationInaccurate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The information about each audio stream.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base.'."\n", + 'type' => 'string', + 'example' => '1/1000', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.'."\n", + 'type' => 'string', + 'example' => 'fltp', + ], + 'ChannelLayout' => [ + 'description' => 'The number of sound channels.'."\n", + 'type' => 'string', + 'example' => '5.1(side)', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html?spm=a2c4g.11186623.2.66.243851cd2SntfN#Metadata).'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n", + 'type' => 'string', + 'example' => '48000', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'DCA (DTS Coherent Acoustics)', + ], + 'Channels' => [ + 'description' => 'The output layout of the sound channels.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the media file.'."\n", + 'type' => 'string', + 'example' => '1536000', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.'."\n", + 'type' => 'string', + 'example' => '[0][0][0][0]', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.042000', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values:'."\n" + ."\n" + .'* **acc**'."\n" + .'* **mp3**'."\n" + .'* **mp4**'."\n" + .'* **ogg**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'acc', + ], + 'Duration' => [ + 'description' => 'The duration of the media file.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.'."\n", + 'type' => 'string', + 'example' => '0x0000', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/48000', + ], + 'DurationInaccurate' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The information about each subtitle stream.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base.'."\n", + 'type' => 'string', + 'example' => '1/1000', + ], + 'Index' => [ + 'description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values:'."\n" + ."\n" + .'* **srt**'."\n" + .'* **ass**'."\n", + 'type' => 'string', + 'example' => 'ass', + ], + 'Lang' => [ + 'description' => 'The language.'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.'."\n", + 'type' => 'string', + 'example' => 'ASS (Advanced SSA) subtitle', + ], + 'Duration' => [ + 'description' => 'The duration. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '1370.116000', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.'."\n", + 'type' => 'string', + 'example' => '0x0000', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '0/1', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.'."\n", + 'type' => 'string', + 'example' => '[0][0][0][0]', + ], + ], + ], + ], + ], + ], + ], + ], + 'Format' => [ + 'description' => 'The format information.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.042000', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Size' => [ + 'description' => 'The size of the image file.'."\n", + 'type' => 'string', + 'example' => '3509895', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the container format.'."\n", + 'type' => 'string', + 'example' => 'QuickTime/MOV', + ], + 'Duration' => [ + 'description' => 'The total duration.'."\n", + 'type' => 'string', + 'example' => '17.226000', + ], + 'Bitrate' => [ + 'description' => 'The total bitrate.'."\n", + 'type' => 'string', + 'example' => '1630.045', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format.'."\n", + 'type' => 'string', + 'example' => 'mov', + ], + ], + ], + 'FileSize' => [ + 'description' => 'The size of the image file.'."\n", + 'type' => 'string', + 'example' => '3509895', + ], + 'FileMd5' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistMediaInfoJobIds\\": {\\n \\"String\\": [\\n \\"11ce1d184c0e4341e5b665e2a12****\\"\\n ]\\n },\\n \\"RequestId\\": \\"46A04AA5-B119-41BB-B750-7C5327AC3E7A\\",\\n \\"MediaInfoJobList\\": {\\n \\"MediaInfoJob\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"State\\": \\"Success\\",\\n \\"JobId\\": \\"23ca1d184c0e4341e5b665e2a12****\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.JsonObjectFormatInvalid\\",\\n \\"Message\\": \\"The parameter ”*” does not conform to the JSON Object specification\\",\\n \\"PipelineId\\": \\"88c6ca184c0e432bbf5b665e2a15****\\",\\n \\"Async\\": true,\\n \\"Input\\": {\\n \\"Object\\": \\"example.mp4\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"123\\",\\n \\"ErrorMessage\\": \\"The parameter \\\\\\\\\\\\\\"Input\\\\\\\\\\\\\\" does not conform to the JSON Object specification\\",\\n \\"ErrorCode\\": \\"InvalidParameter.JsonObjectFormatInvalid\\"\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"1280\\",\\n \\"Height\\": \\"720\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Fps\\": \\"25\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FileFormat\\": \\"QuickTime/MOV\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"1080\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300.34\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Width\\": \\"1920\\",\\n \\"Index\\": \\"1\\",\\n \\"Timebase\\": \\"1/1000\\",\\n \\"AvgFPS\\": \\"23.976025\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Rotate\\": \\"180\\",\\n \\"Bitrate\\": \\"30541090\\",\\n \\"HasBFrames\\": \\"0\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.042000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Duration\\": \\"100\\",\\n \\"Fps\\": \\"25\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"1001/48000\\",\\n \\"Level\\": \\"41\\",\\n \\"ColorRange\\": \\"700\\",\\n \\"ColorTransfer\\": \\"R255 G83 B170\\",\\n \\"ColorPrimaries\\": \\"700\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/1000\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"5.1(side)\\",\\n \\"Lang\\": \\"eng\\",\\n \\"Samplerate\\": \\"48000\\",\\n \\"CodecLongName\\": \\"DCA (DTS Coherent Acoustics)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"123\\",\\n \\"Bitrate\\": \\"1536000\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"StartTime\\": \\"0.042000\\",\\n \\"CodecName\\": \\"acc\\",\\n \\"Duration\\": \\"123\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"1/48000\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Timebase\\": \\"1/1000\\",\\n \\"Index\\": \\"3\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"ass\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"ASS (Advanced SSA) subtitle\\",\\n \\"Duration\\": \\"1370.116000\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"0/1\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.042000\\",\\n \\"NumPrograms\\": \\"2\\",\\n \\"Size\\": \\"3509895\\",\\n \\"NumStreams\\": \\"1\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"3509895\\",\\n \\"FileMd5\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryMediaInfoJobListResponse>\\n <NonExistMediaInfoJobIds>11ce1d184c0e4341e5b665e2a12****</NonExistMediaInfoJobIds>\\n <RequestId>46A04AA5-B119-41BB-B750-7C5327AC3E7A</RequestId>\\n <MediaInfoJobList>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <State>Success</State>\\n <JobId>23ca1d184c0e4341e5b665e2a12****</JobId>\\n <UserData>testid-001</UserData>\\n <PipelineId>88c6ca184c0e432bbf5b665e2a15****</PipelineId>\\n <Async>true</Async>\\n <Input>\\n <Object>example.mp4</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </Input>\\n <MNSMessageResult>\\n <MessageId>123</MessageId>\\n </MNSMessageResult>\\n <Properties>\\n <Width>1280</Width>\\n <Height>720</Height>\\n <Duration>17.226000</Duration>\\n <Fps>25</Fps>\\n <Bitrate>1630.045</Bitrate>\\n <FileFormat>QuickTime/MOV</FileFormat>\\n <Streams>\\n <VideoStreamList>\\n <Sar>1:1</Sar>\\n <Height>1080</Height>\\n <CodecTagString>[0][0][0][0]</CodecTagString>\\n <NetworkCost>\\n <PreloadTime>8</PreloadTime>\\n <AvgBitrate>300.34</AvgBitrate>\\n <CostBandwidth>10</CostBandwidth>\\n </NetworkCost>\\n <Width>1920</Width>\\n <Index>1</Index>\\n <Timebase>1/1000</Timebase>\\n <AvgFPS>24000/1001</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Lang>eng</Lang>\\n <CodecLongName>H.264/AVC/MPEG-4 AVC/MPEG-4 part 10</CodecLongName>\\n <NumFrames>100</NumFrames>\\n <Rotate>180</Rotate>\\n <Bitrate>30541090</Bitrate>\\n <HasBFrames>0</HasBFrames>\\n <Profile>High</Profile>\\n <StartTime>0.042000</StartTime>\\n <Dar>16:9</Dar>\\n <CodecName>h264</CodecName>\\n <Duration>100</Duration>\\n <Fps>25</Fps>\\n <CodecTag>0x0000</CodecTag>\\n <CodecTimeBase>1001/48000</CodecTimeBase>\\n <Level>41</Level>\\n <ColorRange>700</ColorRange>\\n <ColorTransfer>R255 G83 B170</ColorTransfer>\\n <ColorPrimaries>700</ColorPrimaries>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/1000</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>5.1(side)</ChannelLayout>\\n <Lang>eng</Lang>\\n <Samplerate>48000</Samplerate>\\n <CodecLongName>DCA (DTS Coherent Acoustics)</CodecLongName>\\n <Channels>2</Channels>\\n <NumFrames>123</NumFrames>\\n <Bitrate>1536000</Bitrate>\\n <CodecTagString>[0][0][0][0]</CodecTagString>\\n <StartTime>0.042000</StartTime>\\n <CodecName>acc</CodecName>\\n <Duration>123</Duration>\\n <CodecTag>0x0000</CodecTag>\\n <CodecTimeBase>1/48000</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Timebase>1/1000</Timebase>\\n <Index>3</Index>\\n <StartTime>0.000000</StartTime>\\n <CodecName>ass</CodecName>\\n <Lang>eng</Lang>\\n <CodecLongName>ASS (Advanced SSA) subtitle</CodecLongName>\\n <Duration>1370.116000</Duration>\\n <CodecTag>0x0000</CodecTag>\\n <CodecTimeBase>0/1</CodecTimeBase>\\n <CodecTagString>[0][0][0][0]</CodecTagString>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>0.042000</StartTime>\\n <NumPrograms>2</NumPrograms>\\n <Size>3509895</Size>\\n <NumStreams>1</NumStreams>\\n <FormatLongName>QuickTime/MOV</FormatLongName>\\n <Duration>17.226000</Duration>\\n <Bitrate>1630.045</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n <FileSize>3509895</FileSize>\\n </Properties>\\n </MediaInfoJobList>\\n</QueryMediaInfoJobListResponse>","errorExample":""}]', + 'title' => 'QueryMediaInfoJobList', + 'description' => '* In asynchronous mode, the media information can be retrieved only after the Message Service (MNS) callback of **submitting a media information job** is returned. If you have not retrieved the media information for a long period, the job may have failed.'."\n" + .'* You can call this operation to query up to 10 media information analysis jobs at a time.'."\n" + .'* By default, returned jobs are sorted in descending order by CreationTime.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Callback parameters**'."\n" + ."\n" + .'When the status of the media information analysis job changes, MPS sends a message to the specified MNS queue. For more information about how to specify an MNS queue for receiving callbacks, see the [UpdatePipeline](~~188374~~) topic. The callback message is a JSON string that contains the parameters described in the following table.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Type": "MediaInfo",'."\n" + .' "State": "Success",'."\n" + .' "JobId": "bb558c1cc25b45309aab5be44d19****",'."\n" + .' "UserData": "{\\"key\\":\\"value\\"}",'."\n" + .' "RequestId": "B52658D4-07AB-43CD-82B0-210958A6****"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|Type|String|The value is fixed to MediaInfo, which indicates a media information analysis job.|'."\n" + .'|JobId|String|The unique ID of the job.|'."\n" + .'|State|String|The current status of the job. The value is the same as the value of the State parameter returned in the QueryMediaInfoJobList operation.|'."\n" + .'|UserData|String|The user data that was specified for the job in the SubmitMediaInfoJob operation.|', + 'extraInfo' => ' ', + ], + 'SubmitJobs' => [ + 'summary' => 'Submits transcoding jobs. If the transcoding jobs and workflows created in the ApsaraVideo Media Processing (MPS) console cannot meet your business requirements, you can call the SubmitJobs operation to submit transcoding jobs. Specify transcoding parameters as required when you call the SubmitJobs operation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '23174', + 'abilityTreeNodes' => [ + 'FEATUREmts0IG2Y5', + 'FEATUREmtsCLNI07', + 'FEATUREmtsG9UOE6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about the input file. For more information, see the "Input" section of the [Parameter details](~~29253~~) topic.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The path of an Object Storage Service (OSS) object must be URL-encoded in UTF-8 before you use the path in MPS.'."\n" + ."\n" + .'* The OSS bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a/b/c/test-cn.srt', + ], + ], + [ + 'name' => 'Outputs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job output configurations. For more information, see the "Output" section of the [Parameter details](~~29253~~) topic.'."\n" + ."\n" + .'* Specify the value in a JSON array of Output objects. You can specify up to 30 Output objects.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"OutputObject":"exampleOutput.mp4","TemplateId":"6181666213ab41b9bc21da8ff5ff****","WaterMarks":[{"InputFile":{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"image_01.png"},"WaterMarkTemplateId":"9b772ce2740d4d55876d8b542d47****"}],"UserData":"testid-001"}]', + ], + ], + [ + 'name' => 'OutputBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the OSS bucket that stores the output file.'."\n" + ."\n" + .'* For more information about the term bucket, see [Terms](~~31827~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exampleBucket', + ], + ], + [ + 'name' => 'OutputLocation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the OSS bucket that stores the output file resides.'."\n" + ."\n" + .'* The OSS bucket must reside in the same region as MPS.'."\n" + .'* For more information about the term bucket, see [Terms](~~31827~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss-cn-hangzhou', + 'default' => 'oss-cn-hangzhou', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue. For more information, see [Terms](~~31827~~).'."\n" + ."\n" + .'* To obtain the ID of an MPS queue, you can log on to the [MPS console](https://mps.console.aliyun.com/overview) and choose **Global Settings** > **MPS Queue and Callback** in the left-side navigation pane.'."\n" + .'* If you want to receive asynchronous message notifications, associate an MNS queue or topic with the MPS queue. For more information, see [Receive notifications](~~42618~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'dd3dae411e704030b921e52698e5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'JobResultList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'JobResult' => [ + 'description' => 'The transcoding jobs that are generated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code returned if the job failed to be created. This parameter is not returned if the job was created.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.NullValue', + ], + 'Job' => [ + 'description' => 'The details of the job. If the job fails to be submitted, no job ID is generated.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InternalError', + ], + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:20:00Z', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the job input is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the job input is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the job input.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + ], + ], + 'JobId' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by MNS to notify users of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated "%s" cannot be found.', + ], + 'MessageId' => [ + 'description' => 'The ID of the error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => '123', + ], + ], + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The operation has failed due to some unknown error, exception or failure.', + ], + 'Output' => [ + 'description' => 'The output of the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'AmixList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Amix' => [ + 'description' => 'The audio tracks that are mixed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AmixURL' => [ + 'description' => 'The URL of the audio track that is mixed as the background music.'."\n" + ."\n" + .'* The URL can be an OSS URL or the string `input`.'."\n" + .'* A value of input indicates that two audio tracks are mixed in a video.'."\n", + 'type' => 'string', + 'example' => 'https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3', + ], + 'Duration' => [ + 'description' => 'The duration of the mixed audio track. The value is in the number or time format.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'Map' => [ + 'description' => 'The audio track that is mixed. Format: 0:a:{audio_index}. Example: 0:a:0.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + 'MixDurMode' => [ + 'description' => 'The mode to specify the mixing duration. Valid values: **first** and **long**.'."\n" + ."\n" + .'* **first**: The length of the output media equals the length of the input media.'."\n" + .'* **long**: The length of the output media equals the length of the output media or the length of the input media, whichever is longer.'."\n" + .'* Default value: **long**.'."\n", + 'type' => 'string', + 'example' => 'long', + ], + 'Start' => [ + 'description' => 'The start time. The value is in the number or time format. Examples: 1:25:36.240 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'Audio' => [ + 'description' => 'The audio configurations.'."\n" + ."\n" + .'> If this parameter is specified in the request, the corresponding configurations in the specified transcoding template are overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '128', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n" + ."\n" + .'* If the value of Codec is mp3, the value of this parameter can only be **1** or **2**.'."\n" + .'* If the value of Codec is aac, the value of this parameter can only be **1**, **2**, **4**, **5**, **6**, or **8**.'."\n" + .'* Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'Codec' => [ + 'description' => 'The audio codec.'."\n" + ."\n" + .'* Valid values: **aac**, **mp3**, **vorbis**, and **flac**.'."\n" + .'* Default value: **aac**.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Profile' => [ + 'description' => 'The codec profile of the audio.'."\n" + ."\n" + .'> Valid values if the value of **Codec** is **aac**: **aac_low**, **aac_he**, **aac_he_v2**, **aac_ld**, and **aac_eld**.'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the audio.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Valid values: **22050**, **32000**, **44100**, **48000**, and **96000**.'."\n" + .'* Unit: Hz.'."\n" + .'* Default value: **44100**.'."\n" + ."\n" + .'> If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.'."\n", + 'type' => 'string', + 'example' => '32000', + ], + 'Volume' => [ + 'description' => 'The volume configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'description' => 'The volume adjustment range.'."\n" + ."\n" + .'* Unit: decibel.'."\n" + .'* Default value: **-20**.'."\n", + 'type' => 'string', + 'example' => '-20', + ], + 'Method' => [ + 'description' => 'The method that is used to adjust the volume. Valid values:'."\n" + ."\n" + .'* **auto**'."\n" + .'* **dynamic**'."\n" + .'* **linear**'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + ], + ], + ], + ], + 'AudioStreamMap' => [ + 'description' => 'The sequence number of the audio stream.'."\n" + ."\n" + .'* Format: 0:a:{Sequence number}. Example: 0:a:0.'."\n" + .'* The sequence number is the index of the audio stream in the list and starts from 0.'."\n" + .'* If no sequence number is specified, the default audio stream is used.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + 'Clip' => [ + 'description' => 'The information about the clip.'."\n", + 'type' => 'object', + 'properties' => [ + 'TimeSpan' => [ + 'description' => 'The time span of the clip.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The duration of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n", + 'type' => 'string', + 'example' => '01:00:59.999', + ], + 'Seek' => [ + 'description' => 'The start time.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n", + 'type' => 'string', + 'example' => '01:59:59.999', + ], + ], + ], + ], + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n" + ."\n" + .'* Default value: **mp4**.'."\n" + .'* Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).'."\n" + .'* Audio formats include MP3, MP4, Ogg, FLAC, and M4A.'."\n" + .'* Image formats include GIF and WebP.'."\n" + .'* If the container format is GIF, the video codec must be GIF.'."\n" + .'* If the container format is WebP, the video codec must be WebP.'."\n" + .'* If the container format is FLV, the video codec cannot be H.265.'."\n", + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + 'DeWatermark' => [ + 'description' => 'The configurations of watermark blurring. The value is a JSON object. For more information, see the **DeWatermark** section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'string', + 'example' => '{"0": [{"l": 10,"t": 10,"w": 10,"h": 10},{"l": 100,"t": 0.1,"w": 10,"h": 10}],"128000": [],"250000": [{"l": 0.2,"t": 0.1,"w": 0.01,"h": 0.05}]}', + ], + 'DigiWaterMark' => [ + 'description' => 'The digital watermarks.'."\n", + 'type' => 'object', + 'properties' => [ + 'Alpha' => [ + 'description' => 'The transparency of the text or image.'."\n" + ."\n" + .'* Value values: **(0,1]**.'."\n" + .'* Default value: **1.0**.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'InputFile' => [ + 'description' => 'The details of the input file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-intput.flv', + ], + ], + ], + 'Type' => [ + 'description' => 'The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Valid values:'."\n" + ."\n" + .'* **Image** (default)'."\n" + .'* **Text**'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + ], + ], + 'Encryption' => [ + 'description' => 'The encryption configurations. Only outputs in the M3U8 format are supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The encryption ID.'."\n", + 'type' => 'string', + 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', + ], + 'Key' => [ + 'description' => 'The key that is used to encrypt the video.'."\n", + 'type' => 'string', + 'example' => 'encryptionkey128', + ], + 'KeyType' => [ + 'description' => 'The key encryption method. Keys cannot be transmitted to MPS in plaintext. Keys must be encrypted by using Base64 or Key Management Service (KMS). For example, if the key is encryptionkey128, you can encrypt the key by using the following method: Base64("encryptionkey128") or KMS(Base64("encryptionkey128").'."\n", + 'type' => 'string', + 'example' => 'Base64', + ], + 'KeyUri' => [ + 'description' => 'The URL that is used to request the key. The URL is Base64-encoded.'."\n", + 'type' => 'string', + 'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/', + ], + 'SkipCnt' => [ + 'description' => 'The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'Type' => [ + 'description' => 'The encryption type. Only **hls-aes-128** may be returned.'."\n", + 'type' => 'string', + 'example' => 'hls-aes-128', + ], + ], + ], + 'M3U8NonStandardSupport' => [ + 'description' => 'The non-standard support configuration for M3U8. The value is a JSON object. For more information, see the **M3U8NonStandardSupport** section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'TS' => [ + 'description' => 'The non-standard support configurations for TS files. The value is a JSON object. For more information, see the **TS** section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'Md5Support' => [ + 'description' => 'Indicates whether the output of the MD5 value of the TS file is supported in the M3U8 video. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SizeSupport' => [ + 'description' => 'Indicates whether the size of the TS file is generated in the output M3U8 video. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'MergeConfigUrl' => [ + 'description' => 'The URL of the merging configuration file. Only one of **MergeList** and **MergeConfigUrl** takes effect.'."\n" + ."\n" + .'* The configuration file specified by MergeConfigUrl can contain up to 50 clips.'."\n" + .'* MergeConfigUrl indicates the URL of the configuration file for merging clips.'."\n" + .'* Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details about merging parameters.'."\n" + .'* Example of the content of the merging configuration file: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.'."\n", + 'type' => 'string', + 'example' => '`{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}', + ], + 'MergeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Merge' => [ + 'description' => 'The configurations for merging clips.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The duration of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '00000.20', + ], + 'MergeURL' => [ + 'description' => 'The OSS URL of the clip.'."\n" + ."\n" + .'* Example: `http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv`.'."\n" + .'* The OSS URL of the object must be URL-encoded by using the UTF-8 standard.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'Start' => [ + 'description' => 'The start point in time of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '00000.50', + ], + ], + ], + ], + ], + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations. If this parameter is specified in the request, the corresponding configurations in the specified transcoding template are overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gif' => [ + 'description' => 'The transmuxing configurations for GIF.'."\n", + 'type' => 'object', + 'properties' => [ + 'DitherMode' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: **sierra** and **bayer**.'."\n", + 'type' => 'string', + 'example' => 'bayer', + ], + 'FinalDelay' => [ + 'description' => 'The duration for which the final frame is paused. Unit: centisecond.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'Indicates whether a custom palette is used. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configuration. The value is a JSON object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The length of the segment. The value is an integer. Unit: seconds.'."\n" + ."\n" + .'* Valid values: **\\[1,10]**.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '20', + ], + ], + ], + 'Webp' => [ + 'description' => 'The transmuxing configurations for WebP.'."\n", + 'type' => 'object', + 'properties' => [ + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'OpeningList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Opening' => [ + 'description' => 'The opening parts. The value is a JSON object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Height' => [ + 'description' => 'The height of the opening part.'."\n" + ."\n" + .'* Valid values: values in the range of **(0,4096)**, **-1**, and **full**.'."\n" + .'* Default value: **-1**.'."\n" + .'* A value of **-1** indicates that the height of the source of the opening part is retained.'."\n" + .'* A value of **full** indicates that the height of the main part is used for the opening part.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + 'Start' => [ + 'description' => 'The amount of time after which the opening part is played. The value starts from 0.'."\n" + ."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Width' => [ + 'description' => 'The width of the opening part.'."\n" + ."\n" + .'* Valid values: values in the range of **(0,4096)**, **-1**, and **full**.'."\n" + .'* Default value: **-1**.'."\n" + .'* A value of **-1** indicates that the width of the source of the opening part is retained.'."\n" + .'* A value of **full** indicates that the width of the main part is used for the opening part.'."\n", + 'type' => 'string', + 'example' => '1920', + ], + 'openUrl' => [ + 'description' => 'The OSS URL of the opening part.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', + ], + ], + ], + ], + ], + ], + 'OutSubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OutSubtitle' => [ + 'description' => 'The output subtitles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'description' => 'The video track. Format: `0:{Stream}:{Stream sequence number}`, which is `0:v:{video_index}`. The value of Stream is v, which indicates a video stream. The sequence number is the index of the video stream in the list and starts from 0.'."\n", + 'type' => 'string', + 'example' => '0:v:0', + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed to be created. This parameter is not returned if the job was created.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter “%s” cannot be null.', + ], + 'OutSubtitleFile' => [ + 'description' => 'The details of the output file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the output file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the output file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'RoleArn' => [ + 'description' => 'The ARN of the RAM role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the job was created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'OutputFile' => [ + 'description' => 'The details of the output file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the output file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the output file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'RoleArn' => [ + 'description' => 'The ARN of the RAM role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + ], + ], + 'Priority' => [ + 'description' => 'The priority of the job in the MPS queue to which the job is added.'."\n" + ."\n" + .'* A value of **10** indicates the highest priority.'."\n" + .'* Default value: **6**.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Properties' => [ + 'description' => 'The media properties.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => 'The bitrate of the video.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'Duration' => [ + 'description' => 'The duration of the video.'."\n", + 'type' => 'string', + 'example' => '55', + ], + 'FileFormat' => [ + 'description' => 'The format of the video.'."\n", + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'FileSize' => [ + 'description' => 'The size of the file.'."\n", + 'type' => 'string', + 'example' => '3509895', + ], + 'Format' => [ + 'description' => 'The format information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => 'The total bitrate.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'Duration' => [ + 'description' => 'The total duration.'."\n", + 'type' => 'string', + 'example' => '55', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the container format.'."\n", + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'type' => 'string', + 'example' => 'mov', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Size' => [ + 'description' => 'The size of the file.'."\n", + 'type' => 'string', + 'example' => '3509895', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + ], + ], + 'Fps' => [ + 'description' => 'The frame rate of the video. The value is a number.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Streams' => [ + 'description' => 'The stream information.'."\n", + 'type' => 'object', + 'properties' => [ + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The audio streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => 'The bitrate of the audio stream.'."\n", + 'type' => 'string', + 'example' => '128.806', + ], + 'ChannelLayout' => [ + 'description' => 'The output layout of the sound channels.'."\n", + 'type' => 'string', + 'example' => 'stereo', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the codec.'."\n", + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecName' => [ + 'description' => 'The short name of the codec.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecTag' => [ + 'description' => 'The tag of the codec.'."\n", + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the codec.'."\n", + 'type' => 'string', + 'example' => 'mp4a', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/44100', + ], + 'Duration' => [ + 'description' => 'The duration of the audio stream.'."\n", + 'type' => 'string', + 'example' => '17.159546', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Lang' => [ + 'description' => 'The language of the audio stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.'."\n", + 'type' => 'string', + 'example' => 'fltp', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate of the audio stream.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'StartTime' => [ + 'description' => 'The start time of the audio stream.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'Timebase' => [ + 'description' => 'The time base of the audio stream.'."\n", + 'type' => 'string', + 'example' => '1/44100', + ], + ], + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The subtitle streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Lang' => [ + 'description' => 'The language of the subtitle stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + ], + ], + ], + ], + ], + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The video streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AvgFPS' => [ + 'description' => 'The average frame rate of the video stream.'."\n", + 'type' => 'string', + 'example' => '23.976025', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the video stream.'."\n", + 'type' => 'string', + 'example' => '1496.46', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the codec.'."\n", + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'CodecName' => [ + 'description' => 'The short name of the codec.'."\n", + 'type' => 'string', + 'example' => 'h264', + ], + 'CodecTag' => [ + 'description' => 'The tag of the codec.'."\n", + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the codec.'."\n", + 'type' => 'string', + 'example' => 'avc1', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1001/48000', + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR) of the video stream.'."\n", + 'type' => 'string', + 'example' => '16:9', + ], + 'Duration' => [ + 'description' => 'The duration of the video stream.'."\n", + 'type' => 'string', + 'example' => '17.225542', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video stream.'."\n", + 'type' => 'string', + 'example' => '23.976025', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains B-frames.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Height' => [ + 'description' => 'The height of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Lang' => [ + 'description' => 'The language of the video stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'Level' => [ + 'description' => 'The codec level.'."\n", + 'type' => 'string', + 'example' => '51', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth that was consumed.'."\n", + 'type' => 'object', + 'properties' => [ + 'AvgBitrate' => [ + 'description' => 'The average bitrate of the video stream.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that was consumed.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'PreloadTime' => [ + 'description' => 'The amount of time consumed to preload the video stream.'."\n", + 'type' => 'string', + 'example' => '8', + ], + ], + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video stream.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Profile' => [ + 'description' => 'The codec profile.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR) of the video stream.'."\n", + 'type' => 'string', + 'example' => '1:1', + ], + 'StartTime' => [ + 'description' => 'The start time of the video stream.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'Timebase' => [ + 'description' => 'The time base of the video stream.'."\n", + 'type' => 'string', + 'example' => '1/24000', + ], + 'Width' => [ + 'description' => 'The width of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + ], + ], + ], + ], + ], + ], + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + ], + ], + 'Rotate' => [ + 'description' => 'The rotation angle of the video, in the clockwise direction.'."\n", + 'type' => 'string', + 'example' => '180', + ], + 'SubtitleConfig' => [ + 'description' => 'The subtitle configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtSubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExtSubtitle' => [ + 'description' => 'The external subtitles. The value is a JSON array that contains up to **four** objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CharEnc' => [ + 'description' => 'The character set used by the external subtitle.'."\n" + ."\n" + .'* Valid values: **UTF-8**, **GBK**, **BIG5**, and **auto**.'."\n" + .'* Default value: **auto**.'."\n" + ."\n" + .'> If this parameter is set to **auto**, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.'."\n", + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'FontName' => [ + 'description' => 'The font of the hardcoded subtitles converted from external subtitles. Default value: **SimSun**. For more information, see [Fonts](~~59950~~).'."\n", + 'type' => 'string', + 'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"', + ], + 'Input' => [ + 'description' => 'The OSS object that is used as the external subtitle. The value is a JSON object. Files in the **SRT** or **ASS** format are supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + ], + ], + ], + ], + ], + ], + ], + 'SubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Subtitle' => [ + 'description' => 'The subtitles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'description' => 'The audio track. Format: `0:{Stream}:{Stream sequence number}`, which is `0:a:{audio_index}`. The value of Stream is a, which indicates an audio stream. The sequence number is the index of the audio stream in the list and starts from 0.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + ], + ], + ], + ], + ], + ], + ], + 'SuperReso' => [ + 'description' => 'The configurations for using the resolution of the source video.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsHalfSample' => [ + 'description' => 'Indicates whether parameters related to the sampling rate are obtained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'TailSlateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TailSlate' => [ + 'description' => 'The ending parts. The value is a JSON object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BgColor' => [ + 'description' => 'The color of the bars that are added to the ending part if the size of the ending part is smaller than that of the main part. Default value: **White**. For more information, see [Background colors](https://docs-aliyun.cn-hangzhou.oss.aliyun-inc.com/assets/attach/29253/cn_zh/1502784952344/color.txt?spm=a2c4g.11186623.2.63.241240f77qp3Yy\\&file=color.txt).'."\n", + 'type' => 'string', + 'example' => 'White', + ], + 'BlendDuration' => [ + 'description' => 'The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Height' => [ + 'description' => 'The height of the ending part.'."\n" + ."\n" + .'* Valid values: values in the range of **(0,4096)**, **-1**, and **full**.'."\n" + .'* A value of **-1** indicates that the height of the source of the ending part is retained. A value of **full** indicates that the height of the main part is used for the ending part.'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + 'IsMergeAudio' => [ + 'description' => 'Indicates whether the audio content of the ending part is merged. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Start' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'TailUrl' => [ + 'description' => 'The OSS URL of the ending part.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', + ], + 'Width' => [ + 'description' => 'The width of the ending part.'."\n" + ."\n" + .'* Valid values: values in the range of **(0,4096)**, **-1**, and **full**.'."\n" + .'* A value of **-1** indicates that the width of the source of the ending part is retained. A value of **full** indicates that the width of the main part is used for the ending part.'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '1920', + ], + ], + ], + ], + ], + ], + 'TemplateId' => [ + 'description' => 'The ID of the transcoding template.'."\n", + 'type' => 'string', + 'example' => 'S00000000-000010', + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations.'."\n" + ."\n" + .'> If this parameter is specified in the request, the corresponding parameter in the specified transcoding template are overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'AdjDarMethod' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" + ."\n" + .'* rescale: The video image is resized.'."\n" + .'* crop: The video image is cropped.'."\n" + .'* pad: The video image is scaled out to fill the view.'."\n" + .'* none: The resolution is not adjusted.'."\n", + 'type' => 'string', + 'example' => 'crop', + ], + 'IsCheckAudioBitrate' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + ."\n" + .'* **false**'."\n" + ."\n" + .'* Default value:'."\n" + ."\n" + .' * If this parameter is empty and the codec of the output audio is different from the codec of the input audio, the default value is false.'."\n" + .' * If this parameter is empty and the codec of the output audio is the same as the codec of the input audio, the default value is true.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'Indicates whether the audio bitrate is checked. This parameter has a higher priority than **IsCheckAudioBitrate**. If the bitrate of the output audio is higher than that of the input audio, a transcoding failure is returned without transcoding the audio. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the resolution is checked. This parameter has a higher priority than IsCheckReso. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned without transcoding the video. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, a transcoding failure is returned without transcoding the video. This parameter has a higher priority than**IsCheckVideoBitrate**. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'TransMode' => [ + 'description' => 'The transcoding mode. Valid values:'."\n" + ."\n" + .'* **onepass**: transcoding based on one-pass algorithms, which has higher accuracy.'."\n" + .'* **twopass**: transcoding based on two-pass algorithms, which has lower accuracy.'."\n" + .'* **CBR**: transcoding based on a fixed bitrate.'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + ], + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'example data', + ], + 'Video' => [ + 'description' => 'The video configurations.'."\n" + ."\n" + .'> If this parameter is specified, **AliyunVideoCodec** in the template specified by **TemplateId** is overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => 'The bitrate of the output video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'BitrateBnd' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'Min' => [ + 'description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Bufsize' => [ + 'description' => 'The size of the buffer.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'Codec' => [ + 'description' => 'The video codec.'."\n" + ."\n" + .'* Valid values: **H.264**, **H.265**, **GIF**, and **WEBP**.'."\n" + .'* Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Crf' => [ + 'description' => 'The constant rate factor.'."\n" + ."\n" + .'* If **Crf** is returned, the value of **Bitrate** is invalid.'."\n" + .'* Default value if the value of Codec is H.264: **23**. Default value if the value of Codec is H.265: **26**.'."\n", + 'type' => 'string', + 'example' => '22', + ], + 'Crop' => [ + 'description' => 'The method of video cropping. Valid values:'."\n" + ."\n" + .'* **border**: Black borders are automatically detected and removed.'."\n" + .'* A value in the format of width:height:left:top: The video is cropped based on the custom settings.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Degrain' => [ + 'description' => 'The strength of the independent noise reduction algorithm.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n" + ."\n" + .'* Unit: frames per second.'."\n" + .'* Valid values: 0 to 60. The value is 60 if the frame rate of the input file exceeds 60.'."\n" + .'* Default value: the frame rate of the input file.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Gop' => [ + 'description' => 'The maximum interval between keyframes or the maximum number of frames in a frame group. Unit: seconds.'."\n" + ."\n" + .'* Default value: 10.'."\n" + .'* If the maximum number of frames is returned, the value does not have a unit.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the height of the input video.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'MaxFps' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Pad' => [ + 'description' => 'The black borders that are added to the video.'."\n" + ."\n" + .'* The value is in the width:height:left:top format.'."\n" + .'* Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video.'."\n" + ."\n" + .'* The default pixel format can be **yuv420p** or the pixel format of the input file.'."\n" + ."\n" + .'* Valid values: standard pixel formats such as **yuv420p** and **yuvj420p**.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If a non-standard pixel format such as yuvj420p(pc, bt470bg/bt470bg/smpte170m) is used, compatibility with the pixel format must be configured. Otherwise, the transcoding job fails.'."\n", + 'type' => 'string', + 'example' => 'yuvj420p', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" + ."\n" + .'* **veryfast**'."\n" + .'* **fast**'."\n" + .'* **medium**'."\n" + .'* **slow**'."\n" + .'* **slower**'."\n", + 'type' => 'string', + 'example' => 'veryfast', + ], + 'Profile' => [ + 'description' => 'The encoding profile. This parameter is returned only for the H.264 codec. Default value: **high**. Valid values:'."\n" + ."\n" + .'> If multiple definitions are involved, we recommend that you use baseline for the lowest definition to ensure normal playback on low-definition devices, and use main or high for other definitions.'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n", + 'type' => 'string', + 'example' => 'baseline', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'ResoPriority' => [ + 'description' => 'The priority of the resource.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* If this parameter is **empty**, the scan mode of the input file is used.'."\n" + .'* **auto**: automatic deinterlacing.'."\n" + .'* **progressive**: progressive scan.'."\n" + .'* **interlaced**: interlaced scan.'."\n" + .'* **By default**, this parameter is empty.'."\n" + ."\n" + .'**Best practice**: Interlaced scan consumes less bandwidth than progressive scan, but the image quality is poor. Therefore, mainstream video production uses progressive scan.'."\n" + ."\n" + .'* If **progressive scan** or **interlaced scan** is used when the scan mode of the input file is neither of them, the transcoding job fails.'."\n" + .'* We recommend that you use **the scan mode of the input file** or **automatic deinterlacing** to improve compatibility.'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the width of the input video**.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + ], + ], + 'VideoStreamMap' => [ + 'description' => 'The sequence number of the video stream.'."\n" + ."\n" + .'* Format: 0:a:{Sequence number}. Example: 0:a:0.'."\n" + .'* The sequence number is the index of the video stream in the list and starts from 0.'."\n" + .'* If no sequence number is specified, the default video stream is used.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + 'WaterMarkConfigUrl' => [ + 'description' => 'The URL of the watermark configuration file.'."\n", + 'type' => 'string', + 'example' => 'http://example.com/configure', + ], + 'WaterMarkList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WaterMark' => [ + 'description' => 'The watermarks.'."\n" + ."\n" + .'> If watermarks are truncated or fail to be generated, check whether the text watermarks that you add contain special characters. If the text watermarks contain special characters, you must escape the special characters before you add the watermarks. Alternatively, you can [submit a ticket](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.dticket.68797bbcm8H408#/ticket/add/?productId=1232) to contact Alibaba Cloud customer service for compatibility processing.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Dx' => [ + 'description' => 'The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the horizontal offset.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution.'."\n" + ."\n" + .' * Valid values: (0,1).'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Dy' => [ + 'description' => 'The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the vertical offset.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the vertical offset to the height in the output video resolution.'."\n" + ."\n" + .' * Valid values: **(0,1)**.'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Height' => [ + 'description' => 'The height of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the watermark height.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the watermark height to the height in the output video resolution.'."\n" + ."\n" + .' * Valid values: **(0,1)**.'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'InputFile' => [ + 'description' => 'The watermark input file. PNG images and MOV files are supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-logo-****.png', + ], + ], + ], + 'ReferPos' => [ + 'description' => 'The position of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Valid values:'."\n" + ."\n" + .'* **TopRight**'."\n" + .'* **TopLeft**'."\n" + .'* **BottomRight**'."\n" + .'* **BottomLeft**'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'Type' => [ + 'description' => 'The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see [Parameter details](~~29253~~). Valid values:'."\n" + ."\n" + .'* **Image**'."\n" + .'* **Text**'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'WaterMarkTemplateId' => [ + 'description' => 'The ID of the watermark template.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the watermark width.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the watermark width to the width in the output video resolution.'."\n" + ."\n" + .' * Valid values: **(0,1)**.'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + ], + ], + ], + ], + ], + ], + ], + 'Percent' => [ + 'description' => 'The transcoding progress.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a126797', + ], + 'State' => [ + 'description' => 'The state of the job. Valid values:'."\n" + ."\n" + .'* **Submitted**'."\n" + .'* **TranscodeFail**'."\n", + 'type' => 'string', + 'example' => 'Submitted', + ], + ], + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed to be created. This parameter is not returned if the job was created.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter "%s" cannot be null.', + ], + 'Success' => [ + 'description' => 'Indicates whether the job was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A45S71F6-D73936451234', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobResultList\\": {\\n \\"JobResult\\": [\\n {\\n \\"Code\\": \\"InvalidParameter.NullValue\\",\\n \\"Job\\": {\\n \\"Code\\": \\"InternalError\\",\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"FinishTime\\": \\"2014-01-10T12:20:00Z\\",\\n \\"Input\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example.flv\\"\\n },\\n \\"JobId\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"MNSMessageResult\\": {\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"ErrorMessage\\": \\"The resource operated \\\\\\"%s\\\\\\" cannot be found.\\",\\n \\"MessageId\\": \\"123\\"\\n },\\n \\"Message\\": \\"The operation has failed due to some unknown error, exception or failure.\\",\\n \\"Output\\": {\\n \\"AmixList\\": {\\n \\"Amix\\": [\\n {\\n \\"AmixURL\\": \\"https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3\\",\\n \\"Duration\\": \\"20\\",\\n \\"Map\\": \\"0:a:0\\",\\n \\"MixDurMode\\": \\"long\\",\\n \\"Start\\": \\"0\\"\\n }\\n ]\\n },\\n \\"Audio\\": {\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"6\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"Volume\\": {\\n \\"Level\\": \\"-20\\",\\n \\"Method\\": \\"auto\\"\\n }\\n },\\n \\"AudioStreamMap\\": \\"0:a:0\\",\\n \\"Clip\\": {\\n \\"TimeSpan\\": {\\n \\"Duration\\": \\"01:00:59.999\\",\\n \\"Seek\\": \\"01:59:59.999\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n },\\n \\"DeWatermark\\": \\"{\\\\\\"0\\\\\\": [{\\\\\\"l\\\\\\": 10,\\\\\\"t\\\\\\": 10,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10},{\\\\\\"l\\\\\\": 100,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10}],\\\\\\"128000\\\\\\": [],\\\\\\"250000\\\\\\": [{\\\\\\"l\\\\\\": 0.2,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 0.01,\\\\\\"h\\\\\\": 0.05}]}\\",\\n \\"DigiWaterMark\\": {\\n \\"Alpha\\": \\"1.0\\",\\n \\"InputFile\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-intput.flv\\"\\n },\\n \\"Type\\": \\"Image\\"\\n },\\n \\"Encryption\\": {\\n \\"Id\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"Key\\": \\"encryptionkey128\\",\\n \\"KeyType\\": \\"Base64\\",\\n \\"KeyUri\\": \\"https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/\\",\\n \\"SkipCnt\\": \\"3\\",\\n \\"Type\\": \\"hls-aes-128\\"\\n },\\n \\"M3U8NonStandardSupport\\": {\\n \\"TS\\": {\\n \\"Md5Support\\": true,\\n \\"SizeSupport\\": true\\n }\\n },\\n \\"MergeConfigUrl\\": \\"`{\\\\\\"MergeList\\\\\\":[{\\\\\\"MergeURL\\\\\\":\\\\\\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\\\\\\"}]}\\",\\n \\"MergeList\\": {\\n \\"Merge\\": [\\n {\\n \\"Duration\\": \\"00000.20\\",\\n \\"MergeURL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv\\",\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"Start\\": \\"00000.50\\"\\n }\\n ]\\n },\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"DitherMode\\": \\"bayer\\",\\n \\"FinalDelay\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\",\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"20\\"\\n },\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n }\\n },\\n \\"OpeningList\\": {\\n \\"Opening\\": [\\n {\\n \\"Height\\": \\"1080\\",\\n \\"Start\\": \\"1\\",\\n \\"Width\\": \\"1920\\",\\n \\"openUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\"\\n }\\n ]\\n },\\n \\"OutSubtitleList\\": {\\n \\"OutSubtitle\\": [\\n {\\n \\"Map\\": \\"0:v:0\\",\\n \\"Message\\": \\"The specified parameter “%s” cannot be null.\\",\\n \\"OutSubtitleFile\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\"\\n },\\n \\"Success\\": true\\n }\\n ]\\n },\\n \\"OutputFile\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\"\\n },\\n \\"Priority\\": \\"5\\",\\n \\"Properties\\": {\\n \\"Bitrate\\": \\"1000\\",\\n \\"Duration\\": \\"55\\",\\n \\"FileFormat\\": \\"QuickTime / MOV\\",\\n \\"FileSize\\": \\"3509895\\",\\n \\"Format\\": {\\n \\"Bitrate\\": \\"1000\\",\\n \\"Duration\\": \\"55\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"FormatName\\": \\"mov\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"Size\\": \\"3509895\\",\\n \\"StartTime\\": \\"0.000000\\"\\n },\\n \\"Fps\\": \\"25\\",\\n \\"Height\\": \\"720\\",\\n \\"Streams\\": {\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Bitrate\\": \\"128.806\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Channels\\": \\"2\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"Duration\\": \\"17.159546\\",\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"eng\\",\\n \\"NumFrames\\": \\"25\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Timebase\\": \\"1/44100\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"eng\\"\\n }\\n ]\\n },\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"AvgFPS\\": \\"23.976025\\",\\n \\"Bitrate\\": \\"1496.46\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTimeBase\\": \\"1001/48000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Duration\\": \\"17.225542\\",\\n \\"Fps\\": \\"23.976025\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Height\\": \\"720\\",\\n \\"Index\\": \\"0\\",\\n \\"Lang\\": \\"eng\\",\\n \\"Level\\": \\"51\\",\\n \\"NetworkCost\\": {\\n \\"AvgBitrate\\": \\"100\\",\\n \\"CostBandwidth\\": \\"10\\",\\n \\"PreloadTime\\": \\"8\\"\\n },\\n \\"NumFrames\\": \\"25\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Profile\\": \\"high\\",\\n \\"Sar\\": \\"1:1\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Timebase\\": \\"1/24000\\",\\n \\"Width\\": \\"1280\\"\\n }\\n ]\\n }\\n },\\n \\"Width\\": \\"1280\\"\\n },\\n \\"Rotate\\": \\"180\\",\\n \\"SubtitleConfig\\": {\\n \\"ExtSubtitleList\\": {\\n \\"ExtSubtitle\\": [\\n {\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"FontName\\": \\"\\\\\\"WenQuanYi Zen Hei\\\\\\", \\\\\\"Yuanti SC Regular\\\\\\", \\\\\\"SimSun\\\\\\"\\",\\n \\"Input\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-output.flv\\"\\n }\\n }\\n ]\\n },\\n \\"SubtitleList\\": {\\n \\"Subtitle\\": [\\n {\\n \\"Map\\": \\"0:a:0\\"\\n }\\n ]\\n }\\n },\\n \\"SuperReso\\": {\\n \\"IsHalfSample\\": \\"true\\"\\n },\\n \\"TailSlateList\\": {\\n \\"TailSlate\\": [\\n {\\n \\"BgColor\\": \\"White\\",\\n \\"BlendDuration\\": \\"2\\",\\n \\"Height\\": \\"1080\\",\\n \\"IsMergeAudio\\": false,\\n \\"Start\\": \\"1\\",\\n \\"TailUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\",\\n \\"Width\\": \\"1920\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"S00000000-000010\\",\\n \\"TransConfig\\": {\\n \\"AdjDarMethod\\": \\"crop\\",\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"TransMode\\": \\"onepass\\"\\n },\\n \\"UserData\\": \\"example data\\",\\n \\"Video\\": {\\n \\"Bitrate\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"20\\",\\n \\"Min\\": \\"10\\"\\n },\\n \\"Bufsize\\": \\"1000\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Crf\\": \\"22\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Degrain\\": \\"5\\",\\n \\"Fps\\": \\"60\\",\\n \\"Gop\\": \\"1\\",\\n \\"Height\\": \\"1280\\",\\n \\"MaxFps\\": \\"15\\",\\n \\"Maxrate\\": \\"10\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"PixFmt\\": \\"yuvj420p\\",\\n \\"Preset\\": \\"veryfast\\",\\n \\"Profile\\": \\"baseline\\",\\n \\"Qscale\\": \\"15\\",\\n \\"ResoPriority\\": \\"1\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"Width\\": \\"1080\\"\\n },\\n \\"VideoStreamMap\\": \\"0:a:0\\",\\n \\"WaterMarkConfigUrl\\": \\"http://example.com/configure\\",\\n \\"WaterMarkList\\": {\\n \\"WaterMark\\": [\\n {\\n \\"Dx\\": \\"1\\",\\n \\"Dy\\": \\"1\\",\\n \\"Height\\": \\"1280\\",\\n \\"InputFile\\": {\\n \\"Bucket\\": \\"example-bucket\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-logo-****.png\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"Type\\": \\"Image\\",\\n \\"WaterMarkTemplateId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Width\\": \\"1080\\"\\n }\\n ]\\n }\\n },\\n \\"Percent\\": 100,\\n \\"PipelineId\\": \\"88c6ca184c0e47098a5b665e2a126797\\",\\n \\"State\\": \\"Submitted\\"\\n },\\n \\"Message\\": \\"The specified parameter \\\\\\"%s\\\\\\" cannot be null.\\",\\n \\"Success\\": true\\n }\\n ]\\n },\\n \\"RequestId\\": \\"25818875-5F78-4A45S71F6-D73936451234\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitJobsResponse>\\n <JobResultList>\\n <Job>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <Percent>100</Percent>\\n <FinishTime>2014-01-10T12:20:00Z</FinishTime>\\n <State>Submitted</State>\\n <JobId>31fa3c9ca8134f9cec2b4b0b0f78****</JobId>\\n <Code>InternalError</Code>\\n <Message>The operation has failed due to some unknown error, exception or failure.</Message>\\n <Output>\\n <Video>\\n <Bufsize>1000</Bufsize>\\n <Degrain>5</Degrain>\\n <BitrateBnd>\\n <Max>20</Max>\\n <Min>10</Min>\\n </BitrateBnd>\\n <PixFmt>yuvj420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>1280</Height>\\n <Qscale>15</Qscale>\\n <Crop>1280:800:0:140</Crop>\\n <Bitrate>10</Bitrate>\\n <Maxrate>10</Maxrate>\\n <MaxFps>15</MaxFps>\\n <Profile>baseline</Profile>\\n <Crf>22</Crf>\\n <Gop>1</Gop>\\n <Width>1080</Width>\\n <Fps>60</Fps>\\n <Preset>veryfast</Preset>\\n <ScanMode>interlaced</ScanMode>\\n <ResoPriority>1</ResoPriority>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>false</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>false</IsCheckReso>\\n <IsCheckVideoBitrateFail>true</IsCheckVideoBitrateFail>\\n <AdjDarMethod>crop</AdjDarMethod>\\n <IsCheckVideoBitrate>false</IsCheckVideoBitrate>\\n <IsCheckResoFail>false</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>true</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <Encryption>\\n <Type>hls-aes-128</Type>\\n <Key>encryptionkey128</Key>\\n <KeyType>Base64</KeyType>\\n <Id>31fa3c9ca8134f9cec2b4b0b0f78****</Id>\\n <KeyUri>https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/</KeyUri>\\n <SkipCnt>3</SkipCnt>\\n </Encryption>\\n <WaterMarkList>\\n <Type>Image</Type>\\n <ReferPos>TopRight</ReferPos>\\n <Dx>1</Dx>\\n <Width>1080</Width>\\n <Height>1280</Height>\\n <InputFile>\\n <Object>example-logo-****.png</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </InputFile>\\n <WaterMarkTemplateId>88c6ca184c0e47098a5b665e2a12****</WaterMarkTemplateId>\\n <Dy>1</Dy>\\n </WaterMarkList>\\n <WaterMarkConfigUrl>http://example.com/configure</WaterMarkConfigUrl>\\n <DeWatermark>{\\"0\\": [{\\"l\\": 10,\\"t\\": 10,\\"w\\": 10,\\"h\\": 10},{\\"l\\": 100,\\"t\\": 0.1,\\"w\\": 10,\\"h\\": 10}],\\"128000\\": [],\\"250000\\": [{\\"l\\": 0.2,\\"t\\": 0.1,\\"w\\": 0.01,\\"h\\": 0.05}]}</DeWatermark>\\n <M3U8NonStandardSupport>\\n <TS>\\n <SizeSupport>true</SizeSupport>\\n <Md5Support>true</Md5Support>\\n </TS>\\n </M3U8NonStandardSupport>\\n <Priority>5</Priority>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Codec>aac</Codec>\\n <Samplerate>32000</Samplerate>\\n <Qscale>15</Qscale>\\n <Channels>6</Channels>\\n <Volume>\\n <Method>auto</Method>\\n <Level>-20</Level>\\n </Volume>\\n <Bitrate>128</Bitrate>\\n </Audio>\\n <AudioStreamMap>0:a:0</AudioStreamMap>\\n <MergeList>\\n <Start>00000.50</Start>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <MergeURL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv</MergeURL>\\n <Duration>00000.20</Duration>\\n </MergeList>\\n <SuperReso>\\n <IsHalfSample>true</IsHalfSample>\\n </SuperReso>\\n <UserData>example data</UserData>\\n <OutSubtitleList>\\n <Map>0:v:0</Map>\\n <OutSubtitleFile>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </OutSubtitleFile>\\n <Success>true</Success>\\n <Message>The specified parameter “%s” cannot be null.</Message>\\n </OutSubtitleList>\\n <DigiWaterMark>\\n <Type>Image</Type>\\n <Alpha>1.0</Alpha>\\n <InputFile>\\n <Object>example-intput.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </InputFile>\\n </DigiWaterMark>\\n <VideoStreamMap>0:a:0</VideoStreamMap>\\n <OutputFile>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </OutputFile>\\n <AmixList>\\n <Map>0:a:0</Map>\\n <Start>0</Start>\\n <AmixURL>https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3</AmixURL>\\n <Duration>20</Duration>\\n <MixDurMode>long</MixDurMode>\\n </AmixList>\\n <Rotate>180</Rotate>\\n <Container>\\n <Format>flv</Format>\\n </Container>\\n <Clip>\\n <TimeSpan>\\n <Seek>01:59:59.999</Seek>\\n <Duration>01:00:59.999</Duration>\\n </TimeSpan>\\n </Clip>\\n <MergeConfigUrl>`{\\"MergeList\\":[{\\"MergeURL\\":\\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\\"}]}</MergeConfigUrl>\\n <OpeningList>\\n <openUrl>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv</openUrl>\\n <Start>1</Start>\\n <Width>1920</Width>\\n <Height>1080</Height>\\n </OpeningList>\\n <MuxConfig>\\n <Webp>\\n <Loop>0</Loop>\\n </Webp>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <DitherMode>bayer</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>false</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>20</Duration>\\n </Segment>\\n </MuxConfig>\\n <TailSlateList>\\n <Start>1</Start>\\n <BgColor>White</BgColor>\\n <IsMergeAudio>false</IsMergeAudio>\\n <Width>1920</Width>\\n <Height>1080</Height>\\n <BlendDuration>2</BlendDuration>\\n <TailUrl>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv</TailUrl>\\n </TailSlateList>\\n <TemplateId>S00000000-000010</TemplateId>\\n <SubtitleConfig>\\n <ExtSubtitleList>\\n <CharEnc>UTF-8</CharEnc>\\n <FontName>\\"WenQuanYi Zen Hei\\", \\"Yuanti SC Regular\\", \\"SimSun\\"</FontName>\\n <Input>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </Input>\\n </ExtSubtitleList>\\n <SubtitleList>\\n <Map>0:a:0</Map>\\n </SubtitleList>\\n </SubtitleConfig>\\n <Properties>\\n <Width>1280</Width>\\n <Height>720</Height>\\n <Duration>55</Duration>\\n <Fps>25</Fps>\\n <Bitrate>1000</Bitrate>\\n <FileFormat>QuickTime / MOV</FileFormat>\\n <Streams>\\n <VideoStreamList>\\n <Index>0</Index>\\n <Timebase>1/24000</Timebase>\\n <AvgFPS>23.976025</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Sar>1:1</Sar>\\n <Lang>eng</Lang>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Height>720</Height>\\n <NumFrames>25</NumFrames>\\n <Bitrate>1496.46</Bitrate>\\n <CodecTagString>avc1</CodecTagString>\\n <HasBFrames>2</HasBFrames>\\n <Profile>high</Profile>\\n <StartTime>0.000000</StartTime>\\n <NetworkCost>\\n <PreloadTime>8</PreloadTime>\\n <AvgBitrate>100</AvgBitrate>\\n <CostBandwidth>10</CostBandwidth>\\n </NetworkCost>\\n <Dar>16:9</Dar>\\n <CodecName>h264</CodecName>\\n <Width>1280</Width>\\n <Duration>17.225542</Duration>\\n <Fps>23.976025</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1001/48000</CodecTimeBase>\\n <Level>51</Level>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/44100</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>stereo</ChannelLayout>\\n <Lang>eng</Lang>\\n <Samplerate>44100</Samplerate>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <Channels>2</Channels>\\n <NumFrames>25</NumFrames>\\n <Bitrate>128.806</Bitrate>\\n <CodecTagString>mp4a</CodecTagString>\\n <StartTime>0.000000</StartTime>\\n <CodecName>aac</CodecName>\\n <Duration>17.159546</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Index>1</Index>\\n <Lang>eng</Lang>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>0.000000</StartTime>\\n <NumPrograms>0</NumPrograms>\\n <Size>3509895</Size>\\n <NumStreams>2</NumStreams>\\n <FormatLongName>QuickTime / MOV</FormatLongName>\\n <Duration>55</Duration>\\n <Bitrate>1000</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n <FileSize>3509895</FileSize>\\n </Properties>\\n </Output>\\n <PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>\\n <Input>\\n <Object>example.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </Input>\\n <MNSMessageResult>\\n <MessageId>123</MessageId>\\n <ErrorMessage>The resource operated \\"%s\\" cannot be found.</ErrorMessage>\\n <ErrorCode>InvalidParameter.ResourceNotFound</ErrorCode>\\n </MNSMessageResult>\\n </Job>\\n <Success>true</Success>\\n <Code>InvalidParameter.NullValue</Code>\\n <Message>The specified parameter \\"%s\\" cannot be null.</Message>\\n </JobResultList>\\n <RequestId>25818875-5F78-4A45S71F6-D73936451234</RequestId>\\n</SubmitJobsResponse>","errorExample":""}]', + 'title' => 'SubmitJobs', + 'description' => '* SubmitJobs is an asynchronous operation. After you submit transcoding jobs, the jobs are added to an MPS queue to be scheduled and run. The transcoding jobs may not have been complete when the response is returned. After you call this operation, you can call the [QueryJobList](~~602836~~) operation to query the job results. You can also associate a Message Service (MNS) queue or topic with the MPS queue to receive notifications on the jobs. For more information, see [Receive notifications](~~42618~~).'."\n" + .'* An input file can be up to 100 GB in size. If the size of the input file exceeds this limit, the job may fail.'."\n" + .'* If you use an **intelligent preset template** to transcode an input file, you must first call the [SubmitAnalysisJob](~~29223~~) operation to submit a preset template analysis job. After the analysis job is complete, you can call the [QueryAnalysisJobList](~~29224~~)operation to obtain the available preset templates for the input file. When you submit a transcoding job, set TemplateId to the ID of an available preset template. If you specify a preset template that is not in the available preset templates, the transcoding job fails.'."\n" + .'* If you use a **static preset template** to transcode an input file, you do not need to submit a preset template analysis job.'."\n" + .'* If you want to use multiple accounts in MPS, you can create Resource Access Management (RAM) users by using your Alibaba Cloud account. For more information, see [Create a RAM user and grant permissions to the RAM user](~~42841~~). If the Alibaba Cloud account that is used to query transcoding jobs is not the one that is used to submit the transcoding jobs, no data is returned.'."\n" + .'* For information about transcoding FAQ, see [FAQ about MPS](~~38986~~).'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelJob' => [ + 'summary' => 'Cancels a transcoding job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmts0IG2Y5', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the transcoding job to be canceled. You can log on to the **MPS console** and click **Tasks** in the left-side navigation pane to obtain job IDs. Alternatively, you can obtain job IDs from the response of the [SubmitJobs](~~29226~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', + ], + 'JobId' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"JobId\\": \\"d1ce4d3efcb549419193f50f1fcd****\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelJobResponse>\\n <RequestId>338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5</RequestId>\\n <JobId>d1ce4d3efcb549419193f50f1fcd****</JobId>\\n</CancelJobResponse>","errorExample":""}]', + 'title' => 'CancelJob', + 'description' => '* You can cancel a transcoding job only if the job is in the Submitted state.'."\n" + .'* We recommend that you call the **UpdatePipeline** operation to set the status of the ApsaraVideo Media Processing (MPS) queue to Paused before you cancel a job. This suspends job scheduling in the MPS queue. After the job is canceled, you must set the status of the MPS queue back to Active so that the other jobs in the MPS queue can be scheduled.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryJobList' => [ + 'summary' => 'Queries transcoding jobs at a time by job ID.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmts0IG2Y5', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of transcoding jobs. Separate multiple IDs with commas (,). You can query a maximum of 10 transcoding jobs at a time. You can log on to the [ApsaraVideo Media Processing (MPS) console](https://mps.console.aliyun.com/overview) and click **Tasks** in the left-side navigation pane to obtain job IDs. Alternatively, you can obtain job IDs from the response to the [SubmitJobs](~~29226~~) operation.'."\n" + ."\n" + .'> If you do not set the JobIds parameter, the `InvalidParameter` error code is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NonExistJobIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The list of nonexistent job IDs. If all queried job IDs exist, the response does not contain this parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The nonexistent job ID.', + 'type' => 'string', + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '197ADF44-104C-514C-9F92-D8924CB34E2A', + ], + 'JobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Job' => [ + 'description' => 'The transcoding jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'Percent' => [ + 'description' => 'The transcoding progress.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:20:25Z', + ], + 'State' => [ + 'description' => 'The job state. Valid values:'."\n" + ."\n" + .'* **Submitted**: The job was submitted.'."\n" + .'* **Transcoding**: Transcoding is in process.'."\n" + .'* **TranscodeSuccess**: The job was successful.'."\n" + .'* **TranscodeFail**: The job failed.'."\n" + .'* **TranscodeCancelled**: The job was canceled.'."\n", + 'type' => 'string', + 'example' => 'TranscodeSuccess', + ], + 'JobId' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '31fa3c9ca8134fb4b0b0f7878301****', + ], + 'Code' => [ + 'description' => 'The error code returned if the job failed. If the job was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.NullValue', + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed. If the job was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter "%s" cannot be null.', + ], + 'Output' => [ + 'description' => 'The job output.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The buffer size.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'Degrain' => [ + 'description' => 'The strength of the independent noise reduction algorithm.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'BitrateBnd' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The maximum bitrate.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'Min' => [ + 'description' => 'The minimum bitrate.'."\n", + 'type' => 'string', + 'example' => '300', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Pad' => [ + 'description' => 'The black bars that are added to the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Format: width:height:left:top.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Codec' => [ + 'description' => 'The video codec.'."\n" + ."\n" + .'* Valid values: H.264 and H.265.'."\n" + .'* Default value: H.264.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the height of the input video.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Crop' => [ + 'description' => 'The method of video cropping. Valid values:'."\n" + ."\n" + .'* **border**: automatically detects and removes borders.'."\n" + .'* A value in the width:height:left:top format: The video image is cropped based on custom settings.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Bitrate' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '3000', + ], + 'MaxFps' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Profile' => [ + 'description' => 'The codec profile of the video. Valid values: baseline, main, and high.'."\n" + ."\n" + .'> If multiple definitions are involved, we recommend that you use baseline for the lowest definition to ensure normal playback on low-end devices, and use main or high for other definitions.'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'The constant rate factor.'."\n" + ."\n" + .'* Default value when the value of Codec is H.264: **23**, default value when the value of Codec is H.265: **26**.'."\n" + .'* If the value of this parameter is returned, the value of Bitrate becomes invalid.'."\n", + 'type' => 'string', + 'example' => '26', + ], + 'Gop' => [ + 'description' => 'The maximum interval between keyframes or the maximum number of frames in a frame group. Unit: seconds.'."\n" + ."\n" + .'* Default value: **250**.'."\n" + .'* If the maximum number of frames is returned, the value does not contain a unit.'."\n", + 'type' => 'string', + 'example' => '250', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the width of the input video.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video.'."\n" + ."\n" + .'* Unit: frames per second.'."\n" + .'* The value is 60 if the frame rate of the input file exceeds 60.'."\n" + .'* Default value: the frame rate of the input video.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" + ."\n" + .'* **veryfast**'."\n" + .'* **fast**'."\n" + .'* **medium**'."\n" + .'* **slow**'."\n" + .'* **slower**'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* If this parameter is left **empty**, the scan mode of the input video is used.'."\n" + .'* **auto**: automatic deinterlacing.'."\n" + .'* **progressive**: progressive scan.'."\n" + .'* **interlaced**: interlaced scan.'."\n" + .'* **By default**, this parameter is left empty.'."\n" + ."\n" + .'**Best practice**: The interlaced scan mode saves data traffic than the progressive scan mode but provides poor image quality. Therefore, the progressive scan mode is commonly used in mainstream video production.'."\n" + ."\n" + .'* If **progressive** or **interlaced** is used when the scan mode of the input video is neither of them, the transcoding job fails.'."\n" + .'* We recommend that you use **the scan mode of the input video** or **automatic deinterlacing** for higher compatibility.'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'ResoPriority' => [ + 'description' => 'The resource priority.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations.'."\n" + ."\n" + .'> If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + ."\n" + .'* **false**'."\n" + ."\n" + .'* Default value:'."\n" + ."\n" + .' * If this parameter is empty and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" + .' * If this parameter is empty and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'TransMode' => [ + 'description' => 'The transcoding mode.'."\n" + ."\n" + .'* Valid values: onepass, twopass, and CBR.'."\n" + .'* Default value: **onepass**.'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" + ."\n" + .'* **true**:'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input video is not transcoded and a transcoding failure is returned. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'AdjDarMethod' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values: rescale, crop, pad, and none.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input audio is not transcoded and a transcoding failure is returned. This parameter has a higher priority than IsCheckAudioBitrate. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Encryption' => [ + 'description' => 'The encryption configurations. The encrypted video file is generated in the M3U8 format.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The encryption type. Only **hls-aes-128** may be returned.'."\n", + 'type' => 'string', + 'example' => 'hls-aes-128', + ], + 'Key' => [ + 'description' => 'The key that is used to encrypt the video.'."\n", + 'type' => 'string', + 'example' => 'encryptionkey128', + ], + 'KeyType' => [ + 'description' => 'The key encryption method. Valid values: Base64 and KMS.'."\n" + ."\n" + .'> For example, if the key is `encryptionkey128`, the key can be encrypted as `Base64("encryptionkey128")` or `KMS(Base64("encryptionkey128")` depending on the encryption method used.'."\n", + 'type' => 'string', + 'example' => 'Base64', + ], + 'Id' => [ + 'description' => 'The encryption ID.'."\n", + 'type' => 'string', + 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', + ], + 'KeyUri' => [ + 'description' => 'The URL that is used to request the key. The URL is Base64-encoded.'."\n", + 'type' => 'string', + 'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/', + ], + 'SkipCnt' => [ + 'description' => 'The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + ], + 'WaterMarkList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WaterMark' => [ + 'description' => 'The watermarks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see [Parameter details](~~29253~~). Valid values:'."\n" + ."\n" + .'* Image'."\n" + .'* Text'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'ReferPos' => [ + 'description' => 'The position of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Valid values:'."\n" + ."\n" + .'* TopRight'."\n" + .'* TopLeft'."\n" + .'* BottomRight'."\n" + .'* BottomLeft'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'Dx' => [ + 'description' => 'The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the horizontal offset.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution.'."\n" + ."\n" + .' * Valid values: (0,1).'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the watermark width.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the watermark width to the width in the output video resolution.'."\n" + ."\n" + .' * Valid values: **(0,1)**.'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'Height' => [ + 'description' => 'The height of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the watermark height.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the watermark height to the height in the output video resolution.'."\n" + ."\n" + .' * Valid values: **(0,1)**.'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'InputFile' => [ + 'description' => 'The watermark input file. PNG images and MOV files are supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the Object Storage Service (OSS) object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-logo-****.png', + ], + 'Location' => [ + 'description' => 'The OSS region in which the input file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'WaterMarkTemplateId' => [ + 'description' => 'The ID of the watermark template.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Dy' => [ + 'description' => 'The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the vertical offset.'."\n" + ."\n" + .' * Valid values: **\\[8,4096]**.'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the vertical offset to the height in the output video resolution.'."\n" + ."\n" + .' * Valid values: **(0,1)**.'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'WaterMarkConfigUrl' => [ + 'description' => 'The URL of the watermark configuration file.'."\n", + 'type' => 'string', + 'example' => 'http://example.com/configure', + ], + 'DeWatermark' => [ + 'description' => 'The configurations of watermark blurring. The value is a JSON object. For more information, see the DeWatermark section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'string', + 'example' => '{"0":[{"l":10,"t":10,"w":10,"h":10},{"l":100,"t":0.1,"w":10,"h":10}],"128000":[],"250000":[{"l":0.2,"t":0.1,"w":0.01,"h":0.05}]}', + ], + 'M3U8NonStandardSupport' => [ + 'description' => 'The non-standard support configurations for M3U8. The value is a JSON object. For more information, see the M3U8NonStandardSupport section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'TS' => [ + 'description' => 'The non-standard support configurations for TS files. The value is a JSON object. For more information, see the TS section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'SizeSupport' => [ + 'description' => 'Indicates whether the output of the size of the TS file is supported in the M3U8 file. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Md5Support' => [ + 'description' => 'Indicates whether the output of the MD5 value of the TS file is supported in the M3U8 file. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'Priority' => [ + 'description' => 'The priority of the job in the ApsaraVideo Media Processing (MPS) queue to which the job is added.'."\n" + ."\n" + .'* A value of 10 indicates the highest priority.'."\n" + .'* Default value: **6**.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'Audio' => [ + 'description' => 'The audio configurations.'."\n" + ."\n" + .'> If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values when the value of Codec is aac: aaclow, aache, aachev2, aacld, and aaceld.'."\n", + 'type' => 'string', + 'example' => 'aaclow', + ], + 'Codec' => [ + 'description' => 'The audio codec.'."\n" + ."\n" + .'* Valid values: aac, mp3, vorbis, and flac.'."\n" + .'* Default value: **aac**.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" + .'* Unit: Hz.'."\n" + .'* Default value: 44100.'."\n" + ."\n" + .'> If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the audio.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n" + ."\n" + .'* Valid values: 1, 2, 3, 4, 5, 6, 7, and 8.'."\n" + .'* Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Volume' => [ + 'description' => 'The volume configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => 'The method that is used to adjust the volume. Valid values:'."\n" + ."\n" + .'* **auto**'."\n" + .'* **dynamic**'."\n" + .'* **linear**'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'Level' => [ + 'description' => 'The volume adjustment range. Default value: -20. Unit: dB.'."\n", + 'type' => 'string', + 'example' => '-20', + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '128', + ], + ], + ], + 'AudioStreamMap' => [ + 'description' => 'The sequence number of the audio stream.'."\n" + ."\n" + .'* Format: 0:a:{Sequence number}. Example: 0:a:0.'."\n" + .'* The sequence number is the index of the audio stream in the list and starts from 0.'."\n" + .'* If no sequence number is specified, the default audio stream is used.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + 'MergeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Merge' => [ + 'description' => 'The configurations of clip merging. Up to four clips can be merged.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start point in time of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:59:59.999', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role used for delegated authorization.', + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'MergeURL' => [ + 'description' => 'The OSS URL of the clip.'."\n" + ."\n" + .'* Example: `http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv`.'."\n" + .'* The object must be URL-encoded by using the UTF-8 standard. For more information, see [URL encoding](~~423796~~).'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv', + ], + 'Duration' => [ + 'description' => 'The duration of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:59:59.999', + ], + ], + ], + ], + ], + ], + 'SuperReso' => [ + 'description' => 'The configurations for using the resolution of the source video.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsHalfSample' => [ + 'description' => 'Indicates whether parameters related to the sampling rate are obtained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'ExtendData' => [ + 'title' => '扩展字段', + 'description' => 'The custom fields.'."\n", + 'type' => 'string', + 'example' => 'testid-002', + ], + 'OutSubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OutSubtitle' => [ + 'description' => 'The output captions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'description' => 'The video track. Format: `0:{Stream}:{Stream sequence number}`, which is `0:v:{video_index}`. The value of Stream is v, which indicates a video stream. The sequence number is the index of the video stream in the list and starts from 0.'."\n", + 'type' => 'string', + 'example' => '0:v:0', + ], + 'OutSubtitleFile' => [ + 'description' => 'The details of the output caption.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the RAM role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the output caption.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The OSS region in which the output caption resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the output caption is stored.'."\n", + 'type' => 'string', + 'example' => 'exampleBucket', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the job was successful. Valid values:'."\n" + ."\n" + .'* **true**: The job was successful.'."\n" + .'* **false**: The job failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed to be created. This parameter is not returned if the job was created.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter “%s” cannot be null.', + ], + ], + ], + ], + ], + ], + 'VideoStreamMap' => [ + 'description' => 'The sequence number of the video stream. The sequence number is the index of the video stream in the list and starts from 0. If no sequence number is specified, the default video stream is used.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'OutputFile' => [ + 'description' => 'The details of the output file.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the RAM role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the output file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'Location' => [ + 'description' => 'The OSS region in which the output file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the output file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'Rotate' => [ + 'description' => 'The rotation angle of the video.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n" + ."\n" + .'* Default value: mp4.'."\n" + .'* Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).'."\n" + .'* Audio formats include MP3, MP4, Ogg, FLAC, and M4A.'."\n" + .'* Image formats include GIF and WebP. If the container format is GIF, the video codec must be GIF.'."\n" + .'* If the container format is WebP, the video codec must be WebP.'."\n" + .'* If the container format is FLV, the video codec cannot be H.265.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'Clip' => [ + 'description' => 'The information about clips.'."\n", + 'type' => 'object', + 'properties' => [ + 'TimeSpan' => [ + 'description' => 'The time span of the clip.'."\n", + 'type' => 'object', + 'properties' => [ + 'Seek' => [ + 'description' => 'The point in time when the clip starts.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]`.'."\n" + .'* Example: 01:59:59.999.'."\n" + ."\n" + .'Or'."\n" + ."\n" + .'* Format: `sssss[.SSS]`.'."\n" + .'* Example: 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:59:59.999', + ], + 'Duration' => [ + 'description' => 'The duration of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]`.'."\n" + .'* Example: 01:00:59.999.'."\n" + ."\n" + .'Or'."\n" + ."\n" + .'* Format: `sssss[.SSS]`.'."\n" + .'* Example: 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:00:59.999', + ], + ], + ], + ], + ], + 'MergeConfigUrl' => [ + 'description' => 'The URL of the merging configuration file. Only one of MergeList and MergeConfigUrl takes effect.'."\n" + ."\n" + .'* The configuration file specified by MergeConfigUrl can contain up to 50 clips.'."\n" + .'* MergeConfigUrl indicates the URL of the configuration file for merging clips. Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details about merging parameters.'."\n" + .'* Example of the content of the merging configuration file: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.'."\n", + 'type' => 'string', + 'example' => 'https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8', + ], + 'OpeningList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Opening' => [ + 'description' => 'The opening parts. The value is a JSON object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'openUrl' => [ + 'description' => 'The OSS URL of the opening part.'."\n", + 'type' => 'string', + 'example' => 'http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4', + ], + 'Start' => [ + 'description' => 'The amount of time after which the opening part is played.'."\n" + ."\n" + .'* The value starts from 0.'."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Width' => [ + 'description' => 'The width of the opening part.'."\n" + ."\n" + .'* Valid values: values in the range of (0,4096), -1, and full.'."\n" + .'* A value of -1 indicates that the original width of the opening part is retained.'."\n" + .'* A value of full indicates that the width of the opening part equals the width of the main part.'."\n" + .'* Default value: **-1**.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'Height' => [ + 'description' => 'The height of the opening part.'."\n" + ."\n" + .'* Valid values: values in the range of (0,4096), -1, and full.'."\n" + .'* A value of -1 indicates that the original height of the opening part is retained.'."\n" + .'* A value of full indicates that the height of the opening part equals the height of the main part.'."\n" + .'* Default value: **-1**.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + ], + ], + ], + ], + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations. The transmuxing configurations. If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'Webp' => [ + 'description' => 'The transmuxing configurations for WebP.'."\n", + 'type' => 'object', + 'properties' => [ + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Gif' => [ + 'description' => 'The transmuxing configurations for GIF.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The duration for which the final frame is paused. Unit: centisecond.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DitherMode' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", + 'type' => 'string', + 'example' => 'bayer', + ], + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'Indicates whether a custom palette is used. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configurations. The value is a JSON object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The segment length. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + 'TailSlateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TailSlate' => [ + 'description' => 'The ending parts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The time when the ending part is played.'."\n", + 'type' => 'string', + 'example' => '00000.00', + ], + 'BgColor' => [ + 'description' => 'The color of the bars that are added to the ending part if the size of the ending part is smaller than that of the main part. Default value: White. For more information, see [Parameter details](~~29253~~).'."\n", + 'type' => 'string', + 'example' => 'White', + ], + 'IsMergeAudio' => [ + 'description' => 'Indicates whether the audio content of the ending part is merged. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Width' => [ + 'description' => 'The width of the ending part. Valid values: values in the range of (0,4096), -1, and full.'."\n" + ."\n" + .'* A value of -1 indicates that the original width of the ending part is retained.'."\n" + .'* A value of full indicates that the width of the ending part equals the width of the main part.'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'Height' => [ + 'description' => 'The height of the ending part.'."\n" + ."\n" + .'* Valid values: values in the range of (0,4096), -1, and full.'."\n" + .'* A value of -1 indicates that the original height of the ending part is retained.'."\n" + .'* A value of full indicates that the height of the ending part equals the height of the main part.'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'BlendDuration' => [ + 'description' => 'The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TailUrl' => [ + 'description' => 'The OSS URL of the ending part.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', + ], + ], + ], + ], + ], + ], + 'TemplateId' => [ + 'description' => 'The template ID.'."\n", + 'type' => 'string', + 'example' => 'S00000001-200010', + ], + 'SubtitleConfig' => [ + 'description' => 'The caption configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtSubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExtSubtitle' => [ + 'description' => 'The external captions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CharEnc' => [ + 'description' => 'The character set used by the external caption.'."\n" + ."\n" + .'* Valid values: UTF-8, GBK, BIG5, and auto.'."\n" + .'* Default value: **auto**.'."\n" + ."\n" + .'> If the value of CharEnc is auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'FontName' => [ + 'description' => 'The font of the hardcoded captions converted from external captions. Default value: SimSum. For more information, see [Fonts](~~59950~~).'."\n", + 'type' => 'string', + 'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"', + ], + 'Input' => [ + 'description' => 'The input caption file.'."\n" + ."\n" + .'* SRT and ASS files are supported. For more information, see the Input section of the [Parameter details](~~29253~~) topic.'."\n" + .'* Example: `{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}`.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input caption file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'Location' => [ + 'description' => 'The OSS region in which the input caption file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input caption file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + ], + ], + ], + ], + ], + ], + ], + 'SubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Subtitle' => [ + 'description' => 'The captions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'description' => 'The audio track. Format: `0:{Stream}:{Stream sequence number}`, which is `0:a:{audio_index}`. The value of Stream is a, which indicates an audio stream. The sequence number is the index of the audio stream in the list and starts from 0.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + ], + ], + ], + ], + ], + ], + ], + 'Properties' => [ + 'description' => 'The media properties.'."\n", + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => 'The video width.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Height' => [ + 'description' => 'The video height.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'SourceLogos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SourceLogo' => [ + 'description' => 'The non-engine layer keywords.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Source' => [ + 'description' => 'The keyword.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + ], + ], + ], + 'Duration' => [ + 'description' => 'The video duration.'."\n", + 'type' => 'string', + 'example' => '17', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => 'The video bitrate.'."\n", + 'type' => 'string', + 'example' => '490', + ], + 'FileFormat' => [ + 'description' => 'The video format.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + 'Streams' => [ + 'description' => 'The stream information.'."\n", + 'type' => 'object', + 'properties' => [ + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The video streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Timebase' => [ + 'description' => 'The time base of the video stream.'."\n", + 'type' => 'string', + 'example' => '1/15360', + ], + 'AvgFPS' => [ + 'description' => 'The average frame rate of the video stream.'."\n", + 'type' => 'string', + 'example' => '30.0', + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video stream.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR) of the video stream.'."\n", + 'type' => 'string', + 'example' => '1:1', + ], + 'Lang' => [ + 'description' => 'The language of the video stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the codec.'."\n", + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Height' => [ + 'description' => 'The height of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => 'The video bitrate.'."\n", + 'type' => 'string', + 'example' => '421.117', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the codec.'."\n", + 'type' => 'string', + 'example' => 'avc1', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames).'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Profile' => [ + 'description' => 'The codec profile.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth that was consumed.'."\n", + 'type' => 'object', + 'properties' => [ + 'PreloadTime' => [ + 'description' => 'The amount of time consumed to preload the video stream.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'AvgBitrate' => [ + 'description' => 'The average bitrate.'."\n", + 'type' => 'string', + 'example' => '300', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that was consumed.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR) of the video stream.'."\n", + 'type' => 'string', + 'example' => '9:16', + ], + 'CodecName' => [ + 'description' => 'The short name of the codec.'."\n", + 'type' => 'string', + 'example' => 'h264', + ], + 'Width' => [ + 'description' => 'The width of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Duration' => [ + 'description' => 'The duration of the video stream.'."\n", + 'type' => 'string', + 'example' => '17.233333', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video stream.'."\n", + 'type' => 'string', + 'example' => '30.0', + ], + 'CodecTag' => [ + 'description' => 'The tag of the codec.'."\n", + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/60', + ], + 'Level' => [ + 'description' => 'The codec level.'."\n", + 'type' => 'string', + 'example' => '31', + ], + 'colorTransfer' => [ + 'description' => 'The color transfer configuration.'."\n", + 'type' => 'string', + 'example' => 'bt709', + ], + 'colorPrimaries' => [ + 'description' => 'The primary colors.'."\n", + 'type' => 'string', + 'example' => 'bt709', + ], + 'bitsPerRawSample' => [ + 'description' => 'The number of binary bits used by each sample or pixel.'."\n", + 'type' => 'string', + 'example' => '8', + ], + ], + ], + ], + ], + ], + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The audio streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base of the audio stream.'."\n", + 'type' => 'string', + 'example' => '1/32000', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.'."\n", + 'type' => 'string', + 'example' => 'fltp', + ], + 'ChannelLayout' => [ + 'description' => 'The output layout of the sound channels.'."\n", + 'type' => 'string', + 'example' => 'mono', + ], + 'Lang' => [ + 'description' => 'The language of the audio stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'und', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n", + 'type' => 'string', + 'example' => '32000', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the codec.'."\n", + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the audio stream.'."\n", + 'type' => 'string', + 'example' => '64.136', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the codec.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.064000', + ], + 'CodecName' => [ + 'description' => 'The short name of the codec.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => 'The duration of the audio stream.'."\n", + 'type' => 'string', + 'example' => '17.223562', + ], + 'CodecTag' => [ + 'description' => 'The tag of the codec.'."\n", + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/32000', + ], + ], + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The caption streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the caption stream. The value indicates the position of the caption stream in all caption streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Lang' => [ + 'description' => 'The language of the caption stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + ], + ], + ], + ], + ], + ], + ], + 'Format' => [ + 'description' => 'The format information.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '-0.064000', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Size' => [ + 'description' => 'The size of the media file.'."\n", + 'type' => 'string', + 'example' => '1057273', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the container format.'."\n", + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'Duration' => [ + 'description' => 'The total duration.'."\n", + 'type' => 'string', + 'example' => '17.234000', + ], + 'Bitrate' => [ + 'description' => 'The total bitrate.'."\n", + 'type' => 'string', + 'example' => '490.784', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'type' => 'string', + 'example' => 'mov', + ], + ], + ], + 'FileSize' => [ + 'description' => 'The size of the media file.'."\n", + 'type' => 'string', + 'example' => '1057273', + ], + ], + ], + 'MultiSpeedInfo' => [ + 'description' => 'The information about the high-speed transcoding job. This information is available only for jobs that are submitted by using an MPS queue for high-speed transcoding. This does not support MPS queues for high-speed transcoding of an earlier version.'."\n", + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => 'Indicates whether high-speed transcoding is enabled.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The error code returned if high-speed transcoding is not enabled.'."\n", + 'type' => 'string', + 'example' => 'Boost.NotNeedSpeed', + ], + 'Message' => [ + 'description' => 'The error message returned if high-speed transcoding is not enabled.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'SettingSpeed' => [ + 'description' => 'The speed setting.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'DowngradePolicy' => [ + 'description' => 'The downgrade policy if high-speed transcoding is not supported.'."\n", + 'type' => 'string', + 'example' => 'NormalSpeed', + ], + 'RealSpeed' => [ + 'description' => 'The actual transcoding speed.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '6.576886940181647', + ], + 'Duration' => [ + 'description' => 'The duration of the output video.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '21.0', + ], + 'TimeCost' => [ + 'description' => 'The amount of time consumed.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '3.193', + ], + ], + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue that is used to run the job.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47b665e2a1267971****', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'video_01.mp4', + ], + 'Location' => [ + 'description' => 'The OSS region in which the input file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'exampleBucket', + ], + ], + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by Message Service (MNS) to notify users of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated “%s” cannot be found.', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + ], + ], + 'SubmitTime' => [ + 'title' => '任务出队提交执行的时间', + 'description' => 'The time when the job was submitted.'."\n", + 'type' => 'string', + 'example' => '2021-03-04T06:44:43Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistJobIds\\": {\\n \\"String\\": [\\n \\"d1ce4d3efcb549419193f50f1fcd****\\"\\n ]\\n },\\n \\"RequestId\\": \\"197ADF44-104C-514C-9F92-D8924CB34E2A\\",\\n \\"JobList\\": {\\n \\"Job\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 100,\\n \\"FinishTime\\": \\"2014-01-10T12:20:25Z\\",\\n \\"State\\": \\"TranscodeSuccess\\",\\n \\"JobId\\": \\"31fa3c9ca8134fb4b0b0f7878301****\\",\\n \\"Code\\": \\"InvalidParameter.NullValue\\",\\n \\"Message\\": \\"The specified parameter \\\\\\"%s\\\\\\" cannot be null.\\",\\n \\"Output\\": {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1000\\",\\n \\"Min\\": \\"300\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Maxrate\\": \\"3000\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"26\\",\\n \\"Gop\\": \\"250\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\"\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"Encryption\\": {\\n \\"Type\\": \\"hls-aes-128\\",\\n \\"Key\\": \\"encryptionkey128\\",\\n \\"KeyType\\": \\"Base64\\",\\n \\"Id\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"KeyUri\\": \\"https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/\\",\\n \\"SkipCnt\\": \\"3\\"\\n },\\n \\"WaterMarkList\\": {\\n \\"WaterMark\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"50\\",\\n \\"Height\\": \\"50\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-logo-****.png\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"WaterMarkTemplateId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Dy\\": \\"100\\"\\n }\\n ]\\n },\\n \\"WaterMarkConfigUrl\\": \\"http://example.com/configure\\",\\n \\"DeWatermark\\": \\"{\\\\\\"0\\\\\\":[{\\\\\\"l\\\\\\":10,\\\\\\"t\\\\\\":10,\\\\\\"w\\\\\\":10,\\\\\\"h\\\\\\":10},{\\\\\\"l\\\\\\":100,\\\\\\"t\\\\\\":0.1,\\\\\\"w\\\\\\":10,\\\\\\"h\\\\\\":10}],\\\\\\"128000\\\\\\":[],\\\\\\"250000\\\\\\":[{\\\\\\"l\\\\\\":0.2,\\\\\\"t\\\\\\":0.1,\\\\\\"w\\\\\\":0.01,\\\\\\"h\\\\\\":0.05}]}\\",\\n \\"M3U8NonStandardSupport\\": {\\n \\"TS\\": {\\n \\"SizeSupport\\": true,\\n \\"Md5Support\\": true\\n }\\n },\\n \\"Priority\\": \\"6\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aaclow\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Channels\\": \\"2\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"Level\\": \\"-20\\"\\n },\\n \\"Bitrate\\": \\"128\\"\\n },\\n \\"AudioStreamMap\\": \\"0:a:0\\",\\n \\"MergeList\\": {\\n \\"Merge\\": [\\n {\\n \\"Start\\": \\"01:59:59.999\\",\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"MergeURL\\": \\"http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv\\",\\n \\"Duration\\": \\"01:59:59.999\\"\\n }\\n ]\\n },\\n \\"SuperReso\\": {\\n \\"IsHalfSample\\": \\"true\\"\\n },\\n \\"UserData\\": \\"testid-001\\",\\n \\"ExtendData\\": \\"testid-002\\",\\n \\"OutSubtitleList\\": {\\n \\"OutSubtitle\\": [\\n {\\n \\"Map\\": \\"0:v:0\\",\\n \\"OutSubtitleFile\\": {\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"exampleBucket\\"\\n },\\n \\"Success\\": true,\\n \\"Message\\": \\"The specified parameter “%s” cannot be null.\\"\\n }\\n ]\\n },\\n \\"VideoStreamMap\\": \\"0\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"Rotate\\": \\"90\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"Clip\\": {\\n \\"TimeSpan\\": {\\n \\"Seek\\": \\"01:59:59.999\\",\\n \\"Duration\\": \\"01:00:59.999\\"\\n }\\n },\\n \\"MergeConfigUrl\\": \\"https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8\\",\\n \\"OpeningList\\": {\\n \\"Opening\\": [\\n {\\n \\"openUrl\\": \\"http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4\\",\\n \\"Start\\": \\"0\\",\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\"\\n }\\n ]\\n },\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"bayer\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"20\\"\\n }\\n },\\n \\"TailSlateList\\": {\\n \\"TailSlate\\": [\\n {\\n \\"Start\\": \\"00000.00\\",\\n \\"BgColor\\": \\"White\\",\\n \\"IsMergeAudio\\": true,\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\",\\n \\"BlendDuration\\": \\"0\\",\\n \\"TailUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"S00000001-200010\\",\\n \\"SubtitleConfig\\": {\\n \\"ExtSubtitleList\\": {\\n \\"ExtSubtitle\\": [\\n {\\n \\"CharEnc\\": \\"auto\\",\\n \\"FontName\\": \\"\\\\\\"WenQuanYi Zen Hei\\\\\\", \\\\\\"Yuanti SC Regular\\\\\\", \\\\\\"SimSun\\\\\\"\\",\\n \\"Input\\": {\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n }\\n ]\\n },\\n \\"SubtitleList\\": {\\n \\"Subtitle\\": [\\n {\\n \\"Map\\": \\"0:a:0\\"\\n }\\n ]\\n }\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"720\\",\\n \\"Height\\": \\"1280\\",\\n \\"SourceLogos\\": {\\n \\"SourceLogo\\": [\\n {\\n \\"Source\\": \\"example\\"\\n }\\n ]\\n },\\n \\"Duration\\": \\"17\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"490\\",\\n \\"FileFormat\\": \\"mp4\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Timebase\\": \\"1/15360\\",\\n \\"AvgFPS\\": \\"30.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Sar\\": \\"1:1\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Height\\": \\"1280\\",\\n \\"NumFrames\\": \\"30\\",\\n \\"Bitrate\\": \\"421.117\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"high\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Dar\\": \\"9:16\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": \\"720\\",\\n \\"Duration\\": \\"17.233333\\",\\n \\"Fps\\": \\"30.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/60\\",\\n \\"Level\\": \\"31\\",\\n \\"colorTransfer\\": \\"bt709\\",\\n \\"colorPrimaries\\": \\"bt709\\",\\n \\"bitsPerRawSample\\": \\"8\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/32000\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"1\\",\\n \\"NumFrames\\": \\"50\\",\\n \\"Bitrate\\": \\"64.136\\",\\n \\"CodecTagString\\": \\"mp4\\",\\n \\"StartTime\\": \\"0.064000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"17.223562\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/32000\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"eng\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"-0.064000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"1057273\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Duration\\": \\"17.234000\\",\\n \\"Bitrate\\": \\"490.784\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"1057273\\"\\n },\\n \\"MultiSpeedInfo\\": {\\n \\"Enable\\": \\"true\\",\\n \\"Code\\": \\"Boost.NotNeedSpeed\\",\\n \\"Message\\": \\"success\\",\\n \\"SettingSpeed\\": 30,\\n \\"DowngradePolicy\\": \\"NormalSpeed\\",\\n \\"RealSpeed\\": 6.576886940181647,\\n \\"Duration\\": 21,\\n \\"TimeCost\\": 3.193\\n }\\n },\\n \\"PipelineId\\": \\"88c6ca184c0e47b665e2a1267971****\\",\\n \\"Input\\": {\\n \\"Object\\": \\"video_01.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"exampleBucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"123\\",\\n \\"ErrorMessage\\": \\"The resource operated “%s” cannot be found.\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n },\\n \\"SubmitTime\\": \\"2021-03-04T06:44:43Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryJobListResponse>\\n <NonExistJobIds>d1ce4d3efcb549419193f50f1fcd****</NonExistJobIds>\\n <RequestId>197ADF44-104C-514C-9F92-D8924CB34E2A</RequestId>\\n <JobList>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <Percent>100</Percent>\\n <FinishTime>2014-01-10T12:20:25Z</FinishTime>\\n <State>TranscodeSuccess</State>\\n <JobId>31fa3c9ca8134fb4b0b0f7878301****</JobId>\\n <Code>InvalidParameter.NullValue</Code>\\n <Message>The specified parameter \\"%s\\" cannot be null.</Message>\\n <Output>\\n <Video>\\n <Bufsize>6000</Bufsize>\\n <Degrain>5</Degrain>\\n <BitrateBnd>\\n <Max>1000</Max>\\n <Min>300</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>720</Height>\\n <Qscale>15</Qscale>\\n <Crop>1280:800:0:140</Crop>\\n <Bitrate>500</Bitrate>\\n <Maxrate>3000</Maxrate>\\n <MaxFps>60</MaxFps>\\n <Profile>high</Profile>\\n <Crf>26</Crf>\\n <Gop>250</Gop>\\n <Width>1280</Width>\\n <Fps>25</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>interlaced</ScanMode>\\n <ResoPriority>1</ResoPriority>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>false</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>false</IsCheckReso>\\n <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>\\n <AdjDarMethod>none</AdjDarMethod>\\n <IsCheckVideoBitrate>false</IsCheckVideoBitrate>\\n <IsCheckResoFail>false</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <Encryption>\\n <Type>hls-aes-128</Type>\\n <Key>encryptionkey128</Key>\\n <KeyType>Base64</KeyType>\\n <Id>31fa3c9ca8134f9cec2b4b0b0f78****</Id>\\n <KeyUri>https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/</KeyUri>\\n <SkipCnt>3</SkipCnt>\\n </Encryption>\\n <WaterMarkList>\\n <Type>Image</Type>\\n <ReferPos>TopRight</ReferPos>\\n <Dx>100</Dx>\\n <Width>50</Width>\\n <Height>50</Height>\\n <InputFile>\\n <Object>example-logo-****.png</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </InputFile>\\n <WaterMarkTemplateId>88c6ca184c0e47098a5b665e2a12****</WaterMarkTemplateId>\\n <Dy>100</Dy>\\n </WaterMarkList>\\n <WaterMarkConfigUrl>http://example.com/configure</WaterMarkConfigUrl>\\n <DeWatermark>{\\"0\\":[{\\"l\\":10,\\"t\\":10,\\"w\\":10,\\"h\\":10},{\\"l\\":100,\\"t\\":0.1,\\"w\\":10,\\"h\\":10}],\\"128000\\":[],\\"250000\\":[{\\"l\\":0.2,\\"t\\":0.1,\\"w\\":0.01,\\"h\\":0.05}]}</DeWatermark>\\n <M3U8NonStandardSupport>\\n <TS>\\n <SizeSupport>true</SizeSupport>\\n <Md5Support>true</Md5Support>\\n </TS>\\n </M3U8NonStandardSupport>\\n <Priority>6</Priority>\\n <Audio>\\n <Profile>aaclow</Profile>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>15</Qscale>\\n <Channels>2</Channels>\\n <Volume>\\n <Method>auto</Method>\\n <Level>-20</Level>\\n </Volume>\\n <Bitrate>128</Bitrate>\\n </Audio>\\n <AudioStreamMap>0:a:0</AudioStreamMap>\\n <MergeList>\\n <Start>01:59:59.999</Start>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <MergeURL>http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv</MergeURL>\\n <Duration>01:59:59.999</Duration>\\n </MergeList>\\n <SuperReso>\\n <IsHalfSample>true</IsHalfSample>\\n </SuperReso>\\n <UserData>testid-001</UserData>\\n <ExtendData>testid-002</ExtendData>\\n <OutSubtitleList>\\n <Map>0:v:0</Map>\\n <OutSubtitleFile>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <Object>example.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>exampleBucket</Bucket>\\n </OutSubtitleFile>\\n <Success>true</Success>\\n <Message>The specified parameter “%s” cannot be null.</Message>\\n </OutSubtitleList>\\n <VideoStreamMap>0</VideoStreamMap>\\n <OutputFile>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </OutputFile>\\n <Rotate>90</Rotate>\\n <Container>\\n <Format>mp4</Format>\\n </Container>\\n <Clip>\\n <TimeSpan>\\n <Seek>01:59:59.999</Seek>\\n <Duration>01:00:59.999</Duration>\\n </TimeSpan>\\n </Clip>\\n <MergeConfigUrl>https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8</MergeConfigUrl>\\n <OpeningList>\\n <openUrl>http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4</openUrl>\\n <Start>0</Start>\\n <Width>-1</Width>\\n <Height>-1</Height>\\n </OpeningList>\\n <MuxConfig>\\n <Webp>\\n <Loop>0</Loop>\\n </Webp>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <DitherMode>bayer</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>false</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>20</Duration>\\n </Segment>\\n </MuxConfig>\\n <TailSlateList>\\n <Start>00000.00</Start>\\n <BgColor>White</BgColor>\\n <IsMergeAudio>true</IsMergeAudio>\\n <Width>-1</Width>\\n <Height>-1</Height>\\n <BlendDuration>0</BlendDuration>\\n <TailUrl>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv</TailUrl>\\n </TailSlateList>\\n <TemplateId>S00000001-200010</TemplateId>\\n <SubtitleConfig>\\n <ExtSubtitleList>\\n <CharEnc>auto</CharEnc>\\n <FontName>\\"WenQuanYi Zen Hei\\", \\"Yuanti SC Regular\\", \\"SimSun\\"</FontName>\\n <Input>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </Input>\\n </ExtSubtitleList>\\n <SubtitleList>\\n <Map>0:a:0</Map>\\n </SubtitleList>\\n </SubtitleConfig>\\n <Properties>\\n <Width>720</Width>\\n <Height>1280</Height>\\n <SourceLogos>\\n <Source>example</Source>\\n </SourceLogos>\\n <Duration>17</Duration>\\n <Fps>30</Fps>\\n <Bitrate>490</Bitrate>\\n <FileFormat>mp4</FileFormat>\\n <Streams>\\n <VideoStreamList>\\n <Index>0</Index>\\n <Timebase>1/15360</Timebase>\\n <AvgFPS>30.0</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Sar>1:1</Sar>\\n <Lang>eng</Lang>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Height>1280</Height>\\n <NumFrames>30</NumFrames>\\n <Bitrate>421.117</Bitrate>\\n <CodecTagString>avc1</CodecTagString>\\n <HasBFrames>2</HasBFrames>\\n <Profile>high</Profile>\\n <StartTime>0.000000</StartTime>\\n <NetworkCost>\\n <PreloadTime>8</PreloadTime>\\n <AvgBitrate>300</AvgBitrate>\\n <CostBandwidth>10</CostBandwidth>\\n </NetworkCost>\\n <Dar>9:16</Dar>\\n <CodecName>h264</CodecName>\\n <Width>720</Width>\\n <Duration>17.233333</Duration>\\n <Fps>30.0</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1/60</CodecTimeBase>\\n <Level>31</Level>\\n <colorTransfer>bt709</colorTransfer>\\n <colorPrimaries>bt709</colorPrimaries>\\n <bitsPerRawSample>8</bitsPerRawSample>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/32000</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>mono</ChannelLayout>\\n <Lang>und</Lang>\\n <Samplerate>32000</Samplerate>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <Channels>1</Channels>\\n <NumFrames>50</NumFrames>\\n <Bitrate>64.136</Bitrate>\\n <CodecTagString>mp4</CodecTagString>\\n <StartTime>0.064000</StartTime>\\n <CodecName>aac</CodecName>\\n <Duration>17.223562</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/32000</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Index>1</Index>\\n <Lang>eng</Lang>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>-0.064000</StartTime>\\n <NumPrograms>0</NumPrograms>\\n <Size>1057273</Size>\\n <NumStreams>2</NumStreams>\\n <FormatLongName>QuickTime / MOV</FormatLongName>\\n <Duration>17.234000</Duration>\\n <Bitrate>490.784</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n <FileSize>1057273</FileSize>\\n </Properties>\\n </Output>\\n <PipelineId>88c6ca184c0e47b665e2a1267971****</PipelineId>\\n <Input>\\n <Object>video_01.mp4</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>exampleBucket</Bucket>\\n </Input>\\n <MNSMessageResult>\\n <MessageId>123</MessageId>\\n <ErrorMessage>The resource operated “%s” cannot be found.</ErrorMessage>\\n <ErrorCode>InvalidParameter.ResourceNotFound</ErrorCode>\\n </MNSMessageResult>\\n </JobList>\\n</QueryJobListResponse>","errorExample":""}]', + 'title' => 'QueryJobList', + 'description' => '* By default, returned jobs are sorted in descending order by CreationTime.'."\n" + .'* You can call this operation to query up to 10 transcoding jobs at a time.'."\n" + .'* If you do not set the JobIds parameter, the `InvalidParameter` error code is returned.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + 'requestParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of the query results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextPageToken.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'* Default value: **10**.'."\n" + .'* Valid values: **1 to 100**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the transcoding job. Default value: **All**. Valid values:'."\n" + ."\n" + .'* **All**'."\n" + .'* **Submitted**'."\n" + .'* **Transcoding**'."\n" + .'* **TranscodeSuccess**'."\n" + .'* **TranscodeFail**'."\n" + .'* **TranscodeCancelled**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'default' => 'All', + ], + ], + [ + 'name' => 'StartOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-01-10T12:00:00Z', + ], + ], + [ + 'name' => 'EndOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue to which the job is submitted. To obtain the ID of an MPS queue, you can log on to the [MPS console](https://mps.console.aliyun.com/overview) and choose **Global Settings** > **MPS Queue and Callback** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e424d5w5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BC860F04-778A-472F-AB39-E1BF329C1EA8', + ], + 'NextPageToken' => [ + 'description' => 'The pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + 'JobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Job' => [ + 'description' => 'The transcoding jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'Percent' => [ + 'description' => 'The transcoding progress.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:20:25Z', + ], + 'State' => [ + 'description' => 'The state of the job. Valid values:'."\n" + ."\n" + .'* **Submitted**'."\n" + .'* **Transcoding**'."\n" + .'* **TranscodeSuccess**'."\n" + .'* **TranscodeFail**'."\n" + .'* **TranscodeCancelled**'."\n", + 'type' => 'string', + 'example' => 'TranscodeSuccess', + ], + 'JobId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '31fa3c9ca8134fb4b0b0f7878301****', + ], + 'Code' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InternalError', + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The operation has failed due to some unknown error, exception or failure.', + ], + 'Output' => [ + 'description' => 'The output of the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The size of the buffer.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'Degrain' => [ + 'description' => 'The strength of the independent noise reduction algorithm.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'BitrateBnd' => [ + 'description' => 'The bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The maximum bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'Min' => [ + 'description' => 'The minimum bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Pad' => [ + 'description' => 'The black borders that are added to the video. Unit: pixel.'."\n" + ."\n" + .'* Format: width:height:left:top.'."\n" + .'* Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Codec' => [ + 'description' => 'The video codec. Valid values: **H.264**, **H.265**, **GIF**, and **WEBP**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the height of the input video.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Crop' => [ + 'description' => 'The video cropping mode. Valid values:'."\n" + ."\n" + .'* **border**: automatically detects and removes black borders.'."\n" + .'* A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => 'border', + ], + 'Bitrate' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '428', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'MaxFps' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Profile' => [ + 'description' => 'The codec profile. Valid values:'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'The constant rate factor. If this parameter is returned, the value of Bitrate is invalid. Default value: **26**.'."\n", + 'type' => 'string', + 'example' => '26', + ], + 'Gop' => [ + 'description' => 'The maximum number of frames between two keyframes. Default value: 250.'."\n", + 'type' => 'string', + 'example' => '250', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the width of the input video.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n" + ."\n" + .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" + .'* Default value: the frame rate of the input file.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Default value: medium. Valid values:'."\n" + ."\n" + .'* **veryfast**'."\n" + .'* **fast**'."\n" + .'* **medium**'."\n" + .'* **slow**'."\n" + .'* **slower**'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* If this parameter is **empty**, the scan mode of the input file is used.'."\n" + .'* **auto**: automatic deinterlacing.'."\n" + .'* **progressive**: progressive scan.'."\n" + .'* **interlaced**: interlaced scan.'."\n" + .'* **By default**, this parameter is empty.'."\n" + ."\n" + .'**Best practice**: Interlaced scan consumes less bandwidth than progressive scan, but the image quality is poor. Therefore, mainstream video production uses progressive scan.'."\n" + ."\n" + .'* If **progressive scan** or **interlaced scan** is used when the scan mode of the input file is neither of them, the transcoding job fails.'."\n" + .'* We recommend that you use **the scan mode of the input file** or **automatic deinterlacing** to improve compatibility.'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'ResoPriority' => [ + 'description' => 'The priority of the resource.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations. If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + ."\n" + .'* **false**'."\n" + ."\n" + .'* Default value:'."\n" + ."\n" + .' * If this parameter is empty and the codec of the output audio is different from the codec of the input audio, the default value is false.'."\n" + .' * If this parameter is empty and the codec of the output audio is the same as the codec of the input audio, the default value is true.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'TransMode' => [ + 'description' => 'The transcoding mode.'."\n" + ."\n" + .'* Valid values: onepass, twopass, and CBR.'."\n" + .'* Default value: onepass.'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, a transcoding failure is returned without transcoding the video. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: false.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'AdjDarMethod' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values: rescale, crop, pad, and none.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, a transcoding failure is returned without transcoding the audio. This parameter has a higher priority than IsCheckAudioBitrate. Valid values:'."\n" + ."\n" + .'* **false**: The audio bitrate is checked.'."\n" + .'* **true**: The audio bitrate is not checked.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Encryption' => [ + 'description' => 'The encryption configurations. Only outputs in the M3U8 format are supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The encryption type. Only hls-aes-128 may be returned.'."\n", + 'type' => 'string', + 'example' => 'hls-aes-128', + ], + 'Key' => [ + 'description' => 'The key that is used to encrypt the video.'."\n", + 'type' => 'string', + 'example' => 'encryptionkey128', + ], + 'KeyType' => [ + 'description' => 'The key encryption method. Valid values: Base64 and KMS.'."\n" + ."\n" + .'> For example, if the key is encryptionkey128, you can encrypt the key in the Base64 format or use Key Management Service (KMS) to encrypt the key.``````', + 'type' => 'string', + 'example' => 'Base64', + ], + 'Id' => [ + 'description' => 'The encryption ID.'."\n", + 'type' => 'string', + 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', + ], + 'KeyUri' => [ + 'description' => 'The URL that is used to request the key. The URL is Base64-encoded.'."\n", + 'type' => 'string', + 'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/', + ], + 'SkipCnt' => [ + 'description' => 'The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + ], + 'WaterMarkList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WaterMark' => [ + 'description' => 'The watermarks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see [Parameter details](~~29253~~). Valid values:'."\n" + ."\n" + .'* **Image**'."\n" + .'* **Text**'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'ReferPos' => [ + 'description' => 'The position of the watermark.'."\n" + ."\n" + .'* **TopRight**'."\n" + .'* **TopLeft**'."\n" + .'* **BottomRight**'."\n" + .'* **BottomLeft**'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'Dx' => [ + 'description' => 'The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the horizontal offset.'."\n" + ."\n" + .' * Valid values: \\[8,4096].'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution.'."\n" + ."\n" + .' * Valid values: (0,1).'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the watermark width.'."\n" + ."\n" + .' * Valid values: \\[8,4096].'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal indicates the ratio of the watermark width to the width in the output video resolution.'."\n" + ."\n" + .' * Valid values: (0,1).'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'Height' => [ + 'description' => 'The height of the watermark. If this parameter is specified in the request, the corresponding parameter in the specified watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the watermark height.'."\n" + ."\n" + .' * Valid values: \\[8,4096].'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal indicates the ratio of the watermark height to the height in the output video resolution.'."\n" + ."\n" + .' * Valid values: (0,1).'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'InputFile' => [ + 'description' => 'The watermark input file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the Object Storage Service (OSS) object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-logo-****.png', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'WaterMarkTemplateId' => [ + 'description' => 'The ID of the watermark template.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Dy' => [ + 'description' => 'The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" + ."\n" + .'* An integer indicates the pixel value of the vertical offset.'."\n" + ."\n" + .' * Valid values: \\[8,4096].'."\n" + .' * Unit: pixel.'."\n" + ."\n" + .'* A decimal indicates the ratio of the vertical offset to the height in the output video resolution.'."\n" + ."\n" + .' * Valid values: (0,1).'."\n" + .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'WaterMarkConfigUrl' => [ + 'description' => 'The URL of the watermark configuration file.'."\n", + 'type' => 'string', + 'example' => 'http://example.com/configure', + ], + 'DeWatermark' => [ + 'description' => 'The configurations of watermark blurring. The value is a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", + 'type' => 'string', + 'example' => '{"0": [{"l": 10,"t": 10,"w": 10,"h": 10},{"l": 100,"t": 0.1,"w": 10,"h": 10}],"128000": [],"250000": [{"l": 0.2,"t": 0.1,"w": 0.01,"h": 0.05}]}', + ], + 'M3U8NonStandardSupport' => [ + 'description' => 'The non-standard support configuration for M3U8. The value must be a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'TS' => [ + 'description' => 'The non-standard support configurations for TS files. The value is a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'SizeSupport' => [ + 'description' => 'Indicates whether the size of the TS file is included in the M3U8 file.'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Md5Support' => [ + 'description' => 'Indicates whether the MD5 value of the TS file is included in the M3U8 file. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'Priority' => [ + 'description' => 'The priority of the job in the MPS queue to which the job is added.'."\n" + ."\n" + .'* A value of 10 indicates the highest priority.'."\n" + .'* Default value: **6**.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'Audio' => [ + 'description' => 'The audio configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values if the value of Codec is aac: aaclow, aache, aachev2, aacld, and aaceld.'."\n", + 'type' => 'string', + 'example' => 'aaclow', + ], + 'Codec' => [ + 'description' => 'The audio codec.'."\n" + ."\n" + .'* Valid values: aac, mp3, vorbis, and flac.'."\n" + .'* Default value: **aac**.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" + .'* Unit: Hz.'."\n" + .'* Default value: 44100.'."\n" + .'* If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the audio.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n" + ."\n" + .'* If the value of Codec is mp3, the value of this parameter can only be 1 or 2.'."\n" + .'* If the value of Codec is aac, the value of this parameter can only be 1, 2, 4, 5, 6, or 8.'."\n" + .'* Default value: 2.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Volume' => [ + 'description' => 'The volume configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => 'The method that is used to adjust the volume. Valid values:'."\n" + ."\n" + .'* **auto**'."\n" + .'* **dynamic**'."\n" + .'* **linear**'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'Level' => [ + 'description' => 'The volume adjustment range.'."\n" + ."\n" + .'* Unit: decibel.'."\n" + .'* Default value: **-20**.'."\n", + 'type' => 'string', + 'example' => '-20', + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '128', + ], + ], + ], + 'AudioStreamMap' => [ + 'description' => 'The sequence number of the audio stream.'."\n" + ."\n" + .'* Format: `0:a:{Sequence number}`.'."\n" + .'* The sequence number is the index of the audio stream in the list and starts from 0. If no sequence number is specified, the default audio stream is used.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + 'MergeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Merge' => [ + 'description' => 'The configurations for merging clips.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start point in time of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'MergeURL' => [ + 'description' => 'The OSS URL of the clip.'."\n" + ."\n" + .'* Example: `http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object.flv`.'."\n" + .'* The object must be URL-encoded by using the UTF-8 standard.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv', + ], + 'Duration' => [ + 'description' => 'The duration of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:59:59.999', + ], + ], + ], + ], + ], + ], + 'SuperReso' => [ + 'description' => 'The configurations for using the resolution of the source video.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsHalfSample' => [ + 'description' => 'Indicates whether parameters related to the sampling rate are obtained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'test-001', + ], + 'OutSubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OutSubtitle' => [ + 'description' => 'The output subtitles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'description' => 'The video track. Format: 0:{Stream}:{Stream sequence number}, that is, 0:v:{video_index}. The value of Stream is v, which indicates a video stream. The sequence number is the index of the video stream in the list and starts from 0.'."\n", + 'type' => 'string', + 'example' => '0:v:0', + ], + 'OutSubtitleFile' => [ + 'description' => 'The details of the output file.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the RAM role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the output file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the output file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the job was created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed to be created. This parameter is not returned if the job was created.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter “%s” cannot be null.', + ], + ], + ], + ], + ], + ], + 'VideoStreamMap' => [ + 'description' => 'The sequence number of the video stream.'."\n" + ."\n" + .'* Format: 0:a:{Sequence number}. Example value: 0:a:0.'."\n" + .'* The sequence number is the index of the video stream in the list and starts from 0.'."\n" + .'* If no sequence number is specified, the default video stream is used.'."\n", + 'type' => 'string', + 'example' => '0:a:0', + ], + 'OutputFile' => [ + 'description' => 'The details of the output file.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the RAM role used for delegated authorization.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::<your uid>:role/<your role name>', + ], + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the output file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the output file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'Rotate' => [ + 'description' => 'The rotation angle of the video.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n" + ."\n" + .'* Default value: mp4.'."\n" + .'* Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).'."\n" + .'* Audio formats include MP3, MP4, Ogg, FLAC, and M4A.'."\n" + .'* Image formats include GIF and WebP.'."\n" + .'* If the container format is GIF, the video codec must be GIF.'."\n" + .'* If the container format is WebP, the video codec must be WebP.'."\n" + .'* If the container format is FLV, the video codec cannot be H.265.'."\n", + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + 'Clip' => [ + 'description' => 'The information about the clip.'."\n", + 'type' => 'object', + 'properties' => [ + 'TimeSpan' => [ + 'description' => 'The time span of the clip.'."\n", + 'type' => 'object', + 'properties' => [ + 'Seek' => [ + 'description' => 'The point in time when the clip starts.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n" + .'* Examples: 01:59:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:00:59.999', + ], + 'Duration' => [ + 'description' => 'The duration of the clip.'."\n" + ."\n" + .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" + .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n" + .'* Examples: 01:00:59.999 and 32000.23.'."\n", + 'type' => 'string', + 'example' => '01:00:59.999', + ], + ], + ], + ], + ], + 'MergeConfigUrl' => [ + 'description' => 'The URL of the merging configuration file. You can specify either MergeList or MergeConfigUrl when you submit the transcoding job.'."\n" + ."\n" + .'* The configuration file specified by MergeConfigUrl can contain up to 50 clips.'."\n" + .'* MergeConfigUrl indicates the URL of the configuration file for merging clips.'."\n" + .'* Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details of merging parameters.'."\n" + .'* Example of the content of the merging configuration file: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.'."\n", + 'type' => 'string', + 'example' => '{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}', + ], + 'OpeningList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Opening' => [ + 'description' => 'The opening parts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'openUrl' => [ + 'description' => 'The OSS URL of the opening part.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', + ], + 'Start' => [ + 'description' => 'The amount of time after which the opening part is played. The value starts from 0.'."\n" + ."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Width' => [ + 'description' => 'The width of the opening part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" + ."\n" + .'* Default value: **-1**.'."\n" + .'* A value of -1 indicates that the width of the source of the opening part is retained.'."\n" + .'* A value of full indicates that the width of the opening part equals the width of the main part.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'Height' => [ + 'description' => 'The height of the opening part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" + ."\n" + .'* Default value: **-1**.'."\n" + .'* A value of -1 indicates that the height of the source of the opening part is retained.'."\n" + .'* A value of full indicates that the height of the opening part equals the height of the main part.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + ], + ], + ], + ], + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Webp' => [ + 'description' => 'The transmuxing configurations for WebP.'."\n", + 'type' => 'object', + 'properties' => [ + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Gif' => [ + 'description' => 'The transmuxing configurations for GIF.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The duration for which the final frame is paused. Unit: centisecond.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DitherMode' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: **sierra** and **bayer**.'."\n", + 'type' => 'string', + 'example' => 'bayer', + ], + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'Indicates whether a custom palette is used. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configurations. The value is a JSON object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The length of the segment. The value must be an integer. Unit: seconds.'."\n" + ."\n" + .'* Valid values: \\[1,10].'."\n" + .'* Default value: 10.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'TailSlateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TailSlate' => [ + 'description' => 'The ending parts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'BgColor' => [ + 'description' => 'The color of the bars that are added to the ending part if the size of the ending part is smaller than that of the main part. Default value: **White**. For more information, see [Background colors](https://docs-aliyun.cn-hangzhou.oss.aliyun-inc.com/assets/attach/29253/cn_zh/1502784952344/color.txt?spm=a2c4g.11186623.2.63.1df840f74IH4Eq\\&file=color.txt).'."\n", + 'type' => 'string', + 'example' => 'White', + ], + 'IsMergeAudio' => [ + 'description' => 'Indicates whether the audio content of the ending part is merged. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Width' => [ + 'description' => 'The width of the ending part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" + ."\n" + .'* A value of -1 indicates that the width of the source of the ending part is retained. A value of full indicates that the width of the ending part equals the width of the main part.'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'Height' => [ + 'description' => 'The height of the ending part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" + ."\n" + .'* A value of -1 indicates that the height of the source of the ending part is retained.'."\n" + .'* A value of full indicates that the height of the ending part equals the height of the main part.'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'BlendDuration' => [ + 'description' => 'The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TailUrl' => [ + 'description' => 'The OSS URL of the ending part.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', + ], + ], + ], + ], + ], + ], + 'TemplateId' => [ + 'description' => 'The template ID.'."\n", + 'type' => 'string', + 'example' => 'S00000000-000010', + ], + 'SubtitleConfig' => [ + 'description' => 'The subtitle configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtSubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExtSubtitle' => [ + 'description' => 'The external subtitles. The value is a JSON array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CharEnc' => [ + 'description' => 'The character set used by the external subtitle.'."\n" + ."\n" + .'* Valid values: UTF-8, GBK, BIG5, and auto.'."\n" + .'* Default value: **auto**.'."\n" + ."\n" + .'> If this parameter is set to auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'FontName' => [ + 'description' => 'The font of the hardcoded subtitles converted from external subtitles.'."\n", + 'type' => 'string', + 'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"', + ], + 'Input' => [ + 'description' => 'The input subtitle file.'."\n" + ."\n" + .'* Files in the SRT or ASS format are supported. For more information, see [Parameter details](~~29253~~).'."\n" + .'* Example: `{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}`.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-output.flv', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + ], + ], + ], + ], + ], + ], + ], + 'SubtitleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Subtitle' => [ + 'description' => 'The subtitles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'description' => 'The sequence number of the video stream. The sequence number is the index of the video stream in the list and starts from 0. If you do not set the corresponding parameter in the request, the default video stream is selected.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'Properties' => [ + 'description' => 'The media properties.'."\n", + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'description' => 'The width of the video.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'Duration' => [ + 'description' => 'The duration of the video.'."\n", + 'type' => 'string', + 'example' => '17', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the video.'."\n", + 'type' => 'string', + 'example' => '490', + ], + 'FileFormat' => [ + 'description' => 'The format of the video.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + 'Streams' => [ + 'description' => 'The stream information.'."\n", + 'type' => 'object', + 'properties' => [ + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The video streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Timebase' => [ + 'description' => 'The time base of the video stream.'."\n", + 'type' => 'string', + 'example' => '1/15360', + ], + 'AvgFPS' => [ + 'description' => 'The average frame rate of the video stream.'."\n", + 'type' => 'string', + 'example' => '30.0', + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video stream.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR) of the video stream.'."\n", + 'type' => 'string', + 'example' => '1:1', + ], + 'Lang' => [ + 'description' => 'The language of the video stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'und', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the codec.'."\n", + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Height' => [ + 'description' => 'The height of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'NumFrames' => [ + 'description' => 'The total frame rate.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the video stream.'."\n", + 'type' => 'string', + 'example' => '421.117', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the codec.'."\n", + 'type' => 'string', + 'example' => 'avc1', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains B-frames.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Profile' => [ + 'description' => 'The codec profile.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth that was consumed.'."\n", + 'type' => 'object', + 'properties' => [ + 'PreloadTime' => [ + 'description' => 'The amount of time consumed to preload the video stream.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'AvgBitrate' => [ + 'description' => 'The average bitrate of the video stream.'."\n", + 'type' => 'string', + 'example' => '300', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that was consumed.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR).'."\n", + 'type' => 'string', + 'example' => '9:16', + ], + 'CodecName' => [ + 'description' => 'The short name of the codec.'."\n", + 'type' => 'string', + 'example' => 'h264', + ], + 'Width' => [ + 'description' => 'The width of the video stream in pixels.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Duration' => [ + 'description' => 'The duration of the video stream.'."\n", + 'type' => 'string', + 'example' => '17.233333', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video stream.'."\n", + 'type' => 'string', + 'example' => '30.0', + ], + 'CodecTag' => [ + 'description' => 'The tag of the codec.'."\n", + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/60', + ], + 'Level' => [ + 'description' => 'The codec level.'."\n", + 'type' => 'string', + 'example' => '31', + ], + ], + ], + ], + ], + ], + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The audio streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base of the audio stream.'."\n", + 'type' => 'string', + 'example' => '1/32000', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.'."\n", + 'type' => 'string', + 'example' => 'fltp', + ], + 'ChannelLayout' => [ + 'description' => 'The output layout of the sound channels.'."\n", + 'type' => 'string', + 'example' => 'mono', + ], + 'Lang' => [ + 'description' => 'The language of the audio stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", + 'type' => 'string', + 'example' => 'und', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate of the audio stream.'."\n", + 'type' => 'string', + 'example' => '32000', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the codec.'."\n", + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the audio stream.'."\n", + 'type' => 'string', + 'example' => '64.136', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the codec.'."\n", + 'type' => 'string', + 'example' => 'mp4a', + ], + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.000000', + ], + 'CodecName' => [ + 'description' => 'The short name of the codec.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => 'The duration of the audio stream.'."\n", + 'type' => 'string', + 'example' => '17.223562', + ], + 'CodecTag' => [ + 'description' => 'The tag of the codec.'."\n", + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.'."\n", + 'type' => 'string', + 'example' => '1/32000', + ], + ], + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The subtitle streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Lang' => [ + 'description' => 'The language of the subtitle stream.'."\n", + 'type' => 'string', + 'example' => 'und', + ], + ], + ], + ], + ], + ], + ], + ], + 'Format' => [ + 'description' => 'The format information.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '0.064000', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Size' => [ + 'description' => 'The size of the file.'."\n", + 'type' => 'string', + 'example' => '1057273', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the container format.'."\n", + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'Duration' => [ + 'description' => 'The total duration.'."\n", + 'type' => 'string', + 'example' => '17.234000', + ], + 'Bitrate' => [ + 'description' => 'The total bitrate.'."\n", + 'type' => 'string', + 'example' => '490.784', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'type' => 'string', + 'example' => 'mov', + ], + ], + ], + 'FileSize' => [ + 'description' => 'The size of the file.'."\n", + 'type' => 'string', + 'example' => '1057273', + ], + ], + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47b665e2a1267971****', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the job input.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the job input is stored.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the job input is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by Message Service (MNS) to notify users of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated “%s” cannot be found.', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC860F04-778A-472F-AB39-E1BF329C1EA8\\",\\n \\"NextPageToken\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"JobList\\": {\\n \\"Job\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 100,\\n \\"FinishTime\\": \\"2014-01-10T12:20:25Z\\",\\n \\"State\\": \\"TranscodeSuccess\\",\\n \\"JobId\\": \\"31fa3c9ca8134fb4b0b0f7878301****\\",\\n \\"Code\\": \\"InternalError\\",\\n \\"Message\\": \\"The operation has failed due to some unknown error, exception or failure.\\",\\n \\"Output\\": {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1000\\",\\n \\"Min\\": \\"200\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"428\\",\\n \\"Maxrate\\": \\"1000\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"26\\",\\n \\"Gop\\": \\"250\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\"\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"Encryption\\": {\\n \\"Type\\": \\"hls-aes-128\\",\\n \\"Key\\": \\"encryptionkey128\\",\\n \\"KeyType\\": \\"Base64\\",\\n \\"Id\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"KeyUri\\": \\"https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/\\",\\n \\"SkipCnt\\": \\"3\\"\\n },\\n \\"WaterMarkList\\": {\\n \\"WaterMark\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"50\\",\\n \\"Height\\": \\"50\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-logo-****.png\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"WaterMarkTemplateId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Dy\\": \\"100\\"\\n }\\n ]\\n },\\n \\"WaterMarkConfigUrl\\": \\"http://example.com/configure\\",\\n \\"DeWatermark\\": \\"{\\\\\\"0\\\\\\": [{\\\\\\"l\\\\\\": 10,\\\\\\"t\\\\\\": 10,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10},{\\\\\\"l\\\\\\": 100,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10}],\\\\\\"128000\\\\\\": [],\\\\\\"250000\\\\\\": [{\\\\\\"l\\\\\\": 0.2,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 0.01,\\\\\\"h\\\\\\": 0.05}]}\\",\\n \\"M3U8NonStandardSupport\\": {\\n \\"TS\\": {\\n \\"SizeSupport\\": true,\\n \\"Md5Support\\": true\\n }\\n },\\n \\"Priority\\": \\"6\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aaclow\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Channels\\": \\"2\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"Level\\": \\"-20\\"\\n },\\n \\"Bitrate\\": \\"128\\"\\n },\\n \\"AudioStreamMap\\": \\"0:a:0\\",\\n \\"MergeList\\": {\\n \\"Merge\\": [\\n {\\n \\"Start\\": \\"01:59:59.999或者32000.23\\",\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"MergeURL\\": \\"http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv\\",\\n \\"Duration\\": \\"01:59:59.999\\"\\n }\\n ]\\n },\\n \\"SuperReso\\": {\\n \\"IsHalfSample\\": \\"true\\"\\n },\\n \\"UserData\\": \\"test-001\\",\\n \\"OutSubtitleList\\": {\\n \\"OutSubtitle\\": [\\n {\\n \\"Map\\": \\"0:v:0\\",\\n \\"OutSubtitleFile\\": {\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n },\\n \\"Success\\": true,\\n \\"Message\\": \\"The specified parameter “%s” cannot be null.\\"\\n }\\n ]\\n },\\n \\"VideoStreamMap\\": \\"0:a:0\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::<your uid>:role/<your role name>\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"Rotate\\": \\"90\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n },\\n \\"Clip\\": {\\n \\"TimeSpan\\": {\\n \\"Seek\\": \\"01:00:59.999\\",\\n \\"Duration\\": \\"01:00:59.999\\"\\n }\\n },\\n \\"MergeConfigUrl\\": \\"{\\\\\\"MergeList\\\\\\":[{\\\\\\"MergeURL\\\\\\":\\\\\\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\\\\\\"}]}\\",\\n \\"OpeningList\\": {\\n \\"Opening\\": [\\n {\\n \\"openUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\",\\n \\"Start\\": \\"0\\",\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\"\\n }\\n ]\\n },\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"bayer\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"true\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"TailSlateList\\": {\\n \\"TailSlate\\": [\\n {\\n \\"Start\\": \\"1\\",\\n \\"BgColor\\": \\"White\\",\\n \\"IsMergeAudio\\": true,\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\",\\n \\"BlendDuration\\": \\"0\\",\\n \\"TailUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"S00000000-000010\\",\\n \\"SubtitleConfig\\": {\\n \\"ExtSubtitleList\\": {\\n \\"ExtSubtitle\\": [\\n {\\n \\"CharEnc\\": \\"auto\\",\\n \\"FontName\\": \\"\\\\\\"WenQuanYi Zen Hei\\\\\\", \\\\\\"Yuanti SC Regular\\\\\\", \\\\\\"SimSun\\\\\\"\\",\\n \\"Input\\": {\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n }\\n ]\\n },\\n \\"SubtitleList\\": {\\n \\"Subtitle\\": [\\n {\\n \\"Map\\": \\"0\\"\\n }\\n ]\\n }\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"720\\",\\n \\"Height\\": \\"1280\\",\\n \\"Duration\\": \\"17\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"490\\",\\n \\"FileFormat\\": \\"mp4\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Timebase\\": \\"1/15360\\",\\n \\"AvgFPS\\": \\"30.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Sar\\": \\"1:1\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Height\\": \\"1280\\",\\n \\"NumFrames\\": \\"30\\",\\n \\"Bitrate\\": \\"421.117\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"high\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Dar\\": \\"9:16\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": \\"720\\",\\n \\"Duration\\": \\"17.233333\\",\\n \\"Fps\\": \\"30.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/60\\",\\n \\"Level\\": \\"31\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/32000\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"1\\",\\n \\"NumFrames\\": \\"30\\",\\n \\"Bitrate\\": \\"64.136\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"17.223562\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/32000\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.064000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"1057273\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Duration\\": \\"17.234000\\",\\n \\"Bitrate\\": \\"490.784\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"1057273\\"\\n }\\n },\\n \\"PipelineId\\": \\"88c6ca184c0e47b665e2a1267971****\\",\\n \\"Input\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"123\\",\\n \\"ErrorMessage\\": \\"The resource operated “%s” cannot be found.\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListJobResponse>\\n <RequestId>BC860F04-778A-472F-AB39-E1BF329C1EA8</RequestId>\\n <NextPageToken>16f01ad6175e4230ac42bb5182cd****</NextPageToken>\\n <JobList>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <Percent>100</Percent>\\n <FinishTime>2014-01-10T12:20:25Z</FinishTime>\\n <State>TranscodeSuccess</State>\\n <JobId>31fa3c9ca8134fb4b0b0f7878301****</JobId>\\n <Code>InternalError</Code>\\n <Message>The operation has failed due to some unknown error, exception or failure.</Message>\\n <Output>\\n <Video>\\n <Bufsize>6000</Bufsize>\\n <Degrain>5</Degrain>\\n <BitrateBnd>\\n <Max>1000</Max>\\n <Min>200</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>720</Height>\\n <Qscale>15</Qscale>\\n <Crop>border</Crop>\\n <Bitrate>428</Bitrate>\\n <Maxrate>1000</Maxrate>\\n <MaxFps>60</MaxFps>\\n <Profile>high</Profile>\\n <Crf>26</Crf>\\n <Gop>250</Gop>\\n <Width>1280</Width>\\n <Fps>25</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>interlaced</ScanMode>\\n <ResoPriority>1</ResoPriority>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>false</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>false</IsCheckReso>\\n <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>\\n <AdjDarMethod>none</AdjDarMethod>\\n <IsCheckVideoBitrate>false</IsCheckVideoBitrate>\\n <IsCheckResoFail>false</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <Encryption>\\n <Type>hls-aes-128</Type>\\n <Key>encryptionkey128</Key>\\n <KeyType>Base64</KeyType>\\n <Id>31fa3c9ca8134f9cec2b4b0b0f78****</Id>\\n <KeyUri>https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/</KeyUri>\\n <SkipCnt>3</SkipCnt>\\n </Encryption>\\n <WaterMarkList>\\n <Type>Image</Type>\\n <ReferPos>TopRight</ReferPos>\\n <Dx>100</Dx>\\n <Width>50</Width>\\n <Height>50</Height>\\n <InputFile>\\n <Object>example-logo-****.png</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </InputFile>\\n <WaterMarkTemplateId>88c6ca184c0e47098a5b665e2a12****</WaterMarkTemplateId>\\n <Dy>100</Dy>\\n </WaterMarkList>\\n <WaterMarkConfigUrl>http://example.com/configure</WaterMarkConfigUrl>\\n <DeWatermark>{\\"0\\": [{\\"l\\": 10,\\"t\\": 10,\\"w\\": 10,\\"h\\": 10},{\\"l\\": 100,\\"t\\": 0.1,\\"w\\": 10,\\"h\\": 10}],\\"128000\\": [],\\"250000\\": [{\\"l\\": 0.2,\\"t\\": 0.1,\\"w\\": 0.01,\\"h\\": 0.05}]}</DeWatermark>\\n <M3U8NonStandardSupport>\\n <TS>\\n <SizeSupport>true</SizeSupport>\\n <Md5Support>true</Md5Support>\\n </TS>\\n </M3U8NonStandardSupport>\\n <Priority>6</Priority>\\n <Audio>\\n <Profile>aaclow</Profile>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>15</Qscale>\\n <Channels>2</Channels>\\n <Volume>\\n <Method>auto</Method>\\n <Level>-20</Level>\\n </Volume>\\n <Bitrate>128</Bitrate>\\n </Audio>\\n <AudioStreamMap>0:a:0</AudioStreamMap>\\n <MergeList>\\n <Start>01:59:59.999或者32000.23</Start>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <MergeURL>http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv</MergeURL>\\n <Duration>01:59:59.999</Duration>\\n </MergeList>\\n <SuperReso>\\n <IsHalfSample>true</IsHalfSample>\\n </SuperReso>\\n <UserData>test-001</UserData>\\n <OutSubtitleList>\\n <Map>0:v:0</Map>\\n <OutSubtitleFile>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </OutSubtitleFile>\\n <Success>true</Success>\\n <Message>The specified parameter “%s” cannot be null.</Message>\\n </OutSubtitleList>\\n <VideoStreamMap>0:a:0</VideoStreamMap>\\n <OutputFile>\\n <RoleArn>acs:ram::<your uid>:role/<your role name></RoleArn>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </OutputFile>\\n <Rotate>90</Rotate>\\n <Container>\\n <Format>flv</Format>\\n </Container>\\n <Clip>\\n <TimeSpan>\\n <Seek>01:00:59.999</Seek>\\n <Duration>01:00:59.999</Duration>\\n </TimeSpan>\\n </Clip>\\n <MergeConfigUrl>{\\"MergeList\\":[{\\"MergeURL\\":\\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\\"}]}</MergeConfigUrl>\\n <OpeningList>\\n <openUrl>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv</openUrl>\\n <Start>0</Start>\\n <Width>-1</Width>\\n <Height>-1</Height>\\n </OpeningList>\\n <MuxConfig>\\n <Webp>\\n <Loop>0</Loop>\\n </Webp>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <DitherMode>bayer</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>true</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>10</Duration>\\n </Segment>\\n </MuxConfig>\\n <TailSlateList>\\n <Start>1</Start>\\n <BgColor>White</BgColor>\\n <IsMergeAudio>true</IsMergeAudio>\\n <Width>-1</Width>\\n <Height>-1</Height>\\n <BlendDuration>0</BlendDuration>\\n <TailUrl>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv</TailUrl>\\n </TailSlateList>\\n <TemplateId>S00000000-000010</TemplateId>\\n <SubtitleConfig>\\n <ExtSubtitleList>\\n <CharEnc>auto</CharEnc>\\n <FontName>\\"WenQuanYi Zen Hei\\", \\"Yuanti SC Regular\\", \\"SimSun\\"</FontName>\\n <Input>\\n <Object>example-output.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </Input>\\n </ExtSubtitleList>\\n <SubtitleList>\\n <Map>0</Map>\\n </SubtitleList>\\n </SubtitleConfig>\\n <Properties>\\n <Width>720</Width>\\n <Height>1280</Height>\\n <Duration>17</Duration>\\n <Fps>30</Fps>\\n <Bitrate>490</Bitrate>\\n <FileFormat>mp4</FileFormat>\\n <Streams>\\n <VideoStreamList>\\n <Index>0</Index>\\n <Timebase>1/15360</Timebase>\\n <AvgFPS>30.0</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Sar>1:1</Sar>\\n <Lang>und</Lang>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Height>1280</Height>\\n <NumFrames>30</NumFrames>\\n <Bitrate>421.117</Bitrate>\\n <CodecTagString>avc1</CodecTagString>\\n <HasBFrames>2</HasBFrames>\\n <Profile>high</Profile>\\n <StartTime>0.000000</StartTime>\\n <NetworkCost>\\n <PreloadTime>8</PreloadTime>\\n <AvgBitrate>300</AvgBitrate>\\n <CostBandwidth>10</CostBandwidth>\\n </NetworkCost>\\n <Dar>9:16</Dar>\\n <CodecName>h264</CodecName>\\n <Width>720</Width>\\n <Duration>17.233333</Duration>\\n <Fps>30.0</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1/60</CodecTimeBase>\\n <Level>31</Level>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/32000</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>mono</ChannelLayout>\\n <Lang>und</Lang>\\n <Samplerate>32000</Samplerate>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <Channels>1</Channels>\\n <NumFrames>30</NumFrames>\\n <Bitrate>64.136</Bitrate>\\n <CodecTagString>mp4a</CodecTagString>\\n <StartTime>0.000000</StartTime>\\n <CodecName>aac</CodecName>\\n <Duration>17.223562</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/32000</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Index>1</Index>\\n <Lang>und</Lang>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>0.064000</StartTime>\\n <NumPrograms>0</NumPrograms>\\n <Size>1057273</Size>\\n <NumStreams>2</NumStreams>\\n <FormatLongName>QuickTime / MOV</FormatLongName>\\n <Duration>17.234000</Duration>\\n <Bitrate>490.784</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n <FileSize>1057273</FileSize>\\n </Properties>\\n </Output>\\n <PipelineId>88c6ca184c0e47b665e2a1267971****</PipelineId>\\n <Input>\\n <Object>example.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </Input>\\n <MNSMessageResult>\\n <MessageId>123</MessageId>\\n <ErrorMessage>The resource operated “%s” cannot be found.</ErrorMessage>\\n <ErrorCode>InvalidParameter.ResourceNotFound</ErrorCode>\\n </MNSMessageResult>\\n </JobList>\\n</ListJobResponse>","errorExample":""}]', + 'title' => 'ListJob', + 'summary' => 'Traverses transcoding jobs', + 'description' => '* By default, the returned transcoding jobs are sorted by CreationTime in descending order.'."\n" + .'* You can call this operation to return transcoding jobs of the last 90 days. The jobs are returned based on the specified time range.'."\n" + .'* You can filter query results by configuring request parameters such as job status, creation time interval, and ApsaraVideo Media Processing (MPS) queue for transcoding.'."\n" + .'* By default, MPS does not allow you to access data across regions within the same account. Before you call this operation, make sure that the region that you specify is the same as the region of the transcoding jobs to be queried. Otherwise, this operation may fail to be called, or invalid information may be returned.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitAnalysisJob' => [ + 'summary' => 'Submits a preset template analysis job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmts0IG2Y5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The input information about the preset template analysis job to be submitted. The value must be a JSON object. You must log on to the Object Storage Service (OSS) console to grant the read permissions on the specified OSS bucket to MPS. For more information, see the "Input" section of the [Parameter details](~~29253~~) topic.'."\n" + ."\n" + .'> The OSS bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.flv"}', + ], + ], + [ + 'name' => 'AnalysisConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job configurations. Set this parameter as required. For more information, see the "AnalysisConfig" section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"QualityControl":{"RateQuality":25,"MethodStreaming":"network"}}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The custom data can contain letters, digits, and hyphens (-), and can be up to 1,024 bytes in length. The custom data cannot start with a special character.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testid-001', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue to which the job is submitted. To view the ID of the MPS queue, log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane. If you want to enable asynchronous notifications, make sure that the MPS queue is bound to a Message Service (MNS) topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'bb558c1cc25b45309aab5be44d19****', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the job in the MPS queue to which the job is submitted.'."\n" + ."\n" + .'* Valid values: **1 to 10**. A value of 10 indicates the highest priority.'."\n" + .'* Default value: **6**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B52658D4-07AB-43CD-82B0-210958A65E23', + ], + 'AnalysisJob' => [ + 'description' => 'The information about the preset template analysis job that was submitted.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'Percent' => [ + 'description' => 'The transcoding progress.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'State' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* **Submitted**: The job is submitted.'."\n" + .'* **Analyzing**: The job is being run.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'AnalysisConfig' => [ + 'description' => 'The job configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'QualityControl' => [ + 'description' => 'The quality control on the job output.'."\n", + 'type' => 'object', + 'properties' => [ + 'MethodStreaming' => [ + 'description' => 'The playback mode. Valid values:'."\n" + ."\n" + .'* **network**: online playback'."\n" + .'* **local**: playback on local devices'."\n" + .'* Default value: **network**.'."\n", + 'type' => 'string', + 'example' => 'network', + ], + 'RateQuality' => [ + 'description' => 'The quality level of the output file.'."\n", + 'type' => 'string', + 'example' => '50', + ], + ], + ], + 'PropertiesControl' => [ + 'description' => 'The control on the attributes of the job output.'."\n", + 'type' => 'object', + 'properties' => [ + 'Deinterlace' => [ + 'description' => 'Indicates whether deinterlacing was forced to run. Valid values:'."\n" + ."\n" + .'* **Auto**: Deinterlacing was automatically run.'."\n" + .'* **Force**: Deinterlacing was forced to run.'."\n" + .'* **None**: Deinterlacing was forced not to run.'."\n", + 'type' => 'string', + 'example' => 'Force', + ], + 'Crop' => [ + 'description' => 'The cropping configurations of video images.'."\n", + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => 'The top margin that was cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Width' => [ + 'description' => 'The width of the video after the margins were cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Height' => [ + 'description' => 'The height of the video after the margins were cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Left' => [ + 'description' => 'The left margin that was cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Mode' => [ + 'description' => 'The cropping mode. Valid values:'."\n" + ."\n" + .'* **Auto**: Cropping was automatically run. This is the default value.'."\n" + .'* **Force**: Cropping was forced to run.'."\n" + .'* **None**: Cropping was forced not to run.'."\n", + 'type' => 'string', + 'example' => 'Auto', + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed.'."\n", + 'type' => 'string', + 'example' => 'The resource operated \\"PipelineId\\" cannot be found', + ], + 'Priority' => [ + 'description' => 'The priority of the job in the MPS queue to which the job was submitted.'."\n" + ."\n" + .'* Valid values: **1 to 10**. A value of 10 indicates the highest priority.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by MNS to notify users of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message returned if the job was successful. This parameter is not returned if the job failed.'."\n", + 'type' => 'string', + 'example' => '3ca84a39a9024f19853b21be9cf9****', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated \\"PipelineId\\" cannot be found', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + ], + ], + 'TemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The matched preset templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the preset template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The size of the buffer.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => '5000', + ], + 'Degrain' => [ + 'description' => 'The strength of the independent noise reduction algorithm.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'BitrateBnd' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'Min' => [ + 'description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format for video color encoding. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => 'yuvj420p', + ], + 'Codec' => [ + 'description' => 'The video codec. Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the height of the input video.'."\n", + 'type' => 'string', + 'example' => '1880', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Bitrate' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Profile' => [ + 'description' => 'The codec profile. Valid values:'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => 'baseline', + ], + 'Crf' => [ + 'description' => 'The constant rate factor.'."\n" + ."\n" + .'* Default value if the Codec parameter is set to H.264: **23**. Default value if the Codec parameter is set to H.265: **26**.'."\n" + .'* If this parameter is returned, the setting of the Bitrate parameter is invalid.'."\n", + 'type' => 'string', + 'example' => '27', + ], + 'Gop' => [ + 'description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the width of the input video.'."\n", + 'type' => 'string', + 'example' => '1990', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n" + ."\n" + .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" + .'* Default value: the frame rate of the input video.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: **medium**.'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* **interlaced**'."\n" + .'* **progressive**'."\n", + 'type' => 'string', + 'example' => 'progressive', + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => 'The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: **onepass**.'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + ], + ], + 'State' => [ + 'description' => 'The status of the template.'."\n" + ."\n" + .'* **Normal**: The template is normal.'."\n" + .'* **Deleted**: The template is deleted.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gif' => [ + 'description' => 'The transmuxing configurations for the GIF format.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The interval between two consecutive loops for the GIF format. Unit: 0.01s. For example, a value of 500 indicates 5 seconds.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Loop' => [ + 'description' => 'The number of loops for the GIF or WebP format. Default value: 0.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The length of the segment. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'FLV-UD', + ], + 'Audio' => [ + 'description' => 'The audio codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values if the **Codec** parameter is set to **aac**: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Codec' => [ + 'description' => 'The audio codec format. Default value: **acc**.'."\n", + 'type' => 'string', + 'example' => 'mp3', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Unit: Hz.'."\n" + .'* Default value: **44100**.'."\n", + 'type' => 'string', + 'example' => '32000', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the audio.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Channels' => [ + 'description' => 'The number of sound channels. Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '8', + ], + ], + ], + 'Id' => [ + 'description' => 'The ID of the transcoding template.'."\n", + 'type' => 'string', + 'example' => 'S00000000-00****', + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n", + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + ], + ], + ], + ], + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Code' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'InputFile' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue to which the analysis job was submitted.'."\n", + 'type' => 'string', + 'example' => 'bb558c1cc25b45309aab5be44d19****', + ], + 'Id' => [ + 'description' => 'The ID of the template analysis job.'."\n", + 'type' => 'string', + 'example' => '57f6aa3f84824309bcba67231b40****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B52658D4-07AB-43CD-82B0-210958A65E23\\",\\n \\"AnalysisJob\\": {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 100,\\n \\"State\\": \\"Success\\",\\n \\"AnalysisConfig\\": {\\n \\"QualityControl\\": {\\n \\"MethodStreaming\\": \\"network\\",\\n \\"RateQuality\\": \\"50\\"\\n },\\n \\"PropertiesControl\\": {\\n \\"Deinterlace\\": \\"Force\\",\\n \\"Crop\\": {\\n \\"Top\\": \\"8\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Left\\": \\"8\\",\\n \\"Mode\\": \\"Auto\\"\\n }\\n }\\n },\\n \\"Message\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"Priority\\": \\"10\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"ErrorMessage\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n },\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"5000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"20\\",\\n \\"Min\\": \\"10\\"\\n },\\n \\"PixFmt\\": \\"yuvj420p\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"1880\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Bitrate\\": \\"10\\",\\n \\"Maxrate\\": \\"10\\",\\n \\"Profile\\": \\"baseline\\",\\n \\"Crf\\": \\"27\\",\\n \\"Gop\\": \\"1\\",\\n \\"Width\\": \\"1990\\",\\n \\"Fps\\": \\"60\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\"\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"60\\"\\n }\\n },\\n \\"Name\\": \\"FLV-UD\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Codec\\": \\"mp3\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"Qscale\\": \\"10\\",\\n \\"Channels\\": \\"1\\",\\n \\"Bitrate\\": \\"8\\"\\n },\\n \\"Id\\": \\"S00000000-00****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n }\\n }\\n ]\\n },\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"PipelineId\\": \\"bb558c1cc25b45309aab5be44d19****\\",\\n \\"Id\\": \\"57f6aa3f84824309bcba67231b40****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitAnalysisJobResponse>\\n <RequestId>B52658D4-07AB-43CD-82B0-210958A65E23</RequestId>\\n <AnalysisJob>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <Percent>100</Percent>\\n <State>Success</State>\\n <AnalysisConfig>\\n <QualityControl>\\n <MethodStreaming>network</MethodStreaming>\\n <RateQuality>50</RateQuality>\\n </QualityControl>\\n <PropertiesControl>\\n <Deinterlace>Force</Deinterlace>\\n <Crop>\\n <Top>8</Top>\\n <Width>8</Width>\\n <Height>8</Height>\\n <Left>8</Left>\\n <Mode>Auto</Mode>\\n </Crop>\\n </PropertiesControl>\\n </AnalysisConfig>\\n <Message>The resource operated \\\\\\"PipelineId\\\\\\" cannot be found</Message>\\n <Priority>10</Priority>\\n <MNSMessageResult>\\n <MessageId>3ca84a39a9024f19853b21be9cf9****</MessageId>\\n </MNSMessageResult>\\n <TemplateList>\\n <Video>\\n <Bufsize>5000</Bufsize>\\n <Degrain>5</Degrain>\\n <BitrateBnd>\\n <Max>20</Max>\\n <Min>10</Min>\\n </BitrateBnd>\\n <PixFmt>yuvj420p</PixFmt>\\n <Codec>H.264</Codec>\\n <Height>1880</Height>\\n <Qscale>15</Qscale>\\n <Bitrate>10</Bitrate>\\n <Maxrate>10</Maxrate>\\n <Profile>baseline</Profile>\\n <Crf>27</Crf>\\n <Gop>1</Gop>\\n <Width>1990</Width>\\n <Fps>60</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>progressive</ScanMode>\\n </Video>\\n <TransConfig>\\n <TransMode>onepass</TransMode>\\n </TransConfig>\\n <State>Normal</State>\\n <MuxConfig>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <Loop>0</Loop>\\n </Gif>\\n <Segment>\\n <Duration>60</Duration>\\n </Segment>\\n </MuxConfig>\\n <Name>FLV-UD</Name>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Codec>mp3</Codec>\\n <Samplerate>32000</Samplerate>\\n <Qscale>10</Qscale>\\n <Channels>1</Channels>\\n <Bitrate>8</Bitrate>\\n </Audio>\\n <Id>S00000000-00****</Id>\\n <Container>\\n <Format>flv</Format>\\n </Container>\\n </TemplateList>\\n <UserData>testid-001</UserData>\\n <InputFile>\\n <Object>example.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </InputFile>\\n <PipelineId>bb558c1cc25b45309aab5be44d19****</PipelineId>\\n <Id>57f6aa3f84824309bcba67231b40****</Id>\\n </AnalysisJob>\\n</SubmitAnalysisJobResponse>","errorExample":""}]', + 'title' => 'SubmitAnalysisJob', + 'description' => '* After you call the SubmitAnalysisJob operation to submit a preset template analysis job, ApsaraVideo Media Processing (MPS) intelligently analyzes the input file of the job and recommends a suitable preset template. You can call the [QueryAnalysisJobList](~~29224~~) operation to query the analysis result or enable asynchronous notifications to receive the analysis result.'."\n" + .'* The analysis result is retained only for two weeks after it is generated. The analysis result is deleted after two weeks. If you use the recommended preset template in a transcoding job after two weeks, the job fails, and the `AnalysisResultNotFound` error code is returned.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryAnalysisJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AnalysisJobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template analysis job ID list.', + 'type' => 'string', + 'required' => true, + 'example' => 'bb558c1cc25b45309aab5be44d19****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* **Submitted**: The job has been submitted.'."\n" + .'* **Analyzing**: The job is being run.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD811A1', + ], + 'AnalysisJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AnalysisJob' => [ + 'description' => 'The IDs of template analysis jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2014-01-10T12:00:00Z', + ], + 'Percent' => [ + 'description' => 'The transcoding progress.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86', + ], + 'State' => [ + 'description' => 'The job status.'."\n" + ."\n" + .'* **Submitted**: The job was submitted.'."\n" + .'* **Analyzing**: The job is in progress.'."\n" + .'* **Success**: The job was successful.'."\n" + .'* **Fail**: The job failed.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'AnalysisConfig' => [ + 'description' => 'The job configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'QualityControl' => [ + 'description' => 'The quality control on the job output.'."\n", + 'type' => 'object', + 'properties' => [ + 'MethodStreaming' => [ + 'description' => 'The playback mode. Valid values:'."\n" + ."\n" + .'* **network**: online playback.'."\n" + .'* **local**: playback on on-premises devices.'."\n" + .'* Default value: **network**.'."\n", + 'type' => 'string', + 'example' => 'network', + ], + 'RateQuality' => [ + 'description' => 'The quality level of the job output. Default value: **25**.'."\n", + 'type' => 'string', + 'example' => '25', + ], + ], + ], + 'PropertiesControl' => [ + 'description' => 'The control on the attributes of the job output.'."\n", + 'type' => 'object', + 'properties' => [ + 'Deinterlace' => [ + 'description' => 'Specifies whether deinterlacing was forced to run. Valid values:'."\n" + ."\n" + .'* **Auto**: Deinterlacing was automatically run.'."\n" + .'* **Force**: Deinterlacing was forced to run.'."\n" + .'* **None**: Deinterlacing was forced not to run.'."\n", + 'type' => 'string', + 'example' => 'Auto', + ], + 'Crop' => [ + 'description' => 'The cropping configuration of the video image.'."\n", + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => 'The top margin to be cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Width' => [ + 'description' => 'The width of the video image after the margins are cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Height' => [ + 'description' => 'The height of the video image after the margins are cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Left' => [ + 'description' => 'The left margin to be cropped out.'."\n" + ."\n" + .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Mode' => [ + 'description' => 'The cropping mode. Valid values:'."\n" + ."\n" + .'* **Auto**: Cropping was automatically run.'."\n" + .'* **Force**: Cropping was forced to run.'."\n" + .'* **None**: Cropping was forced not to run.'."\n" + .'* This parameter is required if the value of the Crop parameter is not an empty JSON {}.'."\n", + 'type' => 'string', + 'example' => 'Auto', + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => 'The error message returned if the job failed.'."\n", + 'type' => 'string', + 'example' => 'The resource operated \\"PipelineId\\" cannot be found', + ], + 'Priority' => [ + 'description' => 'The priority of the job in the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.'."\n" + ."\n" + .'* Valid values: **1 to 10**. The value 10 indicates the highest priority.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by Message Service (MNS) to notify users of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message returned if the job was successful. This parameter is not returned if the job failed.'."\n", + 'type' => 'string', + 'example' => '3ca84a39a9024f19853b21be9cf9****', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated \\"PipelineId\\" cannot be found', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + ], + ], + 'TemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The matched preset templates.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The buffer size.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'Degrain' => [ + 'description' => 'The strength of the independent noise reduction algorithm.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'BitrateBnd' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1500', + ], + 'Min' => [ + 'description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '800', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Codec' => [ + 'description' => 'The codec. Valid values: H.264 and H.265. Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the height of the input video**.'."\n", + 'type' => 'string', + 'example' => '720', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Bitrate' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video.'."\n" + ."\n" + .'* Valid values: **10 to 50000**.'."\n" + .'* Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '2000', + ], + 'Profile' => [ + 'description' => 'The codec profile. Valid values:'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'The constant rate factor.'."\n" + ."\n" + .'* Default value when the the Codec parameter is set to H.264: **23**, default value when the the Codec parameter is set to H.265: **26**.'."\n" + .'* If this parameter is specified, the value of the Bitrate parameter becomes invalid.'."\n", + 'type' => 'string', + 'example' => '26', + ], + 'Gop' => [ + 'description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", + 'type' => 'string', + 'example' => '250', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the width of the input video**.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video.'."\n" + ."\n" + .'* The value is 60 if the frame rate of the input file exceeds 60.'."\n" + .'* Default value: **the frame rate of the input video**.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: **medium**.'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* **interlaced**'."\n" + .'* **progressive**'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" + ."\n" + .'* **onepass**'."\n" + .'* **twopass**'."\n" + .'* **CBR**'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + ], + ], + 'State' => [ + 'description' => 'The state of the template. Valid values:'."\n" + ."\n" + .'* **Normal**'."\n" + .'* **Deleted**'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gif' => [ + 'description' => 'The transmuxing configurations for the GIF format.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The interval between two consecutive loops for the GIF format. Unit: 0.01 second. For example, a value of 500 indicates 5 seconds.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Loop' => [ + 'description' => 'The number of loops for the GIF or WebP format. Default value: 0.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The segment length. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'FLV-UD', + ], + 'Audio' => [ + 'description' => 'The audio codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values when the **Codec** parameter is set to **aac**:'."\n" + ."\n" + .'* **aac_low**'."\n" + .'* **aac_he**'."\n" + .'* **aac_he_v2**'."\n" + .'* **aac_ld**'."\n" + .'* **aac_eld**'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Codec' => [ + 'description' => 'The audio codec. Default value: **aac**. Valid values:'."\n" + ."\n" + .'* **aac**'."\n" + .'* **mp3**'."\n" + .'* **vorbis**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Unit: Hz.'."\n" + .'* Default value: **44100**.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The level of quality control on the audio.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Channels' => [ + 'description' => 'The number of sound channels. Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Valid values: **8 to 1000**.'."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '128', + ], + ], + ], + 'Id' => [ + 'description' => 'The transcoding template ID.'."\n", + 'type' => 'string', + 'example' => 'S00000000-00****', + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n", + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + ], + ], + ], + ], + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'InputFile' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the Object Storage Service (OSS) object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The region in which OSS resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", + 'type' => 'string', + 'example' => 'bb558c1cc25b45309aab5be44d19****', + ], + 'Id' => [ + 'description' => 'The ID of the template analysis job.'."\n", + 'type' => 'string', + 'example' => '57f6aa3f84824309bcba67231b406****', + ], + ], + ], + ], + ], + ], + 'NonExistAnalysisJobIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The message sent by Message Service (MNS) to notify the user of the job result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The operation that you want to perform. Set the value to **QueryAnalysisJobList**.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD811A1\\",\\n \\"AnalysisJobList\\": {\\n \\"AnalysisJob\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 86,\\n \\"State\\": \\"Success\\",\\n \\"AnalysisConfig\\": {\\n \\"QualityControl\\": {\\n \\"MethodStreaming\\": \\"network\\",\\n \\"RateQuality\\": \\"25\\"\\n },\\n \\"PropertiesControl\\": {\\n \\"Deinterlace\\": \\"Auto\\",\\n \\"Crop\\": {\\n \\"Top\\": \\"8\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Left\\": \\"8\\",\\n \\"Mode\\": \\"Auto\\"\\n }\\n }\\n },\\n \\"Message\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"Priority\\": \\"8\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"ErrorMessage\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n },\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1500\\",\\n \\"Min\\": \\"800\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Bitrate\\": \\"1000\\",\\n \\"Maxrate\\": \\"2000\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"26\\",\\n \\"Gop\\": \\"250\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\"\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"FLV-UD\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"128\\"\\n },\\n \\"Id\\": \\"S00000000-00****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n }\\n }\\n ]\\n },\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"PipelineId\\": \\"bb558c1cc25b45309aab5be44d19****\\",\\n \\"Id\\": \\"57f6aa3f84824309bcba67231b406****\\"\\n }\\n ]\\n },\\n \\"NonExistAnalysisJobIds\\": {\\n \\"String\\": [\\n \\"null\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAnalysisJobListResponse>\\n <RequestId>5CA6E020-4102-4FFF-AA56-5ED7ECD811A1</RequestId>\\n <AnalysisJobList>\\n <CreationTime>2014-01-10T12:00:00Z</CreationTime>\\n <Percent>86</Percent>\\n <State>Success</State>\\n <AnalysisConfig>\\n <QualityControl>\\n <MethodStreaming>network</MethodStreaming>\\n <RateQuality>25</RateQuality>\\n </QualityControl>\\n <PropertiesControl>\\n <Deinterlace>Auto</Deinterlace>\\n <Crop>\\n <Top>8</Top>\\n <Width>8</Width>\\n <Height>8</Height>\\n <Left>8</Left>\\n <Mode>Auto</Mode>\\n </Crop>\\n </PropertiesControl>\\n </AnalysisConfig>\\n <Message>The resource operated \\\\\\"PipelineId\\\\\\" cannot be found</Message>\\n <Priority>8</Priority>\\n <MNSMessageResult>\\n <MessageId>3ca84a39a9024f19853b21be9cf9****</MessageId>\\n </MNSMessageResult>\\n <TemplateList>\\n <Video>\\n <Bufsize>6000</Bufsize>\\n <Degrain>5</Degrain>\\n <BitrateBnd>\\n <Max>1500</Max>\\n <Min>800</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Codec>H.264</Codec>\\n <Height>720</Height>\\n <Qscale>15</Qscale>\\n <Bitrate>1000</Bitrate>\\n <Maxrate>2000</Maxrate>\\n <Profile>high</Profile>\\n <Crf>26</Crf>\\n <Gop>250</Gop>\\n <Width>1280</Width>\\n <Fps>25</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>interlaced</ScanMode>\\n </Video>\\n <TransConfig>\\n <TransMode>onepass</TransMode>\\n </TransConfig>\\n <State>Normal</State>\\n <MuxConfig>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <Loop>0</Loop>\\n </Gif>\\n <Segment>\\n <Duration>10</Duration>\\n </Segment>\\n </MuxConfig>\\n <Name>FLV-UD</Name>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>15</Qscale>\\n <Channels>2</Channels>\\n <Bitrate>128</Bitrate>\\n </Audio>\\n <Id>S00000000-00****</Id>\\n <Container>\\n <Format>flv</Format>\\n </Container>\\n </TemplateList>\\n <UserData>testid-001</UserData>\\n <InputFile>\\n <Object>example.flv</Object>\\n <Location>oss-cn-hangzhou</Location>\\n <Bucket>example-bucket</Bucket>\\n </InputFile>\\n <PipelineId>bb558c1cc25b45309aab5be44d19****</PipelineId>\\n <Id>57f6aa3f84824309bcba67231b406****</Id>\\n </AnalysisJobList>\\n <NonExistAnalysisJobIds>null</NonExistAnalysisJobIds>\\n</QueryAnalysisJobListResponse>","errorExample":""}]', + 'title' => 'QueryAnalysisJobList', + 'summary' => 'Queries the template analysis job and returns a list of available preset templates when the template analysis job is complete.', + 'description' => 'The time when the job was created.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the transcoding template. The name can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mps-example', + ], + ], + [ + 'name' => 'Container', + 'in' => 'query', + 'schema' => [ + 'description' => 'The container format. The value must be a JSON object that contains the Format parameter. If you do not specify this parameter, the transcoded media file is in MP4 format by default. This parameter is required if you want to use the transcoding template to generate media files in other formats. For more information, see [Container](~~29253~~).'."\n" + ."\n" + .'* Default value: MP4.'."\n" + .'* Video transcoding supports the following formats: FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).'."\n" + ."\n" + .'> If the container format is FLV, the video codec cannot be set to H.265.'."\n" + ."\n" + .'* Audio transcoding supports the following formats: MP3, MP4, OGG, FLAC, and M4A.'."\n" + .'* Image transcoding supports the GIF and WebP formats.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the container format is GIF, the video codec must be set to GIF.'."\n" + ."\n" + .'* If the container format is WebP, the video codec must be set to WebP.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Format":"mp4"}', + ], + ], + [ + 'name' => 'Video', + 'in' => 'query', + 'schema' => [ + 'description' => 'The video stream settings. The value must be a JSON object. For more information, see [Video](~~29253~~).'."\n" + ."\n" + .'> If you do not specify this parameter, output files do not contain video streams. This parameter is required if you want to retain the video streams.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10s"}', + ], + ], + [ + 'name' => 'Audio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The audio stream settings. The value must be a JSON object. For more information, see [Audio](~~29253~~).'."\n" + ."\n" + .'> If you do not specify this parameter, output files do not contain audio streams. This parameter is required if you want to retain the audio streams.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Codec":"H.264","Samplerate":"44100","Bitrate":"500","Channels":"2"}', + ], + ], + [ + 'name' => 'TransConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The general transcoding settings. The value must be a JSON object. For more information, see [TransConfig](~~29253~~). If you do not specify this parameter, the default settings are used. This parameter is required if the default settings cannot meet your business requirements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"TransMode":"onepass"}', + ], + ], + [ + 'name' => 'MuxConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The segment settings. The value must be a JSON object. For more information, see [MuxConfig](~~29253~~). If you do not specify this parameter, media segment files are not generated. This parameter is required if you want to generate media segment files.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Segment":{"Duration":"10"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3', + ], + 'Template' => [ + 'description' => 'The details of the transcoding template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The size of the buffer.'."\n" + ."\n" + .'* Default value: **6000**.'."\n" + .'* Unit: KB.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'LongShortMode' => [ + 'description' => 'Indicates whether the auto-rotate screen feature is enabled. Default value: **false**. Valid values:'."\n" + ."\n" + .'* **true**: The auto-rotate screen feature is enabled.'."\n" + .'* **false**: The auto-rotate screen feature is disabled.'."\n" + ."\n" + .'> If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Degrain' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'BitrateBnd' => [ + 'description' => 'The bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The maximum bitrate.'."\n", + 'type' => 'string', + 'example' => '1500', + ], + 'Min' => [ + 'description' => 'The minimum bitrate.'."\n", + 'type' => 'string', + 'example' => '800', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format. Standard pixel formats such as yuv420p and yuvj420p are supported. The default pixel format can be **yuv420p** or the pixel format of the input video.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Pad' => [ + 'description' => 'The black borders to be added to the video. The value is in the width:height:left:top format.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Codec' => [ + 'description' => 'The video codec. Valid values: H.264, H.265, GIF, and WebP. Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the height of the input video.'."\n", + 'type' => 'string', + 'example' => '800', + ], + 'Qscale' => [ + 'description' => 'The level of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Crop' => [ + 'description' => 'The method of video cropping. Valid values:'."\n" + ."\n" + .'* **border**: automatically detects and removes borders.'."\n" + .'* **Value in the format of width:height:left:top**: crops the video image based on the custom settings. Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => 'border', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the output video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'MaxFps' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Profile' => [ + 'description' => 'The codec profile.'."\n" + ."\n" + .'* **baseline**: suitable for mobile devices'."\n" + .'* **main**: suitable for standard-definition devices'."\n" + .'* **high**: suitable for high-definition devices'."\n" + .'* Default value: **high**.'."\n" + ."\n" + .'If multiple definitions are available, we recommend that you set this parameter to baseline for the lowest definition to ensure normal playback on low-end devices. Set this parameter to main or high for other definitions.'."\n" + ."\n" + .'> This parameter is valid only if the Codec parameter is set to H.264.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'The constant rate factor. Default value if the video codec is set to H.264: **23**. Default value if the video codec is set to H.265: **26**.'."\n" + ."\n" + .'> If this parameter is specified, the setting of the Bitrate parameter becomes invalid.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Remove' => [ + 'description' => 'Indicates whether the video stream is deleted.'."\n" + ."\n" + .'* **true**: The video stream is deleted.'."\n" + .'* **false**: The video stream is retained.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Gop' => [ + 'description' => 'The GOP size. The GOP size can be the maximum interval of keyframes or the maximum number of frames in a frame group. If the maximum interval is specified, the value contains the unit (s). If the maximum number of frames is specified, the value does not contain a unit. Default value: **10s**.'."\n", + 'type' => 'string', + 'example' => '10s', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Default value: the width of the input video.****'."\n" + .'* Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '256', + ], + 'Fps' => [ + 'description' => 'The frame rate. Default value: the frame rate of the input file. The value is 60 if the frame rate of the input file exceeds 60. Unit: frames per second.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" + ."\n" + .'* **veryfast**'."\n" + .'* **fast**'."\n" + .'* **medium**'."\n" + .'* **slow**'."\n" + .'* **slower**'."\n" + ."\n" + .'> This parameter is valid only if the Codec parameter is set to H.264.'."\n", + 'type' => 'string', + 'example' => 'fast', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* **interlaced**'."\n" + .'* **progressive**'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'ResoPriority' => [ + 'description' => 'The policy of resolution adjustment.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Hdr2sdr' => [ + 'description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'NarrowBand' => [ + 'description' => 'The Narrowband HD settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'Abrmax' => [ + 'description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '3000', + ], + 'MaxAbrRatio' => [ + 'description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'description' => 'Indicates whether the audio bitrate is checked.'."\n" + ."\n" + .'If this feature is enabled and the system detects that the audio bitrate of the output file is greater than that of the input file, the audio bitrate of the input file is retained after transcoding.'."\n" + ."\n" + .'* **true**: The audio bitrate is checked.'."\n" + .'* **false**: The audio bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'TransMode' => [ + 'description' => 'The transcoding mode. Valid values:'."\n" + ."\n" + .'* **onepass**'."\n" + .'* **twopass**'."\n" + .'* **CBR**'."\n" + .'* Default value: **onepass**.'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the resolution is checked.'."\n" + ."\n" + .'* **true**: The resolution is checked.'."\n" + .'* **false**: The resolution is not checked.'."\n" + .'* Default value: **false**.'."\n" + ."\n" + .'> If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, the resolution of the input file is retained after transcoding.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'Indicates whether the video bitrate is checked. If this feature is enabled and the system detects that the video bitrate of the output file is higher than that of the input file, the input file is not transcoded. This parameter has a higher priority than the IsCheckVideoBitrate parameter.'."\n" + ."\n" + .'* **true**: The video bitrate is checked. In this case, if the video bitrate of the output file is higher than that of the input file, the input file is not transcoded.'."\n" + .'* **false**: The video bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'AdjDarMethod' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" + ."\n" + .'* **rescale**: The input video is rescaled.'."\n" + .'* **crop**: The input video is cropped.'."\n" + .'* **none**: No change is made.'."\n", + 'type' => 'string', + 'example' => 'rescale', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the video bitrate is checked.'."\n" + ."\n" + .'* **true**: The video bitrate is checked.'."\n" + .'* **false**: The video bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n" + ."\n" + .'> If this feature is enabled and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the resolution is checked.'."\n" + ."\n" + .'* **true**: The resolution is checked.'."\n" + .'* **false**: The resolution is not checked.'."\n" + .'* Default value: **false**.'."\n" + ."\n" + .'> If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If this feature is enabled and the system detects that the audio bitrate of the output file is higher than that of the input file, the input file is not transcoded. This parameter has a higher priority than the **IsCheckAudioBitrate** parameter. Valid values:'."\n" + ."\n" + .'* **true**: The audio bitrate is checked. In this case, if the audio bitrate of the output file is higher than that of the input file, the input file is not transcoded.'."\n" + .'* **false**: The audio bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'State' => [ + 'description' => 'The status of the template. Valid values:'."\n" + ."\n" + .'* **Normal**: The template is normal.'."\n" + .'* **Deleted**: The template is deleted.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Webp' => [ + 'description' => 'The transmuxing settings for WebP.'."\n", + 'type' => 'object', + 'properties' => [ + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Gif' => [ + 'description' => 'The transmuxing settings for GIF.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The duration for which the final frame is paused. Unit: centiseconds.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DitherMode' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", + 'type' => 'string', + 'example' => 'sierra', + ], + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'Indicates whether the custom palette is used.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The length of the segment. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the transcoding template.'."\n", + 'type' => 'string', + 'example' => 'mps-example', + ], + 'Audio' => [ + 'description' => 'The audio codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values if the **Codec** parameter is set to **AAC**:'."\n" + ."\n" + .'* **aac_low**'."\n" + .'* **aac_he**'."\n" + .'* **aac_he_v2**'."\n" + .'* **aac_ld**'."\n" + .'* **aac_eld**'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Remove' => [ + 'description' => 'Indicates whether the audio stream is deleted.'."\n" + ."\n" + .'* **true**: The audio stream is deleted.'."\n" + .'* **false**: The audio stream is retained.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Codec' => [ + 'description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" + ."\n" + .'* **aac**'."\n" + .'* **mp3**'."\n" + .'* **vorbis**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Unit: Hz.'."\n" + .'* Default value: **44100**.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The level of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Channels' => [ + 'description' => 'The number of sound channels. Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Volume' => [ + 'description' => 'The volume control configurations'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => 'The volume adjustment method. Valid values:'."\n" + ."\n" + .'* **auto**: The volume is automatically adjusted.'."\n" + .'* **dynamic**: The volume is dynamically adjusted.'."\n" + .'* **linear**: The volume is linearly adjusted.'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'Level' => [ + 'description' => 'The volume adjustment range.'."\n" + ."\n" + .'* Default value: **-20**.'."\n" + .'* Unit: dB.'."\n", + 'type' => 'string', + 'example' => '-20', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量。'."\n" + ."\n" + .'当指定Method为dynamic时生效。'."\n" + ."\n" + .'单位：db。'."\n" + ."\n" + .'值范围：[-70,-5]。'."\n" + ."\n" + .'默认值：-6。', + 'description' => 'The output volume.'."\n" + ."\n" + .'This parameter takes effect only when the value of Method is dynamic.'."\n" + ."\n" + .'Unit: dB.'."\n" + ."\n" + .'Valid values: \\[-70,-5].'."\n" + ."\n" + .'Default value: -6.'."\n", + 'type' => 'string', + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值。'."\n" + ."\n" + .'当指定Method为dynamic时生效。'."\n" + ."\n" + .'单位：db。'."\n" + ."\n" + .'值范围：[-9,0]。'."\n" + ."\n" + .'默认值：-1。', + 'description' => 'The peak volume.'."\n" + ."\n" + .'This parameter takes effect only when the value of Method is dynamic.'."\n" + ."\n" + .'Unit: dB.'."\n" + ."\n" + .'Valid values: \\[-9,0].'."\n" + ."\n" + .'Default value: -1.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'LoudnessRangeTarget' => [ + 'title' => '相对目标音量的波动范围。'."\n" + ."\n" + .'当指定Method为dynamic时生效。'."\n" + ."\n" + .'单位：db。'."\n" + ."\n" + .'值范围：[1,20]。'."\n" + ."\n" + .'默认值：8。', + 'description' => 'The range of the volume relative to the output volume.'."\n" + ."\n" + .'This parameter takes effect only when the value of Method is dynamic.'."\n" + ."\n" + .'Unit: dB.'."\n" + ."\n" + .'Valid values: \\[1,20].'."\n" + ."\n" + .'Default value: 8.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'PeakLevel' => [ + 'title' => '音量调整系数。'."\n" + ."\n" + .'当指定Method为adaptive时生效。'."\n" + ."\n" + .'值范围：[0,1]。'."\n" + ."\n" + .'默认值：0.9。', + 'description' => 'The volume adjustment coefficient.'."\n" + ."\n" + .'This parameter takes effect only when the value of Method is adaptive.'."\n" + ."\n" + .'Valid values: \\[0,1].'."\n" + ."\n" + .'Default value: 0.9.'."\n", + 'type' => 'string', + 'example' => '0.9', + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + ], + 'Id' => [ + 'description' => 'The ID of the transcoding template. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + 'Container' => [ + 'description' => 'The container format settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA258E67-09B8-4EAA-8F33-BA567834A2C3\\",\\n \\"Template\\": {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1500\\",\\n \\"Min\\": \\"800\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10s\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"fast\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"0\\",\\n \\"Hdr2sdr\\": \\"true\\",\\n \\"NarrowBand\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1\\n }\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"rescale\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"sierra\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"mps-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"true\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"5\\",\\n \\"Channels\\": \\"2\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"Level\\": \\"-20\\",\\n \\"IntegratedLoudnessTarget\\": \\"\\",\\n \\"TruePeak\\": \\"\\",\\n \\"LoudnessRangeTarget\\": \\"\\",\\n \\"PeakLevel\\": \\"\\"\\n },\\n \\"Bitrate\\": \\"500\\"\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddTemplateResponse>\\n <RequestId>FA258E67-09B8-4EAA-8F33-BA567834A2C3</RequestId>\\n <Template>\\n <Video>\\n <Bufsize>6000</Bufsize>\\n <LongShortMode>false</LongShortMode>\\n <Degrain>10</Degrain>\\n <BitrateBnd>\\n <Max>1500</Max>\\n <Min>800</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>800</Height>\\n <Qscale>1</Qscale>\\n <Crop>border</Crop>\\n <Bitrate>500</Bitrate>\\n <Maxrate>500</Maxrate>\\n <MaxFps>60</MaxFps>\\n <Profile>high</Profile>\\n <Crf>15</Crf>\\n <Remove>false</Remove>\\n <Gop>10s</Gop>\\n <Width>256</Width>\\n <Fps>25</Fps>\\n <Preset>fast</Preset>\\n <ScanMode>interlaced</ScanMode>\\n <ResoPriority>0</ResoPriority>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>true</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>true</IsCheckReso>\\n <IsCheckVideoBitrateFail>true</IsCheckVideoBitrateFail>\\n <AdjDarMethod>rescale</AdjDarMethod>\\n <IsCheckVideoBitrate>true</IsCheckVideoBitrate>\\n <IsCheckResoFail>true</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>true</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <State>Narmal</State>\\n <MuxConfig>\\n <Webp>\\n <Loop>0</Loop>\\n </Webp>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <DitherMode>sierra</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>false</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>10</Duration>\\n </Segment>\\n </MuxConfig>\\n <Name>mps-example</Name>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Remove>true</Remove>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>5</Qscale>\\n <Channels>2</Channels>\\n <Volume>\\n <Method>auto</Method>\\n <Level>-20</Level>\\n </Volume>\\n <Bitrate>500</Bitrate>\\n </Audio>\\n <Id>16f01ad6175e4230ac42bb5182cd****</Id>\\n <Container>\\n <Format>mp4</Format>\\n </Container>\\n </Template>\\n</AddTemplateResponse>","errorExample":""}]', + 'title' => 'AddTemplate', + 'summary' => 'Creates a custom transcoding template. You need to configure the information such as the container format, video stream settings, and audio stream settings.', + 'description' => 'When you call this operation, you need to set transcoding parameters such as those related to the container format, video stream, and audio stream. If you do not specify some parameters, streams that are generated by using the template do not contain the information specified by those parameters.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => '**Container**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|Format|String|No|The default value of this parameter is MP4. Video transcoding supports the following formats: FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4). Audio transcoding supports the following formats: MP3, MP4, OGG, FLAC, and M4A. Image transcoding supports the GIF and WebP formats. If you set the container format to GIF, the video codec must be set to GIF. If you set the container format to WebP, the video codec must be set to WebP. If you set the container format to FLV, the video codec cannot be set to H.265.|'."\n" + ."\n\n" + .'**Video**'."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'| Codec | String | No | The video codec. Valid values: H.264, H.265, GIF, and WebP. Default value: H.264. | '."\n" + .'| Profile | String | No | The codec profile. Valid values: baseline, main, and high. Default value: high. A value of baseline specifies that media files are transcoded for mobile devices. A value of main specifies that media files are transcoded for standard-resolution devices. A value of high specifies that media files are transcoded for high-resolution devices. If multiple definitions are available, we recommend that you set this parameter to baseline for the lowest definition to ensure normal playback on low-end devices. Set this parameter to main or high for other definitions. This parameter is valid only if the Codec parameter is set to H.264. |'."\n" + .'| Bitrate | String | No | Valid values: 10 to 50000. Unit: Kbit/s.|'."\n" + .'| Crf | String | No | The constant rate factor. Valid values: 0 to 51. Default value: 26. If you specify this parameter, the setting of the Bitrate parameter becomes invalid. | '."\n" + .'| Width | String | No | The width of the video. Valid values: 128 to 4096. Default value: the width of the input video. Unit: pixel.|'."\n" + .'| Height | String | No | The height of the video. Valid values: 128 to 4096. Default value: the height of the input video. Unit: pixel. | '."\n" + .'| Fps | String | No | The frame rate of the video. Default value: the frame rate of the input file. The value is 60 if the frame rate of the input file exceeds 60. Valid values: 0 to 60.Unit: frames per second. | '."\n" + .'| Gop | String | No | The group of pictures (GOP) size. The GOP size can be the maximum interval of keyframes or the maximum number of frames in a frame group. If you specify the maximum interval of keyframes, the unit (s) is required. Default value: 10s. If you specify the maximum number of frames, the value has no unit. Valid values: 1 to 100000. |'."\n" + .'| Preset | String | No | The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium. This parameter is valid only if the Codec parameter is set to H.264. |'."\n" + .'| ScanMode | String | No | The scan mode. Valid values: interlaced and progressive. | '."\n" + .'| Bufsize | String | No | The size of the buffer. Valid values: 1000 to 128000. Default value: 6000. Unit: KB. |'."\n" + .'| Maxrate | String | No | The maximum bitrate of the video. Valid values: 10 to 50000. Unit: Kbit/s. |'."\n" + .'| PixFmt | String | No | The pixel format of the video. Standard pixel formats such as yuv420p and yuvj420p are supported. By default, yuv420p or the pixel format of the input video is used. |'."\n" + .'| Remove | String | No | Specifies whether to delete the video stream. A value of true specifies to delete the video stream. A value of false specifies to retain the video stream. Default value: false. |'."\n" + .'| Crop | String | No | The method for cropping the video. A value of border specifies to automatically detect and crop the black borders. A value in the format of width:height:left:top specifies to crop the video image based on the custom settings. Example: 1280:800:0:140. |'."\n" + .'| Pad | String | No | The black borders to be added to the video. The value must be in the width:height:left:top format. Example: 1280:800:0:140. |'."\n" + .'| LongShortMode | String | No | Specifies whether to enable the auto-rotate screen feature. If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. A value of true specifies to enable the auto-rotate screen feature. A value of false specifies to disable the auto-rotate screen feature. Default value: false. |'."\n" + ."\n" + .'The following table describes the supported combinations of container formats, video codecs, and audio codecs.'."\n" + ."\n" + .'|Container format|Audio codec|Video codec|'."\n" + .'|:---|:---|:---|'."\n" + .'|FLV|AAC and MP3|H.264|'."\n" + .'|MP4|AAC and MP3|H.264 and H.265|'."\n" + .'|TS|AAC and MP3|H.264 and H.265|'."\n" + .'|M3U8|AAC and MP3|H.264 and H.265|'."\n" + .'|GIF|Not supported|GIF|'."\n" + ."\n\n" + .'The following table describes the video stream parameters that are supported by different video codecs. A value of Y specifies that a parameter is supported. A value of N specifies that a parameter is not supported.'."\n" + ."\n" + .'|Video codec|H.264|H.265|GIF|'."\n" + .'|:---|:---|:---|:---|'."\n" + .'|Profile|Y|N|N|'."\n" + .'|Bitrate|Y|Y|N|'."\n" + .'|Crf|Y|Y|N|'."\n" + .'|Width|Y|Y|Y|'."\n" + .'|Height|Y|Y|Y|'."\n" + .'|Fps|Y|Y|Y|'."\n" + .'|Gop|Y|Y|N|'."\n" + .'|Preset|Y|N|N|'."\n" + .'|ScanMode|Y|Y|Y|'."\n" + .'|Bufsize|Y|Y|N|'."\n" + .'|Maxrate|Y|Y|N|'."\n" + .'|PixFmt|Y|Y|bgr8|'."\n" + ."\n\n" + .'**Audio**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|:---|:---|:---|:---|'."\n" + .'|Codec|String|No|The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.|'."\n" + .'|Profile|String|No|The codec profile of the audio. Valid values if the Codec parameter is set to AAC: aac\\_low, aac\\_he, aac\\_he\\_v2, aac\\_ld, and aac\\_eld.|'."\n" + .'|Samplerate|String|No|The sampling rate. Valid values: 22050, 32000, 44100, 48000, and 96000. Default value: 44100. Unit: Hz. If the video container format is FLV and the audio codec is MP3, the sampling rate cannot be 32000, 48000, or 96000. If the audio codec is MP3, the sampling rate cannot be 96000.|'."\n" + .'|Bitrate|String|No|The audio bitrate of the output file. Valid values: 8 to 1000. Default value: 128. Unit: Kbit/s.|'."\n" + .'|Channels|String|No|The number of sound channels. Default value: 2. Valid values if the Codec parameter is set to MP3: 1 and 2. Valid values if the Codec parameter is set to AAC: 1, 2, 4, 5, 6, and 8.|'."\n" + .'|Remove|String|No|Specifies whether to delete the audio stream. A value of true specifies to delete the audio stream. A value of false specifies to retain the audio stream. Default value: false.|'."\n" + ."\n\n" + .'The following table describes the supported combinations of audio codecs and container formats.'."\n" + ."\n" + .'|Container format|Audio codec|'."\n" + .'|:---|:---|'."\n" + .'|MP3|MP3|'."\n" + .'|MP4|AAC|'."\n" + .'|OGG|VORBIS and FLAC|'."\n" + .'|FLAC|FLAC|'."\n" + ."\n\n" + .'**TransConfig**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|:---|:---|:---|:---|'."\n" + .'|TransMode|String|No|The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass.|'."\n" + .'|AdjDarMethod|String|No|The method of resolution adjustment. Valid values: rescale, crop, pad, and none. Default value: none.|'."\n" + .'|IsCheckReso|String|No|Specifies whether to check the resolution. If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, the resolution of the input file is retained after transcoding. A value of true specifies to check the resolution. A value of false specifies not to check the resolution. Default value: false.|'."\n" + .'|IsCheckResoFail|String|No|Specifies whether to check the resolution. If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned. A value of true specifies to check the resolution. A value of false specifies not to check the resolution. Default value: false.|'."\n" + .'|IsCheckVideoBitrate|String|No|Specifies whether to check the video bitrate. If this feature is enabled and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding. A value of true specifies to check the video bitrate. A value of false specifies not to check the video bitrate. Default value: false.|'."\n" + .'|IsCheckAudioBitrate|String|No|Specifies whether to check the audio bitrate. If this feature is enabled and the system detects that the audio bitrate of the output file is greater than that of the input file, the audio bitrate of the input file is retained after transcoding. A value of true specifies to check the audio bitrate. A value of false specifies not to check the audio bitrate. Default value: false.|'."\n" + .'|IsCheckAudioBitrateFail|String|No|Specifies whether to check the audio bitrate. If this feature is enabled and the system detects that the bitrate of the output audio is higher than that of the input audio, the input audio is not transcoded. A value of true specifies to check the audio bitrate. A value of false specifies not to check the audio bitrate. Default value: false. This parameter takes precedence over the IsCheckAudioBitrate parameter.|'."\n" + .'|IsCheckVideoBitrateFail|String|No|Specifies whether to check the video bitrate. If this feature is enabled and the system detects that the bitrate of the output video is higher than that of the input video, the input video is not transcoded. A value of true specifies to check the video bitrate. A value of false specifies not to check the video bitrate. Default value: false. This parameter takes precedence over the IsCheckVideoBitrate parameter.|'."\n" + ."\n\n" + .'**MuxConfig**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|:---|:---|:---|:---|'."\n" + .'|Segment|String|No|The segment settings. The value must be a JSON object. For more information, see the following section.|'."\n" + ."\n\n" + .'**Segment**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|:---|:---|:---|:---|'."\n" + .'|Duration|String|No|The length of the segment. The value must be an integer. Unit: seconds. Valid values: 1 to 60. Default value: 10.|'."\n" + .'|ForceSegTime|String|No|The points in time at which you want to segment the media file. You can specify up to 10 points in time. Separate the points in time with commas (,). The points in time can be accurate to three decimal places. Unit: seconds. For example, if you set this parameter to 23,55,60, the media file will be segmented at the 23rd, 55th, and 60th seconds.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the template. The name can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The container format. The value is a JSON object. Default format: **MP4**.'."\n" + ."\n" + .'* Video formats: FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4)'."\n" + .'* Audio formats: MP3, MP4, OGG, FLAC, and M4A'."\n" + .'* Images formats: GIF and WebP'."\n" + ."\n" + .'For more information, see the [Container](~~29253~~) parameter of the "Parameter details" topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MPS-example', + ], + ], + [ + 'name' => 'Container', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configurations of the video stream. The value is a JSON object. For more information, see the [Video](~~29253~~) parameter of the "Parameter details" topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Format":"mp4"}', + ], + ], + [ + 'name' => 'Video', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configurations of the audio stream. The value is a JSON object. For more information, see the [Audio](~~29253~~) parameter of the "Parameter details" topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10"}', + ], + ], + [ + 'name' => 'Audio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The transmuxing configurations. The value is a JSON object. For more information, see the [MuxConfig](~~29253~~) parameter of the "Parameter details" topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Codec":"aac","Samplerate":"44100","Bitrate":"500","Channels":"2"}', + ], + ], + [ + 'name' => 'MuxConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The general transcoding configurations. The value is a JSON object. For more information, see the [TransConfig](~~29253~~) parameter of the "Parameter details" topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Segment":{"Duration":"10"}}', + ], + ], + [ + 'name' => 'TransConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"TransMode":"onepass"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The type of the transcoding template.'."\n", + 'type' => 'string', + 'example' => '5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21', + ], + 'Template' => [ + 'description' => 'The type of the transcoding template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'LongShortMode' => [ + 'description' => 'The size of the buffer.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Bufsize' => [ + 'description' => 'The level of quality control on the video.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'Degrain' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'BitrateBnd' => [ + 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'Min' => [ + 'description' => 'The pixel format. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The black borders added to the video.'."\n" + ."\n" + .'* Format: width:height:left:top.'."\n" + .'* Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Pad' => [ + 'description' => 'The video codec. Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Codec' => [ + 'description' => 'The height of the output video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: the height of the input video.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The level of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '800', + ], + 'Qscale' => [ + 'description' => 'The method used to crop the video.'."\n" + ."\n" + .'* **border**: automatically detects and removes borders.'."\n" + .'* Value in the width:height:left:top format: crops the video based on custom settings.**** Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Crop' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => 'border', + ], + 'Bitrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Maxrate' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'MaxFps' => [ + 'description' => 'The encoding profile. Valid values:'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Profile' => [ + 'description' => 'The bitrate quality control factor.'."\n" + ."\n" + .'* Default value if the Codec parameter is set to H.264: **23**. Default value if the Codec parameter is set to H.265: **26**.'."\n" + .'* If this parameter is returned, the setting of the Bitrate parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'Indicates whether the video stream is deleted. Valid values:'."\n" + ."\n" + .'* **true**: The video stream is deleted.'."\n" + .'* **false**: The video stream is retained.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Remove' => [ + 'description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Gop' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the width of the input video**.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Width' => [ + 'description' => 'The frame rate.'."\n" + ."\n" + .'* A value of 60 is returned if the frame rate of the input video exceeds 60.'."\n" + .'* Default value: the frame rate of the input video.'."\n", + 'type' => 'string', + 'example' => '256', + ], + 'Fps' => [ + 'description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" + ."\n" + .'* **veryfast**'."\n" + .'* **fast**'."\n" + .'* **medium**'."\n" + .'* **slow**'."\n" + .'* **slower**'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* **interlaced**: An interlaced scan is performed.'."\n" + .'* **progressive**: A progressive scan is performed.'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The policy of resolution adjustment.'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'ResoPriority' => [ + 'description' => 'The general transcoding configurations.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Hdr2sdr' => [ + 'description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'NarrowBand' => [ + 'description' => 'The Narrowband HD settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'Abrmax' => [ + 'description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '3000', + ], + 'MaxAbrRatio' => [ + 'description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is greater than the bitrate of the input audio, the bitrate of the input audio is retained after transcoding. In this case, the specified audio bitrate does not take effect. This parameter has a lower priority than the IsCheckAudioBitrateFail parameter. Valid values:'."\n" + ."\n" + .'* **true**: The audio bitrate is checked.'."\n" + ."\n" + .'* **false**: The audio bitrate is not checked.'."\n" + ."\n" + .'* Default value:'."\n" + ."\n" + .' * If the parameter is left empty and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" + .' * If the parameter is left empty and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" + ."\n" + .'* **onepass**'."\n" + .'* **twopass**'."\n" + .'* **CBR**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'TransMode' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained after transcoding. Valid values:'."\n" + ."\n" + .'* **true**: The resolution is checked.'."\n" + .'* **false**: The resolution is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the video bitrate is checked. This parameter has a higher priority than the IsCheckVideoBitrate parameter. Valid values:'."\n" + ."\n" + .'* **true**: The video bitrate is checked'."\n" + .'* **false**: The video bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" + ."\n" + .'* rescale: The input video is rescaled.'."\n" + .'* crop: The input video is cropped.'."\n" + .'* none: No change is made.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'AdjDarMethod' => [ + 'description' => 'Indicates whether the video bitrate is checked. If this parameter is set to true and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding. Valid values:'."\n" + ."\n" + .'* **true**: The video bitrate is checked.'."\n" + .'* **false**: The video bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the resolution is checked. If this parameter is set to true and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned. Valid values:'."\n" + ."\n" + .'* **true**: The resolution is checked.'."\n" + .'* **false**: The resolution is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the audio bitrate is checked. This parameter has a higher priority than the IsCheckAudioBitrate parameter. Valid values:'."\n" + ."\n" + .'* **true**: The audio bitrate is checked.'."\n" + .'* **false**: The audio bitrate is not checked.'."\n" + .'* Default value: **false**.', + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'The status of the template. Valid values:'."\n" + ."\n" + .'* **Normal**: The template is normal.'."\n" + .'* **Deleted**: The template is deleted.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'State' => [ + 'description' => 'The transmuxing configurations.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations for WebP.'."\n", + 'type' => 'object', + 'properties' => [ + 'Webp' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'object', + 'properties' => [ + 'Loop' => [ + 'description' => 'The transmuxing configurations for GIF.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Gif' => [ + 'description' => 'The duration for which the final frame is paused. Unit: milliseconds.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'DitherMode' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => 'bayer', + ], + 'Loop' => [ + 'description' => 'Indicates whether the custom palette is used.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'The segment configurations.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Segment' => [ + 'description' => 'The length of the segment. Unit: seconds.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The audio codec configurations.'."\n", + 'type' => 'string', + 'example' => 'MPS-example', + ], + 'Audio' => [ + 'description' => 'The audio codec settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'Indicates whether the audio stream is deleted.'."\n" + ."\n" + .'* **true**: The audio stream is deleted.'."\n" + .'* **false**: The audio stream is retained.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Remove' => [ + 'description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" + ."\n" + .'* **aac**'."\n" + .'* **mp3**'."\n" + .'* **vorbis**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Codec' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Unit: Hz.'."\n" + .'* Default value: **44100**.'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The level of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The number of sound channels. Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Channels' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Valid values: 8 to 1000.****'."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Bitrate' => [ + 'description' => 'The ID of the transcoding template.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'Volume' => [ + 'description' => 'The volume control configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => 'The volume adjustment method. Valid values:'."\n" + ."\n" + .'* **auto**'."\n" + .'* **dynamic**'."\n" + .'* **linear**'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'TruePeak' => [ + 'description' => 'The peak volume.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is dynamic.'."\n" + .'* Unit: decibel.'."\n" + .'* Valid values: \\[-9,0].'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'IntegratedLoudnessTarget' => [ + 'description' => 'The expected volume.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is dynamic.'."\n" + .'* Unit: decibel.'."\n" + .'* Valid values: \\[-70,-5].'."\n" + .'* Default value: -6.'."\n", + 'type' => 'string', + 'example' => '-6', + ], + 'Level' => [ + 'description' => 'The increased volume relative to the volume of the input audio.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is linear.'."\n" + .'* Unit: decibel.'."\n" + .'* Valid values: less than or equal to 20.'."\n" + .'* Default value: -20.'."\n", + 'type' => 'string', + 'example' => '-20', + ], + 'LoudnessRangeTarget' => [ + 'description' => 'The range of the volume relative to the expected volume.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is dynamic.'."\n" + .'* Unit: decibel.'."\n" + .'* Valid values: \\[1,20].'."\n" + .'* Default value: 8.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'PeakLevel' => [ + 'title' => '音量调整系数。'."\n" + ."\n" + .'当指定Method为adaptive时生效。'."\n" + ."\n" + .'值范围：[0,1]。'."\n" + ."\n" + .'默认值：0.9。', + 'description' => 'The volume adjustment coefficient.'."\n" + ."\n" + .'This parameter takes effect only if the value of Method is adaptive.'."\n" + ."\n" + .'Valid values: \\[0,1].'."\n" + ."\n" + .'Default value: 0.9.'."\n", + 'type' => 'string', + 'example' => '0.9', + ], + ], + ], + ], + ], + 'Id' => [ + 'description' => 'The container configurations.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + 'Container' => [ + 'description' => 'The container format.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The container format.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21\\",\\n \\"Template\\": {\\n \\"Video\\": {\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"500\\",\\n \\"Min\\": \\"100\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"200\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\",\\n \\"Hdr2sdr\\": \\"true\\",\\n \\"NarrowBand\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1\\n }\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"false\\",\\n \\"DitherMode\\": \\"bayer\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"MPS-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"false\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"Level\\": \\"-20\\",\\n \\"LoudnessRangeTarget\\": \\"8\\",\\n \\"PeakLevel\\": \\"0.9\\"\\n }\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateTemplateResponse>\\n <RequestId>5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21</RequestId>\\n <Template>\\n <Video>\\n <LongShortMode>false</LongShortMode>\\n <Bufsize>6000</Bufsize>\\n <Degrain>10</Degrain>\\n <BitrateBnd>\\n <Max>500</Max>\\n <Min>100</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>800</Height>\\n <Qscale>1</Qscale>\\n <Crop>border</Crop>\\n <Bitrate>200</Bitrate>\\n <Maxrate>500</Maxrate>\\n <MaxFps>60</MaxFps>\\n <Profile>high</Profile>\\n <Crf>15</Crf>\\n <Remove>false</Remove>\\n <Gop>10</Gop>\\n <Width>256</Width>\\n <Fps>25</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>interlaced</ScanMode>\\n <ResoPriority>1</ResoPriority>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>false</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>false</IsCheckReso>\\n <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>\\n <AdjDarMethod>none</AdjDarMethod>\\n <IsCheckVideoBitrate>false</IsCheckVideoBitrate>\\n <IsCheckResoFail>false</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <State>Normal</State>\\n <MuxConfig>\\n <Webp>\\n <Loop>0</Loop>\\n </Webp>\\n <Gif>\\n <FinalDelay>false</FinalDelay>\\n <DitherMode>bayer</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>0</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>10</Duration>\\n </Segment>\\n </MuxConfig>\\n <Name>MPS-example</Name>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Remove>false</Remove>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>1</Qscale>\\n <Channels>2</Channels>\\n <Bitrate>500</Bitrate>\\n </Audio>\\n <Id>16f01ad6175e4230ac42bb5182cd****</Id>\\n <Container>\\n <Format>mp4</Format>\\n </Container>\\n </Template>\\n</UpdateTemplateResponse>","errorExample":""}]', + 'title' => 'UpdateTemplate', + 'description' => 'A custom transcoding template cannot be updated if it is being used by a job that has been submitted.The ID of the template. You can obtain the template ID from the response of the [AddTemplate](~~213306~~) operation.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limit](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryTemplateList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '16f01ad6175e4230ac42bb5182cd****,88c6ca184c0e424d5w5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NonExistTids' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of the templates that do not exist. This parameter is not returned if all specified transcoding templates are found.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of transcoding templates.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e424d5w5b665e2a12****', + ], + ], + ], + ], + 'TemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The transcoding templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The buffer size.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'LongShortMode' => [ + 'description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n" + ."\n" + .'* If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. Valid values:'."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Degrain' => [ + 'description' => 'The level of video quality control.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'BitrateBnd' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Min' => [ + 'description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Pad' => [ + 'description' => 'The black bars that are added to the video. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Codec' => [ + 'description' => 'The codec. Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the height of the input video**.'."\n", + 'type' => 'string', + 'example' => '800', + ], + 'Qscale' => [ + 'description' => 'The strength of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Crop' => [ + 'description' => 'The method of video cropping. Valid values:'."\n" + ."\n" + .'* **border**: automatically detects and removes black bars.'."\n" + .'* **Value in the width:height:left:top format**: crops the video based on custom settings. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => 'border', + ], + 'Bitrate' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'MaxFps' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Profile' => [ + 'description' => 'The encoding profile. Valid values:'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'The constant rate factor.'."\n" + ."\n" + .'* Default value when the encoding format is H.264: **23**. Default value when the encoding format is H.265: **26**.'."\n" + .'* If this parameter is set, the value of Bitrate becomes invalid.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Remove' => [ + 'description' => 'Indicates whether the video stream is deleted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Gop' => [ + 'description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the width of the input video**.'."\n", + 'type' => 'string', + 'example' => '256', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n" + ."\n" + .'* The value is 60 if the frame rate of the input file exceeds 60.'."\n" + .'* Default value: **the frame rate of the input file**.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: **medium**.'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* **interlaced**'."\n" + .'* **progressive**'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'ResoPriority' => [ + 'description' => 'The policy of resolution adjustment. Valid values: cropFirst, widthFirst, and heightFirst.'."\n", + 'type' => 'string', + 'example' => 'heightFirst', + ], + 'Hdr2sdr' => [ + 'description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'NarrowBand' => [ + 'description' => 'The Narrowband HD settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'Abrmax' => [ + 'description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '3000', + ], + 'MaxAbrRatio' => [ + 'description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + ."\n" + .'* **false**'."\n" + ."\n" + .'* Default value:'."\n" + ."\n" + .' * If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" + .' * If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'TransMode' => [ + 'description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" + ."\n" + .'* **onepass**'."\n" + .'* **twopass**'."\n" + .'* **CBR**'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'Indicates whether video bitrate check errors are allowed. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" + ."\n" + .'* **true**: If the video bitrate check fails, the input file is not transcoded.'."\n" + .'* **false**: The video bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'AdjDarMethod' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" + ."\n" + .'* rescale'."\n" + .'* crop'."\n" + .'* none'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'Indicates whether audio bitrate check errors are allowed. This parameter has a greater priority than IsCheckAudioBitrate. Valid values:'."\n" + ."\n" + .'* **true**: If the audio bitrate check fails, the input file is not transcoded.'."\n" + .'* **false**: The audio bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'State' => [ + 'description' => 'The status of the template. Valid values:'."\n" + ."\n" + .'* **Normal**'."\n" + .'* **Deleted**'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Webp' => [ + 'description' => 'The transmuxing configurations for WebP.'."\n", + 'type' => 'object', + 'properties' => [ + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Gif' => [ + 'description' => 'The transmuxing configurations for GIF.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The duration for which the final frame is paused.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DitherMode' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", + 'type' => 'string', + 'example' => 'sierra', + ], + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'Indicates whether a custom palette is used.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The length of the segment. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'MPS-example', + ], + 'Audio' => [ + 'description' => 'The audio codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values when the value of Codec is aac:'."\n" + ."\n" + .'* **aac_low**'."\n" + .'* **aac_he**'."\n" + .'* **aac_he_v2**'."\n" + .'* **aac_ld**'."\n" + .'* **aac_eld**'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Remove' => [ + 'description' => 'Indicates whether the audio stream is deleted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Codec' => [ + 'description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" + ."\n" + .'* **aac**'."\n" + .'* **mp3**'."\n" + .'* **vorbis**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Unit: Hz'."\n" + .'* Default value: **44100**.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The strength of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Channels' => [ + 'description' => 'The number of sound channels. Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Valid values: **\\[8,1000]**.'."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'Volume' => [ + 'description' => 'The volume control configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => 'The method that is used to adjust the volume. Valid values:'."\n" + ."\n" + .'* **auto**'."\n" + .'* **dynamic**'."\n" + .'* **linear**'."\n" + .'* Default value: dynamic.'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'TruePeak' => [ + 'description' => 'The peak volume.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is dynamic.'."\n" + .'* Unit: dB.'."\n" + .'* Valid values: \\[-9,0].'."\n" + .'* Default value: -1.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'IntegratedLoudnessTarget' => [ + 'description' => 'The output volume.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is dynamic.'."\n" + .'* Unit: dB.'."\n" + .'* Valid values: \\[-70,-5].'."\n" + .'* Default value: -6.'."\n", + 'type' => 'string', + 'example' => '-6', + ], + 'LoudnessRangeTarget' => [ + 'description' => 'The range of the volume relative to the output volume.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is dynamic.'."\n" + .'* Unit: dB.'."\n" + .'* Valid values: \\[1,20].'."\n" + .'* Default value: 8.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Level' => [ + 'description' => 'The increased volume relative to the volume of the input audio.'."\n" + ."\n" + .'* This parameter takes effect only if the value of Method is linear.'."\n" + .'* Unit: dB.'."\n" + .'* Valid values: less than or equal to 20.'."\n" + .'* Default value: -20.'."\n", + 'type' => 'string', + 'example' => '-20', + ], + 'PeakLevel' => [ + 'title' => '音量调整系数。'."\n" + ."\n" + .'当指定Method为adaptive时生效。'."\n" + ."\n" + .'值范围：[0,1]。'."\n" + ."\n" + .'默认值：0.9。', + 'description' => 'The volume adjustment coefficient.'."\n" + ."\n" + .'This parameter takes effect only if the value of Method is adaptive.'."\n" + ."\n" + .'Valid values: \\[0,1].'."\n" + ."\n" + .'Default value: 0.9.'."\n", + 'type' => 'string', + 'example' => '0.9', + ], + ], + ], + ], + ], + 'Id' => [ + 'description' => 'The transcoding template ID.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The format of the container. Valid values: flv, mp4, ts, m3u8, gif, mp3, ogg, and flac.'."\n", + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + 'CreationTime' => [ + 'description' => 'The time when the template was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-04T06:44:43Z', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'BC860F04-778A-472F-AB39-E1BF329C1EA8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistTids\\": {\\n \\"String\\": [\\n \\"88c6ca184c0e424d5w5b665e2a12****\\"\\n ]\\n },\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"100\\",\\n \\"Min\\": \\"500\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"200\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"heightFirst\\",\\n \\"Hdr2sdr\\": \\"true\\",\\n \\"NarrowBand\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1\\n }\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"sierra\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"MPS-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"false\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"LoudnessRangeTarget\\": \\"8\\",\\n \\"Level\\": \\"-20\\",\\n \\"PeakLevel\\": \\"0.9\\"\\n }\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n },\\n \\"CreationTime\\": \\"2021-03-04T06:44:43Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BC860F04-778A-472F-AB39-E1BF329C1EA8\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryTemplateListResponse>\\n <NonExistTids>88c6ca184c0e424d5w5b665e2a12****</NonExistTids>\\n <TemplateList>\\n <Video>\\n <Bufsize>6000</Bufsize>\\n <LongShortMode>false</LongShortMode>\\n <Degrain>10</Degrain>\\n <BitrateBnd>\\n <Max>100</Max>\\n <Min>500</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>800</Height>\\n <Qscale>1</Qscale>\\n <Crop>border</Crop>\\n <Bitrate>200</Bitrate>\\n <Maxrate>500</Maxrate>\\n <MaxFps>60</MaxFps>\\n <Profile>high</Profile>\\n <Crf>15</Crf>\\n <Remove>false</Remove>\\n <Gop>10</Gop>\\n <Width>256</Width>\\n <Fps>25</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>interlaced</ScanMode>\\n <ResoPriority>heightFirst</ResoPriority>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>false</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>false</IsCheckReso>\\n <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>\\n <AdjDarMethod>none</AdjDarMethod>\\n <IsCheckVideoBitrate>false</IsCheckVideoBitrate>\\n <IsCheckResoFail>false</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <State>Normal</State>\\n <MuxConfig>\\n <Webp>\\n <Loop>0</Loop>\\n </Webp>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <DitherMode>sierra</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>false</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>10</Duration>\\n </Segment>\\n </MuxConfig>\\n <Name>MPS-example</Name>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Remove>false</Remove>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>1</Qscale>\\n <Channels>2</Channels>\\n <Bitrate>500</Bitrate>\\n </Audio>\\n <Id>16f01ad6175e4230ac42bb5182cd****</Id>\\n <Container>\\n <Format>flv</Format>\\n </Container>\\n </TemplateList>\\n <RequestId>BC860F04-778A-472F-AB39-E1BF329C1EA8</RequestId>\\n</QueryTemplateListResponse>","errorExample":""}]', + 'title' => 'QueryTemplateList', + 'summary' => 'You can call this operation to query up to 10 transcoding templates at a time.', + 'description' => 'The IDs of the transcoding templates that you want to query. You can query up to 10 transcoding templates at a time. Separate multiple IDs of custom transcoding templates with commas (,).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of each page set during the result paging query.'."\n" + ."\n" + .'- Upper limit: 100.'."\n" + .'- Default value: 10.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the custom transcoding templates that you want to query.'."\n" + ."\n" + .'* **All**: All custom transcoding templates are queried.'."\n" + .'* **Normal**: Normal custom transcoding templates are queried.'."\n" + .'* **Deleted**: Deleted custom transcoding templates are queried.'."\n" + .'* Default value: **All**.', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'All', + ], + ], + [ + 'name' => 'NamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name prefix based on which you want to search for templates.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'S00000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of search results.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The transcoding templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The video codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'description' => 'The buffer size.'."\n" + ."\n" + .'* Unit: KB.'."\n" + .'* Default value: **6000**.'."\n", + 'type' => 'string', + 'example' => '6000', + ], + 'LongShortMode' => [ + 'description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n" + ."\n" + .'* If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. Valid values:'."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Degrain' => [ + 'description' => 'The level of video quality control.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'BitrateBnd' => [ + 'description' => 'The average bitrate range of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'Min' => [ + 'description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Pad' => [ + 'description' => 'The black bars that are added to the video.'."\n" + ."\n" + .'* Format: width:height:left:top.'."\n" + .'* Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Codec' => [ + 'description' => 'The codec.'."\n" + ."\n" + .'* Valid values: H.264 and H.265.'."\n" + .'* Default value: **H.264**.'."\n", + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => 'The height of the video.'."\n" + ."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the height of the input video**.'."\n", + 'type' => 'string', + 'example' => '800', + ], + 'Qscale' => [ + 'description' => 'The strength of the independent denoising algorithm.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Crop' => [ + 'description' => 'The method of video cropping. Valid values:'."\n" + ."\n" + .'* **border**: automatically detects and removes black bars.'."\n" + .'* **Value in the width:height:left:top format**: crops the video image based on the custom settings. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", + 'type' => 'string', + 'example' => 'border', + ], + 'Bitrate' => [ + 'description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Maxrate' => [ + 'description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'NarrowBand' => [ + 'description' => 'The Narrowband HD settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Abrmax' => [ + 'description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '3000', + ], + 'MaxAbrRatio' => [ + 'description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + 'Version' => [ + 'description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + ], + ], + 'MaxFps' => [ + 'description' => 'The maximum frame rate.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'Profile' => [ + 'description' => 'The codec profile. Valid values:'."\n" + ."\n" + .'* **baseline**: applicable to mobile devices.'."\n" + .'* **main**: applicable to standard-definition devices.'."\n" + .'* **high**: applicable to high-definition devices.'."\n" + .'* Default value: **high**.'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'Crf' => [ + 'description' => 'The constant rate factor.'."\n" + ."\n" + .'* Default value when the value of Codec is H.264: **23**, default value when the value of Codec is H.265: **26**.'."\n" + .'* If this parameter is set, the value of Bitrate becomes invalid.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'Remove' => [ + 'description' => 'Indicates whether the video stream is deleted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Gop' => [ + 'description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Width' => [ + 'description' => 'The width of the video.'."\n" + ."\n" + .'* Valid values: **\\[128,4096]**.'."\n" + .'* Unit: pixel.'."\n" + .'* Default value: **the width of the input video**.'."\n", + 'type' => 'string', + 'example' => '256', + ], + 'Fps' => [ + 'description' => 'The frame rate of the video.'."\n" + ."\n" + .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" + .'* Default value: **the frame rate of the input video**.'."\n", + 'type' => 'string', + 'example' => '25', + ], + 'Preset' => [ + 'description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" + ."\n" + .'* **veryfast**'."\n" + .'* **fast**'."\n" + .'* **medium**'."\n" + .'* **slow**'."\n" + .'* **slower**'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'description' => 'The scan mode. Valid values:'."\n" + ."\n" + .'* **interlaced**'."\n" + .'* **progressive**'."\n", + 'type' => 'string', + 'example' => 'interlaced', + ], + 'ResoPriority' => [ + 'description' => 'The policy of resolution adjustment.'."\n", + 'type' => 'string', + 'example' => 'heightFirst', + ], + 'Hdr2sdr' => [ + 'description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'TransConfig' => [ + 'description' => 'The general transcoding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + ."\n" + .'* **false**'."\n" + ."\n" + .'* Default value:'."\n" + ."\n" + .' * If this parameter is empty and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" + .' * If this parameter is empty and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'TransMode' => [ + 'description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" + ."\n" + .'* **onepass**'."\n" + .'* **twopass**'."\n" + .'* **CBR**'."\n", + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => 'Indicates whether video bitrate check errors are allowed. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" + ."\n" + .'* **true**: If the video bitrate check fails, the input file is not transcoded.'."\n" + .'* **false**: The video bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'AdjDarMethod' => [ + 'description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" + ."\n" + .'* rescale'."\n" + .'* crop'."\n" + .'* none'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'IsCheckVideoBitrate' => [ + 'description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckResoFail' => [ + 'description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => 'Indicates whether audio bitrate check errors are allowed. This parameter has a greater priority than IsCheckAudioBitrate. Valid values:'."\n" + ."\n" + .'* **true**: If the audio bitrate check fails, the input file is not transcoded.'."\n" + .'* **false**: The audio bitrate is not checked.'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'State' => [ + 'description' => 'The status of the template. Valid values:'."\n" + ."\n" + .'* **Normal**'."\n" + .'* **Deleted**'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'MuxConfig' => [ + 'description' => 'The transmuxing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gif' => [ + 'description' => 'The transmuxing configurations for GIF.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinalDelay' => [ + 'description' => 'The duration for which the final frame is paused. Unit: centisecond.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DitherMode' => [ + 'description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", + 'type' => 'string', + 'example' => 'sierra', + ], + 'Loop' => [ + 'description' => 'The loop count.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsCustomPalette' => [ + 'description' => 'Indicates whether a custom palette is used.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Segment' => [ + 'description' => 'The segment configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => 'The length of the segment. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'MPS-example', + ], + 'Audio' => [ + 'description' => 'The audio codec configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'description' => 'The codec profile of the audio. Valid values when the value of Codec is aac:'."\n" + ."\n" + .'* **aac_low**'."\n" + .'* **aac_he**'."\n" + .'* **aac_he_v2**'."\n" + .'* **aac_ld**'."\n" + .'* **aac_eld**'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Remove' => [ + 'description' => 'Indicates whether the audio stream is deleted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + .'* Default value: **false**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Codec' => [ + 'description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" + ."\n" + .'* **aac**'."\n" + .'* **mp3**'."\n" + .'* **vorbis**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'aac', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.'."\n" + ."\n" + .'* Unit: Hz'."\n" + .'* Default value: **44100**.'."\n", + 'type' => 'string', + 'example' => '44100', + ], + 'Qscale' => [ + 'description' => 'The strength of the independent denoising algorithm. Valid values: **\\[1,9]**.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Channels' => [ + 'description' => 'The number of sound channels. Default value: **2**.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Bitrate' => [ + 'description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'* Unit: Kbit/s.'."\n" + .'* Default value: **128**.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + ], + 'Id' => [ + 'description' => 'The transcoding template ID.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + 'Container' => [ + 'description' => 'The container format configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The format of the container. Valid values:'."\n" + ."\n" + .'* **flv**'."\n" + .'* **mp4**'."\n" + .'* **ts**'."\n" + .'* **m3u8**'."\n" + .'* **gif**'."\n" + .'* **mp3**'."\n" + .'* **ogg**'."\n" + .'* **flac**'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'CreationTime' => [ + 'description' => 'The time when the template was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-04T06:44:43Z', + ], + ], + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'BC860F04-778A-472F-AB39-E1BF329C****', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"500\\",\\n \\"Min\\": \\"100\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"200\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"NarrowBand\\": {\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1,\\n \\"Version\\": \\"1.0\\"\\n },\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\",\\n \\"Hdr2sdr\\": \\"true\\"\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"sierra\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"MPS-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"false\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"500\\"\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"CreationTime\\": \\"2021-03-04T06:44:43Z\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"BC860F04-778A-472F-AB39-E1BF329C****\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<SearchTemplateResponse>\\n <TotalCount>1</TotalCount>\\n <TemplateList>\\n <Video>\\n <Bufsize>6000</Bufsize>\\n <LongShortMode>false</LongShortMode>\\n <Degrain>10</Degrain>\\n <BitrateBnd>\\n <Max>500</Max>\\n <Min>100</Min>\\n </BitrateBnd>\\n <PixFmt>yuv420p</PixFmt>\\n <Pad>1280:800:0:140</Pad>\\n <Codec>H.264</Codec>\\n <Height>800</Height>\\n <Qscale>1</Qscale>\\n <Crop>border</Crop>\\n <Bitrate>200</Bitrate>\\n <Maxrate>500</Maxrate>\\n <MaxFps>60</MaxFps>\\n <Profile>high</Profile>\\n <Crf>15</Crf>\\n <Remove>false</Remove>\\n <Gop>10</Gop>\\n <Width>256</Width>\\n <Fps>25</Fps>\\n <Preset>medium</Preset>\\n <ScanMode>interlaced</ScanMode>\\n </Video>\\n <TransConfig>\\n <IsCheckAudioBitrate>false</IsCheckAudioBitrate>\\n <TransMode>onepass</TransMode>\\n <IsCheckReso>false</IsCheckReso>\\n <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>\\n <AdjDarMethod>none</AdjDarMethod>\\n <IsCheckVideoBitrate>false</IsCheckVideoBitrate>\\n <IsCheckResoFail>false</IsCheckResoFail>\\n <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>\\n </TransConfig>\\n <State>Normal</State>\\n <MuxConfig>\\n <Gif>\\n <FinalDelay>0</FinalDelay>\\n <DitherMode>sierra</DitherMode>\\n <Loop>0</Loop>\\n <IsCustomPalette>false</IsCustomPalette>\\n </Gif>\\n <Segment>\\n <Duration>10</Duration>\\n </Segment>\\n </MuxConfig>\\n <Name>MPS-example</Name>\\n <Audio>\\n <Profile>aac_low</Profile>\\n <Remove>false</Remove>\\n <Codec>aac</Codec>\\n <Samplerate>44100</Samplerate>\\n <Qscale>1</Qscale>\\n <Channels>2</Channels>\\n <Bitrate>500</Bitrate>\\n </Audio>\\n <Id>16f01ad6175e4230ac42bb5182cd****</Id>\\n <Container>\\n <Format>mp4</Format>\\n </Container>\\n </TemplateList>\\n <PageSize>10</PageSize>\\n <RequestId>BC860F04-778A-472F-AB39-E1BF329C****</RequestId>\\n <PageNumber>1</PageNumber>\\n</SearchTemplateResponse>","errorExample":""}]', + 'title' => 'SearchTemplate', + 'summary' => 'You can call this operation to query custom transcoding templates in the specified state.', + 'description' => 'You can call this operation up to 100 times per second. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limit](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom transcoding template that you want to delete. To obtain the ID of the custom transcoding template, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Encoding Templates** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2247541A-9F27-47EE-B6EC-484B5475****', + ], + 'TemplateId' => [ + 'description' => 'The ID of the custom transcoding template that is deleted.'."\n", + 'type' => 'string', + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2247541A-9F27-47EE-B6EC-484B5475****\\",\\n \\"TemplateId\\": \\"16f01ad6175e4230ac42bb5182cd****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTemplateResponse>\\n <RequestId>2247541A-9F27-47EE-B6EC-484B5475****</RequestId>\\n <TemplateId>16f01ad6175e4230ac42bb5182cd****</TemplateId>\\n</DeleteTemplateResponse>","errorExample":""}]', + 'title' => 'DeleteTemplate', + 'summary' => 'Deletes a custom transcoding template.', + 'description' => 'A custom transcoding template cannot be deleted if it is being used by a job that has been submitted.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddWaterMarkTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the watermark template. The value can contain letters and digits and can be up to 128 bytes in size.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-watermark-****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration of the watermark template. The value is a JSON object. For more information, see the "WaterMarks" section of the [Parameter details](~~29253~~) topic.'."\n" + ."\n" + .'> If you do not require a positive correlation between the size of text in the watermark and the resolution, you can enable adaptation for the watermark. To do so, add `[\'adaptive\']=true` to the TextWaterMark parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'WaterMarkTemplate' => [ + 'description' => 'The details of the watermark template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the watermark. Valid values:'."\n" + ."\n" + .'* Image: an image watermark.'."\n" + .'* Text: a text watermark.'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'RatioRefer' => [ + 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" + ."\n" + .'* **Width**: the width edge.'."\n" + .'* **Height**: the height edge.'."\n" + .'* **Long**: the long edge.'."\n" + .'* **Short**: the short edge.'."\n", + 'type' => 'object', + 'properties' => [ + 'Dx' => [ + 'description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.51', + ], + 'Width' => [ + 'description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.36', + ], + 'Height' => [ + 'description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.33', + ], + 'Dy' => [ + 'description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.28', + ], + ], + ], + 'ReferPos' => [ + 'description' => 'The position of the watermark. Valid values:'."\n" + ."\n" + .'* **TopRight**: the upper-right corner.'."\n" + .'* **TopLeft**: the upper-left corner.'."\n" + .'* **BottomRight**: the lower-right corner.'."\n" + .'* **BottomLeft**: the lower-left corner.'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'State' => [ + 'description' => 'The status of the watermark template.'."\n" + ."\n" + .'* **Normal**: The watermark template is normal.'."\n" + .'* **Deleted**: The watermark template is deleted.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'Dx' => [ + 'description' => 'The horizontal offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Height' => [ + 'description' => 'The height of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Timeline' => [ + 'description' => 'The timeline of the watermark.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The beginning of the time range during which the watermark is displayed.'."\n" + ."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the watermark template.'."\n", + 'type' => 'string', + 'example' => 'example-watermark-****', + ], + 'Dy' => [ + 'description' => 'The vertical offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Id' => [ + 'description' => 'The ID of the watermark template. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '54BB917F-DD35-4F32-BABA-E60E31B21W63', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"WaterMarkTemplate\\": {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.28\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"10\\",\\n \\"Width\\": \\"10\\",\\n \\"Height\\": \\"30\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"Name\\": \\"example-watermark-****\\",\\n \\"Dy\\": \\"5\\",\\n \\"Id\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n },\\n \\"RequestId\\": \\"54BB917F-DD35-4F32-BABA-E60E31B21W63\\"\\n}","errorExample":""},{"type":"xml","example":"<AddWaterMarkTemplateResponse>\\n <WaterMarkTemplate>\\n <Type>Image</Type>\\n <RatioRefer>\\n <Dx>0.51</Dx>\\n <Width>0.36</Width>\\n <Height>0.33</Height>\\n <Dy>0.28</Dy>\\n </RatioRefer>\\n <ReferPos>TopRight</ReferPos>\\n <State>Normal</State>\\n <Dx>10</Dx>\\n <Width>10</Width>\\n <Height>30</Height>\\n <Timeline>\\n <Start>0</Start>\\n <Duration>ToEND</Duration>\\n </Timeline>\\n <Name>example-watermark-****</Name>\\n <Dy>5</Dy>\\n <Id>3780bd69b2b74540bc7b1096f564****</Id>\\n </WaterMarkTemplate>\\n <RequestId>54BB917F-DD35-4F32-BABA-E60E31B21W63</RequestId>\\n</AddWaterMarkTemplateResponse>","errorExample":""}]', + 'title' => 'AddWaterMarkTemplate', + 'summary' => 'Creates a watermark template.', + 'description' => 'After you create a watermark template by calling this operation, you can specify the watermark template and watermark asset when you [submit a transcoding job](~~29226~~). This allows you to add watermark information to the output video.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteWaterMarkTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'WaterMarkTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the watermark template that you want to delete. To obtain the template ID, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Watermark Templates** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '030E2671-806A-52AF-A93C-DA8E308603A6', + ], + 'WaterMarkTemplateId' => [ + 'description' => 'The ID of the deleted watermark template.'."\n", + 'type' => 'string', + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"030E2671-806A-52AF-A93C-DA8E308603A6\\",\\n \\"WaterMarkTemplateId\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteWaterMarkTemplateResponse>\\n <RequestId>030E2671-806A-52AF-A93C-DA8E308603A6</RequestId>\\n <WaterMarkTemplateId>3780bd69b2b74540bc7b1096f564****</WaterMarkTemplateId>\\n</DeleteWaterMarkTemplateResponse>","errorExample":""}]', + 'title' => 'DeleteWaterMarkTemplate', + 'summary' => 'Deletes a watermark template.', + 'description' => 'A watermark template cannot be deleted if it is being used by a submitted job.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateWaterMarkTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'WaterMarkTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the watermark template that you want to update. To obtain the ID of the watermark template, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Watermark Templates** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the watermark template. The value can contain letters and digits and can be up to 128 bytes in size.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-watermark-****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'The updated configuration of the watermark template. The value is a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"Width":"10","Height":"30","Dx":"10","Dy":"5","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'WaterMarkTemplate' => [ + 'description' => 'The details of the watermark template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the watermark. Valid values:'."\n" + ."\n" + .'* Image: an image watermark.'."\n" + .'* Text: a text watermark.'."\n" + ."\n" + .'> Only watermarks of the Image type are supported.'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'RatioRefer' => [ + 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" + ."\n" + .'* **Width**: the width edge.'."\n" + .'* **Height**: the height edge.'."\n" + .'* **Long**: the long edge.'."\n" + .'* **Short**: the short edge.'."\n", + 'type' => 'object', + 'properties' => [ + 'Dx' => [ + 'description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.51', + ], + 'Width' => [ + 'description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.36', + ], + 'Height' => [ + 'description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.33', + ], + 'Dy' => [ + 'description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.28', + ], + ], + ], + 'ReferPos' => [ + 'description' => 'The position of the watermark. Valid values:'."\n" + ."\n" + .'* **TopRight**: the upper-right corner.'."\n" + .'* **TopLeft**: the upper-left corner.'."\n" + .'* **BottomRight**: the lower-right corner.'."\n" + .'* **BottomLeft**: the lower-left corner.'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'State' => [ + 'description' => 'The status of the watermark template. Default value: **Normal**.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'Dx' => [ + 'description' => 'The horizontal offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Height' => [ + 'description' => 'The height of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'Timeline' => [ + 'description' => 'The timeline of the watermark.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The beginning of the time range during which the watermark is displayed.'."\n" + ."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the watermark template.'."\n", + 'type' => 'string', + 'example' => 'example-watermark-****', + ], + 'Dy' => [ + 'description' => 'The vertical offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Id' => [ + 'description' => 'The ID of the watermark template. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E558894E-40D9-57C6-B5CC-0F5CDF23614E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"WaterMarkTemplate\\": {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.28\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"10\\",\\n \\"Width\\": \\"10\\",\\n \\"Height\\": \\"30\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"10\\"\\n },\\n \\"Name\\": \\"example-watermark-****\\",\\n \\"Dy\\": \\"5\\",\\n \\"Id\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n },\\n \\"RequestId\\": \\"E558894E-40D9-57C6-B5CC-0F5CDF23614E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateWaterMarkTemplateResponse>\\n <WaterMarkTemplate>\\n <Type>Image</Type>\\n <RatioRefer>\\n <Dx>0.51</Dx>\\n <Width>0.36</Width>\\n <Height>0.33</Height>\\n <Dy>0.28</Dy>\\n </RatioRefer>\\n <ReferPos>TopRight</ReferPos>\\n <State>Normal</State>\\n <Dx>10</Dx>\\n <Width>10</Width>\\n <Height>30</Height>\\n <Timeline>\\n <Start>0</Start>\\n <Duration>10</Duration>\\n </Timeline>\\n <Name>example-watermark-****</Name>\\n <Dy>5</Dy>\\n <Id>3780bd69b2b74540bc7b1096f564****</Id>\\n </WaterMarkTemplate>\\n <RequestId>E558894E-40D9-57C6-B5CC-0F5CDF23614E</RequestId>\\n</UpdateWaterMarkTemplateResponse>","errorExample":""}]', + 'title' => 'UpdateWaterMarkTemplate', + 'summary' => 'Updates the name and configurations of the specified watermark template.', + 'description' => '* You can call this operation to update the information about a watermark template based on the ID of the watermark template. For example, you can update the name and configurations of a watermark template.'."\n" + .'* A watermark template cannot be updated if it is being used by a job that has been submitted.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchWaterMarkTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'* A maximum of **100** entries can be returned on each page.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the watermark templates that you want to query. Valid values:'."\n" + ."\n" + .'* **All (default)**'."\n" + .'* **Normal**'."\n" + .'* **Deleted**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the watermark templates.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The type of the watermark. Valid values:'."\n" + ."\n" + .'* Image: an image watermark.'."\n" + .'* Text: a text watermark.'."\n" + ."\n" + .'> Only watermarks of the **Image** types are supported.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" + ."\n" + .'* **Width**: the width edge.'."\n" + .'* **Height**: the height edge.'."\n" + .'* **Long**: the long edge.'."\n" + .'* **Short**: the short edge.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'FC029D04-8F47-57FF-A759-23383C15617D', + ], + 'PageNumber' => [ + 'description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'WaterMarkTemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WaterMarkTemplate' => [ + 'description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The position of the watermark. Valid values:'."\n" + ."\n" + .'* TopRight: the upper-right corner.'."\n" + .'* TopLeft: the upper-left corner.'."\n" + .'* BottomRight: the lower-right corner.'."\n" + .'* BottomLeft: the lower-left corner.'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'RatioRefer' => [ + 'description' => 'The status of the watermark template. Valid values: Valid values:'."\n" + ."\n" + .'* **Normal**: The watermark template is normal.'."\n" + .'* **Deleted**: The watermark template is deleted.'."\n", + 'type' => 'object', + 'properties' => [ + 'Dx' => [ + 'description' => 'The horizontal offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '0.51', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '0.36', + ], + 'Height' => [ + 'description' => 'The height of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '0.33', + ], + 'Dy' => [ + 'description' => 'The timeline of the watermark.'."\n", + 'type' => 'string', + 'example' => '0.2', + ], + ], + ], + 'ReferPos' => [ + 'description' => 'The beginning of the time range during which the watermark is displayed.'."\n" + ."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'State' => [ + 'description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'Dx' => [ + 'description' => 'The name of the watermark template.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Width' => [ + 'description' => 'The vertical offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Height' => [ + 'description' => 'The ID of the watermark template.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Timeline' => [ + 'description' => 'The timeline of the watermark.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset.'."\n" + ."\n" + .'The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'Name' => [ + 'description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => 'example-watermark', + ], + 'Dy' => [ + 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" + ."\n" + .'* **Width**: the width edge.'."\n" + .'* **Height**: the height edge.'."\n" + .'* **Long**: the long edge.'."\n" + .'* **Short**: the short edge.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Id' => [ + 'description' => 'The vertical offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e4578645b665e2a12****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FC029D04-8F47-57FF-A759-23383C15617D\\",\\n \\"PageNumber\\": 1,\\n \\"WaterMarkTemplateList\\": {\\n \\"WaterMarkTemplate\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.2\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"Name\\": \\"example-watermark\\",\\n \\"Dy\\": \\"100\\",\\n \\"Id\\": \\"88c6ca184c0e4578645b665e2a12****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchWaterMarkTemplateResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>FC029D04-8F47-57FF-A759-23383C15617D</RequestId>\\n <PageNumber>1</PageNumber>\\n <WaterMarkTemplateList>\\n <Type>Image</Type>\\n <RatioRefer>\\n <Dx>0.51</Dx>\\n <Width>0.36</Width>\\n <Height>0.33</Height>\\n <Dy>0.2</Dy>\\n </RatioRefer>\\n <ReferPos>TopRight</ReferPos>\\n <State>Normal</State>\\n <Dx>100</Dx>\\n <Width>8</Width>\\n <Height>8</Height>\\n <Timeline>\\n <Start>0</Start>\\n <Duration>ToEND</Duration>\\n </Timeline>\\n <Name>example-watermark</Name>\\n <Dy>100</Dy>\\n <Id>88c6ca184c0e4578645b665e2a12****</Id>\\n </WaterMarkTemplateList>\\n</SearchWaterMarkTemplateResponse>","errorExample":""}]', + 'title' => 'SearchWaterMarkTemplate', + 'summary' => 'Searches for watermark templates.', + 'description' => 'The total number of returned entries.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryWaterMarkTemplateList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'WaterMarkTemplateIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the watermark templates that you want to query. To obtain the IDs of the watermark templates, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Watermark Templates** in the left-side navigation pane. You can query up to 10 watermark templates at a time. Separate multiple IDs of watermark templates with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '17079AF5-6276-51A9-B755-D26594C93F3C', + ], + 'NonExistWids' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of the templates that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the watermark templates that do not exist. This parameter is not returned if all specified watermark templates are found.'."\n", + 'type' => 'string', + 'example' => '72dfa5e679ab4be9a3ed9974c736****', + ], + ], + ], + ], + 'WaterMarkTemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WaterMarkTemplate' => [ + 'description' => 'The details of the watermark templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the watermark. Valid values:'."\n" + ."\n" + .'* Image: an image watermark.'."\n" + .'* Text: a text watermark.'."\n" + ."\n" + .'> Only watermarks of the **Image** type are supported.'."\n", + 'type' => 'string', + 'example' => 'Image', + ], + 'RatioRefer' => [ + 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" + ."\n" + .'* **Width**: the width edge.'."\n" + .'* **Height**: the height edge.'."\n" + .'* **Long**: the long edge.'."\n" + .'* **Short**: the short edge.'."\n", + 'type' => 'object', + 'properties' => [ + 'Dx' => [ + 'description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.51', + ], + 'Width' => [ + 'description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.36', + ], + 'Height' => [ + 'description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.33', + ], + 'Dy' => [ + 'description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" + ."\n" + .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" + .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", + 'type' => 'string', + 'example' => '0.4', + ], + ], + ], + 'ReferPos' => [ + 'description' => 'The position of the watermark. Valid values:'."\n" + ."\n" + .'* **TopRight**: the upper-right corner.'."\n" + .'* **TopLeft**: the upper-left corner.'."\n" + .'* **BottomRight**: the lower-right corner.'."\n" + .'* **BottomLeft**: the lower-left corner.'."\n", + 'type' => 'string', + 'example' => 'TopRight', + ], + 'State' => [ + 'description' => 'The status of the watermark template. Valid values: Valid values:'."\n" + ."\n" + .'* **Normal**: The watermark template is normal.'."\n" + .'* **Deleted**: The watermark template is deleted.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'Dx' => [ + 'description' => 'The horizontal offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Width' => [ + 'description' => 'The width of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Height' => [ + 'description' => 'The height of the watermark image. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Timeline' => [ + 'description' => 'The timeline of the watermark.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The beginning of the time range during which the watermark is displayed.'."\n" + ."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the watermark template.'."\n", + 'type' => 'string', + 'example' => 'example-watermark', + ], + 'Dy' => [ + 'description' => 'The vertical offset. Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Id' => [ + 'description' => 'The ID of the watermark template.'."\n", + 'type' => 'string', + 'example' => '3780bd69b2b74540bc7b1096f564****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17079AF5-6276-51A9-B755-D26594C93F3C\\",\\n \\"NonExistWids\\": {\\n \\"String\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n },\\n \\"WaterMarkTemplateList\\": {\\n \\"WaterMarkTemplate\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.4\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"10\\"\\n },\\n \\"Name\\": \\"example-watermark\\",\\n \\"Dy\\": \\"100\\",\\n \\"Id\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryWaterMarkTemplateListResponse>\\n <RequestId>17079AF5-6276-51A9-B755-D26594C93F3C</RequestId>\\n <NonExistWids>72dfa5e679ab4be9a3ed9974c736****</NonExistWids>\\n <WaterMarkTemplateList>\\n <Type>Image</Type>\\n <RatioRefer>\\n <Dx>0.51</Dx>\\n <Width>0.36</Width>\\n <Height>0.33</Height>\\n <Dy>0.4</Dy>\\n </RatioRefer>\\n <ReferPos>TopRight</ReferPos>\\n <State>Normal</State>\\n <Dx>100</Dx>\\n <Width>8</Width>\\n <Height>8</Height>\\n <Timeline>\\n <Start>0</Start>\\n <Duration>10</Duration>\\n </Timeline>\\n <Name>example-watermark</Name>\\n <Dy>100</Dy>\\n <Id>3780bd69b2b74540bc7b1096f564****</Id>\\n </WaterMarkTemplateList>\\n</QueryWaterMarkTemplateListResponse>","errorExample":""}]', + 'title' => 'QueryWaterMarkTemplateList', + 'summary' => 'Queries watermark templates.', + 'description' => 'You can call this operation to query up to 10 watermark templates at a time.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitSnapshotJob' => [ + 'summary' => 'Submits a snapshot job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '23185', + 'abilityTreeNodes' => [ + 'FEATUREmtsU2L9V8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about the job input. The value must be a JSON object. You must add the Object Storage Service (OSS) bucket that stores the OSS object to be used as the job input as a media bucket in the MPS console. To add an OSS bucket as a media bucket, you can log on to the MPS console, choose Workflows > Media Buckets in the left-side navigation pane, and then click Add Bucket. After the OSS bucket is added as a media bucket, you must perform URL encoding for the OSS object. Example: `{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}`. This example indicates the `"example-bucket.example-location.aliyuncs.com/example/test.flv"` object.'."\n" + ."\n" + .'> The OSS bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}', + ], + ], + [ + 'name' => 'SnapshotConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The snapshot configurations. For more information, see the "AliyunSnapshotConfig" section of the [Data types](~~29253~~) topic.'."\n" + ."\n" + .'> If you set the Interval parameter that is nested under SnapshotConfig, snapshots are captured at the specified intervals. The default value of the Interval parameter is 10, in seconds. If an input video is short but you specify large values for both the Num and Interval parameters, the actual number of snapshots captured may be smaller than the specified number. For example, if you set the Num parameter to 5 and the Interval parameter to 3 for a video of 10 seconds, the number of snapshots captured cannot reach 5.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"OutputFile":{"Bucket":"example-001","Location":"example-location","Object":"{Count}.jpg"},"Time":"5","Num":"10","Interval":"20"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The custom data can contain letters, digits, and hyphens (-) and be up to 1,024 bytes in size. The custom data cannot start with a special character.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testid-001', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue to which you want to submit the snapshot job. To obtain the ID, you can log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n" + ."\n" + .'> Make sure that an available Message Service (MNS) topic is bound to the specified MPS queue. Otherwise, the relevant messages may fail to be sent as expected.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dd3dae411e704030b921e52698e5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '19B6D8C5-A5DD-467A-B435-29D393C71E2D', + ], + 'SnapshotJob' => [ + 'description' => 'The information about the snapshot job.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2021-05-19T03:11:48Z', + ], + 'SnapshotConfig' => [ + 'description' => 'The snapshot configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => 'The start time for capturing snapshots. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'TileOut' => [ + 'description' => 'The tiling configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Padding' => [ + 'description' => 'The distance between two consecutive single images in the tiled image.'."\n" + ."\n" + .'* Default value: **0**.'."\n" + .'* Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Color' => [ + 'description' => 'The background color.'."\n" + ."\n" + .'* Default value: **black**.'."\n" + .'* You can set the Color parameter to a **color keyword** or **random** in the request.'."\n" + ."\n" + .'> If you want to set the background color to black, you can specify the color keyword in one of the following three formats: Black, black, and #000000.'."\n", + 'type' => 'string', + 'example' => 'black', + ], + 'CellSelStep' => [ + 'description' => 'The step for selecting a single image.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'CellHeight' => [ + 'description' => 'The height of a single image. The default value is the height of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'CellWidth' => [ + 'description' => 'The width of a single image. The default value is the width of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Margin' => [ + 'description' => 'The margin width of the tiled image.'."\n" + ."\n" + .'* Default value: **0**.'."\n" + .'* Unit: pixel.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Columns' => [ + 'description' => 'The number of columns that the tiled image contains. Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'IsKeepCellPic' => [ + 'description' => 'Indicates whether the single images are retained. Valid values:'."\n" + ."\n" + .'* **true**: The single images are retained.'."\n" + .'* **false**: The single images are not retained.'."\n" + .'* Default value: **true**.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Lines' => [ + 'description' => 'The number of rows that the tiled image contains. Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Interval' => [ + 'description' => 'The interval for capturing snapshots.'."\n" + ."\n" + .'* If this parameter is specified in the request, snapshots are captured at intervals. The value must be greater than 0 in the request.'."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'FrameType' => [ + 'description' => 'The type of the snapshot. Default value: **Normal**. Valid values:'."\n" + ."\n" + .'* **normal**: normal frames.'."\n" + .'* **intra**: I-frames (keyframes).'."\n" + ."\n" + .'> If the FrameType parameter is set to intra in the request, only keyframes are captured. If no keyframe is found at the specified point in time, the keyframe closest to the specified point in time is captured. Keyframes are captured faster than normal frames if the same snapshot rules are applied.'."\n", + 'type' => 'string', + 'example' => 'intra', + ], + 'Width' => [ + 'description' => 'The width of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Height' => [ + 'description' => 'The height of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'OutputFile' => [ + 'description' => 'The information about the output file of the snapshot job.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1:role/testrole', + ], + 'Object' => [ + 'description' => 'The OSS object that is generated as the output file of the snapshot job.'."\n", + 'type' => 'string', + 'example' => 'test.png', + ], + 'Location' => [ + 'description' => 'The OSS region in which the OSS bucket for storing the output snapshot resides.'."\n", + 'type' => 'string', + 'example' => 'example-location', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the output snapshot.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'Num' => [ + 'description' => 'The number of snapshots. If the Num parameter is set in the request, snapshots are captured at intervals.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'TileOutputFile' => [ + 'description' => 'The information about the output file of the tiling job.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1:role/testrole', + ], + 'Object' => [ + 'description' => 'The OSS object that is generated as the output file of the tiling job.'."\n", + 'type' => 'string', + 'example' => 'example.png', + ], + 'Location' => [ + 'description' => 'The ID of the region in which the OSS bucket that stores the object is located.'."\n", + 'type' => 'string', + 'example' => 'example-location', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the object.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'TimeArray' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TimePointList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'State' => [ + 'description' => 'The status of the snapshot job. Valid values:'."\n" + ."\n" + .'* **Submitted**: The job is submitted.'."\n" + .'* **Snapshoting**: The job is being processed.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => 'Snapshoting', + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by MNS to notify the user of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message. This parameter is not returned if the job fails.'."\n", + 'type' => 'string', + 'example' => '799454621135656C7F815F198A76****', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + ], + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1:role/testrole', + ], + 'Object' => [ + 'description' => 'The OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The region in which the OSS bucket resides.'."\n", + 'type' => 'string', + 'example' => 'example-location\'', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the object.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'Count' => [ + 'description' => 'The number of snapshots that are captured.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'TileCount' => [ + 'description' => 'The number of single images that are contained in the tiled image.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'ResourceContentBad', + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue to which the snapshot job is submitted.'."\n", + 'type' => 'string', + 'example' => 'dd3dae411e704030b921e52698e5****', + ], + 'Id' => [ + 'description' => 'The ID of the snapshot job.'."\n", + 'type' => 'string', + 'example' => 'f4e3b9ba9f3840c39d6e288056f0****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19B6D8C5-A5DD-467A-B435-29D393C71E2D\\",\\n \\"SnapshotJob\\": {\\n \\"CreationTime\\": \\"2021-05-19T03:11:48Z\\",\\n \\"SnapshotConfig\\": {\\n \\"Time\\": \\"5\\",\\n \\"TileOut\\": {\\n \\"Padding\\": \\"0\\",\\n \\"Color\\": \\"black\\",\\n \\"CellSelStep\\": \\"3\\",\\n \\"CellHeight\\": \\"100\\",\\n \\"CellWidth\\": \\"100\\",\\n \\"Margin\\": \\"5\\",\\n \\"Columns\\": \\"10\\",\\n \\"IsKeepCellPic\\": \\"false\\",\\n \\"Lines\\": \\"10\\"\\n },\\n \\"Interval\\": \\"20\\",\\n \\"FrameType\\": \\"intra\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"test.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Num\\": \\"10\\",\\n \\"TileOutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"TimeArray\\": {\\n \\"TimePointList\\": [\\n 0\\n ]\\n }\\n },\\n \\"State\\": \\"Snapshoting\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"799454621135656C7F815F198A76****\\",\\n \\"ErrorMessage\\": \\"The resource operated InputFile is bad\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\"\\n },\\n \\"Input\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"example-location\'\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Count\\": \\"1\\",\\n \\"TileCount\\": \\"5\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"ResourceContentBad\\",\\n \\"PipelineId\\": \\"dd3dae411e704030b921e52698e5****\\",\\n \\"Id\\": \\"f4e3b9ba9f3840c39d6e288056f0****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitSnapshotJobResponse>\\n <RequestId>19B6D8C5-A5DD-467A-B435-29D393C71E2D</RequestId>\\n <SnapshotJob>\\n <CreationTime>2021-05-19T03:11:48Z</CreationTime>\\n <SnapshotConfig>\\n <Time>5</Time>\\n <TileOut>\\n <Padding>0</Padding>\\n <Color>black</Color>\\n <CellSelStep>3</CellSelStep>\\n <CellHeight>100</CellHeight>\\n <CellWidth>100</CellWidth>\\n <Margin>5</Margin>\\n <Columns>10</Columns>\\n <IsKeepCellPic>false</IsKeepCellPic>\\n <Lines>10</Lines>\\n </TileOut>\\n <Interval>20</Interval>\\n <FrameType>intra</FrameType>\\n <Width>8</Width>\\n <Height>8</Height>\\n <OutputFile>\\n <RoleArn>acs:ram::1:role/testrole</RoleArn>\\n <Object>test.png</Object>\\n <Location>example-location</Location>\\n <Bucket>example</Bucket>\\n </OutputFile>\\n <Num>10</Num>\\n <TileOutputFile>\\n <RoleArn>acs:ram::1:role/testrole</RoleArn>\\n <Object>example.png</Object>\\n <Location>example-location</Location>\\n <Bucket>example</Bucket>\\n </TileOutputFile>\\n </SnapshotConfig>\\n <State>Snapshoting</State>\\n <Message>The resource operated InputFile is bad</Message>\\n <MNSMessageResult>\\n <MessageId>799454621135656C7F815F198A76****</MessageId>\\n <ErrorMessage>The resource operated InputFile is bad</ErrorMessage>\\n <ErrorCode>InvalidParameter</ErrorCode>\\n </MNSMessageResult>\\n <Input>\\n <RoleArn>acs:ram::1:role/testrole</RoleArn>\\n <Object>example.flv</Object>\\n <Location>example-location\'</Location>\\n <Bucket>example</Bucket>\\n </Input>\\n <Count>1</Count>\\n <TileCount>5</TileCount>\\n <UserData>testid-001</UserData>\\n <Code>ResourceContentBad</Code>\\n <PipelineId>dd3dae411e704030b921e52698e5****</PipelineId>\\n <Id>f4e3b9ba9f3840c39d6e288056f0****</Id>\\n </SnapshotJob>\\n</SubmitSnapshotJobResponse>","errorExample":""}]', + 'title' => 'SubmitSnapshotJob', + 'description' => '* Only JPG images can be generated by calling this operation.'."\n" + .'* Asynchronous mode: This operation may return a response before snapshots are captured. Snapshot jobs are queued in the background and asynchronously processed by ApsaraVideo Media Processing (MPS). If the **Interval** or **Num** parameter is set, the snapshot job is processed in asynchronous mode. For more information about FAQ about capturing snapshots, see [FAQ about taking snapshots](~~60805~~).'."\n" + .'* Notifications: When you submit a snapshot job, the **PipelineId** parameter is required. An asynchronous message is sent only after the notification feature is enabled for the MPS queue.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySnapshotJobList' => [ + 'summary' => 'Queries snapshot jobs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '23114', + 'abilityTreeNodes' => [ + 'FEATUREmtsU2L9V8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SnapshotJobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range within which the creation time of snapshot jobs to be queried is.'."\n" + ."\n" + .'* Specify the time in the ISO 8601 standard in the'."\n" + .'* YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '72dfa5e679ab4be9a3ed9974c736****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range within which the creation time of snapshot jobs to be queried is.'."\n" + ."\n" + .'* Specify the time in the ISO 8601 standard in the'."\n" + .'* YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc6cbef8e8d5481ca536f5d2a466****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue to which the snapshot jobs that you want to query are submitted. To obtain the ID, you can log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about the snapshot jobs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Snapshoting', + 'default' => 'All', + ], + ], + [ + 'name' => 'StartOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-01-10T12:00:00Z', + ], + ], + [ + 'name' => 'EndOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The snapshot configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-01-12T12:00:00Z', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time for taking snapshots. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'b11c171cced04565b1f38f1ecc39****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The tiling configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'SnapshotJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SnapshotJob' => [ + 'description' => 'The distance between images.'."\n" + ."\n" + .'* Default value: **0**.'."\n" + .'* Unit: pixel.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The background color.'."\n" + ."\n" + .'* Default value: **black**.'."\n" + .'* You can set the Color parameter to a **color keyword** or **random** in the request.'."\n" + ."\n" + .'> If you want to set the background color to black, you can specify the color keyword in one of the following three formats: Black, black, and #000000.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The stride of a single image.'."\n", + 'type' => 'string', + 'example' => '2021-06-30T12:34:29Z', + ], + 'SnapshotConfig' => [ + 'description' => 'The height of a single image. The default value is the height of the output snapshot.'."\n", + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => 'The width of a single image. The default value is the width of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '4', + ], + 'TileOut' => [ + 'description' => 'The margin width of the tiled image.'."\n" + ."\n" + .'* Default value: **0**.'."\n" + .'* Unit: pixel.'."\n", + 'type' => 'object', + 'properties' => [ + 'Padding' => [ + 'description' => 'The number of columns that the tiled image can contain. Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Color' => [ + 'description' => 'Indicates whether the single images are retained. Default value: **true**.'."\n", + 'type' => 'string', + 'example' => 'black', + ], + 'CellSelStep' => [ + 'description' => 'The number of rows that the tiled image can contain. Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'CellHeight' => [ + 'description' => 'The interval for taking snapshots.'."\n" + ."\n" + .'* If this Interval parameter is specified in the request, snapshots are taken at intervals. The value must be greater than 0.'."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'CellWidth' => [ + 'description' => 'The type of the snapshot. Valid values:'."\n" + ."\n" + .'* **normal**: normal frames.'."\n" + .'* **intra**: I-frames.'."\n" + .'* Default value: **intra**.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Margin' => [ + 'description' => 'The width of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Columns' => [ + 'description' => 'The height of the output snapshot.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'IsKeepCellPic' => [ + 'description' => 'The Object Storage Service (OSS) output file of the snapshot job.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Lines' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Interval' => [ + 'description' => 'The OSS object that is generated as the output file of the snapshot job.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'FrameType' => [ + 'description' => 'The ID of the region in which the output OSS bucket is located.'."\n", + 'type' => 'string', + 'example' => 'intra', + ], + 'Width' => [ + 'description' => 'The OSS bucket that stores the output file.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'Height' => [ + 'description' => 'The number of snapshots to take. If the Num parameter is set in the request, snapshots are taken at intervals.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'OutputFile' => [ + 'description' => 'The OSS output file of the tiling job.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The ARN of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1:role/testrole', + ], + 'Object' => [ + 'description' => 'The OSS object that is generated as the output file of the tiling job.'."\n", + 'type' => 'string', + 'example' => 'example.png', + ], + 'Location' => [ + 'description' => 'The ID of the region in which the output OSS bucket is located.'."\n", + 'type' => 'string', + 'example' => 'example-location', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the output file.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'Num' => [ + 'description' => 'The status of the snapshot job. '."\n" + ."\n" + .'- **Submitted**: The job was submitted.'."\n" + .'- **Snapshoting**: The job is being processed.'."\n" + .'- **Success**: The job was successfully processed.'."\n" + .'- **Fail**: The job failed.', + 'type' => 'string', + 'example' => '10', + ], + 'TileOutputFile' => [ + 'description' => 'The error message returned when the job fails. This parameter is not returned if the job is successfully processed.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The message sent by MNS to notify the user of the job result.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1:role/testrole', + ], + 'Object' => [ + 'description' => 'The ID of the message. This parameter is not returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'example.png', + ], + 'Location' => [ + 'description' => 'The error message returned when the job fails. This parameter is not returned if the job is successfully processed.'."\n", + 'type' => 'string', + 'example' => 'example-location', + ], + 'Bucket' => [ + 'description' => 'The error code returned when the job fails. This parameter is not returned if the job is successfully processed.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'TimeArray' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TimePointList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'State' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'string', + 'example' => 'Snapshoting', + ], + 'Message' => [ + 'description' => 'The ARN of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.'."\n", + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'MNSMessageResult' => [ + 'description' => 'The OSS object that is used as the input file.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the region in which the input OSS bucket is located.'."\n", + 'type' => 'string', + 'example' => '799454621135656C7F815F198A76****', + ], + 'ErrorMessage' => [ + 'description' => 'The OSS bucket that stores the input file.'."\n", + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'ErrorCode' => [ + 'description' => 'The number of snapshots that were taken.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + ], + ], + 'Input' => [ + 'description' => 'The number of snapshots that are contained in the tiled image.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1:role/testrole', + ], + 'Object' => [ + 'description' => 'The error code returned when the job fails. This parameter is not returned if the job is successfully processed.'."\n", + 'type' => 'string', + 'example' => 'example.flv', + ], + 'Location' => [ + 'description' => 'The ID of the MPS queue to which the snapshot job was submitted.'."\n", + 'type' => 'string', + 'example' => 'example-location', + ], + 'Bucket' => [ + 'description' => 'The ID of the snapshot job.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'Count' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '1', + ], + 'TileCount' => [ + 'description' => 'The snapshot job IDs that do not exist. This parameter is not returned if all specified snapshot jobs are found.'."\n", + 'type' => 'string', + 'example' => '7', + ], + 'UserData' => [ + 'description' => 'The token that is used to retrieve the next page of the query results. The value is a 32-bit UUID. If the returned query results cannot be displayed within one page, this parameter is returned. The value of this parameter is updated for each query.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Code' => [ + 'description' => 'You can call this operation to query up to 10 snapshot jobs at a time.'."\n" + ."\n\n" + .'## Limits on QPS'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limit](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'PipelineId' => [ + 'description' => 'The start time for taking snapshots. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => 'b11c171cced04565b1f38f1ecc39****', + ], + 'Id' => [ + 'description' => 'The OSS output file of the tiling job.'."\n", + 'type' => 'string', + 'example' => 'cc6cbef8e8d5481ca536f5d2a466****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the snapshot job.'."\n", + 'type' => 'string', + 'example' => '34BCAB31-2833-43A7-9FBD-B34302AB23EQ', + ], + 'NonExistSnapshotJobIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The OSS object that is generated as the output file of the tiling job.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The interval for taking snapshots.'."\n" + ."\n" + .'* If this Interval parameter is specified in the request, snapshots are taken at intervals. The value must be greater than 0.'."\n" + .'* Unit: seconds.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'string', + 'example' => 'c6d973c33d1c4b21bc39907d3b29****', + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => 'The OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'b11c171cced04565b1f38f1ecc39****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotJobList\\": {\\n \\"SnapshotJob\\": [\\n {\\n \\"CreationTime\\": \\"2021-06-30T12:34:29Z\\",\\n \\"SnapshotConfig\\": {\\n \\"Time\\": \\"4\\",\\n \\"TileOut\\": {\\n \\"Padding\\": \\"0\\",\\n \\"Color\\": \\"black\\",\\n \\"CellSelStep\\": \\"3\\",\\n \\"CellHeight\\": \\"8\\",\\n \\"CellWidth\\": \\"8\\",\\n \\"Margin\\": \\"0\\",\\n \\"Columns\\": \\"10\\",\\n \\"IsKeepCellPic\\": \\"false\\",\\n \\"Lines\\": \\"10\\"\\n },\\n \\"Interval\\": \\"10\\",\\n \\"FrameType\\": \\"intra\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Num\\": \\"10\\",\\n \\"TileOutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"TimeArray\\": {\\n \\"TimePointList\\": [\\n 0\\n ]\\n }\\n },\\n \\"State\\": \\"Snapshoting\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"799454621135656C7F815F198A76****\\",\\n \\"ErrorMessage\\": \\"The resource operated InputFile is bad\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\"\\n },\\n \\"Input\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Count\\": \\"1\\",\\n \\"TileCount\\": \\"7\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"PipelineId\\": \\"b11c171cced04565b1f38f1ecc39****\\",\\n \\"Id\\": \\"cc6cbef8e8d5481ca536f5d2a466****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"34BCAB31-2833-43A7-9FBD-B34302AB23EQ\\",\\n \\"NonExistSnapshotJobIds\\": {\\n \\"String\\": [\\n \\"c6d973c33d1c4b21bc39907d3b29****\\"\\n ]\\n },\\n \\"NextPageToken\\": \\"b11c171cced04565b1f38f1ecc39****\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySnapshotJobListResponse>\\n <SnapshotJobList>\\n <CreationTime>2021-06-30T12:34:29Z</CreationTime>\\n <SnapshotConfig>\\n <Time>4</Time>\\n <TileOut>\\n <Padding>0</Padding>\\n <Color>black</Color>\\n <CellSelStep>3</CellSelStep>\\n <CellHeight>8</CellHeight>\\n <CellWidth>8</CellWidth>\\n <Margin>0</Margin>\\n <Columns>10</Columns>\\n <IsKeepCellPic>false</IsKeepCellPic>\\n <Lines>10</Lines>\\n </TileOut>\\n <Interval>10</Interval>\\n <FrameType>intra</FrameType>\\n <Width>8</Width>\\n <Height>8</Height>\\n <OutputFile>\\n <RoleArn>acs:ram::1:role/testrole</RoleArn>\\n <Object>example.png</Object>\\n <Location>example-location</Location>\\n <Bucket>example</Bucket>\\n </OutputFile>\\n <Num>10</Num>\\n <TileOutputFile>\\n <RoleArn>acs:ram::1:role/testrole</RoleArn>\\n <Object>example.png</Object>\\n <Location>example-location</Location>\\n <Bucket>example</Bucket>\\n </TileOutputFile>\\n </SnapshotConfig>\\n <State>Snapshoting</State>\\n <MNSMessageResult>\\n <MessageId>799454621135656C7F815F198A76****</MessageId>\\n </MNSMessageResult>\\n <Input>\\n <RoleArn>acs:ram::1:role/testrole</RoleArn>\\n <Object>example.flv</Object>\\n <Location>example-location</Location>\\n <Bucket>example</Bucket>\\n </Input>\\n <Count>1</Count>\\n <TileCount>7</TileCount>\\n <UserData>testid-001</UserData>\\n <PipelineId>b11c171cced04565b1f38f1ecc39****</PipelineId>\\n <Id>cc6cbef8e8d5481ca536f5d2a466****</Id>\\n </SnapshotJobList>\\n <RequestId>34BCAB31-2833-43A7-9FBD-B34302AB23EQ</RequestId>\\n <NonExistSnapshotJobIds>c6d973c33d1c4b21bc39907d3b29****</NonExistSnapshotJobIds>\\n <NextPageToken>b11c171cced04565b1f38f1ecc39****</NextPageToken>\\n</QuerySnapshotJobListResponse>","errorExample":""}]', + 'title' => 'QuerySnapshotJobList', + 'description' => 'The status of the snapshot jobs that you want to query.'."\n" + ."\n" + .'* **Submitted**: The job was submitted.'."\n" + .'* **Snapshoting**: The job is being processed.'."\n" + .'* **Success**: The job was successfully processed.'."\n" + .'* **Fail**: The job failed.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdatePipeline' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue that you want to update. To view the MPS queue ID, log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the MPS queue. The value can contain letters, digits, and special characters such as hyphens (-) and can be up to 128 bytes in size. The value cannot start with a special character.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-pipeline-****', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new state of the MPS queue.'."\n" + ."\n" + .'* **Active**: The MPS queue is active. Jobs in the MPS queue can be scheduled and run by MPS.'."\n" + .'* **Paused**: The MPS queue is paused. Jobs in the MPS queue cannot be scheduled or run by MPS, and all jobs remain in the Submitted state. Jobs that are running will not be affected.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Paused', + ], + ], + [ + 'name' => 'NotifyConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Message Service (MNS) configuration, such as the information about the MNS queue or topic. For more information, see the "NotifyConfig" section of the [Parameter details](~~29253~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Topic":"example-topic-****"}', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role that is assigned to the current RAM user. To obtain the role, you can log on to the **Resource Access Management (RAM) console** and choose **Identities** > **Roles** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunMTSDefaultRole', + ], + ], + [ + 'name' => 'ExtendConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1FE0F96B-544D-4244-9D83-DFCFB0E5A231', + ], + 'Pipeline' => [ + 'description' => 'The details of the MPS queue.'."\n", + 'type' => 'object', + 'properties' => [ + 'Speed' => [ + 'description' => 'The type of the MPS queue. Default value: **Standard**. Valid values:'."\n" + ."\n" + .'* **Boost**: MPS queue with transcoding speed boosted'."\n" + .'* **Standard**: standard MPS queue'."\n" + .'* **NarrowBandHDV2**: MPS queue that supports Narrowband HD 2.0'."\n" + .'* **AIVideoCover**: MPS queue for intelligent snapshot capture'."\n" + .'* **AIVideoFPShot**: MPS queue for media fingerprinting'."\n" + .'* **AIVideoCensor**: MPS queue for automated review'."\n" + .'* **AIVideoMCU**: MPS queue for smart tagging'."\n" + .'* **AIVideoSummary**: MPS queue for video synopsis'."\n" + .'* **AIVideoPorn**: MPS queue for pornography detection in videos'."\n" + .'* **AIAudioKWS**: MPS queue for keyword recognition in audio'."\n" + .'* **AIAudioASR**: MPS queue for speech-to-text conversion'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'State' => [ + 'description' => 'The state of the MPS queue. Valid values:'."\n" + ."\n" + .'* **Active**: The MPS queue is active.'."\n" + .'* **Paused**: The MPS queue is paused.'."\n", + 'type' => 'string', + 'example' => 'Paused', + ], + 'NotifyConfig' => [ + 'description' => 'The MNS configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'MqTopic' => [ + 'description' => 'The queue of messages that are received.'."\n", + 'type' => 'string', + 'example' => 'example1,example2', + ], + 'QueueName' => [ + 'description' => 'The queue that is created in MNS.'."\n", + 'type' => 'string', + 'example' => 'example-queue-****', + ], + 'MqTag' => [ + 'description' => 'The tags of the messages.'."\n", + 'type' => 'string', + 'example' => 'mts-test', + ], + 'Topic' => [ + 'description' => 'The topic that is created in MNS.'."\n", + 'type' => 'string', + 'example' => 'example-topic-****', + ], + ], + ], + 'Name' => [ + 'description' => 'The new name of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'example-pipeline-****', + ], + 'Role' => [ + 'description' => 'The role that is assigned to the current RAM user.'."\n", + 'type' => 'string', + 'example' => 'AliyunMTSExampleRole', + ], + 'Id' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + 'QuotaAllocate' => [ + 'description' => 'The quota that is allocated to the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1FE0F96B-544D-4244-9D83-DFCFB0E5A231\\",\\n \\"Pipeline\\": {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Paused\\",\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1,example2\\",\\n \\"QueueName\\": \\"example-queue-****\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"example-topic-****\\"\\n },\\n \\"Name\\": \\"example-pipeline-****\\",\\n \\"Role\\": \\"AliyunMTSExampleRole\\",\\n \\"Id\\": \\"d1ce4d3efcb549419193f50f1fcd****\\",\\n \\"QuotaAllocate\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdatePipelineResponse>\\n <RequestId>1FE0F96B-544D-4244-9D83-DFCFB0E5A231</RequestId>\\n <Pipeline>\\n <Speed>Standard</Speed>\\n <State>Paused</State>\\n <NotifyConfig>\\n <MqTopic>example1,example2</MqTopic>\\n <QueueName>example-queue-****</QueueName>\\n <MqTag>mts-test</MqTag>\\n <Topic>example-topic-****</Topic>\\n </NotifyConfig>\\n <Name>example-pipeline-****</Name>\\n <Role>AliyunMTSExampleRole</Role>\\n <Id>d1ce4d3efcb549419193f50f1fcd****</Id>\\n <QuotaAllocate>10</QuotaAllocate>\\n </Pipeline>\\n</UpdatePipelineResponse>","errorExample":""}]', + 'title' => 'UpdatePipeline', + 'summary' => 'Updates an ApsaraVideo Media Processing (MPS) queue.', + 'description' => '* You can call this operation to modify the name, status, and notification settings of the specified MPS queue.'."\n" + .'* If a paused MPS queue is selected in a workflow or a job, such as a video review or media fingerprint job, the workflow or job fails.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPipelineList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PipelineIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the MPS queues that you want to query. To view the IDs, you can log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane. You can query up to 10 MPS queues at a time. Separate multiple IDs of MPS queues with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1C538EAA-ACAF-5AD8-B091-A72C63007149', + ], + 'PipelineList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Pipeline' => [ + 'description' => 'The MPS queues.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Speed' => [ + 'description' => 'The type of the MPS queue. Default value: **Standard**. Valid values:'."\n" + ."\n" + .'* **Boost**: MPS queue with transcoding speed boosted'."\n" + .'* **Standard**: standard MPS queue'."\n" + .'* **NarrowBandHDV2**: MPS queue that supports Narrowband HD 2.0'."\n" + .'* **AIVideoCover**: MPS queue for intelligent snapshot capture'."\n" + .'* **AIVideoFPShot**: MPS queue for media fingerprinting'."\n" + .'* **AIVideoCensor**: MPS queue for automated review'."\n" + .'* **AIVideoMCU**: MPS queue for smart tagging'."\n" + .'* **AIVideoSummary**: MPS queue for video synopsis'."\n" + .'* **AIVideoPorn**: MPS queue for pornography detection in videos'."\n" + .'* **AIAudioKWS**: MPS queue for keyword recognition in audio'."\n" + .'* **AIAudioASR**: MPS queue for speech-to-text conversion'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'State' => [ + 'description' => 'The state of the MPS queue. Valid values:'."\n" + ."\n" + .'* **Active**: The MPS queue is active.'."\n" + .'* **Paused**: The MPS queue is paused.'."\n", + 'type' => 'string', + 'example' => 'Paused', + ], + 'SpeedLevel' => [ + 'description' => 'The level of the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NotifyConfig' => [ + 'description' => 'The Message Service (MNS) configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'MqTopic' => [ + 'description' => 'The queue of messages that are received.'."\n", + 'type' => 'string', + 'example' => 'example1,example2', + ], + 'QueueName' => [ + 'description' => 'The name of the queue that is created in MNS.'."\n", + 'type' => 'string', + 'example' => 'example-queue-****', + ], + 'MqTag' => [ + 'description' => 'The tag string.'."\n", + 'type' => 'string', + 'example' => 'mts-test', + ], + 'Topic' => [ + 'description' => 'The name of the topic that is created in MNS.'."\n", + 'type' => 'string', + 'example' => 'example-topic-****', + ], + ], + ], + 'Role' => [ + 'description' => 'The role that is assigned to the current RAM user.'."\n", + 'type' => 'string', + 'example' => 'AliyunMTSDefaultRole', + ], + 'Name' => [ + 'description' => 'The name of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'example-pipeline-****', + ], + 'Id' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + 'QuotaAllocate' => [ + 'description' => 'The quota that is allocated to the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ExtendConfig' => [ + 'type' => 'object', + 'properties' => [ + 'IsBoostNew' => [ + 'type' => 'boolean', + ], + 'MaxMultiSpeed' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MultiSpeedDowngradePolicy' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'NonExistPids' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of MPS queues that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The MPS queue IDs that do not exist. This parameter is not returned if all specified MPS queues are found.'."\n" + ."\n" + .'> This parameter is returned if the specified MPS queue IDs that do not exist are valid. Check whether the user ID (UID) that is used to submit the request is the same as the UID to which the queues belong.'."\n", + 'type' => 'string', + 'example' => '72dfa5e679ab4be9a3ed9974c736****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C538EAA-ACAF-5AD8-B091-A72C63007149\\",\\n \\"PipelineList\\": {\\n \\"Pipeline\\": [\\n {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Paused\\",\\n \\"SpeedLevel\\": 2,\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1,example2\\",\\n \\"QueueName\\": \\"example-queue-****\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"example-topic-****\\"\\n },\\n \\"Role\\": \\"AliyunMTSDefaultRole\\",\\n \\"Name\\": \\"example-pipeline-****\\",\\n \\"Id\\": \\"d1ce4d3efcb549419193f50f1fcd****\\",\\n \\"QuotaAllocate\\": 10,\\n \\"ExtendConfig\\": {\\n \\"IsBoostNew\\": true,\\n \\"MaxMultiSpeed\\": 0,\\n \\"MultiSpeedDowngradePolicy\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"NonExistPids\\": {\\n \\"String\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryPipelineListResponse>\\n <RequestId>1C538EAA-ACAF-5AD8-B091-A72C63007149</RequestId>\\n <PipelineList>\\n <Speed>Standard</Speed>\\n <State>Paused</State>\\n <SpeedLevel>2</SpeedLevel>\\n <NotifyConfig>\\n <MqTopic>example1,example2</MqTopic>\\n <QueueName>example-queue-****</QueueName>\\n <MqTag>mts-test</MqTag>\\n <Topic>example-topic-****</Topic>\\n </NotifyConfig>\\n <Role>AliyunMTSDefaultRole</Role>\\n <Name>example-pipeline-****</Name>\\n <Id>d1ce4d3efcb549419193f50f1fcd****</Id>\\n <QuotaAllocate>10</QuotaAllocate>\\n </PipelineList>\\n <NonExistPids>72dfa5e679ab4be9a3ed9974c736****</NonExistPids>\\n</QueryPipelineListResponse>","errorExample":""}]', + 'title' => 'QueryPipelineList', + 'summary' => 'Queries an ApsaraVideo Media Processing (MPS) queue by using the ID of the queue.', + 'description' => '* You can call this operation to query up to 10 MPS queues at a time.'."\n" + .'* If `"Code": "InvalidIdentity.ServiceDisabled","Message": "The request identity was not allowed operated.","Recommend"` is returned after you call this operation, check whether the RAM user that you use is assigned the AliyunMTSDefaultRole role to obtain the permissions on MPS and whether your Alibaba Cloud account has overdue payments.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchPipeline' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'* A maximum of **100** entries can be returned on each page.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the MPS queues that you want to query. If you leave this parameter empty, all MPS queues are queried.'."\n" + ."\n" + .'* **All**: queries all MPS queues.'."\n" + .'* **Active**: queries the MPS queues that are active.'."\n" + .'* **Paused**: queues the MPS queues that are paused.'."\n" + .'* Default value: **All**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Paused', + 'default' => 'All', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PipelineList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Pipeline' => [ + 'description' => 'The MPS queues.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the MPS queue.'."\n", + 'type' => 'object', + 'properties' => [ + 'Speed' => [ + 'description' => 'The type of the MPS queue. Default value: **Standard**. Valid values:'."\n" + ."\n" + .'* **Boost**: MPS queue with transcoding speed boosted'."\n" + .'* **Standard**: standard MPS queue'."\n" + .'* **NarrowBandHDV2**: MPS queue that supports Narrowband HD 2.0'."\n" + .'* **AIVideoCover**: MPS queue for intelligent snapshot capture'."\n" + .'* **AIVideoFPShot**: MPS queue for media fingerprinting'."\n" + .'* **AIVideoCensor**: MPS queue for automated review'."\n" + .'* **AIVideoMCU**: MPS queue for smart tagging'."\n" + .'* **AIVideoSummary**: MPS queue for video synopsis'."\n" + .'* **AIVideoPorn**: MPS queue for pornography detection in videos'."\n" + .'* **AIAudioKWS**: MPS queue for keyword recognition in audio'."\n" + .'* **AIAudioASR**: MPS queue for speech-to-text conversion'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'State' => [ + 'description' => 'The state of the MPS queue. Valid values:'."\n" + ."\n" + .'* **Active**: The MPS queue is active.'."\n" + .'* **Paused**: The MPS queue is paused.'."\n", + 'type' => 'string', + 'example' => 'Paused', + ], + 'SpeedLevel' => [ + 'description' => 'The level of the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NotifyConfig' => [ + 'description' => 'The Message Service (MNS) configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'MqTopic' => [ + 'description' => 'The queue of messages that are received.'."\n", + 'type' => 'string', + 'example' => 'example1,example2', + ], + 'QueueName' => [ + 'description' => 'The name of the queue that is created in MNS.'."\n", + 'type' => 'string', + 'example' => 'example-queue-****', + ], + 'MqTag' => [ + 'description' => 'The tags.'."\n", + 'type' => 'string', + 'example' => 'mts-test', + ], + 'Topic' => [ + 'description' => 'The name of the topic that is created in MNS.'."\n", + 'type' => 'string', + 'example' => 'example-topic-****', + ], + ], + ], + 'Role' => [ + 'description' => 'The role that is assigned to the current RAM user.'."\n", + 'type' => 'string', + 'example' => 'AliyunMTSDefaultRole', + ], + 'Name' => [ + 'description' => 'The name of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'example-pipeline-****', + ], + 'Id' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + 'QuotaAllocate' => [ + 'description' => 'The quota that is allocated to the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'CreationTime' => [ + 'title' => '管道创建时间', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"PageNumber\\": 1,\\n \\"PipelineList\\": {\\n \\"Pipeline\\": [\\n {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Paused\\",\\n \\"SpeedLevel\\": 1,\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1,example2\\",\\n \\"QueueName\\": \\"example-queue-****\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"example-topic-****\\"\\n },\\n \\"Role\\": \\"AliyunMTSDefaultRole\\",\\n \\"Name\\": \\"example-pipeline-****\\",\\n \\"Id\\": \\"d1ce4d3efcb549419193f50f1fcd****\\",\\n \\"QuotaAllocate\\": 10,\\n \\"CreationTime\\": \\" 2021-03-04T06:44:43Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchPipelineResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5</RequestId>\\n <PageNumber>1</PageNumber>\\n <PipelineList>\\n <Speed>Standard</Speed>\\n <State>Paused</State>\\n <SpeedLevel>1</SpeedLevel>\\n <NotifyConfig>\\n <MqTopic>example1,example2</MqTopic>\\n <QueueName>example-queue-****</QueueName>\\n <MqTag>mts-test</MqTag>\\n <Topic>example-topic-****</Topic>\\n </NotifyConfig>\\n <Role>AliyunMTSDefaultRole</Role>\\n <Name>example-pipeline-****</Name>\\n <Id>d1ce4d3efcb549419193f50f1fcd****</Id>\\n <QuotaAllocate>10</QuotaAllocate>\\n </PipelineList>\\n</SearchPipelineResponse>","errorExample":""}]', + 'title' => 'SearchPipeline', + 'summary' => 'Searches for ApsaraVideo Media Processing (MPS) queues in the specified state.', + 'description' => 'You can call this operation to query MPS queues in the specified state. If you do not specify the state, all MPS queues are queried by default.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddPipeline' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the MPS queue. The name can be up to 128 bytes in size.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-pipeline', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the MPS queue. Valid values:'."\n" + ."\n" + .'* **Boost**: MPS queue with transcoding speed boosted.'."\n" + .'* **Standard**: standard MPS queue.'."\n" + .'* **NarrowBandHDV2**: MPS queue that supports Narrowband HD 2.0.'."\n" + .'* **AIVideoCover**: MPS queue for intelligent snapshot capture.'."\n" + .'* **AIVideoTag**: MPS queue for video tagging. The supported regions are China (Shanghai), China (Beijing), and China (Hangzhou).'."\n" + ."\n" + .'Default value: **Standard**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'default' => 'Standard', + ], + ], + [ + 'name' => 'SpeedLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the MPS queue. Valid values: **1 to 3**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NotifyConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Message Service (MNS) configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Topic":"mts-topic-1"}', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunMTSDefaultRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CFEA608A-5A1C-4C83-A54B-6197BC250D23', + ], + 'Pipeline' => [ + 'description' => 'The MPS queue.'."\n", + 'type' => 'object', + 'properties' => [ + 'Speed' => [ + 'description' => 'The type of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'State' => [ + 'description' => 'The state of the MPS queue.'."\n" + ."\n" + .'* Active: The MPS queue is active. The jobs in the MPS queue are scheduled and transcoded by MPS.'."\n" + .'* Paused: The MPS queue is paused. Jobs in the MPS queue are no longer scheduled for transcoding by MPS. All of the jobs in the MPS queue remain in the Submitted state. Jobs that are being transcoded are not affected.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'SpeedLevel' => [ + 'description' => 'The level of the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NotifyConfig' => [ + 'description' => 'The MNS configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'MqTopic' => [ + 'description' => 'The queue of messages that are received.'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'QueueName' => [ + 'description' => 'The name of the queue.'."\n", + 'type' => 'string', + 'example' => 'mts-queue-1', + ], + 'MqTag' => [ + 'description' => 'The tag string.'."\n", + 'type' => 'string', + 'example' => 'mts-test', + ], + 'Topic' => [ + 'description' => 'The name of the topic.'."\n", + 'type' => 'string', + 'example' => 'mts-topic-1', + ], + ], + ], + 'Role' => [ + 'description' => 'The role.'."\n", + 'type' => 'string', + 'example' => 'AliyunMTSDefaultRole', + ], + 'Name' => [ + 'description' => 'The name of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'Media Fingerprint'."\n", + ], + 'Id' => [ + 'description' => 'The ID of the MPS queue.'."\n", + 'type' => 'string', + 'example' => 'ed450ea0bfbd41e29f80a401fb4d****', + ], + 'QuotaAllocate' => [ + 'description' => 'The quota that is allocated to the MPS queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFEA608A-5A1C-4C83-A54B-6197BC250D23\\",\\n \\"Pipeline\\": {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Active\\",\\n \\"SpeedLevel\\": 1,\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1\\",\\n \\"QueueName\\": \\"mts-queue-1\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"mts-topic-1\\"\\n },\\n \\"Role\\": \\"AliyunMTSDefaultRole\\",\\n \\"Name\\": \\"视频DNA\\",\\n \\"Id\\": \\"ed450ea0bfbd41e29f80a401fb4d****\\",\\n \\"QuotaAllocate\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddPipelineResponse>\\n <RequestId>CFEA608A-5A1C-4C83-A54B-6197BC250D23</RequestId>\\n <Pipeline>\\n <Speed>Standard</Speed>\\n <State>Active</State>\\n <SpeedLevel>1</SpeedLevel>\\n <NotifyConfig>\\n <MqTopic>example1</MqTopic>\\n <QueueName>mts-queue-1</QueueName>\\n <MqTag>mts-test</MqTag>\\n <Topic>mts-topic-1</Topic>\\n </NotifyConfig>\\n <Role>AliyunMTSDefaultRole</Role>\\n <Name>视频DNA</Name>\\n <Id>ed450ea0bfbd41e29f80a401fb4d****</Id>\\n <QuotaAllocate>10</QuotaAllocate>\\n </Pipeline>\\n</AddPipelineResponse>","errorExample":""}]', + 'title' => 'AddPipeline', + 'summary' => 'Adds an ApsaraVideo Media Processing (MPS) queue.', + ], + 'DeletePipeline' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue that you want to delete. To obtain the ID of the MPS queue, you can log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue that is deleted.'."\n", + 'type' => 'string', + 'example' => 'd1ce4d3efcb549419193f50f1fcd****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"PipelineId\\": \\"d1ce4d3efcb549419193f50f1fcd****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineResponse>\\n <RequestId>338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5</RequestId>\\n <PipelineId>d1ce4d3efcb549419193f50f1fcd****</PipelineId>\\n</DeletePipelineResponse>","errorExample":""}]', + 'title' => 'DeletePipeline', + 'summary' => 'Deletes an ApsaraVideo Media Processing (MPS) queue.', + 'description' => 'You can call this operation to delete only one MPS queue at a time.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'AddMediaWorkflow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the media workflow.'."\n" + ."\n" + .'* The value cannot be empty.'."\n" + .'* The name cannot be the same as that of an existing media workflow within the current Alibaba Cloud account.'."\n" + .'* The name can be up to 64 characters in length.'."\n" + .'* The value must be encoded in the UTF-8 format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mediaworkflow-example', + ], + ], + [ + 'name' => 'Topology', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topology of the media workflow. The value must be a JSON object that contains the activities and activity dependencies. For more information, see the **Sample topology** section of this topic.'."\n" + ."\n" + .'> The Object Storage Service (OSS) bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'TriggerMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The triggering mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" + .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OssAutoTrigger', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F1D21261-ADB9-406A-1234-491382139D59', + ], + 'MediaWorkflow' => [ + 'description' => 'The information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '016-04-01T05:29:37Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow. We recommend that you keep this ID for later operations on this workflow.'."\n", + 'type' => 'string', + 'example' => 'e00732b977da427d9177a4deb1aa****', + ], + 'State' => [ + 'description' => 'The state of the media workflow. By default, the created workflow is in the **Active** state.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'TriggerMode' => [ + 'description' => 'The triggering mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" + .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", + 'type' => 'string', + 'example' => 'OssAutoTrigger', + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'mediaworkflow-example', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow. The value is a JSON object that contains the activities and activity dependencies.'."\n", + 'type' => 'string', + 'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1D21261-ADB9-406A-1234-491382139D59\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"e00732b977da427d9177a4deb1aa****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"mediaworkflow-example\\",\\n \\"Topology\\": \\"{\\\\\\"Activities\\\\\\": {\\\\\\"mediaworkflow-example\\\\\\": {\\\\\\"Parameters\\\\\\": {\\\\\\"Outputs\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"OutputObject\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"S00000001-200010\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MP4-流畅\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\": \\\\\\"examplebucket\\\\\\",\\\\\\"OutputLocation\\\\\\": \\\\\\"oss-cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\": \\\\\\"Transcode\\\\\\"},\\\\\\"Act-Start\\\\\\": {\\\\\\"Parameters\\\\\\": {\\\\\\"PipelineId\\\\\\": \\\\\\"a7d481f07d8c45da88c71853ce7d****\\\\\\",\\\\\\"InputFile\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ObjectPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mps-test/input/\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\": \\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\": {\\\\\\"Parameters\\\\\\": {\\\\\\"PublishType\\\\\\": \\\\\\"Manual\\\\\\"},\\\\\\"Type\\\\\\": \\\\\\"Report\\\\\\"}},\\\\\\"Dependencies\\\\\\": {\\\\\\"mediaworkflow-example\\\\\\": [\\\\\\"Act-Report\\\\\\"],\\\\\\"Act-Start\\\\\\": [\\\\\\"mediaworkflow-example\\\\\\"],\\\\\\"Act-Report\\\\\\": []}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddMediaWorkflowResponse>\\n <RequestId>F1D21261-ADB9-406A-1234-491382139D59</RequestId>\\n <MediaWorkflow>\\n <CreationTime>016-04-01T05:29:37Z</CreationTime>\\n <MediaWorkflowId>e00732b977da427d9177a4deb1aa****</MediaWorkflowId>\\n <State>Active</State>\\n <TriggerMode>OssAutoTrigger</TriggerMode>\\n <Name>mediaworkflow-example</Name>\\n <Topology>{\\"Activities\\": {\\"mediaworkflow-example\\": {\\"Parameters\\": {\\"Outputs\\": \\"[{\\\\\\"OutputObject\\\\\\":\\\\\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\":\\\\\\"S00000001-200010\\\\\\",\\\\\\"TemplateName\\\\\\":\\\\\\"MP4-流畅\\\\\\"}]\\",\\"OutputBucket\\": \\"examplebucket\\",\\"OutputLocation\\": \\"oss-cn-shanghai\\"},\\"Type\\": \\"Transcode\\"},\\"Act-Start\\": {\\"Parameters\\": {\\"PipelineId\\": \\"a7d481f07d8c45da88c71853ce7d****\\",\\"InputFile\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"example-input\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"ObjectPrefix\\\\\\":\\\\\\"mps-test/input/\\\\\\"}\\"},\\"Type\\": \\"Start\\"},\\"Act-Report\\": {\\"Parameters\\": {\\"PublishType\\": \\"Manual\\"},\\"Type\\": \\"Report\\"}},\\"Dependencies\\": {\\"mediaworkflow-example\\": [\\"Act-Report\\"],\\"Act-Start\\": [\\"mediaworkflow-example\\"],\\"Act-Report\\": []}}</Topology>\\n </MediaWorkflow>\\n</AddMediaWorkflowResponse>","errorExample":""}]', + 'title' => 'AddMediaWorkflow', + 'summary' => 'Creates a media workflow.', + 'description' => '* You can call this operation to define the topology, activities, and dependencies of a media workflow. The topology is represented by a directed acyclic graph (DAG) in the console. For more information, see [Workflow activities](~~68494~~). You can view and run the workflows that are created by calling this operation in the ApsaraVideo Media Processing (MPS) console.'."\n" + .'* MPS media workflows can be automatically triggered only by using the prefix of the file path. Automatic triggering by using the suffix is not supported. For more information about the trigger rules, see [Workflow triggering rules for files](~~68574~~).'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", + 'requestParamsDescription' => '**Sample topology**'."\n" + ."\n" + .'> The OSS bucket must reside in the same region as your MPS service.'."\n" + ."\n" + .' {'."\n" + .' "Activities": {'."\n" + .' "mediaworkflow-example": {'."\n" + .' "Parameters": {'."\n" + .' "Outputs": "[{\\"OutputObject\\":\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\",\\"TemplateId\\":\\"S00000001-200010\\",\\"TemplateName\\":\\"MP4-Low definition\\"}]",'."\n" + .' "OutputBucket": "examplebucket",'."\n" + .' "OutputLocation": "oss-cn-shanghai"'."\n" + .' },'."\n" + .' "Type": "Transcode"'."\n" + .' },'."\n" + .' "Act-Start": {'."\n" + .' "Parameters": {'."\n" + .' "PipelineId": "a7d481f07d8c45da88c71853ce7d****",'."\n" + .' "InputFile": "{\\"Bucket\\":\\"example-input\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"ObjectPrefix\\":\\"mps-test/input/\\"}"'."\n" + .' },'."\n" + .' "Type": "Start"'."\n" + .' },'."\n" + .' "Act-Report": {'."\n" + .' "Parameters": {'."\n" + .' "PublishType": "Manual"'."\n" + .' },'."\n" + .' "Type": "Report"'."\n" + .' }'."\n" + .' },'."\n" + .' "Dependencies": {'."\n" + .' "mediaworkflow-example": ["Act-Report"],'."\n" + .' "Act-Start": ["mediaworkflow-example"],'."\n" + .' "Act-Report": []'."\n" + .' }'."\n" + .' }'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ActivateMediaWorkflow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow. You can obtain the ID from the response of the [AddMediaWorkflow](~~44437~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A1326BD4-30B1-4CB6-Q123-3330B877B0D4', + ], + 'MediaWorkflow' => [ + 'description' => 'The details of the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T05:29:37Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow.'."\n", + 'type' => 'string', + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + 'State' => [ + 'description' => 'The status of the media workflow. The value is **Active**.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'mediaworkflow-example', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'string', + 'example' => '{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"oss-cn-hangzhou\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"OutputObject\\\\\\":\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"panda-vod-hls\\",\\"OutputLocation\\":\\"oss-cn-hangzhou\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1326BD4-30B1-4CB6-Q123-3330B877B0D4\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Active\\",\\n \\"Name\\": \\"mediaworkflow-example\\",\\n \\"Topology\\": \\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"OutputObject\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"panda-vod-hls\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ActivateMediaWorkflowResponse>\\n <RequestId>A1326BD4-30B1-4CB6-Q123-3330B877B0D4</RequestId>\\n <MediaWorkflow>\\n <CreationTime>2016-04-01T05:29:37Z</CreationTime>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e9181d4****</MediaWorkflowId>\\n <State>Active</State>\\n <Name>mediaworkflow-example</Name>\\n <Topology>{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"OutputObject\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"panda-vod-hls\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"oss-cn-hangzhou\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}</Topology>\\n </MediaWorkflow>\\n</ActivateMediaWorkflowResponse>","errorExample":""}]', + 'title' => 'ActivateMediaWorkflow', + 'summary' => 'Activates a media workflow.', + 'description' => 'You can call this operation to activate a media workflow that has been deactivated. After you activate a media workflow, you cannot modify the workflow information, such as the name, topology, or trigger mode. A media workflow is activated by default after it is created.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeactivateMediaWorkflow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow that is deactivated.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The name of the media workflow that is deactivated.'."\n", + 'type' => 'string', + 'example' => '16CD0CDD-457E-420D-9755-8385075A1234', + ], + 'MediaWorkflow' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '* After you deactivate a media workflow, you can modify the workflow information.'."\n" + .'* After you delete or deactivate a media workflow, the workflow cannot be used. In this case, the workflow is not automatically triggered when you upload a file to the bucket specified by the workflow.'."\n" + ."\n" + .'## Limits on QPS'."\n" + ."\n" + .'You can call this operation up to 100 times per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limits](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + 'type' => 'string', + 'example' => '2016-04-01T05:29:37Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow that you want to deactivate. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + 'State' => [ + 'description' => 'The topology of the media workflow.The status of the media workflow. The value is **Inactive**.', + 'type' => 'string', + 'example' => 'Inactive', + ], + 'Name' => [ + 'description' => 'The details of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Topology' => [ + 'description' => 'The status of the media workflow. The value is **Inactive**.'."\n", + 'type' => 'string', + 'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-9755-8385075A1234\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Inactive\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeactivateMediaWorkflowResponse>\\n <RequestId>16CD0CDD-457E-420D-9755-8385075A1234</RequestId>\\n <MediaWorkflow>\\n <CreationTime>2016-04-01T05:29:37Z</CreationTime>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e9181d4****</MediaWorkflowId>\\n <State>Inactive</State>\\n <Name>example-mediaworkflow-****</Name>\\n <Topology>{mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}</Topology>\\n </MediaWorkflow>\\n</DeactivateMediaWorkflowResponse>","errorExample":""}]', + 'title' => 'DeactivateMediaWorkflow', + 'summary' => 'Disables a media workflow.', + 'description' => 'The time when the media workflow was created.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMediaWorkflow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow that you want to delete. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7D752035-97DA-54E5-88E2-E8405EEA4394', + ], + 'MediaWorkflow' => [ + 'description' => 'The information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T05:29:37Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow that is deleted.'."\n", + 'type' => 'string', + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + 'State' => [ + 'description' => 'The status of the media workflow. The value is **Deleted**.'."\n", + 'type' => 'string', + 'example' => 'Deleted', + ], + 'Name' => [ + 'description' => 'The name of the media workflow that is deleted.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'string', + 'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D752035-97DA-54E5-88E2-E8405EEA4394\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Deleted\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMediaWorkflowResponse>\\n <RequestId>7D752035-97DA-54E5-88E2-E8405EEA4394</RequestId>\\n <MediaWorkflow>\\n <CreationTime>2016-04-01T05:29:37Z</CreationTime>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e9181d4****</MediaWorkflowId>\\n <State>Deleted</State>\\n <Name>example-mediaworkflow-****</Name>\\n <Topology>{mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}</Topology>\\n </MediaWorkflow>\\n</DeleteMediaWorkflowResponse>","errorExample":""}]', + 'title' => 'DeleteMediaWorkflow', + 'summary' => 'Deletes a media workflow. This does not affect workflow instances that are running.', + 'description' => 'After you delete or disable a workflow, the workflow cannot be used. In this case, the workflow is not automatically triggered when you upload a file to the bucket specified by the workflow.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMediaWorkflow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25042', + 'abilityTreeNodes' => [ + 'FEATUREmts0IG2Y5', + ], + ], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow that you want to update. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '6307eb0d3f85477882d205aa040f****', + ], + ], + [ + 'name' => 'Topology', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new topology of the media workflow. The value is a JSON object that contains the activity list and activity dependencies.'."\n" + ."\n" + .'> The Object Storage Service (OSS) bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "Activities": {'."\n" + .' "Act-Start": {'."\n" + .' "Parameters": {'."\n" + .' "PipelineId": "130266f58161436a80bf07cb12c8****",'."\n" + .' "InputFile": "{\\"Bucket\\": \\"example-bucket-****\\",\\"Location\\": \\"cn-shanghai\\"}"'."\n" + .' },'."\n" + .' "Type": "Start"'."\n" + .' },'."\n" + .' "Act-Report": {'."\n" + .' "Parameters": {},'."\n" + .' "Type": "Report"'."\n" + .' },'."\n" + .' "Act-Transcode-M3U8": {'."\n" + .' "Parameters": {'."\n" + .' "Outputs": "[{\\"Object\\":\\"transcode/{ObjectPrefix}{FileName}\\",\\"TemplateId\\": \\"957d1719ee85ed6527b90cf62726****\\"}]",'."\n" + .' "OutputBucket": "example-bucket-****",'."\n" + .' "OutputLocation": "cn-shanghai"'."\n" + .' },'."\n" + .' "Type": "Transcode"'."\n" + .' }'."\n" + .' },'."\n" + .' "Dependencies": {'."\n" + .' "Act-Start": ['."\n" + .' "Act-Transcode-M3U8"'."\n" + .' ],'."\n" + .' "Act-Report": [],'."\n" + .' "Act-Transcode-M3U8": ['."\n" + .' "Act-Report"'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'TriggerMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7D752035-97DA-54E5-88E2-E8405EEA****', + ], + 'MediaWorkflow' => [ + 'description' => 'The detailed information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T05:29:38Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow that is updated.'."\n", + 'type' => 'string', + 'example' => '6307eb0d3f85477882d205aa040f****', + ], + 'State' => [ + 'description' => 'The state of the media workflow. Valid values:'."\n" + ."\n" + .'* **Inactive**: The media workflow is disabled.'."\n" + .'* **Active**: The media workflow is enabled.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'TriggerMode' => [ + 'description' => 'The trigger mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" + .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", + 'type' => 'string', + 'example' => 'OssAutoTrigger', + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'examp-mediaworkflow-****', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "Activities": {'."\n" + .' "Act-Start": {'."\n" + .' "Parameters": {'."\n" + .' "PipelineId": "130266f58161436a80bf07cb12c8****",'."\n" + .' "InputFile": "{\\"Bucket\\": \\"example-bucket-****\\",\\"Location\\": \\"cn-shanghai\\"}"'."\n" + .' },'."\n" + .' "Type": "Start"'."\n" + .' },'."\n" + .' "Act-Report": {'."\n" + .' "Parameters": {},'."\n" + .' "Type": "Report"'."\n" + .' },'."\n" + .' "Act-Transcode-M3U8": {'."\n" + .' "Parameters": {'."\n" + .' "Outputs": "[{\\"Object\\":\\"transcode/{ObjectPrefix}{FileName}\\",\\"TemplateId\\": \\"957d1719ee85ed6527b90cf62726****\\"}]",'."\n" + .' "OutputBucket": "example-bucket-****",'."\n" + .' "OutputLocation": "cn-shanghai"'."\n" + .' },'."\n" + .' "Type": "Transcode"'."\n" + .' }'."\n" + .' },'."\n" + .' "Dependencies": {'."\n" + .' "Act-Start": ['."\n" + .' "Act-Transcode-M3U8"'."\n" + .' ],'."\n" + .' "Act-Report": [],'."\n" + .' "Act-Transcode-M3U8": ['."\n" + .' "Act-Report"'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D752035-97DA-54E5-88E2-E8405EEA****\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:38Z\\",\\n \\"MediaWorkflowId\\": \\"6307eb0d3f85477882d205aa040f****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"examp-mediaworkflow-****\\",\\n \\"Topology\\": \\"{\\\\n \\\\\\"Activities\\\\\\": {\\\\n \\\\\\"Act-Start\\\\\\": {\\\\n \\\\\\"Parameters\\\\\\": {\\\\n \\\\\\"PipelineId\\\\\\": \\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\n \\\\\\"InputFile\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"\\\\n },\\\\n \\\\\\"Type\\\\\\": \\\\\\"Start\\\\\\"\\\\n },\\\\n \\\\\\"Act-Report\\\\\\": {\\\\n \\\\\\"Parameters\\\\\\": {},\\\\n \\\\\\"Type\\\\\\": \\\\\\"Report\\\\\\"\\\\n },\\\\n \\\\\\"Act-Transcode-M3U8\\\\\\": {\\\\n \\\\\\"Parameters\\\\\\": {\\\\n \\\\\\"Outputs\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\n \\\\\\"OutputBucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\n \\\\\\"OutputLocation\\\\\\": \\\\\\"cn-shanghai\\\\\\"\\\\n },\\\\n \\\\\\"Type\\\\\\": \\\\\\"Transcode\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"Dependencies\\\\\\": {\\\\n \\\\\\"Act-Start\\\\\\": [\\\\n \\\\\\"Act-Transcode-M3U8\\\\\\"\\\\n ],\\\\n \\\\\\"Act-Report\\\\\\": [],\\\\n \\\\\\"Act-Transcode-M3U8\\\\\\": [\\\\n \\\\\\"Act-Report\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaWorkflowResponse>\\n <RequestId>7D752035-97DA-54E5-88E2-E8405EEA****</RequestId>\\n <MediaWorkflow>\\n <CreationTime>2016-04-01T05:29:38Z</CreationTime>\\n <MediaWorkflowId>6307eb0d3f85477882d205aa040f****</MediaWorkflowId>\\n <State>Active</State>\\n <TriggerMode>OssAutoTrigger</TriggerMode>\\n <Name>examp-mediaworkflow-****</Name>\\n <Topology>{mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}</Topology>\\n </MediaWorkflow>\\n</UpdateMediaWorkflowResponse>","errorExample":""}]', + 'title' => 'UpdateMediaWorkflow', + 'summary' => 'Updates the topology of a media workflow.', + 'description' => '* You can call this operation to update the topology of a media workflow. To update the trigger mode of a media workflow, call the [UpdateMediaWorkflowTriggerMode](~~70372~~) operation.'."\n" + .'* After you delete or deactivate a media workflow, the workflow cannot be used. In this case, the workflow is not automatically triggered when you upload a file to the bucket specified by the workflow.'."\n" + .'<warning>Deleting or deactivating a workflow will not affect tasks that have already been submitted. If a workflow is deleted or deactivated after a task has been submitted, tasks that are already in the processing queue will not be canceled and will be executed normally and charged the corresponding fees.></warning>'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).>', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMediaWorkflowList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the media workflows that you want to query. To obtain the IDs of the media workflows, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane. You can query up to 10 media workflows at a time. Separate multiple IDs of media workflows with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '93ab850b4f6f44eab54b6e9181d4****,72dfa5e679ab4be9a3ed9974c736****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NonExistMediaWorkflowIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaWorkflowId' => [ + 'description' => 'The workflows that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the media workflows that do not exist. This parameter is not returned if all specified media workflows are found.'."\n", + 'type' => 'string', + 'example' => '72dfa5e679ab4be9a3ed9974c736****', + ], + ], + ], + ], + 'MediaWorkflowList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaWorkflow' => [ + 'description' => 'The media workflows.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T05:29:38Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow.'."\n", + 'type' => 'string', + 'example' => '93ab850b4f6f44eab54b6e9181d4****', + ], + 'State' => [ + 'description' => 'The state of the media workflow. Valid values:'."\n" + ."\n" + .'* **Inactive**: The media workflow was deactivated.'."\n" + .'* **Active**: The media workflow was activated.'."\n" + .'* **Deleted**: The media workflow was deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'TriggerMode' => [ + 'description' => 'The trigger mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" + .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", + 'type' => 'string', + 'example' => 'OssAutoTrigger', + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'string', + 'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '16CD0CDD-457E-420D-1234-8385075A618B', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NonExistMediaWorkflowIds\\": {\\n \\"MediaWorkflowId\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n },\\n \\"MediaWorkflowList\\": {\\n \\"MediaWorkflow\\": [\\n {\\n \\"CreationTime\\": \\"2016-04-01T05:29:38Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-1234-8385075A618B\\"\\n}","type":"json"}]', + 'title' => 'QueryMediaWorkflowList', + 'summary' => 'Queries registered media workflows.', + 'description' => 'You can call this operation to query up to 10 media workflows at a time.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchMediaWorkflow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'* A maximum of **100** entries can be returned on each page.'."\n" + .'* Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StateList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the media workflows that you want to query. You can specify multiple states. Separate multiple states with commas (,). Default value: **Inactive,Active,Deleted**. Valid values:'."\n" + ."\n" + .'* **Inactive**: Deactivated media workflows are queried.'."\n" + .'* **Active**: Activated media workflows are queried.'."\n" + .'* **Deleted**: Deleted media workflows are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Inactive,Active,Deleted', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MediaWorkflowList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaWorkflow' => [ + 'description' => 'The details of the media workflows.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T05:38:41Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e4578645b665e2a12****', + ], + 'State' => [ + 'description' => 'The status of the media workflow. Valid values:'."\n" + ."\n" + .'* **Inactive**: The media workflow is deactivated.'."\n" + .'* **Active**: The media workflow is activated.'."\n" + .'* **Deleted**: The media workflow is deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'TriggerMode' => [ + 'description' => 'The trigger mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" + .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", + 'type' => 'string', + 'example' => 'OssAutoTrigger', + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'string', + 'example' => '{"MediaWorkflowList":{"MediaWorkflow":[{"CreationTime":"2016-04-01T05:29:38Z","Name":"example-mediaworkflow-****","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"example-location\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"example-location\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}', + ], + ], + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '16CD0CDD-457E-420D-9755-8385075A1234', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"MediaWorkflowList\\": {\\n \\"MediaWorkflow\\": [\\n {\\n \\"CreationTime\\": \\"2016-04-01T05:38:41Z\\",\\n \\"MediaWorkflowId\\": \\"88c6ca184c0e4578645b665e2a12****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{\\\\\\"MediaWorkflowList\\\\\\":{\\\\\\"MediaWorkflow\\\\\\":[{\\\\\\"CreationTime\\\\\\":\\\\\\"2016-04-01T05:29:38Z\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"example-mediaworkflow-****\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-location\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-9755-8385075A1234\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<SearchMediaWorkflowResponse>\\n <TotalCount>1</TotalCount>\\n <MediaWorkflowList>\\n <CreationTime>2016-04-01T05:38:41Z</CreationTime>\\n <MediaWorkflowId>88c6ca184c0e4578645b665e2a12****</MediaWorkflowId>\\n <State>Active</State>\\n <TriggerMode>OssAutoTrigger</TriggerMode>\\n <Name>example-mediaworkflow-****</Name>\\n <Topology>{\\"MediaWorkflowList\\":{\\"MediaWorkflow\\":[{\\"CreationTime\\":\\"2016-04-01T05:29:38Z\\",\\"Name\\":\\"example-mediaworkflow-****\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-location\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"example-location\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}</Topology>\\n </MediaWorkflowList>\\n <PageSize>10</PageSize>\\n <RequestId>16CD0CDD-457E-420D-9755-8385075A1234</RequestId>\\n <PageNumber>1</PageNumber>\\n</SearchMediaWorkflowResponse>","errorExample":""}]', + 'title' => 'SearchMediaWorkflow', + 'summary' => 'Queries media workflows in the specified state.', + 'description' => 'You can call this operation to query media workflows in the specified state. If you do not specify the state, all media workflows are queried by default.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMediaWorkflowTriggerMode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow that you want to update. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'e00732b977da427d9177a4dee646****', + ], + ], + [ + 'name' => 'TriggerMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The trigger mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: automatically triggers the media workflow.'."\n" + .'* **NotInAuto**: does not automatically trigger the media workflow.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NotInAuto', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '16CD0CDD-457E-420D-9755-8385075A1234', + ], + 'MediaWorkflow' => [ + 'description' => 'The information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T05:29:37Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'e00732b977da427d9177a4dee646****', + ], + 'State' => [ + 'description' => 'The status of the media workflow. Valid values:'."\n" + ."\n" + .'* **Inactive**: The media workflow is disabled.'."\n" + .'* **Active**: The media workflow is enabled.'."\n", + 'type' => 'string', + 'example' => 'Inactive', + ], + 'TriggerMode' => [ + 'description' => 'The trigger mode of the media workflow. Valid values:'."\n" + ."\n" + .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" + .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", + 'type' => 'string', + 'example' => 'NotInAuto', + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Topology' => [ + 'description' => 'The topology of the media workflow.'."\n", + 'type' => 'string', + 'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-9755-8385075A1234\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"e00732b977da427d9177a4dee646****\\",\\n \\"State\\": \\"Inactive\\",\\n \\"TriggerMode\\": \\"NotInAuto\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaWorkflowTriggerModeResponse>\\n <RequestId>16CD0CDD-457E-420D-9755-8385075A1234</RequestId>\\n <MediaWorkflow>\\n <CreationTime>2016-04-01T05:29:37Z</CreationTime>\\n <MediaWorkflowId>e00732b977da427d9177a4dee646****</MediaWorkflowId>\\n <State>Inactive</State>\\n <TriggerMode>NotInAuto</TriggerMode>\\n <Name>example-mediaworkflow-****</Name>\\n <Topology>{mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}</Topology>\\n </MediaWorkflow>\\n</UpdateMediaWorkflowTriggerModeResponse>","errorExample":""}]', + 'title' => 'UpdateMediaWorkflowTriggerMode', + 'summary' => 'Updates the trigger mode of a media workflow.', + 'description' => 'You can call this operation only to modify the trigger mode of a media workflow. To modify other information about the workflow, call the [UpdateMediaWorkflow](~~44438~~) operation.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMediaWorkflowExecutionList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RunIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the media workflow execution instances. To obtain the instance ID, log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Execution Instances** in the left-side navigation pane. Separate multiple IDs with commas (,). You can query a maximum of 10 media workflow execution instances at a time.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '48e33690ac19445488c706924321****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NonExistRunIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RunId' => [ + 'description' => 'The IDs of the execution instances that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the execution instances that do not exist. null is returned if all specified execution instances exist.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + 'MediaWorkflowExecutionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaWorkflowExecution' => [ + 'description' => 'The details of the media workflows.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '016-04-01T06:53:43Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow.'."\n", + 'type' => 'string', + 'example' => '93ab850b4f6f44eab54b6e91****81d4', + ], + 'State' => [ + 'description' => 'The status of the media workflow. Valid values:'."\n" + ."\n" + .'* Running: The media workflow is running.'."\n" + .'* Completed: The media workflow is complete.'."\n" + ."\n" + .'> Completed only indicates that the media workflow is complete. View the status of each method in the workflow, such as the transcode and snapshot methods, to check whether the method is called.'."\n" + ."\n" + .'* Fail: The media workflow fails.'."\n", + 'type' => 'string', + 'example' => 'Completed', + ], + 'ActivityList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Activity' => [ + 'description' => 'The methods that are called in the media workflow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the method.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The time when the method ends.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T06:53:44Z', + ], + 'Type' => [ + 'description' => 'The methods that are supported in the media workflow. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see [Methods supported for media workflows](~~68494~~).'."\n", + 'type' => 'string', + 'example' => 'Start', + ], + 'StartTime' => [ + 'description' => 'The time when the method is called.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T06:53:44Z', + ], + 'State' => [ + 'description' => 'The status of the workflow method. Valid values:'."\n" + ."\n" + .'* Running: The method is being called.'."\n" + .'* Success: The method is called.'."\n" + .'* Fail: The method failed to be called.'."\n" + .'* Skipped: The method is skipped.'."\n" + ."\n" + .'> For example, after the analysis is complete, the transcode method is called and high-definition and standard-definition transcoding jobs are created. The system determines whether to run the jobs based on the analysis result. If the resolution of the input video is low, the high-definition transcoding job may be skipped.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'JobId' => [ + 'description' => 'The IDs of the jobs that are generated when the methods are called, such as the job IDs for the analysis, transcode, and snapshot methods.'."\n", + 'type' => 'string', + 'example' => '2376030d9d0849399cd20e20f4f3****', + ], + 'Code' => [ + 'description' => 'The error code.'."\n" + ."\n" + .'* This parameter is returned only if **Fail** is returned for the State parameter.'."\n" + .'* This parameter is not returned if the method status is **Success**.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceContentBad', + ], + 'Message' => [ + 'description' => 'The error message.'."\n" + ."\n" + .'* This parameter is returned only if **Fail** is returned for the State parameter.'."\n" + .'* This parameter is not returned if the method status is **Success**.'."\n", + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'Name' => [ + 'description' => 'The name of the method.'."\n" + ."\n" + .'> The name of each method in a media workflow is unique.'."\n", + 'type' => 'string', + 'example' => 'Start', + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by Message Service (MNS) to notify the user of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the message that indicates the MNS message is sent. This parameter is not returned if the MNS message fails to be sent.'."\n", + 'type' => 'string', + 'example' => '4f3bc83233de4e2f81c7dade443e****', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.'."\n", + 'type' => 'string', + 'example' => 'MessageConfigEmpty', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.'."\n", + 'type' => 'string', + 'example' => 'The Topic/Queue config is empty, not send message', + ], + ], + ], + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Input' => [ + 'description' => 'The input data of the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserData' => [ + 'description' => 'The user-defined data.'."\n", + 'type' => 'string', + 'example' => 'example data ****', + ], + 'InputFile' => [ + 'description' => 'The input file of the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-mediaWorkflow-****/example-object-****/example.mp4', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file resides.'."\n", + 'type' => 'string', + 'example' => 'mps-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + ], + ], + ], + ], + 'MediaId' => [ + 'description' => 'The ID of the media asset. A media file contains all the information about a media workflow.'."\n", + 'type' => 'string', + 'example' => '512046582a924698a41e0f8b0d2b****', + ], + 'RunId' => [ + 'description' => 'The ID of the execution instance.'."\n", + 'type' => 'string', + 'example' => '48e33690ac19445488c706924321****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistRunIds\\": {\\n \\"RunId\\": [\\n \\"null\\"\\n ]\\n },\\n \\"MediaWorkflowExecutionList\\": {\\n \\"MediaWorkflowExecution\\": [\\n {\\n \\"CreationTime\\": \\"016-04-01T06:53:43Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91****81d4\\",\\n \\"State\\": \\"Completed\\",\\n \\"ActivityList\\": {\\n \\"Activity\\": [\\n {\\n \\"EndTime\\": \\"2016-04-01T06:53:44Z\\",\\n \\"Type\\": \\"Start\\",\\n \\"StartTime\\": \\"2016-04-01T06:53:44Z\\",\\n \\"State\\": \\"Running\\",\\n \\"JobId\\": \\"2376030d9d0849399cd20e20f4f3****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"Name\\": \\"Start\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"4f3bc83233de4e2f81c7dade443e****\\",\\n \\"ErrorMessage\\": \\"MessageConfigEmpty\\",\\n \\"ErrorCode\\": \\"The Topic/Queue config is empty, not send message\\"\\n }\\n }\\n ]\\n },\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Input\\": {\\n \\"UserData\\": \\"example data ****\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-mediaWorkflow-****/example-object-****/example.mp4\\",\\n \\"Location\\": \\"mps-cn-shanghai\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n },\\n \\"MediaId\\": \\"512046582a924698a41e0f8b0d2b****\\",\\n \\"RunId\\": \\"48e33690ac19445488c706924321****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMediaWorkflowExecutionListResponse>\\n <NonExistRunIds>null</NonExistRunIds>\\n <MediaWorkflowExecutionList>\\n <CreationTime>016-04-01T06:53:43Z</CreationTime>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e91****81d4</MediaWorkflowId>\\n <State>Completed</State>\\n <ActivityList>\\n <EndTime>2016-04-01T06:53:44Z</EndTime>\\n <Type>Start</Type>\\n <StartTime>2016-04-01T06:53:44Z</StartTime>\\n <State>Running</State>\\n <JobId>2376030d9d0849399cd20e20f4f3****</JobId>\\n <Code>InvalidParameter.ResourceContentBad</Code>\\n <Message>The resource operated InputFile is bad</Message>\\n <Name>Start</Name>\\n <MNSMessageResult>\\n <MessageId>4f3bc83233de4e2f81c7dade443e****</MessageId>\\n <ErrorMessage>MessageConfigEmpty</ErrorMessage>\\n <ErrorCode>The Topic/Queue config is empty, not send message</ErrorCode>\\n </MNSMessageResult>\\n </ActivityList>\\n <Name>example-mediaworkflow-****</Name>\\n <Input>\\n <UserData>example data ****</UserData>\\n <InputFile>\\n <Object>example-mediaWorkflow-****/example-object-****/example.mp4</Object>\\n <Location>mps-cn-shanghai</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </InputFile>\\n </Input>\\n <MediaId>512046582a924698a41e0f8b0d2b****</MediaId>\\n <RunId>48e33690ac19445488c706924321****</RunId>\\n </MediaWorkflowExecutionList>\\n <RequestId>D1D5C080-8E2F-5030-8AB4-13092F17631B</RequestId>\\n</QueryMediaWorkflowExecutionListResponse>","errorExample":""}]', + 'title' => 'QueryMediaWorkflowExecutionList', + 'summary' => 'Queries media workflow execution instances.', + 'description' => '* You can call this operation to query a maximum of 10 media workflow execution instances at a time.'."\n" + .'* Before you call this operation, make sure that the workflow pipeline is enabled. Otherwise, the workflow may not run as expected. For example, the following exceptions may occur: the workflow node is invalid and jobs created in the workflow cannot be executed.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListMediaWorkflowExecutions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow whose execution instances you want to query. To obtain the workflow ID, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '43b7335a4b1d4fe883670036affb****', + ], + ], + [ + 'name' => 'MediaWorkflowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the media workflow. To obtain the workflow name, you can log on to the **MPS console** and choose **Workflows** > **Workflow Settings**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-mediaworkflow-****', + ], + ], + [ + 'name' => 'InputFileURL', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Object Storage Service (OSS) URL of the input file of the media workflow. The URL complies with RFC 3986 and is encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-****.cn-hangzhou.aliyuncs.com/test****.flv', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. The value is a UUID that contains 32 characters. When you request the first page of query results, leave the NextPageToken parameter empty. When you request more query results, specify the value of the NextPageToken parameter returned in the query results on the previous page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of media workflow execution instances to return. Valid values: `[1,100]`. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaWorkflowExecutionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaWorkflowExecution' => [ + 'description' => 'The details of the media workflows.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media workflow was created.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T06:53:43Z', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the media workflow.'."\n", + 'type' => 'string', + 'example' => '43b7335a4b1d4fe883670036affb****', + ], + 'State' => [ + 'description' => 'The status of the media workflow. Valid values:'."\n" + ."\n" + .'* **running**: The execution is in progress.'."\n" + .'* **Completed**: The execution is complete.'."\n" + ."\n" + .'> A value of Completed indicates that the execution is complete. For the information about whether each activity, such as Transcode or Snapshot, is successful, check the status of the activity.'."\n" + ."\n" + .'* **Fail**: The execution failed.'."\n" + .'* **Success**: The execution was successful.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'ActivityList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Activity' => [ + 'description' => 'The activities that are executed in the media workflow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the media workflow activity.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The end time of the activity.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T06:54:00Z', + ], + 'Type' => [ + 'description' => 'The type of the media workflow activity. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see [Methods supported for media workflows](~~68494~~).'."\n", + 'type' => 'string', + 'example' => 'Start', + ], + 'StartTime' => [ + 'description' => 'The start time of the activity.'."\n", + 'type' => 'string', + 'example' => '2016-04-01T06:53:45Z', + ], + 'State' => [ + 'description' => 'The status of the activity. Valid values:'."\n" + ."\n" + .'* **Running**: The activity is being executed.'."\n" + .'* **Fail**: The activity failed to be executed.'."\n" + .'* **Skipped**: The activity was skipped.'."\n" + .'* **Success**: The activity was successfully executed.'."\n" + ."\n" + .'> For example, the high-definition and standard-definition transcoding activities are to be run after the analysis activity is complete. The system determines the activity to run based on the analysis result. If the definition of the input video content is insufficient, the high-definition transcoding activity may be skipped.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'JobId' => [ + 'description' => 'The ID of the job generated when the activity is executed. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '2376030d9d0849399cd20e20c876****', + ], + 'Code' => [ + 'description' => 'The error code returned if the request failed.'."\n" + ."\n" + .'* The specific error code appears if the state of the activity is **Fail**.'."\n" + .'* This parameter is not returned if the state of the activity is **Success**.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n" + ."\n" + .'* The detailed error message appears if the state of the activity is **Fail**.'."\n" + .'* This parameter is not returned if the state of the activity is **Success**.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Name' => [ + 'description' => 'The name of the media workflow activity.'."\n" + ."\n" + .'> The name of an activity in a media workflow is unique.'."\n", + 'type' => 'string', + 'example' => 'Act-2', + ], + 'MNSMessageResult' => [ + 'description' => 'The message sent by Message Service (MNS) to notify the user of the job result.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The ID of the success message. If the job failed, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '4f3bc83233de4e2f81c7dade443e****', + ], + 'ErrorMessage' => [ + 'description' => 'The error message returned if the job failed. If the job was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'MessageConfigEmpty', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the job failed. If the job was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'The Topic/Queue config is empty, not send message', + ], + ], + ], + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the media workflow.'."\n", + 'type' => 'string', + 'example' => 'example-mediaworkflow-****', + ], + 'Input' => [ + 'description' => 'The custom data of the media workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'example data', + ], + 'InputFile' => [ + 'description' => 'The information about the storage location of the input file of the media workflow in OSS.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input media file.'."\n", + 'type' => 'string', + 'example' => 'example-mediaWorkflow-****/example-object-****/example.mp4', + ], + 'Location' => [ + 'description' => 'The OSS region in which the input file resides.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input media file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + ], + ], + ], + ], + 'MediaId' => [ + 'description' => 'The ID of the media file. A media file contains all the information about a media workflow.'."\n", + 'type' => 'string', + 'example' => '512046582a924698a41e0f8b0d2b****', + ], + 'RunId' => [ + 'description' => 'The ID of the execution instance.'."\n", + 'type' => 'string', + 'example' => '48e33690ac19445488c706924321****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', + ], + 'NextPageToken' => [ + 'description' => 'The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaWorkflowExecutionList\\": {\\n \\"MediaWorkflowExecution\\": [\\n {\\n \\"CreationTime\\": \\"2016-04-01T06:53:43Z\\",\\n \\"MediaWorkflowId\\": \\"43b7335a4b1d4fe883670036affb****\\",\\n \\"State\\": \\"Success\\",\\n \\"ActivityList\\": {\\n \\"Activity\\": [\\n {\\n \\"EndTime\\": \\"2016-04-01T06:54:00Z\\",\\n \\"Type\\": \\"Start\\",\\n \\"StartTime\\": \\"2016-04-01T06:53:45Z\\",\\n \\"State\\": \\"Success\\",\\n \\"JobId\\": \\"2376030d9d0849399cd20e20c876****\\",\\n \\"Code\\": \\"null\\",\\n \\"Message\\": \\"null\\",\\n \\"Name\\": \\"Act-2\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"4f3bc83233de4e2f81c7dade443e****\\",\\n \\"ErrorMessage\\": \\"MessageConfigEmpty\\",\\n \\"ErrorCode\\": \\"The Topic/Queue config is empty, not send message\\"\\n }\\n }\\n ]\\n },\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Input\\": {\\n \\"UserData\\": \\"example data\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-mediaWorkflow-****/example-object-****/example.mp4\\",\\n \\"Location\\": \\"cn-shanghai\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n },\\n \\"MediaId\\": \\"512046582a924698a41e0f8b0d2b****\\",\\n \\"RunId\\": \\"48e33690ac19445488c706924321****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\",\\n \\"NextPageToken\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListMediaWorkflowExecutionsResponse>\\n <MediaWorkflowExecutionList>\\n <CreationTime>2016-04-01T06:53:43Z</CreationTime>\\n <MediaWorkflowId>43b7335a4b1d4fe883670036affb****</MediaWorkflowId>\\n <State>Success</State>\\n <ActivityList>\\n <EndTime>2016-04-01T06:54:00Z</EndTime>\\n <Type>Start</Type>\\n <StartTime>2016-04-01T06:53:45Z</StartTime>\\n <State>Success</State>\\n <JobId>2376030d9d0849399cd20e20c876****</JobId>\\n <Code>null</Code>\\n <Message>null</Message>\\n <Name>Act-2</Name>\\n <MNSMessageResult>\\n <MessageId>4f3bc83233de4e2f81c7dade443e****</MessageId>\\n <ErrorMessage>MessageConfigEmpty</ErrorMessage>\\n <ErrorCode>The Topic/Queue config is empty, not send message</ErrorCode>\\n </MNSMessageResult>\\n </ActivityList>\\n <Name>example-mediaworkflow-****</Name>\\n <Input>\\n <UserData>example data</UserData>\\n <InputFile>\\n <Object>example-mediaWorkflow-****/example-object-****/example.mp4</Object>\\n <Location>cn-shanghai</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </InputFile>\\n </Input>\\n <MediaId>512046582a924698a41e0f8b0d2b****</MediaId>\\n <RunId>48e33690ac19445488c706924321****</RunId>\\n </MediaWorkflowExecutionList>\\n <RequestId>D1D5C080-8E2F-5030-8AB4-13092F17631B</RequestId>\\n <NextPageToken>39f8e0bc005e4f309379701645f4****</NextPageToken>\\n</ListMediaWorkflowExecutionsResponse>","errorExample":""}]', + 'title' => 'ListMediaWorkflowExecutions', + 'summary' => 'Queries the execution instances of a media workflow.', + 'description' => 'This operation returns execution instances only in the recent 90 days.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindInputBucket' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Bucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the input media bucket to be bound. The name can be up to 64 bytes in size. To obtain the media bucket name, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Media Buckets** in the left-side navigation pane.'."\n" + ."\n" + .'> The bucket name can contain lowercase letters, digits, and hyphens (-), and cannot start or end with a hyphen (-).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket-****', + ], + ], + [ + 'name' => 'Referer', + 'in' => 'query', + 'schema' => [ + 'description' => 'The settings of Object Storage Service (OSS) hotlink protection. For more information, see [Hotlink protection](~~31869~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","errorExample":""},{"type":"xml","example":"<BindInputBucketResponse>\\n <RequestId>4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3</RequestId>\\n</BindInputBucketResponse>","errorExample":""}]', + 'title' => 'BindInputBucket', + 'summary' => 'Binds an input media bucket.', + 'description' => 'Before you call this operation to bind an input media bucket, you must create a media bucket. For more information, see [Add media buckets](~~42430~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'BindOutputBucket' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Bucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Object Storage Service (OSS) bucket that you want to bind. The name can be up to 64 bytes in size and can contain letters, digits, and hyphens (-). The name cannot start with a special character.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D0F80646-90D4-402F-9D56-CEFEAA6BCC9B', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0F80646-90D4-402F-9D56-CEFEAA6BCC9B\\"\\n}","errorExample":""},{"type":"xml","example":"<BindOutputBucketResponse>\\n <RequestId>D0F80646-90D4-402F-9D56-CEFEAA6BCC9B</RequestId>\\n</BindOutputBucketResponse>","errorExample":""}]', + 'title' => 'BindOutputBucket', + 'summary' => 'Binds an output media bucket. Media buckets are Object Storage Service (OSS) buckets that are used by ApsaraVideo Media Processing (MPS) to store media resources. After you bind an OSS bucket to MPS as an input media bucket or output media bucket, MPS has the permissions to listen to the messages of the bucket, which indicate that files are uploaded to the bucket. This way, MPS can trigger workflows and return files that are processed. You can all this operation to bind an output media bucket to the media library.', + 'description' => 'Before you call this operation to bind an output media bucket to the media library, you must create a media bucket. For more information, see [Add media buckets](~~42430~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnbindInputBucket' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Bucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the input media bucket to be unbound. To obtain the media bucket name, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Media Buckets** in the left-side navigation pane. Alternatively, you can log on to the **Object Storage Service (OSS) console** and click **Historical Paths**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket-****', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role used for delegated authorization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::174809843091****:role/exampleRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","type":"json"}]', + 'title' => 'UnbindInputBucket', + 'summary' => 'Unbinds an input media bucket from the media library.', + 'description' => '# Usage notes'."\n" + ."\n" + .'You can call this operation to unbind an input media bucket from the media library based on the name of the output media bucket.'."\n" + ."\n" + .'# QPS limits'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'UnbindOutputBucket' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Bucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The operation that you want to perform. Set the value to **UnbindOutputBucket**.'."\n", + 'type' => 'string', + 'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindOutputBucketResponse>\\n <RequestId>4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3</RequestId>\\n</UnbindOutputBucketResponse>","errorExample":""}]', + 'title' => 'UnbindOutputBucket', + 'summary' => 'You can call this operation to unbind an output media bucket from the media library based on the name of the output media bucket.'."\n" + ."\n" + .'\\## QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see \\[QPS limits]\\(https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + 'description' => 'The name of the output media bucket to be unbound. To obtain the media bucket name, you can log on to the **ApsaraVideo Media Processing (MPS)** console and choose **Workflows** > **Media Buckets** in the left-side navigation pane. Alternatively, you can log on to the **Object Storage Service (OSS) console** and click **My OSS Paths**.'."\n", + ], + 'ListAllMediaBucket' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The response to the first request contains this parameter, which is added to the next request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of media buckets to return. Valid values: 1 to 100. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79760D91-D3CF-4165-****-B7E2836EF62A', + ], + 'NextPageToken' => [ + 'description' => 'The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****', + ], + 'MediaBucketList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaBucket' => [ + 'description' => 'The media buckets returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the media bucket.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the media bucket. Valid values:'."\n" + ."\n" + .'* Input: input media bucket'."\n" + .'* Output: output media bucket'."\n", + 'type' => 'string', + 'example' => 'Input', + ], + 'Bucket' => [ + 'description' => 'The name of the media bucket.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + 'Referer' => [ + 'description' => 'The settings of Object Storage Service (OSS) hotlink protection. For more information, see [Hotlink protection](~~31869~~).'."\n", + 'type' => 'string', + 'example' => 'http://www.example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"79760D91-D3CF-4165-****-B7E2836EF62A\\",\\n \\"NextPageToken\\": \\"P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****\\",\\n \\"MediaBucketList\\": {\\n \\"MediaBucket\\": [\\n {\\n \\"Type\\": \\"Input\\",\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Referer\\": \\"http://www.example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAllMediaBucketResponse>\\n <RequestId>79760D91-D3CF-4165-****-B7E2836EF62A</RequestId>\\n <NextPageToken>P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****</NextPageToken>\\n <MediaBucketList>\\n <Type>Input</Type>\\n <Bucket>example-bucket-****</Bucket>\\n <Referer>http://www.example.com</Referer>\\n </MediaBucketList>\\n</ListAllMediaBucketResponse>","errorExample":""}]', + 'title' => 'ListAllMediaBucket', + 'summary' => 'Queries all media buckets bound to the media library.', + 'description' => 'A maximum of 100 media buckets can be returned.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddMedia' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'FileURL', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the input file. You can obtain the URL in the MPS or OSS console. For more information, see the **Triggering and matching rule for a workflow** section of this topic.'."\n" + ."\n" + .'* Only OSS HTTP URLs are supported. Alibaba Cloud CDN URLs and HTTPS URLs are not supported.'."\n" + .'* The value can be up to 3,200 bytes in size.'."\n" + .'* The URL complies with RFC 2396 and is encoded in UTF-8. For more information, see [URL encoding](~~423796~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => 'The title of the media file.'."\n" + ."\n" + .'* The title can be up to 128 bytes in length.'."\n" + .'* The value must be encoded in UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mytest', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the media file.'."\n" + ."\n" + .'* The description can be up to 1,024 bytes in length.'."\n" + .'* The value must be encoded in UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'A test video', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the thumbnail. To obtain the URL, you can log on to the **MPS console** and choose **Workflows** > **Media Buckets**. Alternatively, you can log on to the **OSS console** and click **My OSS Paths**.'."\n" + ."\n" + .'* The value can be up to 3,200 bytes in length.'."\n" + .'* The URL complies with RFC 2396 and is encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags that you want to add to the media file.'."\n" + ."\n" + .'> In MPS, each tag that is specified for a media file is independent. You can search for all the media files that have the same tags in the Media Library.'."\n" + ."\n" + .'* You can specify up to 16 tags for a media file. Separate multiple tags with commas (,).'."\n" + .'* Each tag can be up to 32 bytes in size'."\n" + .'* The value must be encoded in UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1,tag2', + ], + ], + [ + 'name' => 'MediaWorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media workflow that you want to run for the media file. To query the ID of a media workflow, you can log on to the MPS console or call the [AddMediaWorkflow](~~44437~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '07da6c65da7f458997336e0de192****', + ], + ], + [ + 'name' => 'MediaWorkflowUserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data of the media workflow.'."\n" + ."\n" + .'* The value can be up to 1,024 bytes in length.'."\n" + .'* The value must be encoded in UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InputUnbind', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to check if the media workflow supports the specified input path. We recommend that you set this parameter to true to prevent errors that may result from invalid paths. Valid values:'."\n" + ."\n" + .'* **true**: checks whether the workflow supports the specified input path.'."\n" + .'* **false**: does not check whether the workflow supports the specified input path.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the category to which the media file belongs. The value cannot be negative.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'OverrideParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subtitle settings that are used to overwrite the original settings.'."\n" + ."\n" + .'* Example 1: Use `{"WebVTTSubtitleOverrides",[{"RefActivityName":"subtitleNode","WebVTTSubtitleURL":"http://test.oss-cn-hangzhou.aliyuncs.com/example1.vtt"}]}` to overwrite the original subtitle settings during HTTP Live Streaming (HLS) packaging.'."\n" + .'* Example 2: Use `{"subtitleTransNodeName":{"InputConfig":{"Format":"stl","InputFile":{"URL":"http://subtitleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}}` to overwrite the original subtitle settings during Dynamic Adaptive Streaming over HTTP (DASH) packaging.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{“subtitleTransNodeName”:{“InputConfig”:{“Format”:”stl”,”InputFile”:{“URL”:”http://exampleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD', + ], + 'Media' => [ + 'description' => 'The detailed information about the media file.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media file was created.'."\n", + 'type' => 'string', + 'example' => '2016-09-20T03:02:40Z', + ], + 'CateId' => [ + 'description' => 'The ID of the category to which the media file belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Height' => [ + 'description' => 'The height of the media file.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'CensorState' => [ + 'description' => 'The review status of the media file. Valid values:'."\n" + ."\n" + .'* **Initiated**: The media file is uploaded but not reviewed.'."\n" + .'* **Pass**: The media file is uploaded and passes the review.'."\n", + 'type' => 'string', + 'example' => 'Initiated', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags of the media file.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are added to the media file.'."\n", + 'type' => 'string', + 'example' => 'tag,tag2', + ], + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The bitrate.'."\n", + 'type' => 'string', + 'example' => '1148.77', + ], + 'MediaId' => [ + 'description' => 'The ID of the media file.'."\n", + 'type' => 'string', + 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', + ], + 'File' => [ + 'description' => 'The information about the input file.'."\n", + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => 'The status of the file. The default value is **Normal**.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'URL' => [ + 'description' => 'The URL of the media file.'."\n", + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4', + ], + ], + ], + 'PublishState' => [ + 'description' => 'The publishing status of the media file. Valid values:'."\n" + ."\n" + .'* **Initiated**: The media file is in the initial state.'."\n" + .'* **UnPublish**: The media file has not been published, and the playback permission on the OSS object is Private.'."\n" + .'* **Published**: The media file has been published, and the playback permission on the OSS object is Default.'."\n", + 'type' => 'string', + 'example' => 'Published', + ], + 'Description' => [ + 'description' => 'The description of the media file. The description can be up to 1,024 bytes in length.'."\n", + 'type' => 'string', + 'example' => 'A test video', + ], + 'Width' => [ + 'description' => 'The width of the media file.'."\n", + 'type' => 'string', + 'example' => '1280', + ], + 'Size' => [ + 'description' => 'The size of the media file.'."\n", + 'type' => 'string', + 'example' => '379860', + ], + 'CoverURL' => [ + 'description' => 'The URL of the thumbnail.'."\n", + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png', + ], + 'RunIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RunId' => [ + 'description' => 'The IDs of the media workflow execution instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the executed workflow execution instances. The IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '{"RunId":["cbad98d35629470fa05ff393d347****"]}', + ], + ], + ], + ], + 'Duration' => [ + 'description' => 'The duration of the media file.'."\n", + 'type' => 'string', + 'example' => '2.645333', + ], + 'Fps' => [ + 'description' => 'The frame rate of the media file.'."\n", + 'type' => 'string', + 'example' => '25.0', + ], + 'Title' => [ + 'description' => 'The title of the media file. The title can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'example' => 'mytest.mp4', + ], + 'Format' => [ + 'description' => 'The format of the media file. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\",\\n \\"Media\\": {\\n \\"CreationTime\\": \\"2016-09-20T03:02:40Z\\",\\n \\"CateId\\": 1,\\n \\"Height\\": \\"1280\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag,tag2\\"\\n ]\\n },\\n \\"Bitrate\\": \\"1148.77\\",\\n \\"MediaId\\": \\"3e6149d5a8c944c09b1a8d2dc3e4****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4\\"\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"Description\\": \\"A test video\\",\\n \\"Width\\": \\"1280\\",\\n \\"Size\\": \\"379860\\",\\n \\"CoverURL\\": \\"http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png\\",\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"{\\\\\\"RunId\\\\\\":[\\\\\\"cbad98d35629470fa05ff393d347****\\\\\\"]}\\"\\n ]\\n },\\n \\"Duration\\": \\"2.645333\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Title\\": \\"mytest.mp4\\",\\n \\"Format\\": \\"mp4\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddMediaResponse>\\n <RequestId>05F8B913-E9F3-4A6F-9922-48CADA0FFAAD</RequestId>\\n <Media>\\n <CreationTime>2016-09-20T03:02:40Z</CreationTime>\\n <CateId>1</CateId>\\n <Height>1280</Height>\\n <CensorState>Initiated</CensorState>\\n <Tags>tag,tag2</Tags>\\n <Bitrate>1148.77</Bitrate>\\n <MediaId>3e6149d5a8c944c09b1a8d2dc3e4****</MediaId>\\n <File>\\n <State>Normal</State>\\n <URL>http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4</URL>\\n </File>\\n <PublishState>Published</PublishState>\\n <Description>A test video</Description>\\n <Width>1280</Width>\\n <Size>379860</Size>\\n <CoverURL>http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png</CoverURL>\\n <RunIdList>{\\"RunId\\":[\\"cbad98d35629470fa05ff393d347****\\"]}</RunIdList>\\n <Duration>2.645333</Duration>\\n <Fps>25.0</Fps>\\n <Title>mytest.mp4</Title>\\n <Format>mp4</Format>\\n </Media>\\n</AddMediaResponse>","errorExample":""}]', + 'title' => 'AddMedia', + 'summary' => 'Adds a media file.', + 'description' => '* You can call this operation to process videos that are uploaded to Object Storage Service (OSS) but not processed. This way, you do not need to upload the videos to OSS again. If you have configured media workflows, OSS automatically notifies ApsaraVideo Media Processing (MPS) when a media file is uploaded to OSS. MPS automatically finds the corresponding workflow in the Active state based on the specified OSS bucket and object. Therefore, in most cases, you do not need to manually call the AddMedia operation to process the media file.'."\n" + .'* Media information is automatically obtained only when the specified media workflow is in the Active state. If no media workflow is specified or the specified media workflow is not in the Active state, media information is not obtained.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => '**Triggering and matching rule for a workflow**'."\n" + ."\n" + .'MPS checks whether the URL of the input file contains the URL to which the workflow is bound. If yes, the workflow matches the input file and runs. Otherwise, the workflow does not match the input file and does not run. Example: The URL of the input file is `http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv`.'."\n" + ."\n" + .'```'."\n" + .'1. When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/, the workflow is triggered.'."\n" + .'2. When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/, the workflow is triggered.'."\n" + .'3.When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A/, the workflow is triggered.'."\n" + .'4. When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/, the workflow is triggered.'."\n" + .'5. When test.flv is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/, the workflow is triggered.'."\n" + .'6. When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/, the workflow is not triggered.'."\n" + .'7. When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/, the workflow is not triggered.'."\n" + .'8. When a media file is added to http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/, the workflow is not triggered.'."\n" + .'```'."\n" + ."\n" + .'**Note**When you create a media workflow, do not configure the input URL of a workflow to be the same as the prefix of the input URL of another workflow. Otherwise, two workflow execution instances will be triggered for adding one media file. For example, if you specify the test folder for the first workflow triggering rule and the test1 folder for the second workflow triggering rule, the two workflows are triggered when a media file is added to the test1 folder.'."\n" + ."\n" + .'**File name extension matching**'."\n" + ."\n" + .'Only multimedia files can trigger workflows. MPS determines whether to trigger a workflow by checking the file name extensions. A workflow is matched for a file that does not have a file name extension or a file with the name extension described in the following table. A file that does not have a file name extension has no separator dot in the file name.'."\n" + ."\n" + .'**Note**For SWF files, the snapshot and transcoding features may not deliver optimal performance.'."\n" + ."\n" + .'|Type|File name extension|'."\n" + .'|:---|:---|'."\n" + .'|Video|3gp, asf, avi, dat, dv, flv, f4v, gif, m2t, m3u8, m4v, mj2, mjpeg, mkv, mov, mp4, mpe, mpg, mpeg, mts, ogg, qt, rm, rmvb, swf, ts, vob, wmv, webm|'."\n" + .'|Audio|aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff|'."\n" + ."\n\n" + .'**Media workflow message**'."\n" + ."\n" + .'Media workflows use [Alibaba Cloud Message Service (MNS)](https://www.alibabacloud.com/en/product/message-service?_p_lc=1) to send messages to MPS service users. A media workflow sends a message when the Start or Report activity is complete. To receive the message, you must set the queue or notification name on the Start activity. The message generated by the media workflow is stored in the queue or notification. You can use [MNS SDK](~~27508~~) to obtain the message. The following table describes the message specifications.'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|:---|:---|:---|'."\n" + .'|RunId|String|The ID of the workflow execution instance.|'."\n" + .'|Name|String|The name of the activity.|'."\n" + .'|Type|String|The type of the activity. Valid values: Report and Start.|'."\n" + .'|State|String|The status of the activity. Valid values: Fail and Success.|'."\n" + .'|Code|String|The error code returned if the activity fails. The specific error code appears if the activity status is Fail.|'."\n" + .'|Message|String|The error message returned if the activity fails. The detailed error message is returned if the activity status is Fail.|'."\n" + .'|MediaWorkflowExecution|MediaWorkflowExecution|The detailed information about the workflow execution instance.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMedia' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the media files that you want to remove. Separate multiple IDs with commas (,). You can remove up to 10 media files at a time.'."\n" + ."\n" + .'> You can obtain the ID of the media file from the response parameters of the [AddMedia](~~44458~~) operation. Alternatively, you can log on to the MPS console. In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage** in the Actions column. The ID of the video is displayed on the Basics tab.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3e1cd21131a94525be55acf65888****,3e6149d5a8c944c09b1a8d2dc3e4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMediaResponse>\\n <RequestId>05F8B913-E9F3-4A6F-9922-48CADA0FFAAD</RequestId>\\n</DeleteMediaResponse>","errorExample":""}]', + 'title' => 'DeleteMedia', + 'summary' => 'Deletes media files from ApsaraVideo Media Processing (MPS).', + 'description' => 'This operation allows you to logically delete a media file. The media file can no longer be processed, but the corresponding objects in the input and output Object Storage Service (OSS) buckets are retained.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMedia' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media file whose basic information you want to update. To obtain the ID of the media file, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Media Management** > **Media List** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3e1cd21131a94525be55acf65888****', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => 'The title of the media file. Multiple character types, such as letters and digits, are supported.'."\n" + ."\n" + .'* If you do not specify this parameter, the value is NULL.'."\n" + .'* The value is encoded in UTF-8 and can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the media file. Multiple character types, such as letters and digits, are supported.'."\n" + ."\n" + .'* If you do not specify this parameter, the value is NULL.'."\n" + .'* The value is encoded in UTF-8 and can be up to 1,024 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example description', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the thumbnail. This parameter is used to specify the storage location of the thumbnail. To obtain the URL, you can log on to the **MPS console** and choose **Workflows** > **Media Buckets** in the left-side navigation pane. Alternatively, you can log on to the **OSS console** and click **Buckets** in the left-side navigation pane.'."\n" + ."\n" + .'* The value can be up to 3,200 bytes in length.'."\n" + .'* The URL complies with RFC 2396 and is encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/test****.jpg', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the category to which the media file belongs. The value must be an integer.'."\n" + ."\n" + .'* If you do not specify this parameter, the value is NULL.'."\n" + .'* The value cannot be negative.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags that you want to add to the media file.'."\n" + ."\n" + .'* You can specify up to 16 tags for a media file. Separate multiple tags with commas (,).'."\n" + .'* Each tag can be up to 32 bytes in length.'."\n" + .'* The value is encoded in UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1,tag2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6A88246F-C91F-42BD-BABE-DB0DF993F960', + ], + 'Media' => [ + 'description' => 'The information about the media file.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media file was created.'."\n", + 'type' => 'string', + 'example' => '2016-09-14T08:30:33Z', + ], + 'CateId' => [ + 'description' => 'The ID of the category to which the media file belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Height' => [ + 'description' => 'The height of the media file.'."\n", + 'type' => 'string', + 'example' => '1080', + ], + 'CensorState' => [ + 'description' => 'The review state of the media file. Valid values:'."\n" + ."\n" + .'* **Initiated**: The media file is uploaded but not reviewed.'."\n" + .'* **Pass**: The media file is uploaded and passes the review.'."\n", + 'type' => 'string', + 'example' => 'Initiated', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The information about the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that you want to add to the media file.'."\n", + 'type' => 'string', + 'example' => 'tag1,tag2', + ], + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the media file.'."\n", + 'type' => 'string', + 'example' => '2659.326', + ], + 'MediaId' => [ + 'description' => 'The ID of the media file.'."\n", + 'type' => 'string', + 'example' => '3e1cd21131a94525be55acf65888****', + ], + 'File' => [ + 'description' => 'The information about the input file.'."\n", + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => 'The state of the input file. Valid values:'."\n" + ."\n" + .'* **Normal**: The input file is normal.'."\n" + .'* **Deleted**: The input file is deleted.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'URL' => [ + 'description' => 'The name of the OSS bucket in which the input media file is stored.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', + ], + ], + ], + 'PublishState' => [ + 'description' => 'The publishing state of the media file. Valid values:'."\n" + ."\n" + .'* **Initiated**: The media file is in the initial state.'."\n" + .'* **UnPublish**: The media file has not been published, and the playback permission on the OSS object is Private.'."\n" + .'* **Published**: The media file has been published, and the playback permission on the OSS object is Default.'."\n" + .'* **Deleted**: The media file is deleted.'."\n", + 'type' => 'string', + 'example' => 'Published', + ], + 'Description' => [ + 'description' => 'The description of the media file.'."\n", + 'type' => 'string', + 'example' => 'example description', + ], + 'Width' => [ + 'description' => 'The width of the media file.'."\n", + 'type' => 'string', + 'example' => '1920', + ], + 'Size' => [ + 'description' => 'The size of the media file.'."\n", + 'type' => 'string', + 'example' => '2647692', + ], + 'CoverURL' => [ + 'description' => 'The URL of the thumbnail.'."\n", + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg', + ], + 'RunIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RunId' => [ + 'description' => 'The IDs of the media workflow execution instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the media workflow execution instances.'."\n", + 'type' => 'string', + 'example' => '{"RunId":["47b42486019c4f688bf144c1a6ba****"]}', + ], + ], + ], + ], + 'Duration' => [ + 'description' => 'The duration of the media file.'."\n", + 'type' => 'string', + 'example' => '7.965000', + ], + 'Fps' => [ + 'description' => 'The frame rate of the media file.'."\n", + 'type' => 'string', + 'example' => '25.0', + ], + 'Title' => [ + 'description' => 'The title of the media file.'."\n", + 'type' => 'string', + 'example' => 'hello', + ], + 'Format' => [ + 'description' => 'The format of the media file. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'type' => 'string', + 'example' => 'mov', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6A88246F-C91F-42BD-BABE-DB0DF993F960\\",\\n \\"Media\\": {\\n \\"CreationTime\\": \\"2016-09-14T08:30:33Z\\",\\n \\"CateId\\": 1,\\n \\"Height\\": \\"1080\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag1,tag2\\"\\n ]\\n },\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"MediaId\\": \\"3e1cd21131a94525be55acf65888****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"Description\\": \\"example description\\",\\n \\"Width\\": \\"1920\\",\\n \\"Size\\": \\"2647692\\",\\n \\"CoverURL\\": \\"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg\\",\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"{\\\\\\"RunId\\\\\\":[\\\\\\"47b42486019c4f688bf144c1a6ba****\\\\\\"]}\\"\\n ]\\n },\\n \\"Duration\\": \\"7.965000\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Title\\": \\"hello\\",\\n \\"Format\\": \\"mov\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaResponse>\\n <RequestId>6A88246F-C91F-42BD-BABE-DB0DF993F960</RequestId>\\n <Media>\\n <CreationTime>2016-09-14T08:30:33Z</CreationTime>\\n <CateId>1</CateId>\\n <Height>1080</Height>\\n <CensorState>Initiated</CensorState>\\n <Tags>tag1,tag2</Tags>\\n <Bitrate>2659.326</Bitrate>\\n <MediaId>3e1cd21131a94525be55acf65888****</MediaId>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4</URL>\\n </File>\\n <PublishState>Published</PublishState>\\n <Description>example description</Description>\\n <Width>1920</Width>\\n <Size>2647692</Size>\\n <CoverURL>http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg</CoverURL>\\n <RunIdList>{\\"RunId\\":[\\"47b42486019c4f688bf144c1a6ba****\\"]}</RunIdList>\\n <Duration>7.965000</Duration>\\n <Fps>25.0</Fps>\\n <Title>hello</Title>\\n <Format>mov</Format>\\n </Media>\\n</UpdateMediaResponse>","errorExample":""}]', + 'title' => 'UpdateMedia', + 'summary' => 'Updates the basic information about a media file.', + 'description' => 'The basic information that you can update by calling this operation includes the title, description, and category of a media file. This operation applies to a full update. You must set all the parameters unless you want to replace the value of a specific parameter with a NULL value.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMediaCategory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media file whose category you want to update.'."\n" + ."\n" + .'> To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management > Media List**. Find the required video and click **Manage** in the Actions column. The ID of the video is displayed on the Basics tab.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3e1cd21131a94525be55acf65888****', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the category. The value cannot be negative.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E3931857-E3D3-4D6E-9C7B-D2C09441BD01', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E3931857-E3D3-4D6E-9C7B-D2C09441BD01\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaCategoryResponse>\\n <RequestId>E3931857-E3D3-4D6E-9C7B-D2C09441BD01</RequestId>\\n</UpdateMediaCategoryResponse>","errorExample":""}]', + 'title' => 'UpdateMediaCategory', + 'summary' => 'Updates the category to which a media file belongs.', + 'description' => 'You can call this operation to update only the category of a media file. For more information about how to update all the information about a media file, see [UpdateMedia](~~44464~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMediaCover' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media file whose thumbnail you want to update. To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage**. The ID of the video is displayed on the Basics tab.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the thumbnail that you want to specify for the media file. The URL complies with RFC 2396 and is encoded in UTF-8. The URL can be up to 3,200 bytes in length.'."\n" + ."\n" + .'> To obtain the thumbnail URL, you can find the image in the Object Storage Service (OSS) bucket and click the image to view details. In the View Details panel, copy the part before the question mark (?) from the URL field. You can enter only an HTTP URL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0DC39B9E-13D4-40BA-AE76-CFF9BD64239D', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0DC39B9E-13D4-40BA-AE76-CFF9BD64239D\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaCoverResponse>\\n <RequestId>0DC39B9E-13D4-40BA-AE76-CFF9BD64239D</RequestId>\\n</UpdateMediaCoverResponse>","errorExample":""}]', + 'title' => 'UpdateMediaCover', + 'summary' => 'Updates the thumbnail of a media file.', + 'description' => 'You can call this operation to update only the thumbnail of a media file. For more information about how to update all the information about a media file, see [UpdateMedia](~~44464~~).'."\n" + ."\n" + .'## Limits on QPS'."\n" + ."\n" + .'You can call this operation up to 100 times per second. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limits](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + ], + 'AddMediaTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media file to which you want to add tags.'."\n" + ."\n" + .'> To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the file that you want to manage and click **Manage** in the Actions column. The ID of the file is displayed on the Basics tab.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag that you want to add to the medial file. The value is encoded in UTF-8 and can be up to 32 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '91B6CAB9-034C-4E4E-A40B-E7F5C81E1A2K', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91B6CAB9-034C-4E4E-A40B-E7F5C81E1A2K\\"\\n}","type":"json"}]', + 'title' => 'AddMediaTag', + 'summary' => 'Adds a tag to a media file.', + 'description' => 'You can call this operation to add only one tag. To add multiple tags at a time, you can call the [UpdateMedia](~~44464~~) operation.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'DeleteMediaTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media file for which you want to remove a tag. To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage** in the Actions column. The ID of the video is displayed on the Basics tab.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The media tag that you want to remove. The value is encoded in UTF-8 and can be up to 32 bytes in length.'."\n" + ."\n" + .'> You can remove only one tag at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '283DC68C-146F-4489-A2A1-2F88F1472A56', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283DC68C-146F-4489-A2A1-2F88F1472A56\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMediaTagResponse>\\n <RequestId>283DC68C-146F-4489-A2A1-2F88F1472A56</RequestId>\\n</DeleteMediaTagResponse>","errorExample":""}]', + 'title' => 'DeleteMediaTag', + 'summary' => 'Removes a tag for a media file.', + 'description' => 'You can call this operation to remove only one tag at a time.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMediaPublishState' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media file whose publishing status you want to update. You can obtain the ID of a media file from the response of the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage**. The ID of the video is displayed on the Basics tab.', + 'type' => 'string', + 'required' => true, + 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', + ], + ], + [ + 'name' => 'Publish', + 'in' => 'query', + 'schema' => [ + 'description' => 'The publishing status. Default value: **Initialed**. Valid values:'."\n" + ."\n" + .'* **true**: published.'."\n" + .'* **false**: unpublished.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '91B6CAB9-034C-4E4E-A40B-E7F5C81E688C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91B6CAB9-034C-4E4E-A40B-E7F5C81E688C\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaPublishStateResponse>\\n <RequestId>91B6CAB9-034C-4E4E-A40B-E7F5C81E688C</RequestId>\\n</UpdateMediaPublishStateResponse>","errorExample":""}]', + 'title' => 'UpdateMediaPublishState', + 'summary' => 'Updates the publishing status of a media file.', + 'description' => 'The published state indicates that the access control list (ACL) of media playback resources and snapshot files is set to inherit the ACL of the bucket to which they belong. The unpublished state indicates that the ACL of media playback resources and snapshot files is set to private.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => '**Default publishing state of a media file and status change rules**'."\n" + ."\n" + .'Default publishing state:'."\n" + ."\n" + .'The default publishing state of a media file is **Initialed**. The following two types of media files are in the Initialed state:'."\n" + ."\n" + .'* New media file: When a media file is generated for the first time (a media workflow is triggered for the first time), and the media execution of the workflow is in progress, the media file is in the Initialed state. After the execution of the media workflow is complete, the status of the media file changes to published or unpublished based on the configurations of the media workflow.'."\n" + .'* Deleted media file: After a media file is deleted, the publishing status is meaningless, and the media file is in the Initialed state. If you restore the deleted media file to the media library, a workflow is executed on the file as a new media file.'."\n" + ."\n" + .'Status change rules'."\n" + ."\n" + .'**Note**The publishing status changes among the Initialed, published, and unpublished states. The status change rules for the API are different from those for workflow execution.'."\n" + ."\n" + .'|Caller|Status|Changed status|Allowed|'."\n" + .'|:---|:---|:---|:---|'."\n" + .'|API|Initialed|Published|No|'."\n" + .'|API|Initialed|Unpublished|No|'."\n" + .'|API|Published|Unpublished|Yes|'."\n" + .'|API|Unpublished|Published|Yes|'."\n" + .'|Workflow execution|Initialed|Published|Yes|'."\n" + .'|Workflow execution|Initialed|Unpublished|Yes|'."\n" + .'|Workflow execution|Published|Unpublished|No|'."\n" + .'|Workflow execution|Unpublished|Published|No|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMediaList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the media files. To obtain the ID of a media file, you can perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click Manage. The ID of the video is displayed on the Basics tab. Separate multiple IDs with commas (,). You can query up to 10 media files at a time.'."\n", + 'example' => '3e1cd21131a94525be55acf65888****,e26cfa29e784402388463f61dbec****', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'IncludePlayList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include playback information in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IncludeSnapshotList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include snapshot information in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IncludeMediaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include media information in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IncludeSummaryList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include summaries in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'properties' => [ + 'NonExistMediaIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaId' => [ + 'description' => 'The IDs of the media files that do not exist. This parameter is not returned when all specified media files exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'example' => '{"MediaId":[e26cfa29e784402388463f61dbec****]}', + 'type' => 'string', + ], + ], + ], + ], + 'MediaList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Media' => [ + 'description' => 'The list of media files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media file was created.'."\n", + 'example' => '2016-09-14T08:30:33Z', + 'type' => 'string', + ], + 'CateId' => [ + 'description' => 'The ID of the category to which the media file belongs.'."\n", + 'example' => '1', + 'format' => 'int64', + 'type' => 'integer', + ], + 'Height' => [ + 'description' => 'The height of the media file.'."\n", + 'example' => '1080', + 'type' => 'string', + ], + 'CensorState' => [ + 'description' => 'The review status of the media file. Valid values:'."\n" + ."\n" + .'* **Initiated**: The media file is uploaded but not reviewed.'."\n" + .'* **Pass**: The media file is uploaded and passes the review.'."\n", + 'example' => 'Initiated', + 'type' => 'string', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags of the media file.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'example' => 'tag1,tag2', + 'type' => 'string', + ], + ], + ], + ], + 'PlayList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Play' => [ + 'description' => 'The playlist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Encryption' => [ + 'description' => 'Indicates whether the media file is encrypted. Valid values:'."\n" + ."\n" + .'* **0**: The media file is not encrypted.'."\n" + .'* **1**: The media file is encrypted.'."\n", + 'example' => '0', + 'type' => 'string', + ], + 'Height' => [ + 'description' => 'The height.'."\n", + 'example' => '1080', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the media file.', + 'example' => '2659.326', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The playback file.'."\n", + 'properties' => [ + 'State' => [ + 'description' => 'The status of the file. Valid values:'."\n" + ."\n" + .'* **Normal**: normal'."\n" + .'* **Deleted**: deleted'."\n", + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The Object Storage Service (OSS) URL of the output file.'."\n", + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the workflow that generates the playback file.'."\n", + 'example' => '93ab850b4f6f44eab54b6e91d24d****', + 'type' => 'string', + ], + 'Width' => [ + 'description' => 'The width of the media file.'."\n", + 'example' => '760', + 'type' => 'string', + ], + 'Size' => [ + 'description' => 'The size of the media file.'."\n", + 'example' => '2647692', + 'type' => 'string', + ], + 'Fps' => [ + 'description' => 'The frame rate of the media file.'."\n", + 'example' => '25.0', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration of the media file.'."\n", + 'example' => '7.965000', + 'type' => 'string', + ], + 'ActivityName' => [ + 'description' => 'The name of the workflow activity.'."\n", + 'example' => 'example-activity-****', + 'type' => 'string', + ], + 'Format' => [ + 'description' => 'The encoding format of the media file. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'example' => 'mp4', + 'type' => 'string', + ], + 'MediaWorkflowName' => [ + 'description' => 'The name of the workflow that generates the playback file.'."\n", + 'example' => 'example-mediaworkflow-****', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '2659.326', + 'type' => 'string', + ], + 'MediaId' => [ + 'description' => 'The ID of the media file.'."\n", + 'example' => '3e1cd21131a94525be55acf65888****', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The details of the input file.'."\n", + 'properties' => [ + 'State' => [ + 'description' => 'The status of the input file. Valid values:'."\n" + ."\n" + .'* **Normal**: normal'."\n" + .'* **Deleted**: deleted'."\n", + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the input file.'."\n", + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'SummaryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Summary' => [ + 'description' => 'The list of video summaries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the summary. Valid values:'."\n" + ."\n" + .'* **Video**: video'."\n" + .'* **Gif**: dynamic image'."\n", + 'example' => 'Video', + 'type' => 'string', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the workflow that generates the summary.'."\n", + 'example' => '93ab850b4f6f44eab54b6e91d24d****', + 'type' => 'string', + ], + 'ActivityName' => [ + 'description' => 'The name of the workflow activity.'."\n", + 'example' => 'example-activity-****', + 'type' => 'string', + ], + 'MediaWorkflowName' => [ + 'description' => 'The name of the workflow that generates the summary.'."\n", + 'example' => 'example-mediaworkflow-****', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The information about the input file.'."\n", + 'properties' => [ + 'State' => [ + 'description' => 'The status of the file. Valid values:'."\n" + ."\n" + .'* **Normal**: normal'."\n" + .'* **Deleted**: deleted'."\n", + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the input file.'."\n", + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'PublishState' => [ + 'description' => 'The publishing status of the media file. Valid values:'."\n" + ."\n" + .'- **Initiated**: The media file is in the initial state.'."\n" + .'- **UnPublish**: The media file has not been published, and the playback permission on the OSS object is Private.'."\n" + .'- **Published**: The media file has been published, and the playback permission on the OSS object is Default.'."\n" + .'- **Deleted**: The media file has been deleted.', + 'example' => 'Published', + 'type' => 'string', + ], + 'MediaInfo' => [ + 'description' => 'The media information.', + 'properties' => [ + 'Streams' => [ + 'description' => 'The stream information.', + 'properties' => [ + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The list of video streams.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR).', + 'example' => '1:1', + 'type' => 'string', + ], + 'Height' => [ + 'description' => 'The latter number in the video resolution. The number indicates the video height.', + 'example' => '1080', + 'type' => 'string', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.', + 'example' => 'avc1', + 'type' => 'string', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth consumption.', + 'properties' => [ + 'PreloadTime' => [ + 'description' => 'The amount of preload time.', + 'example' => '0.01', + 'type' => 'string', + ], + 'AvgBitrate' => [ + 'description' => 'The average bitrate.', + 'example' => '2659.326', + 'type' => 'string', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that was consumed.', + 'example' => '100', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'Width' => [ + 'description' => 'The former number in the video resolution. The number indicates the video width.', + 'example' => '100', + 'type' => 'string', + ], + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.', + 'example' => '5', + 'type' => 'string', + ], + 'Timebase' => [ + 'description' => 'The time base.', + 'example' => '1/30000', + 'type' => 'string', + ], + 'AvgFPS' => [ + 'description' => 'The average frame rate.', + 'example' => '29.97003', + 'type' => 'string', + ], + 'PixFmt' => [ + 'description' => 'The pixel format.', + 'example' => 'yuv420p', + 'type' => 'string', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', + 'example' => 'und', + 'type' => 'string', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.', + 'example' => 'QuickTime/MOV', + 'type' => 'string', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.', + 'example' => '12', + 'type' => 'string', + ], + 'Rotate' => [ + 'description' => 'The video rotation angle.', + 'example' => '90', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '2659.326', + 'type' => 'string', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). A value of **1** indicates that the video stream contains B-frames. A value of **2** indicates that the video stream does not contain B-frames.', + 'example' => '2', + 'type' => 'string', + ], + 'Profile' => [ + 'description' => 'The codec profile.', + 'example' => 'High', + 'type' => 'string', + ], + 'StartTime' => [ + 'description' => 'The start time.', + 'example' => '0.000000', + 'type' => 'string', + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR).', + 'example' => '16:9', + 'type' => 'string', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', + 'example' => 'mov', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration.', + 'example' => '182.683000', + 'type' => 'string', + ], + 'Fps' => [ + 'description' => 'The frame rate.', + 'example' => '29.97003', + 'type' => 'string', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.', + 'example' => '0x31637661', + 'type' => 'string', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.', + 'example' => '1001/60000', + 'type' => 'string', + ], + 'Level' => [ + 'description' => 'The codec level.', + 'example' => '40', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The list of audio streams.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base.', + 'example' => '1/44100', + 'type' => 'string', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.', + 'example' => '1', + 'type' => 'string', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.', + 'example' => 'fltp', + 'type' => 'string', + ], + 'ChannelLayout' => [ + 'description' => 'The output layout of the sound channels.', + 'example' => 'stereo', + 'type' => 'string', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', + 'example' => 'und', + 'type' => 'string', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.', + 'example' => '44100', + 'type' => 'string', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.', + 'example' => 'AAC(Advanced Audio Coding)', + 'type' => 'string', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.', + 'example' => '2', + 'type' => 'string', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.', + 'example' => '100', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '160.008', + 'type' => 'string', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.', + 'example' => 'mp4a', + 'type' => 'string', + ], + 'StartTime' => [ + 'description' => 'The start time.', + 'example' => '0.000000', + 'type' => 'string', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.', + 'example' => 'mov', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration.', + 'example' => '182.591995', + 'type' => 'string', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.', + 'example' => '0x6134706d', + 'type' => 'string', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.', + 'example' => '1/44100', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The list of subtitle streams.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.', + 'example' => '3', + 'type' => 'string', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', + 'example' => 'und', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + ], + 'type' => 'object', + ], + 'Format' => [ + 'description' => 'The format information.', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time.', + 'example' => '0.000000', + 'type' => 'string', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.', + 'example' => '2', + 'type' => 'string', + ], + 'Size' => [ + 'description' => 'The size of the file.', + 'example' => '2647692', + 'type' => 'string', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.', + 'example' => '2', + 'type' => 'string', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the container format.', + 'example' => 'QuickTime/MOV', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The total duration.', + 'example' => '7.965000', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '2659.326', + 'type' => 'string', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', + 'example' => 'mov', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + 'Description' => [ + 'description' => 'The description.', + 'example' => 'This is description ****', + 'type' => 'string', + ], + 'Size' => [ + 'description' => 'The size of the file.', + 'example' => '2647692', + 'type' => 'string', + ], + 'Width' => [ + 'description' => 'The width.', + 'example' => '1920', + 'type' => 'string', + ], + 'CoverURL' => [ + 'description' => 'The OSS URL of the thumbnail.', + 'example' => 'http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png', + 'type' => 'string', + ], + 'SnapshotList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => 'The list of snapshots.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the snapshot. Valid values:'."\n" + ."\n" + .'- **Single**'."\n" + .'- **Sequence**', + 'example' => 'Sequence', + 'type' => 'string', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the workflow that generates the snapshot.', + 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', + 'type' => 'string', + ], + 'ActivityName' => [ + 'description' => 'The name of the workflow activity that generates the snapshot.', + 'example' => 'example-activity1-****', + 'type' => 'string', + ], + 'Count' => [ + 'description' => 'The number of snapshots. This parameter is valid only when the value of the **Type** parameter is **Sequence**.', + 'example' => '5', + 'type' => 'string', + ], + 'MediaWorkflowName' => [ + 'description' => 'The name of the workflow that generates the snapshot.', + 'example' => 'example-workflow-****', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The snapshot.', + 'properties' => [ + 'State' => [ + 'description' => 'The status of the file. Valid values:'."\n" + ."\n" + .'- **Normal**: normal'."\n" + .'- **Deleted**: deleted', + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the snapshot.', + 'example' => 'http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'RunIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RunId' => [ + 'description' => 'The ID of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'example' => '{"RunId":["47b42486019c4f688bf144c1a6ba****"]}', + 'type' => 'string', + ], + ], + ], + ], + 'Duration' => [ + 'description' => 'The duration.', + 'example' => '7.965000', + 'type' => 'string', + ], + 'Fps' => [ + 'description' => 'The frame rate.', + 'example' => '25.0', + 'type' => 'string', + ], + 'Title' => [ + 'description' => 'The title.', + 'example' => 'example-title-****', + 'type' => 'string', + ], + 'Format' => [ + 'description' => 'The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', + 'example' => 'mov', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'example' => '283DC68C-146F-4489-A2A1-2F88F1472A56', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistMediaIds\\": {\\n \\"MediaId\\": [\\n \\"{\\\\\\"MediaId\\\\\\":[e26cfa29e784402388463f61dbec****]}\\"\\n ]\\n },\\n \\"MediaList\\": {\\n \\"Media\\": [\\n {\\n \\"CreationTime\\": \\"2016-09-14T08:30:33Z\\",\\n \\"CateId\\": 1,\\n \\"Height\\": \\"1080\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag1,tag2\\"\\n ]\\n },\\n \\"PlayList\\": {\\n \\"Play\\": [\\n {\\n \\"Encryption\\": \\"0\\",\\n \\"Height\\": \\"1080\\",\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91d24d****\\",\\n \\"Width\\": \\"760\\",\\n \\"Size\\": \\"2647692\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Duration\\": \\"7.965000\\",\\n \\"ActivityName\\": \\"example-activity-****\\",\\n \\"Format\\": \\"mp4\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\"\\n }\\n ]\\n },\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"MediaId\\": \\"3e1cd21131a94525be55acf65888****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"SummaryList\\": {\\n \\"Summary\\": [\\n {\\n \\"Type\\": \\"Video\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91d24d****\\",\\n \\"ActivityName\\": \\"example-activity-****\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n }\\n }\\n ]\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"MediaInfo\\": {\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"1080\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"0.01\\",\\n \\"AvgBitrate\\": \\"2659.326\\",\\n \\"CostBandwidth\\": \\"100\\"\\n },\\n \\"Width\\": \\"100\\",\\n \\"Index\\": \\"5\\",\\n \\"Timebase\\": \\"1/30000\\",\\n \\"AvgFPS\\": \\"29.97003\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"QuickTime/MOV\\",\\n \\"NumFrames\\": \\"12\\",\\n \\"Rotate\\": \\"90\\",\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"mov\\",\\n \\"Duration\\": \\"182.683000\\",\\n \\"Fps\\": \\"29.97003\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1001/60000\\",\\n \\"Level\\": \\"40\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/44100\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC(Advanced Audio Coding)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Bitrate\\": \\"160.008\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"mov\\",\\n \\"Duration\\": \\"182.591995\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"3\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NumPrograms\\": \\"2\\",\\n \\"Size\\": \\"2647692\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"7.965000\\",\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"FormatName\\": \\"mov\\"\\n }\\n },\\n \\"Description\\": \\"This is description ****\\",\\n \\"Size\\": \\"2647692\\",\\n \\"Width\\": \\"1920\\",\\n \\"CoverURL\\": \\"http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png\\",\\n \\"SnapshotList\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Type\\": \\"Sequence\\",\\n \\"MediaWorkflowId\\": \\"6cc3aa66d1cb4bb2adf14e726c0a****\\",\\n \\"ActivityName\\": \\"example-activity1-****\\",\\n \\"Count\\": \\"5\\",\\n \\"MediaWorkflowName\\": \\"example-workflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png\\"\\n }\\n }\\n ]\\n },\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"{\\\\\\"RunId\\\\\\":[\\\\\\"47b42486019c4f688bf144c1a6ba****\\\\\\"]}\\"\\n ]\\n },\\n \\"Duration\\": \\"7.965000\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Title\\": \\"example-title-****\\",\\n \\"Format\\": \\"mov\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"283DC68C-146F-4489-A2A1-2F88F1472A56\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMediaListResponse>\\n <NonExistMediaIds>{\\"MediaId\\":[e26cfa29e784402388463f61dbec****]}</NonExistMediaIds>\\n <MediaList>\\n <CreationTime>2016-09-14T08:30:33Z</CreationTime>\\n <CateId>1</CateId>\\n <Height>1080</Height>\\n <CensorState>Initiated</CensorState>\\n <Tags>tag1,tag2</Tags>\\n <PlayList>\\n <Encryption>0</Encryption>\\n <Height>1080</Height>\\n <Bitrate>2659.326</Bitrate>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4</URL>\\n </File>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e91d24d****</MediaWorkflowId>\\n <Width>760</Width>\\n <Size>2647692</Size>\\n <Fps>25.0</Fps>\\n <Duration>7.965000</Duration>\\n <ActivityName>example-activity-****</ActivityName>\\n <Format>mp4</Format>\\n <MediaWorkflowName>example-mediaworkflow-****</MediaWorkflowName>\\n </PlayList>\\n <Bitrate>2659.326</Bitrate>\\n <MediaId>3e1cd21131a94525be55acf65888****</MediaId>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4</URL>\\n </File>\\n <SummaryList>\\n <Type>Video</Type>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e91d24d****</MediaWorkflowId>\\n <ActivityName>example-activity-****</ActivityName>\\n <MediaWorkflowName>example-mediaworkflow-****</MediaWorkflowName>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4</URL>\\n </File>\\n </SummaryList>\\n <PublishState>Published</PublishState>\\n <MediaInfo>\\n <Streams>\\n <VideoStreamList>\\n <Sar>1:1</Sar>\\n <Height>1080</Height>\\n <CodecTagString>avc1</CodecTagString>\\n <NetworkCost>\\n <PreloadTime>0.01</PreloadTime>\\n <AvgBitrate>2659.326</AvgBitrate>\\n <CostBandwidth>100</CostBandwidth>\\n </NetworkCost>\\n <Width>100</Width>\\n <Index>5</Index>\\n <Timebase>1/30000</Timebase>\\n <AvgFPS>29.97003</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Lang>und</Lang>\\n <CodecLongName>QuickTime/MOV</CodecLongName>\\n <NumFrames>12</NumFrames>\\n <Rotate>90</Rotate>\\n <Bitrate>2659.326</Bitrate>\\n <HasBFrames>2</HasBFrames>\\n <Profile>High</Profile>\\n <StartTime>0.000000</StartTime>\\n <Dar>16:9</Dar>\\n <CodecName>mov</CodecName>\\n <Duration>182.683000</Duration>\\n <Fps>29.97003</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1001/60000</CodecTimeBase>\\n <Level>40</Level>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/44100</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>stereo</ChannelLayout>\\n <Lang>und</Lang>\\n <Samplerate>44100</Samplerate>\\n <CodecLongName>AAC(Advanced Audio Coding)</CodecLongName>\\n <Channels>2</Channels>\\n <NumFrames>100</NumFrames>\\n <Bitrate>160.008</Bitrate>\\n <CodecTagString>mp4a</CodecTagString>\\n <StartTime>0.000000</StartTime>\\n <CodecName>mov</CodecName>\\n <Duration>182.591995</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Index>3</Index>\\n <Lang>und</Lang>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>0.000000</StartTime>\\n <NumPrograms>2</NumPrograms>\\n <Size>2647692</Size>\\n <NumStreams>2</NumStreams>\\n <FormatLongName>QuickTime/MOV</FormatLongName>\\n <Duration>7.965000</Duration>\\n <Bitrate>2659.326</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n </MediaInfo>\\n <Description>This is descirption ****</Description>\\n <Size>2647692</Size>\\n <Width>1920</Width>\\n <CoverURL>http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png</CoverURL>\\n <SnapshotList>\\n <Type>Sequence</Type>\\n <MediaWorkflowId>6cc3aa66d1cb4bb2adf14e726c0a****</MediaWorkflowId>\\n <ActivityName>example-activity1-****</ActivityName>\\n <Count>5</Count>\\n <MediaWorkflowName>example-workflow-****</MediaWorkflowName>\\n <File>\\n <State>Normal</State>\\n <URL>http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png</URL>\\n </File>\\n </SnapshotList>\\n <RunIdList>{\\"RunId\\":[\\"47b42486019c4f688bf144c1a6ba****\\"]}</RunIdList>\\n <Duration>7.965000</Duration>\\n <Fps>25.0</Fps>\\n <Title>example-title-****</Title>\\n <Format>mov</Format>\\n </MediaList>\\n <RequestId>283DC68C-146F-4489-A2A1-2F88F1472A56</RequestId>\\n</QueryMediaListResponse>","errorExample":""}]', + 'description' => 'You can call this operation to query up to 10 media files at a time.'."\n" + ."\n\n" + .'## QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limits](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'summary' => 'Queries media files based on media file IDs.', + 'title' => 'QueryMediaList', + ], + 'QueryMediaListByURL' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FileURLs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URLs of the media files. To obtain the OSS URL of a media file, you can perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the media file whose OSS URL you want to view and click **Manage** in the **Actions** column. The OSS URL of the media file is displayed on the **Obtain Encoding URL** tab. Separate multiple URLs with commas (,). You can query up to 10 media files at a time.'."\n" + ."\n" + .'* The URL complies with RFC 3986 and is encoded in UTF-8, with reserved characters being percent-encoded. The value can be up to 3,200 bytes in size. For more information, see [URL encoding](~~423796~~).'."\n" + .'* Only OSS HTTP URLs are supported. Alibaba Cloud CDN URLs and HTTPS URLs are not supported.'."\n", + 'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example.mp4', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'IncludePlayList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include playback information in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IncludeSnapshotList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include snapshot information in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IncludeMediaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include media information in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + ."\n" + .'* Default value: **false**.'."\n" + ."\n" + .'> To obtain detailed information about the media files, set this parameter to true.', + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IncludeSummaryList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include summaries in the returned result.'."\n" + ."\n" + .'* Valid values: true and false.'."\n" + .'* Default value: **false**.'."\n", + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'properties' => [ + 'MediaList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Media' => [ + 'description' => 'The list of media files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the media file was created.'."\n", + 'example' => '2021-07-14T13:05:00Z', + 'type' => 'string', + ], + 'CateId' => [ + 'description' => 'The ID of the category to which the media file belongs.'."\n", + 'example' => '123', + 'format' => 'int64', + 'type' => 'integer', + ], + 'Height' => [ + 'description' => 'The height of the queried media file.'."\n", + 'example' => '360', + 'type' => 'string', + ], + 'CensorState' => [ + 'description' => 'The review status of the media file. Valid values:'."\n" + ."\n" + .'* **Initiated**: The media file is uploaded but not reviewed.'."\n" + .'* **Pass**: The media file is uploaded and passes the review.'."\n", + 'example' => 'Initiated', + 'type' => 'string', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags of the media file.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'example' => 'tag1,tag2', + 'type' => 'string', + ], + ], + ], + ], + 'PlayList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Play' => [ + 'description' => 'The playlist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Encryption' => [ + 'description' => 'Indicates whether the media file is encrypted. Valid values:'."\n" + ."\n" + .'* **0**: The media file is not encrypted.'."\n" + .'* **1**: The media file is encrypted.'."\n", + 'example' => '1', + 'type' => 'string', + ], + 'Height' => [ + 'description' => 'The height of the media file.'."\n", + 'example' => '10', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate of the media file.', + 'example' => '25.067', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The playback file.'."\n", + 'properties' => [ + 'State' => [ + 'description' => 'The status of the media file. Valid values:'."\n" + ."\n" + .'* **Normal**: The file is normal.'."\n" + .'* **Deleted**: The file is deleted.'."\n", + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the playback file.'."\n", + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the workflow that generates the playback file.'."\n", + 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', + 'type' => 'string', + ], + 'Width' => [ + 'description' => 'The width.'."\n", + 'example' => '11', + 'type' => 'string', + ], + 'Size' => [ + 'description' => 'The size.'."\n", + 'example' => '100', + 'type' => 'string', + ], + 'Fps' => [ + 'description' => 'The frame rate.'."\n", + 'example' => '25.0', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration.'."\n", + 'example' => '7.965000', + 'type' => 'string', + ], + 'ActivityName' => [ + 'description' => 'The name of the workflow activity.'."\n", + 'example' => 'test name', + 'type' => 'string', + ], + 'Format' => [ + 'description' => 'The encoding format of the media file. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", + 'example' => 'mov', + 'type' => 'string', + ], + 'MediaWorkflowName' => [ + 'description' => 'The name of the workflow that generates the playback file.'."\n", + 'example' => 'example-mediaworkflow-****', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '593.192', + 'type' => 'string', + ], + 'MediaId' => [ + 'description' => 'The ID of the media file.'."\n", + 'example' => '52d7e98b05e648199612290bb819****', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The details of the input file.'."\n", + 'properties' => [ + 'State' => [ + 'description' => 'The status of the media file. Valid values:'."\n" + ."\n" + .'* **Normal**: The file is normal.'."\n" + .'* **Deleted**: The file is deleted.'."\n", + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the input file.'."\n", + 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'SummaryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Summary' => [ + 'description' => 'The list of video summaries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the summary. Valid values:'."\n" + ."\n" + .'* **Video**: video'."\n" + .'* **Gif**: dynamic image'."\n", + 'example' => 'Gif', + 'type' => 'string', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the workflow that generates the summary.'."\n", + 'example' => '93ab850b4f6f44eab54b6e91d24d****', + 'type' => 'string', + ], + 'ActivityName' => [ + 'description' => 'The name of the workflow activity.'."\n", + 'example' => 'example-activity-****', + 'type' => 'string', + ], + 'MediaWorkflowName' => [ + 'description' => 'The name of the workflow that generates the summary.'."\n", + 'example' => 'example-mediaworkflow-****', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The information about the input file.'."\n", + 'properties' => [ + 'State' => [ + 'description' => 'The status of the media file. Valid values:'."\n" + ."\n" + .'* **Normal**: The file is normal.'."\n" + .'* **Deleted**: The file is deleted.'."\n", + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the input file.'."\n", + 'example' => 'http://example-bucket-****.o', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'PublishState' => [ + 'description' => 'The publishing status of the media file. Valid values:'."\n" + ."\n" + .'- **Initiated**: The media file is in the initial state.'."\n" + .'- **UnPublish**: The media file has not been published, and the playback permission on the OSS object is Private.'."\n" + .'- **Published**: The media file has been published, and the playback permission on the OSS object is Default.'."\n" + .'- **Deleted**: The file is deleted.', + 'example' => 'Published', + 'type' => 'string', + ], + 'MediaInfo' => [ + 'description' => 'The media information.', + 'properties' => [ + 'Streams' => [ + 'description' => 'The stream information.', + 'properties' => [ + 'VideoStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStream' => [ + 'description' => 'The list of video streams.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Sar' => [ + 'description' => 'The sample aspect ratio (SAR).', + 'example' => '1:1', + 'type' => 'string', + ], + 'Height' => [ + 'description' => 'The latter number in the video resolution. The number indicates the video height.', + 'example' => '360', + 'type' => 'string', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.', + 'example' => 'avc1', + 'type' => 'string', + ], + 'NetworkCost' => [ + 'description' => 'The network bandwidth consumption.', + 'properties' => [ + 'PreloadTime' => [ + 'description' => 'The amount of preload time.', + 'example' => '0.01', + 'type' => 'string', + ], + 'AvgBitrate' => [ + 'description' => 'The average bitrate of the video stream.', + 'example' => '2659.326', + 'type' => 'string', + ], + 'CostBandwidth' => [ + 'description' => 'The maximum bandwidth that was consumed.', + 'example' => '100', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'Width' => [ + 'description' => 'The former number in the video resolution. The number indicates the video width and cannot be negative.', + 'example' => '640', + 'type' => 'string', + ], + 'Index' => [ + 'description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.', + 'example' => '5', + 'type' => 'string', + ], + 'Timebase' => [ + 'description' => 'The time base.', + 'example' => '1/15360', + 'type' => 'string', + ], + 'AvgFPS' => [ + 'description' => 'The average frame rate.', + 'example' => '15.0', + 'type' => 'string', + ], + 'PixFmt' => [ + 'description' => 'The pixel format of the video stream.', + 'example' => 'yuv420p', + 'type' => 'string', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', + 'example' => 'und', + 'type' => 'string', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.', + 'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10', + 'type' => 'string', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.', + 'example' => '12', + 'type' => 'string', + ], + 'Rotate' => [ + 'description' => 'The rotation angle of the video.', + 'example' => '90', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '512.701', + 'type' => 'string', + ], + 'HasBFrames' => [ + 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). A value of **1** indicates that the video stream contains B-frames. A value of **2** indicates that the video stream does not contain B-frames.', + 'example' => '2', + 'type' => 'string', + ], + 'Profile' => [ + 'description' => 'The codec profile.', + 'example' => 'High', + 'type' => 'string', + ], + 'StartTime' => [ + 'description' => 'The start time.', + 'example' => '0.046029', + 'type' => 'string', + ], + 'Dar' => [ + 'description' => 'The display aspect ratio (DAR) of the video stream.', + 'example' => '16:9', + 'type' => 'string', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.', + 'example' => 'H264', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration.', + 'example' => '79.200000', + 'type' => 'string', + ], + 'Fps' => [ + 'description' => 'The frame rate.', + 'example' => '15.0', + 'type' => 'string', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.', + 'example' => '0x31637661', + 'type' => 'string', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.', + 'example' => '1/30', + 'type' => 'string', + ], + 'Level' => [ + 'description' => 'The codec level.', + 'example' => '31', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'AudioStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStream' => [ + 'description' => 'The list of audio streams.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Timebase' => [ + 'description' => 'The time base.', + 'example' => '1/44100', + 'type' => 'string', + ], + 'Index' => [ + 'description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.', + 'example' => '1', + 'type' => 'string', + ], + 'SampleFmt' => [ + 'description' => 'The sampling format.', + 'example' => 'fltp', + 'type' => 'string', + ], + 'ChannelLayout' => [ + 'description' => 'The output layout of the sound channels.', + 'example' => 'stereo', + 'type' => 'string', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg language definition](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', + 'example' => 'und', + 'type' => 'string', + ], + 'Samplerate' => [ + 'description' => 'The sampling rate.', + 'example' => '44100', + 'type' => 'string', + ], + 'CodecLongName' => [ + 'description' => 'The full name of the encoding format.', + 'example' => 'AAC (Advanced Audio Coding)', + 'type' => 'string', + ], + 'Channels' => [ + 'description' => 'The number of sound channels.', + 'example' => '2', + 'type' => 'string', + ], + 'NumFrames' => [ + 'description' => 'The total number of frames.', + 'example' => '100', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '76.356', + 'type' => 'string', + ], + 'CodecTagString' => [ + 'description' => 'The tag string of the encoding format.', + 'example' => 'mp4a', + 'type' => 'string', + ], + 'StartTime' => [ + 'description' => 'The start time.', + 'example' => '0.000000', + 'type' => 'string', + ], + 'CodecName' => [ + 'description' => 'The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.', + 'example' => 'aac', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration of the media file.', + 'example' => '79.203265', + 'type' => 'string', + ], + 'CodecTag' => [ + 'description' => 'The tag of the encoding format.', + 'example' => '0x6134706d', + 'type' => 'string', + ], + 'CodecTimeBase' => [ + 'description' => 'The codec time base.', + 'example' => '1/44100', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'SubtitleStreamList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleStream' => [ + 'description' => 'The list of subtitle streams.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Index' => [ + 'description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.', + 'example' => '1', + 'type' => 'string', + ], + 'Lang' => [ + 'description' => 'The language. For more information, see [FFmpeg language definition](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', + 'example' => 'und', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + ], + 'type' => 'object', + ], + 'Format' => [ + 'description' => 'The format information.', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time.', + 'example' => '0.000000', + 'type' => 'string', + ], + 'NumPrograms' => [ + 'description' => 'The total number of program streams.', + 'example' => '0', + 'type' => 'string', + ], + 'Size' => [ + 'description' => 'The size.', + 'example' => '5872904', + 'type' => 'string', + ], + 'NumStreams' => [ + 'description' => 'The total number of media streams.', + 'example' => '2', + 'type' => 'string', + ], + 'FormatLongName' => [ + 'description' => 'The full name of the encoding format.', + 'example' => 'QuickTime/MOV', + 'type' => 'string', + ], + 'Duration' => [ + 'description' => 'The duration.', + 'example' => '79.204000', + 'type' => 'string', + ], + 'Bitrate' => [ + 'description' => 'The bitrate.', + 'example' => '593.192', + 'type' => 'string', + ], + 'FormatName' => [ + 'description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', + 'example' => 'mov', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + 'Description' => [ + 'description' => 'The description.', + 'example' => 'This is description ****', + 'type' => 'string', + ], + 'Size' => [ + 'description' => 'The size of the file.', + 'example' => '5872904', + 'type' => 'string', + ], + 'Width' => [ + 'description' => 'The width.', + 'example' => '640', + 'type' => 'string', + ], + 'CoverURL' => [ + 'description' => 'The OSS URL of the thumbnail.', + 'example' => 'http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png', + 'type' => 'string', + ], + 'SnapshotList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => 'The list of snapshots.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the snapshot. Valid values:'."\n" + ."\n" + .'- **Single**: a single snapshot'."\n" + .'- **Sequence**: snapshots in sequence', + 'example' => 'Single', + 'type' => 'string', + ], + 'MediaWorkflowId' => [ + 'description' => 'The ID of the workflow that generates the snapshot.', + 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', + 'type' => 'string', + ], + 'ActivityName' => [ + 'description' => 'The name of the workflow activity that generates the snapshot.', + 'example' => 'example-activity1-****', + 'type' => 'string', + ], + 'Count' => [ + 'description' => 'The number of snapshots. This parameter is valid only when the value of the **Type** parameter is **Sequence**.', + 'example' => '3', + 'type' => 'string', + ], + 'MediaWorkflowName' => [ + 'description' => 'The name of the workflow that generates the snapshot.', + 'example' => 'example-workflow-****', + 'type' => 'string', + ], + 'File' => [ + 'description' => 'The snapshot.', + 'properties' => [ + 'State' => [ + 'description' => 'The status of the file. Valid values:'."\n" + ."\n" + .'- **Normal**: The file is normal.'."\n" + .'- **Deleted**: The file is deleted.', + 'example' => 'Normal', + 'type' => 'string', + ], + 'URL' => [ + 'description' => 'The OSS URL of the snapshot.', + 'example' => 'http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'RunIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RunId' => [ + 'description' => 'The IDs of the media workflow execution instances.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'example' => '9343bd0e7bb54ae19228529908e5****', + 'type' => 'string', + ], + ], + ], + ], + 'Duration' => [ + 'description' => 'The duration.', + 'example' => '79.204000', + 'type' => 'string', + ], + 'Fps' => [ + 'description' => 'The frame rate.', + 'example' => '15.0', + 'type' => 'string', + ], + 'Title' => [ + 'description' => 'The title.', + 'example' => 'kled.mp4', + 'type' => 'string', + ], + 'Format' => [ + 'description' => 'The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', + 'example' => 'mov', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + 'NonExistFileURLs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileURL' => [ + 'description' => 'The IDs of the media files that do not exist. This parameter is not returned if all specified media files exist.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'example' => 'null', + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'example' => '1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaList\\": {\\n \\"Media\\": [\\n {\\n \\"CreationTime\\": \\"2021-07-14T13:05:00Z\\",\\n \\"CateId\\": 123,\\n \\"Height\\": \\"360\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag1,tag2\\"\\n ]\\n },\\n \\"PlayList\\": {\\n \\"Play\\": [\\n {\\n \\"Encryption\\": \\"1\\",\\n \\"Height\\": \\"10\\",\\n \\"Bitrate\\": \\"25.067\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4\\"\\n },\\n \\"MediaWorkflowId\\": \\"6cc3aa66d1cb4bb2adf14e726c0a****\\",\\n \\"Width\\": \\"11\\",\\n \\"Size\\": \\"100\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Duration\\": \\"7.965000\\",\\n \\"ActivityName\\": \\"test name\\",\\n \\"Format\\": \\"mov\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\"\\n }\\n ]\\n },\\n \\"Bitrate\\": \\"593.192\\",\\n \\"MediaId\\": \\"52d7e98b05e648199612290bb819****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"SummaryList\\": {\\n \\"Summary\\": [\\n {\\n \\"Type\\": \\"Gif\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91d24d****\\",\\n \\"ActivityName\\": \\"example-activity-****\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.o\\"\\n }\\n }\\n ]\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"MediaInfo\\": {\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"360\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"0.01\\",\\n \\"AvgBitrate\\": \\"2659.326\\",\\n \\"CostBandwidth\\": \\"100\\"\\n },\\n \\"Width\\": \\"640\\",\\n \\"Index\\": \\"5\\",\\n \\"Timebase\\": \\"1/15360\\",\\n \\"AvgFPS\\": \\"15.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"12\\",\\n \\"Rotate\\": \\"90\\",\\n \\"Bitrate\\": \\"512.701\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.046029\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"H264\\",\\n \\"Duration\\": \\"79.200000\\",\\n \\"Fps\\": \\"15.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/30\\",\\n \\"Level\\": \\"31\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/44100\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Bitrate\\": \\"76.356\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"79.203265\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"5872904\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"79.204000\\",\\n \\"Bitrate\\": \\"593.192\\",\\n \\"FormatName\\": \\"mov\\"\\n }\\n },\\n \\"Description\\": \\"This is description ****\\",\\n \\"Size\\": \\"5872904\\",\\n \\"Width\\": \\"640\\",\\n \\"CoverURL\\": \\"http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png\\",\\n \\"SnapshotList\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Type\\": \\"Single\\",\\n \\"MediaWorkflowId\\": \\"6cc3aa66d1cb4bb2adf14e726c0a****\\",\\n \\"ActivityName\\": \\"example-activity1-****\\",\\n \\"Count\\": \\"3\\",\\n \\"MediaWorkflowName\\": \\"example-workflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png\\"\\n }\\n }\\n ]\\n },\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"9343bd0e7bb54ae19228529908e5****\\"\\n ]\\n },\\n \\"Duration\\": \\"79.204000\\",\\n \\"Fps\\": \\"15.0\\",\\n \\"Title\\": \\"kled.mp4\\",\\n \\"Format\\": \\"mov\\"\\n }\\n ]\\n },\\n \\"NonExistFileURLs\\": {\\n \\"FileURL\\": [\\n \\"null\\"\\n ]\\n },\\n \\"RequestId\\": \\"1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMediaListByURLResponse>\\n <MediaList>\\n <CreationTime>2021-07-14T13:05:00Z</CreationTime>\\n <CateId>123</CateId>\\n <Height>360</Height>\\n <CensorState>Initiated</CensorState>\\n <Tags>tag1,tag2</Tags>\\n <PlayList>\\n <Encryption>1</Encryption>\\n <Height>10</Height>\\n <Bitrate>25.067</Bitrate>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4</URL>\\n </File>\\n <MediaWorkflowId>6cc3aa66d1cb4bb2adf14e726c0a****</MediaWorkflowId>\\n <Width>11</Width>\\n <Size>100</Size>\\n <Fps>25.0</Fps>\\n <Duration>7.965000</Duration>\\n <ActivityName>test name</ActivityName>\\n <Format>mov</Format>\\n <MediaWorkflowName>example-mediaworkflow-****</MediaWorkflowName>\\n </PlayList>\\n <Bitrate>593.192</Bitrate>\\n <MediaId>52d7e98b05e648199612290bb819****</MediaId>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4</URL>\\n </File>\\n <SummaryList>\\n <Type>Gif</Type>\\n <MediaWorkflowId>93ab850b4f6f44eab54b6e91d24d****</MediaWorkflowId>\\n <ActivityName>example-activity-****</ActivityName>\\n <MediaWorkflowName>example-mediaworkflow-****</MediaWorkflowName>\\n <File>\\n <State>Normal</State>\\n <URL>http://example-bucket-****.o</URL>\\n </File>\\n </SummaryList>\\n <PublishState>Published</PublishState>\\n <MediaInfo>\\n <Streams>\\n <VideoStreamList>\\n <Sar>1:1</Sar>\\n <Height>360</Height>\\n <CodecTagString>avc1</CodecTagString>\\n <NetworkCost>\\n <PreloadTime>0.01</PreloadTime>\\n <AvgBitrate>2659.326</AvgBitrate>\\n <CostBandwidth>100</CostBandwidth>\\n </NetworkCost>\\n <Width>640</Width>\\n <Index>5</Index>\\n <Timebase>1/15360</Timebase>\\n <AvgFPS>15.0</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Lang>und</Lang>\\n <CodecLongName>H.264/AVC/MPEG-4 AVC/MPEG-4 part 10</CodecLongName>\\n <NumFrames>12</NumFrames>\\n <Rotate>90</Rotate>\\n <Bitrate>512.701</Bitrate>\\n <HasBFrames>2</HasBFrames>\\n <Profile>High</Profile>\\n <StartTime>0.046029</StartTime>\\n <Dar>16:9</Dar>\\n <CodecName>H264</CodecName>\\n <Duration>79.200000</Duration>\\n <Fps>15.0</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1/30</CodecTimeBase>\\n <Level>31</Level>\\n </VideoStreamList>\\n <AudioStreamList>\\n <Timebase>1/44100</Timebase>\\n <Index>1</Index>\\n <SampleFmt>fltp</SampleFmt>\\n <ChannelLayout>stereo</ChannelLayout>\\n <Lang>und</Lang>\\n <Samplerate>44100</Samplerate>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <Channels>2</Channels>\\n <NumFrames>100</NumFrames>\\n <Bitrate>76.356</Bitrate>\\n <CodecTagString>mp4a</CodecTagString>\\n <StartTime>0.000000</StartTime>\\n <CodecName>aac</CodecName>\\n <Duration>79.203265</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n </AudioStreamList>\\n <SubtitleStreamList>\\n <Index>1</Index>\\n <Lang>und</Lang>\\n </SubtitleStreamList>\\n </Streams>\\n <Format>\\n <StartTime>0.000000</StartTime>\\n <NumPrograms>0</NumPrograms>\\n <Size>5872904</Size>\\n <NumStreams>2</NumStreams>\\n <FormatLongName>QuickTime/MOV</FormatLongName>\\n <Duration>79.204000</Duration>\\n <Bitrate>593.192</Bitrate>\\n <FormatName>mov</FormatName>\\n </Format>\\n </MediaInfo>\\n <Description>This is description ****</Description>\\n <Size>5872904</Size>\\n <Width>640</Width>\\n <CoverURL>http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png</CoverURL>\\n <SnapshotList>\\n <Type>Single</Type>\\n <MediaWorkflowId>6cc3aa66d1cb4bb2adf14e726c0a****</MediaWorkflowId>\\n <ActivityName>example-activity1-****</ActivityName>\\n <Count>3</Count>\\n <MediaWorkflowName>example-workflow-****</MediaWorkflowName>\\n <File>\\n <State>Normal</State>\\n <URL>http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png</URL>\\n </File>\\n </SnapshotList>\\n <RunIdList>9343bd0e7bb54ae19228529908e5****</RunIdList>\\n <Duration>79.204000</Duration>\\n <Fps>15.0</Fps>\\n <Title>kled.mp4</Title>\\n <Format>mov</Format>\\n </MediaList>\\n <NonExistFileURLs>null</NonExistFileURLs>\\n <RequestId>1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42</RequestId>\\n</QueryMediaListByURLResponse>","errorExample":""}]', + 'description' => '* You can call this operation to query up to 10 media files at a time.'."\n" + .'* Before you call this operation, you must call the [AddMedia](~~44458~~) operation to add media files.'."\n" + .'* You can call this operation to query only media files that are processed in a workflow. To obtain comprehensive information about a media file that is newly uploaded to OSS, you can call this operation after the corresponding workflow is complete. To query media files that are not processed in a workflow, you must call the [SubmitMediaInfoJob](~~29220~~) operation to submit a media information analysis job. After the job is complete, you can query the information about the media files.'."\n" + ."\n\n" + .'## QPS limit'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limit](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'summary' => 'Queries media files based on their Object Storage Service (OSS) URLs.', + 'title' => 'QueryMediaListByURL', + ], + 'QueryIProductionJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e432bbf5b665e2a15****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ImageCartoonize', + ], + 'Input' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12', + ], + 'UserData' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'State' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Output' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt', + ], + 'PipelineId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + 'JobParams' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{mode:"gif"}', + ], + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '88c6ca184c0e432bbf5b665e2a15****', + ], + 'Result' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"Code":"Success","Data":"{\\"result\\":[{\\"file\\":\\"iproduction/test-result.jpg\\"},{\\"file\\":\\"iproduction/test-origin.jpg\\"}]}","Message":"Successful."}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FunctionName\\": \\"ImageCartoonize\\",\\n \\"Input\\": \\"oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4\\",\\n \\"RequestId\\": \\"D127C68E-F1A1-4CE5-A874-8FF724881A12\\",\\n \\"UserData\\": \\"null\\",\\n \\"State\\": \\"Success\\",\\n \\"Output\\": \\"oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt\\",\\n \\"PipelineId\\": \\"39f8e0bc005e4f309379701645f4****\\",\\n \\"JobParams\\": \\"{mode:\\\\\\"gif\\\\\\"}\\",\\n \\"JobId\\": \\"88c6ca184c0e432bbf5b665e2a15****\\",\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"Data\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"result\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"file\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"iproduction/test-result.jpg\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"file\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"iproduction/test-origin.jpg\\\\\\\\\\\\\\"}]}\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"Successful.\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryIProductionJobResponse>\\n <FunctionName>ImageCartoonize</FunctionName>\\n <Input>oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4</Input>\\n <RequestId>D127C68E-F1A1-4CE5-A874-8FF724881A12</RequestId>\\n <UserData>null</UserData>\\n <State>Success</State>\\n <Output>oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt</Output>\\n <PipelineId>39f8e0bc005e4f309379701645f4****</PipelineId>\\n <JobParams>{mode:\\"gif\\"}</JobParams>\\n <JobId>88c6ca184c0e432bbf5b665e2a15****</JobId>\\n <Result>{\\"Code\\":\\"Success\\",\\"Data\\":\\"{\\\\\\"result\\\\\\":[{\\\\\\"file\\\\\\":\\\\\\"iproduction/test-result.jpg\\\\\\"},{\\\\\\"file\\\\\\":\\\\\\"iproduction/test-origin.jpg\\\\\\"}]}\\",\\"Message\\":\\"Successful.\\"}</Result>\\n</QueryIProductionJobResponse>","errorExample":""}]', + 'title' => 'QueryIProductionJob', + 'summary' => 'Queries the information about a smart production job.', + ], + 'SubmitIProductionJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ImageCartoonize', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'JobParams', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"Model":"gif"}', + ], + ], + [ + 'name' => 'ScheduleParams', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26', + ], + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + 'Result' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\",\\n \\"Result\\": \\"{ \\\\\\"Code\\\\\\":\\\\\\"Success\\\\\\", \\\\\\"Details\\\\\\":[], \\\\\\"FunctionName\\\\\\":\\\\\\"ImageCartoonize\\\\\\", \\\\\\"JobId\\\\\\":\\\\\\"39f8e0bc005e4f309379701645f4****\\\\\\", \\\\\\"Message\\\\\\":\\\\\\"success\\\\\\", \\\\\\"State\\\\\\":\\\\\\"Success\\\\\\", \\\\\\"Type\\\\\\":\\\\\\"IProduction\\\\\\" }\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitIProductionJobResponse>\\n <RequestId>5210DBB0-E327-4D45-ADBC-0B83C8796E26</RequestId>\\n <JobId>39f8e0bc005e4f309379701645f4****</JobId>\\n <Result>{ \\"Code\\":\\"Success\\", \\"Details\\":[], \\"FunctionName\\":\\"ImageCartoonize\\", \\"JobId\\":\\"39f8e0bc005e4f309379701645f4****\\", \\"Message\\":\\"success\\", \\"State\\":\\"Success\\", \\"Type\\":\\"IProduction\\" }</Result>\\n</SubmitIProductionJobResponse>","errorExample":""}]', + 'title' => 'SubmitIProductionJob', + 'summary' => 'Submits a smart production job.', + 'description' => '* Jobs that are submitted by calling this operation run in an asynchronous manner. After a job is added to the ApsaraVideo Media Processing (MPS) queue, the job is scheduled to run. You can call the [QueryIProductionJob](~~170217~~) operation or configure a callback to query the job result.'."\n" + .'* Capabilities provided by the intelligent production feature vary based on the region. Before you call this operation to submit an intelligent production job, check whether the job is supported in the region in which your service is activated. For more information, see [Regions and endpoints](~~43248~~).'."\n" + ."\n" + .'### [](#qps)QPS limit'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", + ], + 'SubmitSmarttagJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'example-title-****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'example content ****', + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'application/zip', + ], + ], + [ + 'name' => 'ContentAddr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'http://exampleBucket.oss-cn-shanghai.aliyuncs.com/mps-test/ai-tag.mp4', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com/endpoint/aliyun/ai?id=76401125000***', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"key":"value"}', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://mybucket-****/example-****.mp4', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template ID, which is used to specify the analysis algorithm of the smart tagging job. For more information about how to manage templates, see [AddSmarttagTemplate](~~602910~~), [QuerySmarttagTemplateList](~~187770~~), [UpdateSmarttagTemplate](~~187776~~), and [DeleteSmarttagTemplate](~~187775~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the job in the ApsaraVideo Media Processing (MPS) queue to which the job is added. Valid values: 0 to 9. Default value: 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitSmarttagJobResponse>\\n <RequestId>7B117AF5-2A16-412C-B127-FA6175ED1AD0</RequestId>\\n <JobId>39f8e0bc005e4f309379701645f4****</JobId>\\n</SubmitSmarttagJobResponse>","errorExample":""}]', + 'title' => 'SubmitSmarttagJob', + 'summary' => 'Submits a smart tagging job.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'QuerySmarttagJob' => [ + 'summary' => 'Queries a smart tagging job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmts0VQEVI', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"labelResultType":"auto"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"title":"example-title-****"}', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Meta', + ], + ], + ], + ], + ], + ], + 'UserData' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example UserData ****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobStatus\\": \\"Success\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Data\\": \\"{\\\\\\"title\\\\\\":\\\\\\"example-title-****\\\\\\"}\\",\\n \\"Type\\": \\"Meta\\"\\n }\\n ]\\n },\\n \\"UserData\\": \\"example UserData ****\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySmarttagJobResponse>\\n <JobStatus>Success</JobStatus>\\n <RequestId>7B117AF5-2A16-412C-B127-FA6175ED1AD0</RequestId>\\n <UserData>example UserData ****</UserData>\\n <Results>\\n <Type>Meta</Type>\\n <Data>{\\"title\\":\\"example-title-****\\"}</Data>\\n </Results>\\n</QuerySmarttagJobResponse>","errorExample":""}]', + 'title' => 'QuerySmarttagJob', + ], + 'AddSmarttagTemplate' => [ + 'summary' => 'Adds an analysis template of a smart tagging job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmts0VQEVI', + 'FEATUREmts0A6ARW', + 'FEATUREmtsS08B52', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'template-example-****', + ], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'common', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'search', + ], + ], + [ + 'name' => 'AnalyseTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ocr', + ], + ], + [ + 'name' => 'FaceCategoryIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'celebrity', + ], + ], + [ + 'name' => 'FaceCustomParamsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }', + ], + ], + [ + 'name' => 'ObjectGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'general,item,weapon,animal', + ], + ], + [ + 'name' => 'LandmarkGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'common', + ], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LabelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hmi', + ], + ], + [ + 'name' => 'LabelVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'KnowledgeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }', + ], + ], + [ + 'name' => 'KeywordConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '"type": "name,location,organization,other" }', + ], + ], + [ + 'name' => 'LabelCustomCategoryIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'LabelCustomParamsConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175EDAS3Q', + ], + 'TemplateId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '05de22f255284c7a8d2aab535dde****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175EDAS3Q\\",\\n \\"TemplateId\\": \\"05de22f255284c7a8d2aab535dde****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddSmarttagTemplateResponse>\\n <RequestId>7B117AF5-2A16-412C-B127-FA6175EDAS3Q</RequestId>\\n <TemplateId>05de22f255284c7a8d2aab535dde****</TemplateId>\\n</AddSmarttagTemplateResponse>","errorExample":""}]', + 'title' => 'AddSmarttagTemplate', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'QuerySmarttagTemplateList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the template. You can obtain the template ID from the response of the [AddSmarttagTemplate](~~187759~~) operation. If you set this parameter to a specific value, the information about the corresponding template is returned. If you do not specify this parameter, the operation returns the information about all the templates that are created by the current RAM user.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '05de22f255284c7a8d2aab535dde****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26', + ], + 'Templates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed information about the template.'."\n", + 'type' => 'object', + 'properties' => [ + 'AnalyseTypes' => [ + 'description' => 'The analysis types that are used in the template. One or more values are returned. Valid values:'."\n" + ."\n" + .'* **ocr**: text recognition'."\n" + .'* **asr**: speech recognition'."\n" + .'* **classification**: video classification'."\n" + .'* **shows**: program recognition'."\n" + .'* **face**: facial recognition'."\n" + .'* **role**: figure recognition'."\n" + .'* **object**: object recognition'."\n" + .'* **tvstation**: logo recognition'."\n" + .'* **action**: action recognition'."\n" + .'* **emotion**: facial expression recognition'."\n" + .'* **landmark**: landmark recognition'."\n" + .'* **scene**: scene recognition'."\n" + .'* **movieip**: movie intellectual property recognition'."\n" + .'* **subtitle**: subtitle extraction'."\n", + 'type' => 'string', + 'example' => 'ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene', + ], + 'Industry' => [ + 'description' => 'The industry to which the template applies. Default value: **common**. Valid values:'."\n" + ."\n" + .'* **microVideo**: short video industry'."\n" + .'* **common**: general industries'."\n", + 'type' => 'string', + 'example' => 'common', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the template is the default template. Valid values:'."\n" + ."\n" + .'* **true**: The template is the default template.'."\n" + .'* **false**: The template is not the default template.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'TemplateName' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'example-****', + ], + 'TemplateId' => [ + 'description' => 'The ID of the template.'."\n", + 'type' => 'string', + 'example' => '05de22f255284c7a8d2aab535dde****', + ], + 'FaceCategoryIds' => [ + 'description' => 'The IDs of the system facial image libraries that are used in the template. One or more values are returned. Valid values:'."\n" + ."\n" + .'* celebrity: the facial image library of celebrities'."\n" + .'* politician: the facial image library of politicians'."\n" + .'* sensitive: the facial image library of sensitive figures'."\n", + 'type' => 'string', + 'example' => 'politician,sensitive,celebrity', + ], + 'FaceCustomParamsConfig' => [ + 'description' => 'The configurations of face-related algorithms. The value of this parameter is a JSON string and consists of the thresholds set for face detection and facial recognition. Valid values:'."\n" + ."\n" + .'* **faceDetThreshold**: The default threshold for face detection is 0.999. The threshold takes effect only for the faces that are strange to the system.'."\n" + .'* **faceRegThreshold**: The default threshold for facial recognition is 0.9.'."\n", + 'type' => 'string', + 'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }', + ], + 'ObjectGroupIds' => [ + 'description' => 'The IDs of the object libraries that are used in the template.'."\n", + 'type' => 'string', + 'example' => 'general,item,weapon,animal', + ], + 'LandmarkGroupIds' => [ + 'description' => 'The IDs of the landmark libraries that are used in the template.'."\n", + 'type' => 'string', + 'example' => 'common', + ], + 'Scene' => [ + 'description' => 'The scenario in which the template is used. Valid values:'."\n" + ."\n" + .'* **search**: search scenarios'."\n" + .'* **recommend**: recommendation scenarios'."\n", + 'type' => 'string', + 'example' => 'search', + ], + 'LabelType' => [ + 'description' => 'The type of the tagging. Default value: **auto**. Valid values:'."\n" + ."\n" + .'* **auto**: machine tagging'."\n" + .'* **hmi**: tagging by human and machine'."\n", + 'type' => 'string', + 'example' => 'hmi', + ], + 'LabelVersion' => [ + 'description' => 'The version of the smart tagging feature. Default value: 1.0. Valid values:'."\n" + ."\n" + .'* 1.0: Smart tagging V1.0'."\n" + .'* 2.0: Smart tagging V2.0 (CPV tagging)'."\n" + .'* 2.0-custom: Smart tagging V2.0-custom (CPV tagging by using custom models)'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'KnowledgeConfig' => [ + 'description' => 'The fields to be identified as knowledge graph information when tags are returned in Smart tagging V2.0 and Smart tagging V2.0-custom modes. For more information, see [Knowledge graph fields in smart tagging jobs](~~356383~~). If this parameter is not specified or the specified value is NULL or invalid because it is not a JSON string, the following fields are returned:'."\n" + ."\n" + .'* movie-related fields:'."\n" + ."\n" + .' * name: the name of the intellectual property that is featured in the movie'."\n" + .' * alias: the alias of the intellectual property that is featured in the movie'."\n" + .' * chnl: the category of the movie'."\n" + .' * genre: the genre of the movie'."\n" + .' * country: the country or region in which the movie was produced'."\n" + .' * language: the language of the movie'."\n" + .' * releaseYear: the year when the movie was released'."\n" + ."\n" + .'* music-related fields:'."\n" + ."\n" + .' * songName: the name of the song'."\n" + .' * artistName: the name of the singer'."\n" + .' * artistArea: the region to which the singer belongs, such as China, Japan, Korea, Europe, and America, or others.'."\n" + .' * albumName: the name of the album'."\n" + ."\n" + .'* person-related fields:'."\n" + ."\n" + .' * name: the name of the person'."\n" + .' * gender: the gender of the person'."\n" + .' * citizenship: the nationality of the person'."\n" + .' * occupation: the occupation of the person'."\n" + .' * classification: the type into which the person is classified'."\n" + .' * nationality: the ethnic group of the person'."\n" + .' * birthPlace: the place where the person was born'."\n" + .' * birthDate: the date when the person was born'."\n" + ."\n" + .'* landmark-related fields:'."\n" + ."\n" + .' * name: the display name of the landmark'."\n" + .' * nameEn: the English name of the landmark'."\n" + .' * Description: the description of the parameter'."\n" + .' * address: the address of the landmark'."\n" + ."\n" + .'* item-related fields:'."\n" + ."\n" + .' * brandName: the brand of the item'."\n" + .' * finegrainName: the fine-grained description of the item'."\n", + 'type' => 'string', + 'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }', + ], + 'KeywordConfig' => [ + 'description' => 'The configuration of keyword tags. The type field specifies the category of a keyword tag. You can specify one or more values and separate the values with commas (,). Valid values:'."\n" + ."\n" + .'* name'."\n" + .'* location'."\n" + .'* organization'."\n" + .'* other'."\n" + ."\n" + .'> Keyword tags of all the categories are returned in one of the following scenarios: The KeywordConfig parameter is not specified or the Keyword field is invalid because it is not a JSON string, or the KeywordConfig parameter does not contain the type field or the type field is invalid.'."\n", + 'type' => 'string', + 'example' => '{ "type": "name,location,organization,other" }', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\",\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"AnalyseTypes\\": \\"ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene\\",\\n \\"Industry\\": \\"common\\",\\n \\"IsDefault\\": false,\\n \\"TemplateName\\": \\"example-****\\",\\n \\"TemplateId\\": \\"05de22f255284c7a8d2aab535dde****\\",\\n \\"FaceCategoryIds\\": \\"politician,sensitive,celebrity\\",\\n \\"FaceCustomParamsConfig\\": \\"{ \\\\\\"faceDetThreshold\\\\\\":0.999, \\\\\\"faceRegThreshold\\\\\\":0.9 }\\",\\n \\"ObjectGroupIds\\": \\"general,item,weapon,animal\\",\\n \\"LandmarkGroupIds\\": \\"common\\",\\n \\"Scene\\": \\"search\\",\\n \\"LabelType\\": \\"hmi\\",\\n \\"LabelVersion\\": \\"1.0\\",\\n \\"KnowledgeConfig\\": \\"{ \\\\\\"movie\\\\\\":\\\\\\"name,alias,chnl,genre\\\\\\", \\\\\\"music\\\\\\":\\\\\\"songName,artistName\\\\\\", \\\\\\"person\\\\\\":\\\\\\"name,gender\\\\\\" }\\",\\n \\"KeywordConfig\\": \\"{ \\\\\\"type\\\\\\": \\\\\\"name,location,organization,other\\\\\\" }\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySmarttagTemplateListResponse>\\n <RequestId>5210DBB0-E327-4D45-ADBC-0B83C8796E26</RequestId>\\n <Templates>\\n <AnalyseTypes>ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene</AnalyseTypes>\\n <Industry>common</Industry>\\n <IsDefault>false</IsDefault>\\n <TemplateName>example-****</TemplateName>\\n <TemplateId>05de22f255284c7a8d2aab535dde****</TemplateId>\\n <FaceCategoryIds>politician,sensitive,celebrity</FaceCategoryIds>\\n <FaceCustomParamsConfig>{ \\"faceDetThreshold\\":0.999, \\"faceRegThreshold\\":0.9 }</FaceCustomParamsConfig>\\n <ObjectGroupIds>general,item,weapon,animal</ObjectGroupIds>\\n <LandmarkGroupIds>common</LandmarkGroupIds>\\n <Scene>search</Scene>\\n <LabelType>hmi</LabelType>\\n <LabelVersion>1.0</LabelVersion>\\n <KnowledgeConfig>{ \\"movie\\":\\"name,alias,chnl,genre\\", \\"music\\":\\"songName,artistName\\", \\"person\\":\\"name,gender\\" }</KnowledgeConfig>\\n <KeywordConfig>{ \\"type\\": \\"name,location,organization,other\\" }</KeywordConfig>\\n </Templates>\\n</QuerySmarttagTemplateListResponse>","errorExample":""}]', + 'title' => 'QuerySmarttagTemplateList', + 'summary' => 'Queries the analysis template of a smart tagging job.', + 'description' => 'If you call this operation to query the information about a smart tagging template, you must specify the template ID. Otherwise, the operation returns the information about all the templates that are created by the current RAM user.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### SDK sample code'."\n" + ."\n" + .'* [Java SDK](~~188025~~)'."\n" + .'* [Python SDK](~~188026~~)'."\n" + .'* [Php SDK](~~188027~~)'."\n", + ], + 'UpdateSmarttagTemplate' => [ + 'summary' => 'Updates the analysis template of a smart tagging job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmts0A6ARW', + 'FEATUREmtsS08B52', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '05de22f255284c7a8d2aab535dde****', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'template-example-****', + ], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'common', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'search', + ], + ], + [ + 'name' => 'AnalyseTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ocr,asr', + ], + ], + [ + 'name' => 'FaceCategoryIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'celebrity', + ], + ], + [ + 'name' => 'FaceCustomParamsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }', + ], + ], + [ + 'name' => 'ObjectGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'general,item,weapon,animal', + ], + ], + [ + 'name' => 'LandmarkGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'common', + ], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LabelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hmi', + ], + ], + [ + 'name' => 'LabelVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'KnowledgeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }', + ], + ], + [ + 'name' => 'KeywordConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ "type": "name,location,organization,other" }', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateSmarttagTemplateResponse>\\n <RequestId>5210DBB0-E327-4D45-ADBC-0B83C8796E26</RequestId>\\n</UpdateSmarttagTemplateResponse>","errorExample":""}]', + 'title' => 'UpdateSmarttagTemplate', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteSmarttagTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the template that you want to delete. You can obtain the template ID from the response of the [AddSmarttagTemplate](~~187759~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '05de22f255284c7a8d2aab535dde****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5F37036F-5267-43F1-AE47-10A18E840739', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F37036F-5267-43F1-AE47-10A18E840739\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSmarttagTemplateResponse>\\n <RequestId>5F37036F-5267-43F1-AE47-10A18E840739</RequestId>\\n</DeleteSmarttagTemplateResponse>","errorExample":""}]', + 'title' => 'DeleteSmarttagTemplate', + 'summary' => 'Deletes a template.', + 'description' => 'You can call this operation to delete only one template at a time.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### Sample SDKs'."\n" + ."\n" + .'* [SDK for Java](~~188025~~)'."\n" + .'* [SDK for Python](~~188026~~)'."\n" + .'* [SDK for PHP](~~188027~~)'."\n", + ], + 'RegisterCustomFace' => [ + 'summary' => 'Registers a custom face.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmtsS08B52', + ], + ], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the figure library in which you want to register a custom face. The ID is used to uniquely identify a figure library. You can specify the ID of a custom figure library. Make sure that the ID is unique and keep the ID for future API operation calls. If you set this parameter to the ID of a system figure library, the custom face is registered in the system figure library. The ID can be up to 120 characters in length and is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CategoryId001-****', + ], + ], + [ + 'name' => 'PersonId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the figure for which you want to register a custom face. The ID is used to uniquely identify a figure. You can specify a figure ID. Make sure that the ID is unique and keep the ID for future API operation calls. The ID can be up to 120 characters in length and is not case-sensitive. The value returned is of the String type.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PersonId001-****', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the facial image that you want to register for the specified figure. The image must contain only one face.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://example-****.jpeg', + ], + ], + [ + 'name' => 'PersonName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => 'The ID of the face.'."\n", + 'type' => 'string', + 'example' => 'c6cc71cb44a9491093818faf9d60****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '91AEA76D-25B5-50DF-9126-AA6BB10FDAF4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FaceId\\": \\"c6cc71cb44a9491093818faf9d60****\\",\\n \\"RequestId\\": \\"91AEA76D-25B5-50DF-9126-AA6BB10FDAF4\\"\\n}","errorExample":""},{"type":"xml","example":"<RegisterCustomFaceResponse>\\n <FaceId>c6cc71cb44a9491093818faf9d60****</FaceId>\\n <RequestId>91AEA76D-25B5-50DF-9126-AA6BB10FDAF4</RequestId>\\n</RegisterCustomFaceResponse>","errorExample":""}]', + 'title' => 'RegisterCustomFace', + 'description' => '* You can call this operation to register only one custom face at a time.'."\n" + .'* A maximum of 10 images can be registered for a custom face.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### SDK sample code'."\n" + ."\n" + .'* [Java SDK](~~188025~~)'."\n" + .'* [Python SDK](~~188026~~)'."\n" + .'* [Php SDK](~~188027~~)'."\n", + ], + 'UnregisterCustomFace' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the figure library. The ID is used to uniquely identify a figure library. You can specify the ID of a custom figure library. Make sure that the ID is unique. If you set this parameter to the ID of a system figure library, the system figure library is used. The ID can be up to 120 characters in length and is not case-sensitive. You can call the [ListCustomPersons](~~187787~~) operation to query the figure library ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CategoryId001-****', + ], + ], + [ + 'name' => 'PersonId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the figure. The ID is used to uniquely identify a custom figure. Make sure that the ID is unique. The ID can be up to 120 characters in length and is not case-sensitive. You can call the [ListCustomPersons](~~187787~~) operation to query the figure ID. If you set this parameter to ALL, all the faces in the specified figure library are deleted, and the custom figure library is deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PersonId001-****', + ], + ], + [ + 'name' => 'FaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the face. The ID is used to uniquely identify a face. Make sure that the ID is unique. The ID can be up to 120 characters in length and is not case-sensitive. You can call the [ListCustomPersons](~~187787~~) operation to query the face ID. If you set this parameter to ALL, all the faces associated with the specified figure are deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '15****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1A3347BF-7BCE-40A6-B33E-43C2B8A9A278', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A3347BF-7BCE-40A6-B33E-43C2B8A9A278\\"\\n}","errorExample":""},{"type":"xml","example":"<UnregisterCustomFaceResponse>\\n <RequestId>1A3347BF-7BCE-40A6-B33E-43C2B8A9A278</RequestId>\\n</UnregisterCustomFaceResponse>","errorExample":""}]', + 'title' => 'UnregisterCustomFace', + 'summary' => 'Deletes a custom face, all the custom faces that are registered in a custom figure library, or a custom figure library.', + 'description' => 'You can call this operation to delete a specific custom face, all the custom faces that are registered in a custom figure library, or a custom figure library.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### Sample SDKs'."\n" + ."\n" + .'* [SDK for Java](~~188025~~)'."\n" + .'* [SDK for Python](~~188026~~)'."\n" + .'* [SDK for PHP](~~188027~~)'."\n", + ], + 'TagCustomPerson' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CategoryId001-****', + ], + ], + [ + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CategoryNametest-****', + ], + ], + [ + 'name' => 'CategoryDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CategoryDescription001-****', + ], + ], + [ + 'name' => 'PersonId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PersonId001-****', + ], + ], + [ + 'name' => 'PersonName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PersonNametest-****', + ], + ], + [ + 'name' => 'PersonDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PersonDescriptiontest-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FD8B5B8C-0C3D-5776-B3B1-EE6AD11F905A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD8B5B8C-0C3D-5776-B3B1-EE6AD11F905A\\"\\n}","type":"json"}]', + 'title' => 'TagCustomPerson', + 'summary' => 'Adds tags to a custom figure library or a figure.', + 'description' => 'The response parameters.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => 'The ID of the request.'."\n", + ], + 'ListCustomPersons' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the figure library about which you want to query information. The ID is used to uniquely identify a custom figure library. Make sure that the ID is unique. If you do not specify this parameter, the operation returns all the custom figure libraries. The ID can be up to 120 characters in length and is not case-sensitive.'."\n" + ."\n" + .'> You cannot specify the ID of the system figure library for this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CategoryId-****', + ], + ], + [ + 'name' => 'PersonId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the figure about which you want to query information. The ID is used to uniquely identify a figure. Make sure that the ID is unique. If you do not specify this parameter, the operation returns the information about all the figures in the specified figure library.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PersonId-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57', + ], + 'Categories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Category' => [ + 'description' => 'The array of the figure libraries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the figure libraries.'."\n", + 'type' => 'object', + 'properties' => [ + 'Persons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Person' => [ + 'description' => 'The array of the figures.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the figures.'."\n", + 'type' => 'object', + 'properties' => [ + 'PersonName' => [ + 'description' => 'The name of the figure.'."\n", + 'type' => 'string', + 'example' => 'PersonName-****', + ], + 'PersonDescription' => [ + 'description' => 'The description of the figure.'."\n", + 'type' => 'string', + 'example' => 'PersonDescription-****', + ], + 'Faces' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Face' => [ + 'description' => 'The array of the faces.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the faces.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageUrl' => [ + 'description' => 'The URL of the facial image that was registered for the figure.'."\n", + 'type' => 'string', + 'example' => 'http://example-****.jpeg', + ], + 'FaceId' => [ + 'description' => 'The ID of the face.'."\n", + 'type' => 'string', + 'example' => '15****', + ], + ], + ], + ], + ], + ], + 'PersonId' => [ + 'description' => 'The ID of the figure.'."\n", + 'type' => 'string', + 'example' => 'PersonId-****', + ], + ], + ], + ], + ], + ], + 'CategoryId' => [ + 'description' => 'The ID of the figure library.'."\n", + 'type' => 'string', + 'example' => 'CategoryId-****', + ], + 'CategoryName' => [ + 'description' => 'The name of the figure library.'."\n", + 'type' => 'string', + 'example' => 'CategoryName-****', + ], + 'CategoryDescription' => [ + 'description' => 'The description of the figure library.'."\n", + 'type' => 'string', + 'example' => 'CategoryDescription-****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57\\",\\n \\"Categories\\": {\\n \\"Category\\": [\\n {\\n \\"Persons\\": {\\n \\"Person\\": [\\n {\\n \\"PersonName\\": \\"PersonName-****\\",\\n \\"PersonDescription\\": \\"PersonDescription-****\\",\\n \\"Faces\\": {\\n \\"Face\\": [\\n {\\n \\"ImageUrl\\": \\"http://example-****.jpeg\\",\\n \\"FaceId\\": \\"15****\\"\\n }\\n ]\\n },\\n \\"PersonId\\": \\"PersonId-****\\"\\n }\\n ]\\n },\\n \\"CategoryId\\": \\"CategoryId-****\\",\\n \\"CategoryName\\": \\"CategoryName-****\\",\\n \\"CategoryDescription\\": \\"CategoryDescription-****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCustomPersonsResponse>\\n <RequestId>FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57</RequestId>\\n <Categories>\\n <Persons>\\n <PersonName>PersonName-****</PersonName>\\n <PersonDescription>PersonDescription-****</PersonDescription>\\n <Faces>\\n <ImageUrl>http://example-****.jpeg</ImageUrl>\\n <FaceId>15****</FaceId>\\n </Faces>\\n <PersonId>PersonId-****</PersonId>\\n </Persons>\\n <CategoryId>CategoryId-****</CategoryId>\\n <CategoryName>CategoryName-****</CategoryName>\\n <CategoryDescription>CategoryDescription-****</CategoryDescription>\\n </Categories>\\n</ListCustomPersonsResponse>","errorExample":""}]', + 'title' => 'ListCustomPersons', + 'summary' => 'Queries the information about all figures and faces in a specific figure library.', + 'description' => 'You can specify the ID of a figure or a figure library to query the corresponding information. If neither the figure ID nor figure library ID is specified, the operation returns the information about all figures and faces in all figure libraries within the current RAM user.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### SDK sample code'."\n" + ."\n" + .'* [Java SDK](~~188025~~)'."\n" + .'* [Python SDK](~~188026~~)'."\n" + .'* [Php SDK](~~188027~~)'."\n", + ], + 'CreateCustomGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CustomGroupDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CustomGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '129****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomGroupId\\": \\"129****\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomGroupResponse>\\n <CustomGroupId>129****</CustomGroupId>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n</CreateCustomGroupResponse>","errorExample":""}]', + 'title' => 'CreateCustomGroup', + 'summary' => 'Creates a custom library.', + ], + 'CreateCustomEntity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomEntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CustomEntityInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{ "finegrainName":"examplName" }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CustomEntityId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomEntityId\\": \\"1\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomEntityResponse>\\n <CustomEntityId>1</CustomEntityId>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n</CreateCustomEntityResponse>","errorExample":""}]', + 'title' => 'CreateCustomEntity', + 'summary' => 'Creates a custom entity in a custom library.', + ], + 'RegisterCustomView' => [ + 'summary' => 'Registers an image of a custom entity.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmtsS08B52', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomEntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'http://127.66.**.**/image.jpeg', + ], + ], + [ + 'name' => 'LabelPrompt', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CustomViewId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomViewId\\": \\"1\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"<RegisterCustomViewResponse>\\n <CustomViewId>1</CustomViewId>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n</RegisterCustomViewResponse>","errorExample":""}]', + 'title' => 'RegisterCustomView', + ], + 'DeleteCustomEntity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomEntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomEntityResponse>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n</DeleteCustomEntityResponse>","errorExample":""}]', + 'title' => 'DeleteCustomEntity', + 'summary' => 'Deletes a custom entity from a custom library.', + ], + 'DeleteCustomGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom type of the image library. Valid values:'."\n" + ."\n" + .'* landmark: custom landmarks.'."\n" + .'* object: custom objects.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom image library.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is unique.'."\n", + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomGroupResponse>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n</DeleteCustomGroupResponse>","errorExample":""}]', + 'title' => 'DeleteCustomGroup', + 'summary' => 'Delete a custom image library.', + 'description' => 'You can call this operation only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'DeleteCustomView' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomEntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomViewId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomViewResponse>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n</DeleteCustomViewResponse>","errorExample":""}]', + 'title' => 'DeleteCustomView', + 'summary' => 'Deletes an image of a custom entity in a custom library.', + ], + 'ListCustomViews' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomEntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CustomViews' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomView' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CustomViewId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'ImageUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://127.66.**.**/photo.jpeg', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"CustomViews\\": {\\n \\"CustomView\\": [\\n {\\n \\"CustomViewId\\": \\"1\\",\\n \\"ImageUrl\\": \\"http://127.66.**.**/photo.jpeg\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCustomViewsResponse>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <CustomViews>\\n <CustomViewId>1</CustomViewId>\\n <ImageUrl>http://127.66.**.**/photo.jpeg</ImageUrl>\\n </CustomViews>\\n</ListCustomViewsResponse>","errorExample":""}]', + 'title' => 'ListCustomViews', + 'summary' => 'Queries a list of images of an entity in a custom library.', + ], + 'ListCustomEntities' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'CustomGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CustomEntities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomEntity' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CustomEntityId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'CustomEntityName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'exampleName', + ], + 'CustomEntityInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{ "finegrainName":"example" }', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"CustomEntities\\": {\\n \\"CustomEntity\\": [\\n {\\n \\"CustomEntityId\\": \\"1\\",\\n \\"CustomEntityName\\": \\"exampleName\\",\\n \\"CustomEntityInfo\\": \\"{ \\\\\\"finegrainName\\\\\\":\\\\\\"example\\\\\\" }\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCustomEntitiesResponse>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <CustomEntities>\\n <CustomEntityId>1</CustomEntityId>\\n <CustomEntityName>exampleName</CustomEntityName>\\n <CustomEntityInfo>{ \\"finegrainName\\":\\"example\\" }</CustomEntityInfo>\\n </CustomEntities>\\n</ListCustomEntitiesResponse>","errorExample":""}]', + 'title' => 'ListCustomEntities', + 'summary' => 'Queries a list of entities in a custom library.', + ], + 'ListCustomGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CustomGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomGroup' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CustomGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'CustomGroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CustomGroupDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"CustomGroups\\": {\\n \\"CustomGroup\\": [\\n {\\n \\"CustomGroupId\\": \\"1\\",\\n \\"CustomGroupName\\": \\"自定义库名称\\",\\n \\"CustomGroupDescription\\": \\"这是一个自定义库\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCustomGroupsResponse>\\n <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <CustomGroups>\\n <CustomGroupId>1</CustomGroupId>\\n <CustomGroupName>自定义库名称</CustomGroupName>\\n <CustomGroupDescription>这是一个自定义库</CustomGroupDescription>\\n </CustomGroups>\\n</ListCustomGroupsResponse>","errorExample":""}]', + 'title' => 'ListCustomGroups', + 'summary' => 'Queries a list of custom libraries.', + ], + 'SubmitMediaCensorJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '23177', + 'abilityTreeNodes' => [ + 'FEATUREmtsFCTHFB', + 'FEATUREmtsGG7DI2', + 'FEATUREmtsJSWAH9', + 'FEATUREmtsIZYFIQ', + 'FEATUREmtsZMZNBE', + 'FEATUREmtsNP97O9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Object Storage Service (OSS) URL of the media file to be moderated. To view the OSS URL of the media file, you can log on to the **MPS console** and choose **Media Management** > **Media List** in the left-side navigation pane. To moderate an image file, use the `CoverImage` parameter to specify the OSS URL of the image file. The value is a JSON object. For more information, see the "Input" section of the [Parameter details](~~29253~~) topic.'."\n" + ."\n" + .'* Bucket: the name of the OSS bucket that stores the input file.'."\n" + ."\n" + .'* Location: the OSS region. The OSS region must be the same as the region in which your MPS service is activated.'."\n" + ."\n" + .'* Object: the OSS object to be moderated.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note**The name of the object cannot start with a forward slash (/). Otherwise, the operation fails to be called.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}', + ], + ], + [ + 'name' => 'CoverImages', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URL of the image file that is used as the thumbnail. To view the OSS URL of the image file, you can log on to the **MPS console** and choose **Media Management** > **Media List** in the left-side navigation pane. You can specify up to five thumbnails in a JSON array.'."\n" + ."\n" + .'* Bucket: the name of the OSS bucket that stores the input file.'."\n" + ."\n" + .'* Location: the OSS region. The OSS region must be the same as the region in which your MPS service is activated.'."\n" + ."\n" + .'* Object: the OSS object to be moderated.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note**The name of the object cannot start with a forward slash (/). Otherwise, the operation fails to be called.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg"}]', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => 'The title of the video. The value can be up to 64 bytes in size.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Hello World', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the video. The value can be up to 128 bytes in size.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example description', + ], + ], + [ + 'name' => 'Barrages', + 'in' => 'query', + 'schema' => [ + 'description' => 'The live comments.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello world', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue. This ID can be used to associate the job with a notification method. To view the ID of the MPS queue, you can log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane. An empty string ("") indicates that the default MPS queue is used to run the job. By default, an MPS queue can process a maximum of 10 concurrent content moderation jobs. To increase the limit, [submit a ticket](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.ditem-sub.35da7bbcitpQnr#/ticket/createIndex).'."\n" + ."\n" + .'> MPS queues are automatically created by the system. For more information about how to query and update MPS queues, see the [UpdatePipeline](~~188374~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'b22c173cced04565b1f38f1ecc39****', + ], + ], + [ + 'name' => 'VideoCensorConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The video moderation configurations and the OSS URLs of the output snapshots. To view the OSS URL of the media file, you can log on to the **MPS console** and choose **Media Management** > **Media List** in the left-side navigation pane.'."\n" + ."\n" + .'The value is a JSON object.'."\n" + ."\n" + .'* OutputFile:'."\n" + ."\n" + .' * Bucket: the name of the OSS bucket that stores the output file.'."\n" + .' * Location: the OSS region. The OSS region must be the same as the region in which your MPS service is activated.'."\n" + .' * Object: the OSS object to be generated. In the value, {Count} indicates the sequence number of the frame snapshot.'."\n" + ."\n" + .'* StoreVideoTimeline: specifies whether to generate the `{jobId}.video_timeline` file. The file is stored in OSS. A value of true indicates that the file is generated. A value of false indicates that the file is not generated. If you do not specify this parameter, the file is not generated by default. For more information about the format of the file, see the "VideoTimelines" parameter in the [QueryMediaCensorJobDetail](~~91779~~) topic.'."\n" + ."\n" + .'* SaveType: the output mode. A value of abnormal indicates that snapshots are generated only for illegal frames. A value of all indicates that snapshots are generated for all frames.'."\n" + ."\n" + .'* Biztype: the moderation template. If you do not specify this parameter or set the value to common, the default template is used. You can submit a ticket to create a custom moderation template. Then, set this parameter to your user ID to use the custom moderation template.'."\n" + ."\n" + .'* Scenes: the moderation scenarios. You can specify the moderation scenarios that you want to use. If you do not specify this parameter, the terrorism and porn moderation scenarios are used by default. Valid values:'."\n" + ."\n" + .' * porn: pornographic content detection'."\n" + .' * terrorism: terrorist content detection'."\n" + .' * ad: ad violation detection'."\n" + .' * live: undesirable scene detection'."\n" + .' * logo: special logo detection'."\n" + .' * audio: audio anti-spam'."\n" + ."\n" + .'> If the input file contains audio tracks and the audio moderation scenario is specified, the audio tracks are moderated. If the input file does not contain audio tracks, you do not need to specify the audio moderation scenario.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Scenes" : ["porn"], "OutputFile":{"Bucket": "example-001","Location": "oss-cn-hangzhou","Object": "test/example-{Count}.jpg"},"SaveType" : "abnormal","BizType":"common"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The value can be up to 128 bytes in size.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'UserDatatestid-001-****', + ], + ], + [ + 'name' => 'ExternalUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the video.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/video-****/test-****.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobId' => [ + 'description' => 'The ID of the content moderation job. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitMediaCensorJobResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <JobId>88c6ca184c0e47098a5b665e2****</JobId>\\n</SubmitMediaCensorJobResponse>","errorExample":""}]', + 'title' => 'SubmitMediaCensorJob', + 'summary' => 'Submits a content moderation job.', + 'description' => 'The job that you submit by calling this operation is run in asynchronous mode. The job is added to an ApsaraVideo Media Processing (MPS) queue and then scheduled, queued, and run. You can call the [QueryMediaCensorJobDetail](~~91779~~) operation or configure an asynchronous notification to obtain the job result.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Asynchronous notification parameters**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|:---|:---|:---|'."\n" + .'|Type|String|The type of the message. The value is MediaCensor.|'."\n" + .'|MediaCensorJobNotify|AliyunMediaCensorJobNotify|The notification content of the content moderation job.|'."\n" + .'|UserData|String|The custom data.|', + 'extraInfo' => ' ', + ], + 'QueryMediaCensorJobDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the content moderation job. You can obtain the job ID from the response parameters of the [SubmitMediaCensorJob](~~91774~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The token of the next page is returned after you call this operation to query the results of a content moderation job for the first time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return on each page.'."\n" + ."\n" + .'* Default value: **30**.'."\n" + .'* Valid values: **1 to 300**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA', + ], + 'MediaCensorJobDetail' => [ + 'description' => 'The results of the content moderation job.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2018-09-13T16:32:24Z', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '2018-09-21', + ], + 'Suggestion' => [ + 'description' => 'The overall result of the job. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n" + ."\n" + .'If the moderation result of one type of the moderated content is review, the overall result is review. If the moderation result of one type of the moderated content is block, the overall result is block.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'CoverImageCensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CoverImageCensorResult' => [ + 'description' => 'The moderation results of thumbnails.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The Object Storage Service (OSS) object that is used as the video thumbnail.'."\n", + 'type' => 'string', + 'example' => 'test/ai/censor/v2/vme-****.jpg', + ], + 'Location' => [ + 'description' => 'The OSS region in which the video thumbnail resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the video thumbnail.'."\n", + 'type' => 'string', + 'example' => 'bucket-out-test-****', + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => 'The moderation results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Multiple labels are separated with commas (,).'."\n" + ."\n" + .'* Valid values in the pornographic content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **sexy**: sexy content'."\n" + .' * **porn**: pornographic content'."\n" + ."\n" + .'* Valid values in the terrorist content moderation scenario:'."\n" + ."\n" + .' * **narmal**: normal content'."\n" + .' * **bloody**: bloody content'."\n" + .' * **explosion**: explosion and smoke'."\n" + .' * **outfit**: special costume'."\n" + .' * **logo**: special logo'."\n" + .' * **weapon**: weapon'."\n" + .' * **politics**: political content'."\n" + .' * **violence**: violence'."\n" + .' * **crowd**: crowd'."\n" + .' * **parade**: parade'."\n" + .' * **carcrash**: car accident'."\n" + .' * **flag**: flag'."\n" + .' * **location**: landmark'."\n" + .' * **others**: other content'."\n" + ."\n" + .'* Valid values in the ad moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **ad**: other ads'."\n" + .' * **politics**: political content in text'."\n" + .' * **porn**: pornographic content in text'."\n" + .' * **abuse**: abuse in text'."\n" + .' * **terrorism**: terrorist content in text'."\n" + .' * **contraband**: prohibited content in text'."\n" + .' * **spam**: spam in text'."\n" + .' * **npx**: illegal ads'."\n" + .' * **qrcode**: QR code'."\n" + .' * **programCode**: mini program code'."\n" + ."\n" + .'* Valid values in the live moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **meaningless**: meaningless content, such as a black or white screen'."\n" + .' * **PIP**: picture-in-picture'."\n" + .' * **smoking**: smoking'."\n" + .' * **drivelive**: live broadcasting in a running vehicle'."\n" + ."\n" + .'* Valid values in the logo moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **TV**: controlled TV station logo'."\n" + .' * **trademark**: trademark'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values:'."\n" + ."\n" + .'* **porn**: pornographic content moderation'."\n" + .'* **terrorism**: terrorist content moderation'."\n" + .'* **ad**: ad violation moderation'."\n" + .'* **live**: undesirable scene moderation'."\n" + .'* **logo**: logo moderation'."\n", + 'type' => 'string', + 'example' => 'porn', + ], + 'Rate' => [ + 'description' => 'The score. Valid values: **0 to 100**.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'State' => [ + 'description' => 'The status of the job. Valid values:'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'TitleCensorResult' => [ + 'description' => 'The moderation result of the title.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Valid values:'."\n" + ."\n" + .'* **normal**: normal content'."\n" + .'* **spam**: spam'."\n" + .'* **ad**: ads'."\n" + .'* **abuse**: abuse'."\n" + .'* **flood**: excessive junk content'."\n" + .'* **contraband**: prohibited content'."\n" + .'* **meaningless**: meaningless content'."\n", + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values: The value is **antispam**.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated cannot be found', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input media file.'."\n", + 'type' => 'string', + 'example' => 'test/ai/censor/test-****.mp4', + ], + 'Location' => [ + 'description' => 'The OSS region in which the input media file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input media file is stored.'."\n", + 'type' => 'string', + 'example' => 'bucket-test-in-****', + ], + ], + ], + 'BarrageCensorResult' => [ + 'description' => 'The moderation result of live comments.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Multiple labels are separated with commas (,). Valid values:'."\n" + ."\n" + .'* **spam**: spam'."\n" + .'* **ad**: ads'."\n" + .'* **abuse**: abuse'."\n" + .'* **flood**: excessive junk content'."\n" + .'* **contraband**: prohibited content'."\n" + .'* **meaningless**: meaningless content'."\n" + .'* **normal**: normal content'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values: The value is **antispam**.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'DescCensorResult' => [ + 'description' => 'The moderation result of the description.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'review', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Valid values:'."\n" + ."\n" + .'* **spam**: spam'."\n" + .'* **ad**: ads'."\n" + .'* **abuse**: abuse'."\n" + .'* **flood**: excessive junk content'."\n" + .'* **contraband**: prohibited content'."\n" + .'* **meaningless**: meaningless content'."\n" + .'* **normal**: normal content'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values: The value is **antispam**.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'VideoCensorConfig' => [ + 'description' => 'The video moderation configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'OutputFile' => [ + 'description' => 'The information about output snapshots.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The one or more OSS objects that are generated as the output snapshots.'."\n" + ."\n" + .'> In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-****.jpg`, `output00002-****.jpg`, and so on.'."\n", + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'Location' => [ + 'description' => 'The region in which the OSS bucket that stores the output snapshot resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the output snapshots.'."\n", + 'type' => 'string', + 'example' => 'test-bucket-****', + ], + ], + ], + 'VideoCensor' => [ + 'description' => 'Indicates whether the video content needs to be moderated. Default value: **true** Valid values:'."\n" + ."\n" + .'* **true**: The video content needs to be moderated.'."\n" + .'* **false**: The video content does not need to be moderated.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'BizType' => [ + 'description' => 'The custom business type. Default value: common.'."\n", + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + 'JobId' => [ + 'description' => 'The ID of the content moderation job.'."\n", + 'type' => 'string', + 'example' => 'f8f166eea7a44e9bb0a4aecf9543****', + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'example userdata ****', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'VensorCensorResult' => [ + 'description' => 'The moderation results of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'VideoTimelines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoTimeline' => [ + 'description' => 'The moderation results that are sorted in ascending order by time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => 'The position in the video. Format: `hh:mm:ss[.SSS]`.'."\n", + 'type' => 'string', + 'example' => '00:02:59.999', + ], + 'Object' => [ + 'description' => 'The one or more OSS objects that are generated as the output snapshots.'."\n" + ."\n" + .'> In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-****.jpg`, `output00002-****.jpg`, and so on.'."\n", + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => 'The moderation results that include information such as labels and scores.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Multiple labels are separated with commas (,). Valid values:'."\n" + ."\n" + .'* Valid values in the pornographic content moderation scenario:'."\n" + ."\n" + .' * **porn**: pornographic content'."\n" + .' * **sexy**: sexy content'."\n" + .' * **normal**: normal content'."\n" + ."\n" + .'* Valid values in the terrorist content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **bloody**: bloody content'."\n" + .' * **explosion**: explosion and smoke'."\n" + .' * **outfit**: special costume'."\n" + .' * **logo**: special logo'."\n" + .' * **weapon**: weapon'."\n" + .' * **politics**: political content'."\n" + .' * **violence**: violence'."\n" + .' * **crowd**: crowd'."\n" + .' * **parade**: parade'."\n" + .' * **carcrash**: car accident'."\n" + .' * **flag**: flag'."\n" + .' * **location**: landmark'."\n" + .' * **others**: other content'."\n" + ."\n" + .'* Valid values in the ad moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **ad**: other ads'."\n" + .' * **politics**: political content in text'."\n" + .' * **porn**: pornographic content in text'."\n" + .' * **abuse**: abuse in text'."\n" + .' * **terrorism**: terrorist content in text'."\n" + .' * **contraband**: prohibited content in text'."\n" + .' * **spam**: spam in text'."\n" + .' * **npx**: illegal ads'."\n" + .' * **qrcode**: QR code'."\n" + .' * **programCode**: mini program code'."\n" + ."\n" + .'* Valid values in the live moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **meaningless**: meaningless content, such as a black or white screen'."\n" + .' * **PIP**: picture-in-picture'."\n" + .' * **smoking**: smoking'."\n" + .' * **drivelive**: live broadcasting in a running vehicle'."\n" + ."\n" + .'* Valid values in the logo moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **TV**: controlled TV station logo'."\n" + .' * **trademark**: trademark'."\n", + 'type' => 'string', + 'example' => 'porn,ad', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values:'."\n" + ."\n" + .'* **porn**: pornographic content moderation'."\n" + .'* **terrorism**: terrorist content moderation'."\n" + .'* **ad**: ad violation moderation'."\n" + .'* **live**: undesirable scene moderation'."\n" + .'* **logo**: logo moderation'."\n", + 'type' => 'string', + 'example' => 'porn', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '99.99', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'ea04afcca7cd4e80b9ece8fbb251****', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => 'A collection of the moderation results. The information includes the summary of various scenarios such as pornographic content and terrorist content.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The moderation result of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'review', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Multiple labels are separated with commas (,). Valid values:'."\n" + ."\n" + .'* Valid values in the pornographic content moderation scenario:'."\n" + ."\n" + .' * **porn**: pornographic content'."\n" + .' * **sexy**: sexy content'."\n" + .' * **normal**: normal content'."\n" + ."\n" + .'* Valid values in the terrorist content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **bloody**: bloody content'."\n" + .' * **explosion**: explosion and smoke'."\n" + .' * **outfit**: special costume'."\n" + .' * **logo**: special logo'."\n" + .' * **weapon**: weapon'."\n" + .' * **politics**: political content'."\n" + .' * **violence**: violence'."\n" + .' * **crowd**: crowd'."\n" + .' * **parade**: parade'."\n" + .' * **carcrash**: car accident'."\n" + .' * **flag**: flag'."\n" + .' * **location**: landmark'."\n" + .' * **others**: other content'."\n" + ."\n" + .'* Valid values in the ad moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **ad**: other ads'."\n" + .' * **politics**: political content in text'."\n" + .' * **porn**: pornographic content in text'."\n" + .' * **abuse**: abuse in text'."\n" + .' * **terrorism**: terrorist content in text'."\n" + .' * **contraband**: prohibited content in text'."\n" + .' * **spam**: spam in text'."\n" + .' * **npx**: illegal ads'."\n" + .' * **qrcode**: QR code'."\n" + .' * **programCode**: mini program code'."\n" + ."\n" + .'* Valid values in the live moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **meaningless**: meaningless content, such as a black or white screen'."\n" + .' * **PIP**: picture-in-picture'."\n" + .' * **smoking**: smoking'."\n" + .' * **drivelive**: live broadcasting in a running vehicle'."\n" + ."\n" + .'* Valid values in the logo moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **TV**: controlled TV station logo'."\n" + .' * **trademark**: trademark'."\n", + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values:'."\n" + ."\n" + .'* **porn**: pornographic content moderation'."\n" + .'* **terrorism**: terrorist content moderation'."\n" + .'* **ad**: ad violation moderation'."\n" + .'* **live**: undesirable scene moderation'."\n" + .'* **logo**: logo moderation'."\n", + 'type' => 'string', + 'example' => 'terrorism', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'AudioCensorResult' => [ + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'type' => 'string', + ], + 'Label' => [ + 'type' => 'string', + ], + 'AudioDetailResultList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioDetailResult' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'EndTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Text' => [ + 'type' => 'string', + ], + 'Label' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the content moderation job is submitted.'."\n", + 'type' => 'string', + 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA\\",\\n \\"MediaCensorJobDetail\\": {\\n \\"CreationTime\\": \\"2018-09-13T16:32:24Z\\",\\n \\"FinishTime\\": \\"2018-09-21\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-out-test-****\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"porn\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"Success\\",\\n \\"TitleCensorResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-test-in-****\\"\\n },\\n \\"BarrageCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"DescCensorResult\\": {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"test-bucket-****\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543****\\",\\n \\"UserData\\": \\"example userdata ****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"VensorCensorResult\\": {\\n \\"VideoTimelines\\": {\\n \\"VideoTimeline\\": [\\n {\\n \\"Timestamp\\": \\"00:02:59.999\\",\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"porn,ad\\",\\n \\"Scene\\": \\"porn\\",\\n \\"Rate\\": \\"99.99\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251****\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"terrorism\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"AudioCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"AudioDetailResultList\\": {\\n \\"AudioDetailResult\\": [\\n {\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 30,\\n \\"Text\\": \\"测试一下\\",\\n \\"Label\\": \\"normal\\"\\n }\\n ]\\n }\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryMediaCensorJobDetailResponse>\\n <RequestId>B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA</RequestId>\\n <MediaCensorJobDetail>\\n <CreationTime>2018-09-13T16:32:24Z</CreationTime>\\n <FinishTime>2018-09-21</FinishTime>\\n <Suggestion>block</Suggestion>\\n <CoverImageCensorResults>\\n <Object>test/ai/censor/v2/vme-****.jpg</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>bucket-out-test-****</Bucket>\\n <Results>\\n <Suggestion>pass</Suggestion>\\n <Label>normal</Label>\\n <Scene>porn</Scene>\\n <Rate>100</Rate>\\n </Results>\\n </CoverImageCensorResults>\\n <State>Success</State>\\n <TitleCensorResult>\\n <Suggestion>block</Suggestion>\\n <Label>meaningless</Label>\\n <Scene>antispam</Scene>\\n <Rate>99.91</Rate>\\n </TitleCensorResult>\\n <Message>The resource operated cannot be found</Message>\\n <Input>\\n <Object>test/ai/censor/test-****.mp4</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>bucket-test-in-****</Bucket>\\n </Input>\\n <BarrageCensorResult>\\n <Suggestion>pass</Suggestion>\\n <Label>normal</Label>\\n <Scene>antispam</Scene>\\n <Rate>99.91</Rate>\\n </BarrageCensorResult>\\n <DescCensorResult>\\n <Suggestion>review</Suggestion>\\n <Label>normal</Label>\\n <Scene>antispam</Scene>\\n <Rate>100</Rate>\\n </DescCensorResult>\\n <VideoCensorConfig>\\n <OutputFile>\\n <Object>output{Count}.jpg</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>test-bucket-****</Bucket>\\n </OutputFile>\\n <VideoCensor>true</VideoCensor>\\n <BizType>common</BizType>\\n </VideoCensorConfig>\\n <JobId>f8f166eea7a44e9bb0a4aecf9543****</JobId>\\n <UserData>example userdata ****</UserData>\\n <Code>InvalidParameter.ResourceNotFound</Code>\\n <VensorCensorResult>\\n <VideoTimelines>\\n <Timestamp>00:02:59.999</Timestamp>\\n <Object>output{Count}.jpg</Object>\\n <CensorResults>\\n <Suggestion>block</Suggestion>\\n <Label>porn,ad</Label>\\n <Scene>porn</Scene>\\n <Rate>99.99</Rate>\\n </CensorResults>\\n </VideoTimelines>\\n <NextPageToken>ea04afcca7cd4e80b9ece8fbb251****</NextPageToken>\\n <CensorResults>\\n <Suggestion>review</Suggestion>\\n <Label>meaningless</Label>\\n <Scene>terrorism</Scene>\\n <Rate>100</Rate>\\n </CensorResults>\\n </VensorCensorResult>\\n <PipelineId>c5b30b7c0d0e4a0abde1d5f9e751****</PipelineId>\\n </MediaCensorJobDetail>\\n</QueryMediaCensorJobDetailResponse>","errorExample":""}]', + 'title' => 'QueryMediaCensorJobDetail', + 'summary' => 'Queries the information about a content moderation job.', + 'description' => 'In the content moderation results, the moderation results of the video are sorted in ascending order by time into a timeline. If the video is long, the content moderation results are paginated, and the first page is returned. You can call this operation again to query the remaining moderation results of the video.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMediaCensorJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the content moderation job. You can call the [SubmitMediaCensorJob](~~91779~~) operation to query the ID of the content moderation job. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '79aff3eee82242e092899db5f669****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return on each page.'."\n" + ."\n" + .'* Default value: **30**.'."\n" + .'* Valid values: **1 to 300**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the jobs to be queried. Valid values:'."\n" + ."\n" + .'* **All**: all jobs.'."\n" + .'* **Queuing**: the jobs that are being queued.'."\n" + .'* **Analysing**: the jobs that are in progress.'."\n" + .'* **Fail**: failed jobs.'."\n" + .'* **Success**: successful jobs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'default' => 'All', + ], + ], + [ + 'name' => 'StartOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range within which the jobs to be queried were created.'."\n" + ."\n" + .'* Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.'."\n" + .'* The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-22T03:48:05Z', + ], + ], + [ + 'name' => 'EndOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range within which the jobs to be queried were created.'."\n" + ."\n" + .'* Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.'."\n" + .'* The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-14T02:16:07Z', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job. To obtain the ID of the MPS queue, perform the following steps: Log on to the [**MPS console**](https://mps.console.aliyun.com/overview). In the left-side navigation pane, choose **Global Settings** > **Pipelines**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaCensorJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaCensorJob' => [ + 'description' => 'The content moderation jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a content moderation job.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2021-11-04T07:25:48Z', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was completed.'."\n", + 'type' => 'string', + 'example' => '2021-11-04T07:25:48Z', + ], + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'CoverImageCensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CoverImageCensorResult' => [ + 'description' => 'The moderation results of thumbnails.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the moderation result of a thumbnail.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The Object Storage Service (OSS) object that is used as the video thumbnail.'."\n", + 'type' => 'string', + 'example' => 'test/ai/censor/v2/vme-****.jpg', + ], + 'Location' => [ + 'description' => 'The OSS region in which the video thumbnail resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the video thumbnail.'."\n", + 'type' => 'string', + 'example' => 'example-Bucket-****', + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => 'The moderation results of the content moderation jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the moderation result of a content moderation job'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The overall result of the job. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n" + ."\n" + .'> If the moderation result of any type of the moderated content is review, the overall result is review. If the moderation result of any type of the moderated content is block, the overall result is block.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Separate multiple labels with commas (,).'."\n" + ."\n" + .'* Valid values in the pornographic content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **sexy**: sexy content'."\n" + .' * **porn**: pornographic content'."\n" + ."\n" + .'* Valid values in the terrorist content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **bloody**: bloody content'."\n" + .' * **explosion**: explosion and smoke'."\n" + .' * **outfit**: special costume'."\n" + .' * **logo**: special logo'."\n" + .' * **weapon**: weapon'."\n" + .' * **politics**: political content'."\n" + .' * **violence**: violence'."\n" + .' * **crowd**: crowd'."\n" + .' * **parade**: parade'."\n" + .' * **carcrash**: car accident'."\n" + .' * **flag**: flag'."\n" + .' * **location**: landmark'."\n" + .' * **others**: other content'."\n" + ."\n" + .'* Valid values in the ad moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **ad**: other ads'."\n" + .' * **politics**: political content in text'."\n" + .' * **porn**: pornographic content in text'."\n" + .' * **abuse**: abuse in text'."\n" + .' * **terrorism**: terrorist content in text'."\n" + .' * **contraband**: prohibited content in text'."\n" + .' * **spam**: spam in text'."\n" + .' * **npx**: illegal ads'."\n" + .' * **qrcode**: QR code'."\n" + .' * **programCode**: mini program code'."\n" + ."\n" + .'* Valid values in the live moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **meaningless**: meaningless content, such as a black or white screen'."\n" + .' * **PIP**: picture-in-picture'."\n" + .' * **smoking**: smoking'."\n" + .' * **drivelive**: live broadcasting in a running vehicle'."\n" + ."\n" + .'* Valid values in the logo moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **TV**: controlled TV station logo'."\n" + .' * **trademark**: trademark'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values:'."\n" + ."\n" + .'* **porn**: pornographic content moderation'."\n" + .'* **terrorism**: terrorist content moderation'."\n" + .'* **ad**: ad violation moderation'."\n" + .'* **live**: undesirable scene moderation'."\n" + .'* **logo**: special logo moderation'."\n", + 'type' => 'string', + 'example' => 'live', + ], + 'Rate' => [ + 'description' => 'The score. Valid values: 0 to 100.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'State' => [ + 'description' => 'The status of the job.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'TitleCensorResult' => [ + 'description' => 'The moderation result of the title.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Separate multiple labels with commas (,).'."\n" + ."\n" + .'* **normal**: normal content'."\n" + .'* **spam**: spam'."\n" + .'* **ad**: ads'."\n" + .'* **abuse**: abuse content'."\n" + .'* **flood**: excessive junk content'."\n" + .'* **contraband**: prohibited content'."\n" + .'* **meaningless**: meaningless content'."\n", + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. The value is **antispam**.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The resource operated cannot be found', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'test/ai/censor/test-****.mp4', + ], + 'Location' => [ + 'description' => 'The OSS region in which the input file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'bucket-test-in-****', + ], + ], + ], + 'BarrageCensorResult' => [ + 'description' => 'The moderation result of live comments.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" + ."\n" + .'* **spam**: spam'."\n" + .'* **ad**: ads'."\n" + .'* **abuse**: abuse'."\n" + .'* **flood**: excessive junk content'."\n" + .'* **contraband**: prohibited content'."\n" + .'* **meaningless**: meaningless content'."\n" + .'* **normal**: normal content'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. The value is **antispam**.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'DescCensorResult' => [ + 'description' => 'The moderation result of the description.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" + ."\n" + .'* **spam**: spam'."\n" + .'* **ad**: ads'."\n" + .'* **abuse**: abuse'."\n" + .'* **flood**: excessive junk content'."\n" + .'* **contraband**: prohibited content'."\n" + .'* **meaningless**: meaningless content'."\n" + .'* **normal**: normal content'."\n", + 'type' => 'string', + 'example' => 'ad', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. The value is **antispam**.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'VideoCensorConfig' => [ + 'description' => 'The video moderation configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'OutputFile' => [ + 'description' => 'The information about output snapshots.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The one or more OSS objects that are generated as the output snapshots.'."\n" + ."\n" + .'> In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-****.jpg, output00002-****.jpg`, and so on.'."\n", + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'Location' => [ + 'description' => 'The OSS region in which the OSS bucket for storing the output snapshot resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket that stores the output snapshot.'."\n", + 'type' => 'string', + 'example' => 'test-bucket-****', + ], + ], + ], + 'VideoCensor' => [ + 'description' => 'Indicates whether the video content needs to be moderated. Default value: true. Valid values:'."\n" + ."\n" + .'* **true**: The video content needs to be moderated.'."\n" + .'* **false**: The video content does not need to be moderated.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'BizType' => [ + 'description' => 'The moderation template. Default value: common. The default value indicates that the default template is used.'."\n" + ."\n" + .'> If the moderation template is not specified, the default value common is returned. If a custom moderation template that is created by submitting a ticket is specified, a user ID is returned.'."\n", + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + 'JobId' => [ + 'description' => 'The ID of the content moderation job.'."\n", + 'type' => 'string', + 'example' => 'f8f166eea7a44e9bb0a4aecf9543****', + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'example userdata ****', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'VensorCensorResult' => [ + 'description' => 'The moderation results of the video.'."\n", + 'type' => 'object', + 'properties' => [ + 'VideoTimelines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoTimeline' => [ + 'description' => 'The moderation results that are sorted in ascending order by time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the moderation results.'."\n", + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => 'The position in the video. Format: `hh:mm:ss[.SSS]`.'."\n", + 'type' => 'string', + 'example' => '00:02:59.999', + ], + 'Object' => [ + 'description' => 'The OSS object that is generated as the output snapshot.'."\n" + ."\n" + .'> In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-****.jpg, output00002-****.jpg`, and so on.'."\n", + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => 'The moderation results that include information such as labels and scores.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the moderation results.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" + ."\n" + .'* Valid values in the pornographic content moderation scenario:'."\n" + ."\n" + .' * **porn**: pornographic content'."\n" + .' * **sexy**: sexy content'."\n" + .' * **normal**: normal content'."\n" + ."\n" + .'* Valid values in the terrorist content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **bloody**: bloody content'."\n" + .' * **explosion**: explosion and smoke'."\n" + .' * **outfit**: special costume'."\n" + .' * **logo**: special logo'."\n" + .' * **weapon**: weapon'."\n" + .' * **politics**: political content'."\n" + .' * **violence**: violence'."\n" + .' * **crowd**: crowd'."\n" + .' * **parade**: parade'."\n" + .' * **carcrash**: car accident'."\n" + .' * **flag**: flag'."\n" + .' * **location**: landmark'."\n" + .' * **others**: other content'."\n" + ."\n" + .'* Valid values in the ad moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **ad**: other ads'."\n" + .' * **politics**: political content in text'."\n" + .' * **porn**: pornographic content in text'."\n" + .' * **abuse**: abuse in text'."\n" + .' * **terrorism**: terrorist content in text'."\n" + .' * **contraband**: prohibited content in text'."\n" + .' * **spam**: spam in text'."\n" + .' * **npx**: illegal ads'."\n" + .' * **qrcode**: QR code'."\n" + .' * **programCode**: mini program code'."\n" + ."\n" + .'* Valid values in the live moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **meaningless**: meaningless content, such as a black or white screen'."\n" + .' * **PIP**: picture-in-picture'."\n" + .' * **smoking**: smoking'."\n" + .' * **drivelive**: live broadcasting in a running vehicle'."\n" + ."\n" + .'* Valid values in the logo moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **TV**: controlled TV station logo'."\n" + .' * **trademark**: trademark'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values:'."\n" + ."\n" + .'* **porn**: pornographic content moderation'."\n" + .'* **terrorism**: terrorist content moderation'."\n" + .'* **ad**: ad violation moderation'."\n" + .'* **live**: undesirable scene moderation'."\n" + .'* **logo**: special logo moderation'."\n", + 'type' => 'string', + 'example' => 'pron', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '99.99', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'ea04afcca7cd4e80b9ece8fbb251****', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => 'A collection of the moderation results. The information includes the summary about various scenarios such as pornographic content and terrorist content.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the moderation results.'."\n", + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* **pass**: The content passes the moderation.'."\n" + .'* **review**: The content needs to be manually reviewed again.'."\n" + .'* **block**: The content needs to be blocked.'."\n", + 'type' => 'string', + 'example' => 'review', + ], + 'Label' => [ + 'description' => 'The labels of the moderation result. Separate multiple labels with commas (,).'."\n" + ."\n" + .'* Valid values in the pornographic content moderation scenario:'."\n" + ."\n" + .' * **porn**: pornographic content'."\n" + .' * **sexy**: sexy content'."\n" + .' * **normal**: normal content'."\n" + ."\n" + .'* Valid values in the terrorist content moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **bloody**: bloody content'."\n" + .' * **explosion**: explosion and smoke'."\n" + .' * **outfit**: special costume'."\n" + .' * **logo**: special logo'."\n" + .' * **weapon**: weapon'."\n" + .' * **politics**: political content'."\n" + .' * **violence**: violence'."\n" + .' * **crowd**: crowd'."\n" + .' * **parade**: parade'."\n" + .' * **carcrash**: car accident'."\n" + .' * **flag**: flag'."\n" + .' * **location**: landmark'."\n" + .' * **others**: other content'."\n" + ."\n" + .'* Valid values in the ad moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **ad**: other ads'."\n" + .' * **politics**: political content in text'."\n" + .' * **porn**: pornographic content in text'."\n" + .' * **abuse**: abuse in text'."\n" + .' * **terrorism**: terrorist content in text'."\n" + .' * **contraband**: prohibited content in text'."\n" + .' * **spam**: spam in text'."\n" + .' * **npx**: illegal ads'."\n" + .' * **qrcode**: QR code'."\n" + .' * **programCode**: mini program code'."\n" + ."\n" + .'* Valid values in the live moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **meaningless**: meaningless content, such as a black or white screen'."\n" + .' * **PIP**: picture-in-picture'."\n" + .' * **smoking**: smoking'."\n" + .' * **drivelive**: live broadcasting in a running vehicle'."\n" + ."\n" + .'* Valid values in the logo moderation scenario:'."\n" + ."\n" + .' * **normal**: normal content'."\n" + .' * **TV**: controlled TV station logo'."\n" + .' * **trademark**: trademark'."\n", + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => 'The moderation scenario. Valid values:'."\n" + ."\n" + .'* **porn**: pornographic content moderation'."\n" + .'* **terrorism**: terrorist content moderation'."\n" + .'* **ad**: ad violation moderation'."\n" + .'* **live**: undesirable scene moderation'."\n" + .'* **logo**: special logo moderation'."\n", + 'type' => 'string', + 'example' => 'terrorism', + ], + 'Rate' => [ + 'description' => 'The score.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'AudioCensorResult' => [ + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'type' => 'string', + ], + 'Label' => [ + 'type' => 'string', + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue that is used to run the job.'."\n", + 'type' => 'string', + 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', + ], + 'NextPageToken' => [ + 'description' => 'The token that is used to retrieve the next page of the query results. The value is a UUID that contains 32 characters. If the returned query results cannot be displayed within one page, this parameter is returned. The value of this parameter is updated for each query.'."\n", + 'type' => 'string', + 'example' => '9b1a42bc6e8d46e6a1383b7e7f01****', + ], + 'NonExistIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of the jobs that do not exist. This parameter is not returned if all specified jobs are found.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the job that does not exist.'."\n", + 'type' => 'string', + 'example' => '78dc866518b843259669df58ed30****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaCensorJobList\\": {\\n \\"MediaCensorJob\\": [\\n {\\n \\"CreationTime\\": \\"2021-11-04T07:25:48Z\\",\\n \\"FinishTime\\": \\"2021-11-04T07:25:48Z\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"example-Bucket-****\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"live\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"Success\\",\\n \\"TitleCensorResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-test-in-****\\"\\n },\\n \\"BarrageCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"DescCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"ad\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"test-bucket-****\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543****\\",\\n \\"UserData\\": \\"example userdata ****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"VensorCensorResult\\": {\\n \\"VideoTimelines\\": {\\n \\"VideoTimeline\\": [\\n {\\n \\"Timestamp\\": \\"00:02:59.999\\",\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"pron\\",\\n \\"Rate\\": \\"99.99\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251****\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"terrorism\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"AudioCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\"\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\",\\n \\"NextPageToken\\": \\"9b1a42bc6e8d46e6a1383b7e7f01****\\",\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"78dc866518b843259669df58ed30****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryMediaCensorJobListResponse>\\n <MediaCensorJobList>\\n <CreationTime>2021-11-04T07:25:48Z</CreationTime>\\n <FinishTime>2021-11-04T07:25:48Z</FinishTime>\\n <Suggestion>pass</Suggestion>\\n <CoverImageCensorResults>\\n <Object>test/ai/censor/v2/vme-****.jpg</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>example-Bucket-****</Bucket>\\n <Results>\\n <Suggestion>pass</Suggestion>\\n <Label>normal</Label>\\n <Scene>live</Scene>\\n <Rate>100</Rate>\\n </Results>\\n </CoverImageCensorResults>\\n <State>Success</State>\\n <TitleCensorResult>\\n <Suggestion>block</Suggestion>\\n <Label>meaningless</Label>\\n <Scene>Antispam</Scene>\\n <Rate>99.91</Rate>\\n </TitleCensorResult>\\n <Message>The resource operated cannot be found</Message>\\n <Input>\\n <Object>test/ai/censor/test-****.mp4</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>bucket-test-in-****</Bucket>\\n </Input>\\n <BarrageCensorResult>\\n <Suggestion>pass</Suggestion>\\n <Label>normal</Label>\\n <Scene>antispam</Scene>\\n <Rate>99.91</Rate>\\n </BarrageCensorResult>\\n <DescCensorResult>\\n <Suggestion>pass</Suggestion>\\n <Label>ad</Label>\\n <Scene>antispam</Scene>\\n <Rate>100</Rate>\\n </DescCensorResult>\\n <VideoCensorConfig>\\n <OutputFile>\\n <Object>output{Count}.jpg</Object>\\n <Location>oss-cn-shanghai</Location>\\n <Bucket>test-bucket-****</Bucket>\\n </OutputFile>\\n <VideoCensor>true</VideoCensor>\\n <BizType>common</BizType>\\n </VideoCensorConfig>\\n <JobId>f8f166eea7a44e9bb0a4aecf9543****</JobId>\\n <UserData>example userdata ****</UserData>\\n <Code>InvalidParameter.ResourceNotFound</Code>\\n <VensorCensorResult>\\n <VideoTimelines>\\n <Timestamp>00:02:59.999</Timestamp>\\n <Object>output{Count}.jpg</Object>\\n <CensorResults>\\n <Suggestion>block</Suggestion>\\n <Label>normal</Label>\\n <Scene>pron</Scene>\\n <Rate>99.99</Rate>\\n </CensorResults>\\n </VideoTimelines>\\n <NextPageToken>ea04afcca7cd4e80b9ece8fbb251****</NextPageToken>\\n <CensorResults>\\n <Suggestion>review</Suggestion>\\n <Label>meaningless</Label>\\n <Scene>terrorism</Scene>\\n <Rate>100</Rate>\\n </CensorResults>\\n </VensorCensorResult>\\n <PipelineId>c5b30b7c0d0e4a0abde1d5f9e751****</PipelineId>\\n </MediaCensorJobList>\\n <RequestId>D1D5C080-8E2F-5030-8AB4-13092F17631B</RequestId>\\n <NextPageToken>9b1a42bc6e8d46e6a1383b7e7f01****</NextPageToken>\\n <NonExistIds>78dc866518b843259669df58ed30****</NonExistIds>\\n</QueryMediaCensorJobListResponse>","errorExample":""}]', + 'title' => 'QueryMediaCensorJobList', + 'summary' => 'Queries content moderation jobs.', + 'description' => 'You can call this operation to query only the content moderation jobs within three months.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'ImAudit' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Images', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image URLs. You can specify up to 5 image URLs. The value must be a JSON array. To view the URLs of the images, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Media Management** > **Media List** in the left-side navigation pane. You must set at least one of the Images and Contents parameters. The image to be moderated must meet the following limits. Otherwise, the moderation task may fail.'."\n" + ."\n" + .'* The image size cannot exceed 20 MB, the height or width of the image cannot exceed 30,000 pixels, and the image cannot exceed 0.25 billion pixels.'."\n" + .'* We recommend that you upload images of at least 256 × 256 pixels to ensure required moderation result.', + 'type' => 'string', + 'required' => false, + 'example' => '["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"]', + ], + ], + [ + 'name' => 'Contents', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom text entries. You can specify up to 5 text entries. The value must be a JSON array. You must specify at least one of the Images and Contents parameters.', + 'type' => 'string', + 'required' => false, + 'example' => '\\["Hello","Who are you","Where am I"]'."\n", + ], + ], + [ + 'name' => 'Scenes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The moderation scenarios. Separate multiple scenarios with commas (,). For example, if you specify {"porn","terrorism"} for this parameter, both pornographic content detection and terrorist content detection are performed on the images and text. Valid values:'."\n" + ."\n" + .'* porn: pornography'."\n" + .'* terrorism: terrorist content'."\n" + .'* ad: ad violation'."\n" + .'* qrcode: QR code'."\n" + .'* live: undesirable scene'."\n" + .'* logo: special logo'."\n" + .'* antispam: text anti-spam (valid only for text)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '["porn","terrorism","ad"]', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business type. By default, the public business type is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139440480445****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TextQuotaExceed' => [ + 'description' => 'Indicates whether the text moderation QPS exceeds the limit. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ImageQuotaExceed' => [ + 'description' => 'Indicates whether the image moderation QPS exceeds the limit. Valid values: true and false. A value of true indicates that the QPS does not exceed the limit. A value of false indicates that the QPS exceeds the limit.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8793421', + ], + 'ImageResults' => [ + 'description' => 'The image moderation results. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. For more information about the parameters, see [Data returned by the ImAudit operation](~~268644~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The image moderation results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the image moderation results.'."\n", + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => 'The error code. The error code is the same as the HTTP status code. This parameter is not returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'dataId' => [ + 'description' => 'The ID of the moderated object.'."\n" + ."\n" + .'> If you set the dataId parameter in the moderation request, the dataId parameter is returned in the response.'."\n", + 'type' => 'string', + 'example' => 'uuid-1234-1234-1234', + ], + 'extras' => [ + 'description' => 'The additional information about the image. If ad is specified for the Scenes parameter, the following content may be returned for this parameter: hitLibInfo: the information about the custom text library that is hit by the text in the image. The value of this parameter is an array. For more information about the structure, see [hitLibInfo](~~268644~~).'."\n", + 'type' => 'object', + 'example' => '', + ], + 'msg' => [ + 'description' => 'The message that is returned for the request.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + 'results' => [ + 'description' => 'The returned data. If the call is successful, the array in the returned results contains one or more elements. Each element is a struct.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'The category of the moderation results. Valid values vary based on the specified moderation scenario.'."\n" + ."\n" + .'* If the Scenes parameter is set to porn, the valid values are:'."\n" + ."\n" + .' * normal: no pornographic content'."\n" + .' * sexy: sexy content'."\n" + .' * porn: pornographic content'."\n" + ."\n" + .'* If the Scenes parameter is set to terrorism, the valid values are:'."\n" + ."\n" + .' * normal: no pornographic content'."\n" + .' * bloody: bloody content'."\n" + .' * explosion: explosions and smoke'."\n" + .' * outfit: special costume'."\n" + .' * logo: special logo'."\n" + .' * weapon: weapon'."\n" + .' * politics: political content'."\n" + .' * violence: violence'."\n" + .' * crowd: crowd'."\n" + .' * parade: parade'."\n" + .' * carcrash: car accident'."\n" + .' * flag: flag'."\n" + .' * location: landmark'."\n" + .' * others: other content'."\n" + ."\n" + .'* If the Scenes parameter is set to ad, the valid values are:'."\n" + ."\n" + .' * normal: no pornographic content'."\n" + .' * ad: ad violation'."\n" + .' * politics: politically sensitive content in text'."\n" + .' * porn: pornographic content in text'."\n" + .' * abuse: abuse in text'."\n" + .' * terrorism: terrorist content in text'."\n" + .' * contraband: prohibited content in text'."\n" + .' * spam: junk content in text'."\n" + .' * npx: illegal ad'."\n" + .' * qrcode: QR code'."\n" + .' * programCode: mini program code'."\n" + ."\n" + .'* If the Scenes parameter is set to qrcode, the valid values are:'."\n" + ."\n" + .' * normal: no pornographic content'."\n" + .' * qrcode: QR code'."\n" + .' * programCode: mini program code'."\n" + ."\n" + .'* If the Scenes parameter is set to live, the valid values are:'."\n" + ."\n" + .' * normal: no pornographic content'."\n" + .' * meaningless: no content in the image, such as black or white screen'."\n" + .' * PIP: picture-in-picture'."\n" + .' * smoking: smoking'."\n" + .' * drivelive: live broadcasting in a running vehicle'."\n" + ."\n" + .'* If the Scenes parameter is set to logo, the valid values are:'."\n" + ."\n" + .' * normal: no pornographic content'."\n" + .' * TV: controlled logo'."\n" + .' * trademark: trademark'."\n", + 'type' => 'string', + 'example' => 'sexy', + ], + 'Rate' => [ + 'description' => 'The score of the confidence level. Valid values: 0 to 100. A greater value indicates a higher confidence level. If a value of pass is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content is normal. If a value of review or block is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content contains violations.'."\n" + ."\n" + .'> This score is for reference only. We strongly recommend that you do not use this score in your business. We recommend that you use the values that are returned for the suggestion, label, and sublabel parameters to determine whether the content contains violations. The sublabel parameter is returned by some operations.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '91.54', + ], + 'Scene' => [ + 'description' => 'The image moderation scenario. Valid values:'."\n" + ."\n" + .'* porn: pornography'."\n" + .'* terrorism: terrorist content'."\n" + .'* ad: ad violation'."\n" + .'* qrcode: QR code'."\n" + .'* live: undesirable scene'."\n" + .'* logo: special logo'."\n", + 'type' => 'string', + 'example' => 'porn', + ], + 'Suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* pass: The content passes the moderation. No further actions are required.'."\n" + .'* review: The moderation object contains suspected violations and requires human review.'."\n" + .'* block: The moderation object contains violations. We recommend that you delete or block the object.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'hintWordsInfo' => [ + 'description' => 'The information about the term hit by the ad or violation text detected in the moderated image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'hintWordsInfo'."\n", + 'type' => 'object', + 'properties' => [ + 'context' => [ + 'description' => 'The term hit by the detected text.'."\n", + 'type' => 'string', + 'example' => 'Sensitive words'."\n", + ], + ], + ], + ], + 'qrcodeData' => [ + 'description' => 'The information about the text that is included in the QR code detected in the moderated image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The text included in the QR code.'."\n", + 'type' => 'string', + 'example' => '"http://example.com/01ZZOliO"', + ], + ], + 'qrcodeLocations' => [ + 'description' => 'The coordinates of the QR code detected in the image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'qrcodeLocation'."\n", + 'type' => 'object', + 'properties' => [ + 'x' => [ + 'description' => 'The distance between the upper-left corner of the QR code area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '11', + ], + 'y' => [ + 'description' => 'The distance between the upper-left corner of the QR code area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'w' => [ + 'description' => 'The width of the QR code area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '402.0', + ], + 'h' => [ + 'description' => 'The height of the QR code area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '413.0', + ], + 'qrcode' => [ + 'description' => 'The URL that the detected QR code points to.'."\n", + 'type' => 'string', + 'example' => 'http://xxx', + ], + ], + ], + ], + 'programCodeData' => [ + 'description' => 'The location information of the mini program code detected in the moderated image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mini program codes.'."\n", + 'type' => 'object', + 'properties' => [ + 'x' => [ + 'description' => 'The distance between the upper-left corner of the mini program code area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '11.0', + ], + 'y' => [ + 'description' => 'The distance between the upper-left corner of the mini program code area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'w' => [ + 'description' => 'The width of the mini program code area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '402.0', + ], + 'h' => [ + 'description' => 'The height of the mini program code area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '413.0', + ], + ], + ], + ], + 'logoData' => [ + 'description' => 'The information about the logo detected in the moderated image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detected logos.'."\n", + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the detected logo. For example, a value of TV indicates a controlled media logo.'."\n", + 'type' => 'string', + 'example' => 'TV', + ], + 'name' => [ + 'description' => 'The name of the detected logo.'."\n", + 'type' => 'string', + 'example' => 'Hunan TV'."\n", + ], + 'x' => [ + 'description' => 'The distance between the upper-left corner of the logo area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '140', + ], + 'y' => [ + 'description' => 'The distance between the upper-left corner of the logo area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '68', + ], + 'w' => [ + 'description' => 'The width of the logo area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '106', + ], + 'h' => [ + 'description' => 'The height of the logo area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '106', + ], + ], + ], + ], + 'sfaceData' => [ + 'description' => 'The information about the terrorist content detected in the moderated image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detected terrorist content.'."\n", + 'type' => 'object', + 'properties' => [ + 'x' => [ + 'description' => 'The distance between the upper-left corner of the face area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '49', + ], + 'y' => [ + 'description' => 'The distance between the upper-left corner of the face area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '39', + ], + 'w' => [ + 'description' => 'The width of the face area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '47', + ], + 'h' => [ + 'description' => 'The height of the face area. Unit: pixel.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '121', + ], + 'faces' => [ + 'description' => 'The information about the face detected in the moderated image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the face detected in the moderated image.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'This value is a string, which indicates the name of a similar person.'."\n", + 'type' => 'string', + 'example' => 'Name'."\n", + ], + 're' => [ + 'description' => 'The score of the confidence level. The value is a float point number. Valid values: 0 to 100. A greater value indicates a higher confidence level for facial recognition.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '91.54', + ], + 'idid' => [ + 'description' => 'The ID of the detected face. The value is a string.'."\n", + 'type' => 'string', + 'example' => 'AliFace_0001234', + ], + ], + ], + ], + ], + ], + ], + 'ocrData' => [ + 'description' => 'ocrData'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the complete text detected in the moderated image.'."\n", + 'type' => 'string', + 'example' => 'Detection result'."\n", + ], + ], + 'frames' => [ + 'description' => 'If the temporary access URL of the image is too long, a truncated temporary access URL is returned for each frame.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'frame'."\n", + 'type' => 'object', + 'properties' => [ + 'rate' => [ + 'description' => 'The score of the confidence level. Valid values: 0 to 100. A higher confidence level indicates higher reliability of the moderation result. We recommend that you do not use this score in your business.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '89.85', + ], + 'url' => [ + 'description' => 'The temporary access URL of the truncated frame. The URL is valid for 5 minutes.'."\n", + 'type' => 'string', + 'example' => 'http://example.com/test-01.jpg', + ], + ], + ], + ], + ], + ], + ], + 'taskId' => [ + 'description' => 'The ID of the moderation task.'."\n", + 'type' => 'string', + 'example' => 'img4wlJcb7p4wH4lAP3111111-12****', + ], + 'url' => [ + 'description' => 'The URL of the moderated object.'."\n", + 'type' => 'string', + 'example' => 'http://example.com/example-****.jpg', + ], + ], + ], + ], + ], + ], + 'TextResults' => [ + 'description' => 'The text moderation results. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. For more information about the parameters, see [Data returned by the ImAudit operation](~~268644~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The text moderation results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the text moderation results.'."\n", + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => 'The error code. The error code is the same as the HTTP status code. For more information, see [Error codes](~~29254~~).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'content' => [ + 'description' => 'The text that you specify in the moderation request.'."\n", + 'type' => 'string', + 'example' => 'This is test text.'."\n", + ], + 'dataId' => [ + 'description' => 'The sequence number of the text.'."\n", + 'type' => 'string', + 'example' => 'cfd33235-71a4-468b-8137-a5ffe323****', + ], + 'msg' => [ + 'description' => 'The message that is returned for the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'results' => [ + 'description' => 'The returned data. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. Each element is a struct.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'details' => [ + 'description' => 'The risky content that the moderated text hits. A text entry can hit multiple pieces of risky content.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the risky content that the moderated text hits.'."\n", + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'The category of the risky content that the moderated text hits. Valid values:'."\n" + ."\n" + .'* spam: spam'."\n" + .'* ad: ad'."\n" + .'* politics: political content'."\n" + .'* terrorism: terrorist content'."\n" + .'* abuse: abuse'."\n" + .'* porn: pornographic content'."\n" + .'* flood: excessive junk content'."\n" + .'* contraband: prohibited content'."\n" + .'* meaningless: meaningless content'."\n" + .'* customized: custom content, such as a custom keyword'."\n", + 'type' => 'string', + 'example' => 'porn', + ], + 'contexts' => [ + 'description' => 'The context information of the risky content that the moderated text hits.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The context information of the risky content that the moderated text hits.'."\n", + 'type' => 'object', + 'properties' => [ + 'context' => [ + 'description' => 'The term that the moderated text hits. If the text hits a term, the term is returned. If the text hits the algorithmic model, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'Door-to-door service'."\n", + ], + 'positions' => [ + 'description' => 'The position of the term that the moderated text hits in the original text.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The position of the term that the moderated text hits in the original text.'."\n", + 'type' => 'string', + 'example' => '{"startPos":1, "endPos":10}', + ], + ], + 'libName' => [ + 'description' => 'The name of the custom text library. This parameter is returned if the moderated text hits a term in the custom text library.'."\n", + 'type' => 'string', + 'example' => 'Name of your custom text library'."\n", + ], + 'libCode' => [ + 'description' => 'The code of the custom text library. This parameter is returned if the moderated text hits a term in the custom text library.'."\n", + 'type' => 'string', + 'example' => '123456', + ], + 'ruleType' => [ + 'description' => 'The behavior rule. This parameter is returned if the moderated text hits the behavior rule. Valid values:'."\n" + ."\n" + .'* user_id'."\n" + .'* ip'."\n" + .'* umid'."\n" + .'* content'."\n" + .'* similar_content'."\n" + .'* imei'."\n" + .'* imsi'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + ], + ], + ], + ], + ], + ], + 'label' => [ + 'description' => 'The category of the moderation result for the moderated text. Valid values:'."\n" + ."\n" + .'* normal: normal content'."\n" + .'* spam: spam'."\n" + .'* ad: ad'."\n" + .'* politics: political content'."\n" + .'* terrorism: terrorist content'."\n" + .'* abuse: abuse'."\n" + .'* porn: pornographic content'."\n" + .'* flood: excessive junk content'."\n" + .'* contraband: prohibited content'."\n" + .'* meaningless: meaningless content'."\n" + .'* customized: custom content, such as a custom keyword'."\n", + 'type' => 'string', + 'example' => 'porn', + ], + 'rate' => [ + 'description' => 'The score of the confidence level. Valid values: 0 to 100. A greater value indicates a higher confidence level. If a value of pass is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content is normal. If a value of review or block is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content contains violations.'."\n" + ."\n" + .'> This score is for reference only. We strongly recommend that you do not use this score in your business. We recommend that you use the values that are returned for the suggestion, label, and sublabel parameters to determine whether the content contains violations. The sublabel parameter is returned by some operations.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '99.90', + ], + 'scene' => [ + 'description' => 'The moderation scenario.'."\n", + 'type' => 'string', + 'example' => 'antispam', + ], + 'suggestion' => [ + 'description' => 'The recommended subsequent operation. Valid values:'."\n" + ."\n" + .'* pass: The content passes the moderation.'."\n" + .'* review: The content needs to be manually reviewed again.'."\n" + .'* block: The content contains violations. We recommend that you delete or block the content.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + ], + ], + ], + 'taskId' => [ + 'description' => 'The ID of the moderation task.'."\n", + 'type' => 'string', + 'example' => 'txt6HB8NQoEbU@5fosnj2xVEM-1t****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TextQuotaExceed\\": false,\\n \\"ImageQuotaExceed\\": false,\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8793421\\",\\n \\"ImageResults\\": {\\n \\"result\\": [\\n {\\n \\"code\\": 200,\\n \\"dataId\\": \\"uuid-1234-1234-1234\\",\\n \\"extras\\": {\\n \\"hitLibInfo\\": [\\n {\\n \\"context\\": \\"检测视频\\",\\n \\"libCode\\": \\"1234567\\",\\n \\"libName\\": \\"相似文本库a\\"\\n }\\n ]\\n },\\n \\"msg\\": \\"ok\\",\\n \\"results\\": [\\n {\\n \\"Label\\": \\"sexy\\",\\n \\"Rate\\": 91.54,\\n \\"Scene\\": \\"porn\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"hintWordsInfo\\": [\\n {\\n \\"context\\": \\"敏感词\\"\\n }\\n ],\\n \\"qrcodeData\\": [\\n \\"\\\\\\"http://example.com/01ZZOliO\\\\\\"\\"\\n ],\\n \\"qrcodeLocations\\": [\\n {\\n \\"x\\": 11,\\n \\"y\\": 0,\\n \\"w\\": 402,\\n \\"h\\": 413,\\n \\"qrcode\\": \\"http://xxx\\"\\n }\\n ],\\n \\"programCodeData\\": [\\n {\\n \\"x\\": 11,\\n \\"y\\": 0,\\n \\"w\\": 402,\\n \\"h\\": 413\\n }\\n ],\\n \\"logoData\\": [\\n {\\n \\"type\\": \\"TV\\",\\n \\"name\\": \\"湖南台\\",\\n \\"x\\": 140,\\n \\"y\\": 68,\\n \\"w\\": 106,\\n \\"h\\": 106\\n }\\n ],\\n \\"sfaceData\\": [\\n {\\n \\"x\\": 49,\\n \\"y\\": 39,\\n \\"w\\": 47,\\n \\"h\\": 121,\\n \\"faces\\": [\\n {\\n \\"name\\": \\"命中人名\\",\\n \\"re\\": 91.54,\\n \\"idid\\": \\"AliFace_0001234\\"\\n }\\n ]\\n }\\n ],\\n \\"ocrData\\": [\\n \\"识别结果\\"\\n ],\\n \\"frames\\": [\\n {\\n \\"rate\\": 89.85,\\n \\"url\\": \\"http://example.com/test-01.jpg\\"\\n }\\n ]\\n }\\n ],\\n \\"taskId\\": \\"img4wlJcb7p4wH4lAP3111111-12****\\",\\n \\"url\\": \\"http://example.com/example-****.jpg\\"\\n }\\n ]\\n },\\n \\"TextResults\\": {\\n \\"result\\": [\\n {\\n \\"code\\": 200,\\n \\"content\\": \\"这是一段测试文本\\",\\n \\"dataId\\": \\"cfd33235-71a4-468b-8137-a5ffe323****\\",\\n \\"msg\\": \\"OK\\",\\n \\"results\\": [\\n {\\n \\"details\\": [\\n {\\n \\"Label\\": \\"porn\\",\\n \\"contexts\\": [\\n {\\n \\"context\\": \\"上门服务\\",\\n \\"positions\\": [\\n \\"{\\\\\\"startPos\\\\\\":1, \\\\\\"endPos\\\\\\":10}\\"\\n ],\\n \\"libName\\": \\"您自定义的词库名称\\",\\n \\"libCode\\": \\"123456\\",\\n \\"ruleType\\": \\"ip\\"\\n }\\n ]\\n }\\n ],\\n \\"label\\": \\"porn\\",\\n \\"rate\\": 99.9,\\n \\"scene\\": \\"antispam\\",\\n \\"suggestion\\": \\"block\\"\\n }\\n ],\\n \\"taskId\\": \\"txt6HB8NQoEbU@5fosnj2xVEM-1t****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ImAuditResponse>\\n <TextQuotaExceed>false</TextQuotaExceed>\\n <ImageQuotaExceed>false</ImageQuotaExceed>\\n <RequestId>5210DBB0-E327-4D45-ADBC-0B83C8793421</RequestId>\\n <ImageResults>\\n <result>\\n <code>200</code>\\n <dataId>uuid-1234-1234-1234</dataId>\\n <msg>ok</msg>\\n <results>\\n <Label>sexy</Label>\\n <Rate>91.54</Rate>\\n <Scene>porn</Scene>\\n <Suggestion>block</Suggestion>\\n </results>\\n <taskId>img4wlJcb7p4wH4lAP3111111-12****</taskId>\\n <url>http://example.com/example-****.jpg</url>\\n </result>\\n </ImageResults>\\n <TextResults>\\n <result>\\n <code>200</code>\\n <content>这是一段测试文本</content>\\n <dataId>cfd33235-71a4-468b-8137-a5ffe323****</dataId>\\n <msg>OK</msg>\\n <results>\\n <details>\\n <Label>porn</Label>\\n </details>\\n <label>porn</label>\\n <rate>99.9</rate>\\n <scene>antispam</scene>\\n <suggestion>block</suggestion>\\n </results>\\n <taskId>txt6HB8NQoEbU@5fosnj2xVEM-1t****</taskId>\\n </result>\\n </TextResults>\\n</ImAuditResponse>","errorExample":""}]', + 'title' => 'ImAudit', + 'summary' => 'Reviews images and text and returns the review results.', + 'description' => '* The moderation results are synchronously returned after the moderation is complete.'."\n" + .'* You can use the image and text moderation feature only in the China (Beijing), China (Shanghai), and Singapore regions.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'SubmitFpShotJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URL of the job input. The value is a JSON object. You can query the OSS URL in the OSS or MPS console.'."\n" + ."\n" + .'> The OSS bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue. This ID can be used to associate the job with a notification method. To view the ID of the MPS queue, perform the following steps: Log on to the **MPS console**. In the left-side navigation pane, choose **Global Settings** > **Pipelines**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'FpShotConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configurations of the media fingerprint analysis job. The value is a JSON object. For more information, see the "FpShotConfig" section of the [Parameter details](~~93568~~) topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "PrimaryKey": "12345****",'."\n" + .' "SaveType": "save",'."\n" + .' "FpDBId": "417f2ada5999daf****"'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The value can be up to 128 bytes in length and cannot start with a special character.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testid-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobId' => [ + 'description' => 'The ID of the media fingerprint analysis job. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '2a0697e35a7342859f733a9190c4****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"2a0697e35a7342859f733a9190c4****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitFpShotJobResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <JobId>2a0697e35a7342859f733a9190c4****</JobId>\\n</SubmitFpShotJobResponse>","errorExample":""}]', + 'title' => 'SubmitFpShotJob', + 'summary' => 'Submits a media fingerprint analysis job to query the media fingerprint repository for a media file with the identical or similar fingerprint as the input file.', + 'description' => '* You can call this operation to submit a video, audio, image, or text fingerprint analysis job.'."\n" + ."\n" + .'* This operation asynchronously submits a job. The query results may not have been generated when the response is returned. After the results are generated, an asynchronous message is returned.'."\n" + ."\n" + .'* You can submit a text fingerprint analysis job only in the China (Shanghai) region.'."\n" + ."\n" + .'* The input file of the job must be in one of the following formats:'."\n" + ."\n" + .' * Image formats: JPEG, PNG, and BMP.'."\n" + .' * Video formats: MP4, AVI, MKV, MPG, TS, MOV, FLV, MXF.'."\n" + .' * Video encoding formats: MPEG2, MPEG4, H264, HEVC, and WMV.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 150 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Asynchronous notification parameters**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|:---|:---|:---|'."\n" + .'|Type|String|The type of the message.|'."\n" + .'|FpShotJobNotify|AliyunFpShotJobNotify|The notification of the results of the media fingerprint analysis job. For more information, see the "AliyunFpShotJobNotify" section of the [Data types](~~29251~~) topic.|'."\n" + .'|UserData|String|The custom data.|', + 'extraInfo' => ' ', + ], + 'QueryFpShotJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media fingerprint analysis job that you want to query. To view the job ID, log on to the [ApsaraVideo Media Processing (MPS) console](https://mps.console.aliyun.com/overview), click **Tasks** in the left-side navigation pane, and then click the **Video DNA** tab on the Tasks page. You can query up to 10 media fingerprint analysis jobs at a time. Separate multiple job IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of the query results. You do not need to specify this parameter in the first request. The response to the first request contains this parameter, which you add to the next request.', + 'type' => 'string', + 'required' => false, + 'example' => '16f01ad6175e4230ac42bb5182cd****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return on each page. '."\n" + ."\n" + .'* Default value: **10**.'."\n" + .'* Valid values: **1 to 100**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the jobs to be queried. Valid values:'."\n" + ."\n" + .'* **All**: all jobs.'."\n" + .'* **Queuing**: the jobs that are being queued.'."\n" + .'* **Analysing**: the jobs that are in progress.'."\n" + .'* **Fail**: failed jobs.'."\n" + .'* **Success**: successful jobs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'default' => 'All', + ], + ], + [ + 'name' => 'StartOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range within which the jobs to be queried were created. '."\n" + ."\n" + .'* Specify the time in the ISO 8601 standard in the'."\n" + .'* YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-22T03:48:05Z', + ], + ], + [ + 'name' => 'EndOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range within which the jobs to be queried were created. '."\n" + ."\n" + .'* Specify the time in the ISO 8601 standard in the'."\n" + .'* YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-14T02:16:07Z', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MPS queue. To view the ID of the MPS queue, log on to the [MPS console](https://mps.console.aliyun.com/overview) and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'b11c171cced04565b1f38f1ecc39**** ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'NextPageToken' => [ + 'description' => 'The token that is used to retrieve the next page of the query results. The value is a 32-bit UUID. If the returned query results cannot be displayed within one page, this parameter is returned. The value of this parameter is updated for each query.'."\n", + 'type' => 'string', + 'example' => 'b11c171cced04565b1f38f1ecc39****', + ], + 'FpShotJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShotJob' => [ + 'description' => 'The information about media fingerprint analysis jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of media fingerprint analysis jobs.'."\n", + 'type' => 'object', + 'properties' => [ + 'FpShotResult' => [ + 'description' => 'The results of the media fingerprint analysis job.'."\n", + 'type' => 'object', + 'properties' => [ + 'AudioFpShots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShot' => [ + 'description' => 'The audio fingerprint analysis results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the audio fingerprint analysis results.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => 'The unique primary key of the input audio.'."\n", + 'type' => 'string', + 'example' => '498ac941373341599c4777c8d884****', + ], + 'FpShotSlices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShotSlice' => [ + 'description' => 'The audio files that have similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of audio files that have similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duplication' => [ + 'description' => 'The start point in time and duration of the similar audio clip in the audio file that has similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start point in time of the similar audio clip in the audio file that has similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The duration of the similar audio clip in the audio file that has similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + ], + 'Similarity' => [ + 'description' => 'The similarity of the input audio against the audio file that has similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Input' => [ + 'description' => 'The start point in time and duration of the similar audio clip in the input audio.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start point in time of the similar audio clip in the input audio.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The duration of the similar audio clip in the input audio.'."\n", + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + 'Similarity' => [ + 'description' => 'The overall similarity of the input audio against audio files that have similar fingerprints to the input audio in the audio fingerprint library.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'FpShots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShot' => [ + 'description' => 'The video fingerprint analysis results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the video fingerprint analysis results.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => 'The unique primary key of the input video.'."\n", + 'type' => 'string', + 'example' => '498ac941373341599c4777c8d884****', + ], + 'FpShotSlices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShotSlice' => [ + 'description' => 'The video files that have similar fingerprints to the input video in the video fingerprint library.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of video files that have similar fingerprints to the input video in the video fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Duplication' => [ + 'description' => 'The start point in time and duration of the similar video clip in the video file that has similar fingerprints to the input video in the video fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start point in time of the similar video clip in the video file that has similar fingerprints to the input video in the video fingerprint library.'."\n", + 'type' => 'string', + 'example' => '1260', + ], + 'Duration' => [ + 'description' => 'The duration of the similar video clip in the video file that has similar fingerprints to the input video in the video fingerprint library.'."\n", + 'type' => 'string', + 'example' => '48', + ], + ], + ], + 'Similarity' => [ + 'description' => 'The similarity of the input video clip against the video file that has similar fingerprints to the input video in the video fingerprint library.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Input' => [ + 'description' => 'The start time and duration of the similar video clip in the input video.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start point in time of the similar video clip in the input video.'."\n", + 'type' => 'string', + 'example' => '46', + ], + 'Duration' => [ + 'description' => 'The duration of the similar video clip in the input video.'."\n", + 'type' => 'string', + 'example' => '48', + ], + ], + ], + ], + ], + ], + ], + ], + 'Similarity' => [ + 'description' => 'The overall similarity of the input video against video files that have similar fingerprints to the input video in the video fingerprint library.'."\n" + ."\n" + .'> The overall similarity is the average value of the similarities of the input video clips with the clips of the video that has a similar fingerprint. If multiple video files that have similar fingerprints to the input video exist in the video fingerprint library, the similarities of the input video against multiple similar video clips are returned.'."\n", + 'type' => 'string', + 'example' => '0.8914769887924194', + ], + ], + ], + ], + ], + ], + 'TextFpShots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TextFpShot' => [ + 'description' => 'The text fingerprint analysis results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the text fingerprint analysis results.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => 'The unique primary key of the input text.'."\n", + 'type' => 'string', + 'example' => '3e34ac649945b53a1b0f863ce030****', + ], + 'Similarity' => [ + 'description' => 'The similarity of the input text against text snippets that have similar fingerprints to the input text in the text fingerprint library.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'TextFpShotSlices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TextFpShotSlice' => [ + 'description' => 'The text snippets that have similar fingerprints to the input text in the text fingerprint library.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of text snippets that have similar fingerprints to the input text in the text fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Similarity' => [ + 'description' => 'The similarity of the input text against the text snippet that has similar fingerprints to the input text in the text fingerprint library.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'InputText' => [ + 'description' => 'The input text for text fingerprint analysis.'."\n", + 'type' => 'string', + 'example' => 'It\'s snowy today.'."\n", + ], + 'DuplicationText' => [ + 'description' => 'The text snippet that has similar fingerprints to the input text in the text fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'It\'s snowy today.'."\n", + ], + 'InputFragment' => [ + 'description' => 'The start point in time and duration of the similar text snippet in the input text.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start time of the similar text snippet in the input text.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The duration of the similar text snippet in the input text.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2017-01-10T12:00:00Z', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'State' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* **Queuing**: The job is waiting in the queue.'."\n" + .'* **Analysing**: The job is in progress.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The parameter \\"Id\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long', + ], + 'FpShotConfig' => [ + 'description' => 'The configurations of the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => 'The unique primary key of the video.'."\n", + 'type' => 'string', + 'example' => '3ca84a39a9024f19853b21be9cf9****', + ], + 'SaveType' => [ + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'* **nosave**: The fingerprints of the job input are not saved to the media fingerprint library.'."\n" + .'* **save**: The fingerprints of the job input are saved to the media fingerprint library only if the job input is not duplicated with media content in the media fingerprint library.'."\n" + .'* **forcesave**: The fingerprints of the job input are forcibly saved to the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'save', + ], + 'FpDBId' => [ + 'description' => 'The ID of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'FileId' => [ + 'description' => 'The ID of the uploaded file.'."\n", + 'type' => 'string', + 'example' => 'ebb51ee30f0b49aba959823fa991****', + ], + 'UserData' => [ + 'description' => 'The custom data.'."\n", + 'type' => 'string', + 'example' => 'testid-001', + ], + 'Duration' => [ + 'description' => 'The length of the input file.'."\n" + .'Unit: seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter.UUIDFormatInvalid', + ], + 'InputFile' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The Object Storage Service (OSS) object that is used as the job input.'."\n", + 'type' => 'string', + 'example' => 'test.mp4', + ], + 'Location' => [ + 'description' => 'The OSS region in which the job input resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-beijing', + ], + 'Bucket' => [ + 'description' => 'The OSS bucket in which the job input resides.'."\n", + 'type' => 'string', + 'example' => 'oss-test', + ], + ], + ], + 'PipelineId' => [ + 'description' => 'The ID of the MPS queue to which the analysis job is submitted.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Id' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Input' => [ + 'description' => 'The information about the job input.'."\n", + 'type' => 'string', + 'example' => '{"Bucket":"oss-test","Location":"oss-cn-beijing","Object":"test.mp4"}', + ], + ], + ], + ], + ], + ], + 'NonExistIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of the jobs that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the jobs that do not exist. This parameter is not returned if all specified jobs are found.'."\n", + 'type' => 'string', + 'example' => 'ae687c02fe944327ba9631e50da23128****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NextPageToken\\": \\"b11c171cced04565b1f38f1ecc39****\\",\\n \\"FpShotJobList\\": {\\n \\"FpShotJob\\": [\\n {\\n \\"FpShotResult\\": {\\n \\"AudioFpShots\\": {\\n \\"FpShot\\": [\\n {\\n \\"PrimaryKey\\": \\"498ac941373341599c4777c8d884****\\",\\n \\"FpShotSlices\\": {\\n \\"FpShotSlice\\": [\\n {\\n \\"Duplication\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"3\\"\\n },\\n \\"Similarity\\": \\"0\\",\\n \\"Input\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"5\\"\\n }\\n }\\n ]\\n },\\n \\"Similarity\\": \\"0\\"\\n }\\n ]\\n },\\n \\"FpShots\\": {\\n \\"FpShot\\": [\\n {\\n \\"PrimaryKey\\": \\"498ac941373341599c4777c8d884****\\",\\n \\"FpShotSlices\\": {\\n \\"FpShotSlice\\": [\\n {\\n \\"Duplication\\": {\\n \\"Start\\": \\"1260\\",\\n \\"Duration\\": \\"48\\"\\n },\\n \\"Similarity\\": \\"0\\",\\n \\"Input\\": {\\n \\"Start\\": \\"46\\",\\n \\"Duration\\": \\"48\\"\\n }\\n }\\n ]\\n },\\n \\"Similarity\\": \\"0.8914769887924194\\"\\n }\\n ]\\n },\\n \\"TextFpShots\\": {\\n \\"TextFpShot\\": [\\n {\\n \\"PrimaryKey\\": \\"3e34ac649945b53a1b0f863ce030****\\",\\n \\"Similarity\\": \\"1.0\\",\\n \\"TextFpShotSlices\\": {\\n \\"TextFpShotSlice\\": [\\n {\\n \\"Similarity\\": \\"1.0\\",\\n \\"InputText\\": \\"今天下雪了\\",\\n \\"DuplicationText\\": \\"今天下雪了\\",\\n \\"InputFragment\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"3\\"\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"CreationTime\\": \\"2017-01-10T12:00:00Z\\",\\n \\"FinishTime\\": \\"0\\",\\n \\"State\\": \\"Success\\",\\n \\"Message\\": \\"The parameter \\\\\\\\\\\\\\"Id\\\\\\\\\\\\\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long\\",\\n \\"FpShotConfig\\": {\\n \\"PrimaryKey\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"SaveType\\": \\"save\\",\\n \\"FpDBId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\"\\n },\\n \\"FileId\\": \\"ebb51ee30f0b49aba959823fa991****\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Duration\\": 5,\\n \\"Code\\": \\"InvalidParameter.UUIDFormatInvalid\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"test.mp4\\",\\n \\"Location\\": \\"oss-cn-beiing\\",\\n \\"Bucket\\": \\"oss-test\\"\\n },\\n \\"PipelineId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Id\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Input\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"oss-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-beiing\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"test.mp4\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"ae687c02fe944327ba9631e50da23128****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryFpShotJobListResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <FpShotJobList>\\n <FpShotResult>\\n <AudioFpShots>\\n <PrimaryKey>498ac941373341599c4777c8d884****</PrimaryKey>\\n <FpShotSlices>\\n <Duplication>\\n <Start>0</Start>\\n <Duration>3</Duration>\\n </Duplication>\\n <Similarity>0</Similarity>\\n <Input>\\n <Start>0</Start>\\n <Duration>5</Duration>\\n </Input>\\n </FpShotSlices>\\n <Similarity>0</Similarity>\\n </AudioFpShots>\\n <FpShots>\\n <PrimaryKey>498ac941373341599c4777c8d884****</PrimaryKey>\\n <FpShotSlices>\\n <Duplication>\\n <Start>1260</Start>\\n <Duration>48</Duration>\\n </Duplication>\\n <Similarity>0</Similarity>\\n <Input>\\n <Start>46</Start>\\n <Duration>48</Duration>\\n </Input>\\n </FpShotSlices>\\n <Similarity>0.8914769887924194</Similarity>\\n </FpShots>\\n <TextFpShots>\\n <PrimaryKey>3e34ac649945b53a1b0f863ce030****</PrimaryKey>\\n <Similarity>1.0</Similarity>\\n <TextFpShotSlices>\\n <Similarity>1.0</Similarity>\\n <InputText>今天下雪了</InputText>\\n <DuplicationText>今天下雪了</DuplicationText>\\n <InputFragment>\\n <Start>0</Start>\\n <Duration>3</Duration>\\n </InputFragment>\\n </TextFpShotSlices>\\n </TextFpShots>\\n </FpShotResult>\\n <CreationTime>2017-01-10T12:00:00Z</CreationTime>\\n <FinishTime>0</FinishTime>\\n <State>Success</State>\\n <Message>The parameter \\\\\\"Id\\\\\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long</Message>\\n <FpShotConfig>\\n <PrimaryKey>3ca84a39a9024f19853b21be9cf9****</PrimaryKey>\\n <SaveType>save</SaveType>\\n <FpDBId>2288c6ca184c0e47098a5b665e2a12****</FpDBId>\\n </FpShotConfig>\\n <FileId>ebb51ee30f0b49aba959823fa991****</FileId>\\n <UserData>testid-001</UserData>\\n <Code>InvalidParameter.UUIDFormatInvalid</Code>\\n <InputFile>\\n <Object>test.mp4</Object>\\n <Location>oss-cn-beiing</Location>\\n <Bucket>oss-test</Bucket>\\n </InputFile>\\n <PipelineId>88c6ca184c0e47098a5b665e2a12****</PipelineId>\\n <Id>88c6ca184c0e47098a5b665e2a12****</Id>\\n <Input>{\\"Bucket\\":\\"oss-test\\",\\"Location\\":\\"oss-cn-beiing\\",\\"Object\\":\\"test.mp4\\"}</Input>\\n </FpShotJobList>\\n <NonExistIds>ae687c02fe944327ba9631e50da23128****</NonExistIds>\\n</QueryFpShotJobListResponse>","errorExample":""}]', + 'title' => 'QueryFpShotJobList', + 'summary' => 'Queries media fingerprint analysis jobs. You can call this operation to query video fingerprint analysis jobs and text fingerprint analysis jobs.', + 'description' => '* After a media fingerprint analysis job is submitted, the media fingerprinting service compares the fingerprints of the job input with those of the media files in the media fingerprint library. You can call this operation to query the job results.'."\n" + .'* You can query the results of a text fingerprint analysis job only in the China (Shanghai) region.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateFpShotDB' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the media fingerprint library.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'example name', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The model ID of the media fingerprint library. To create a text fingerprint library, set the parameter to **11**. To create a video fingerprint library, set the parameter to **12**. To create an audio fingerprint library, set the parameter to **13**. To create an image fingerprint library, set the parameter to **14**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '11', + 'default' => '12', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configurations of the media fingerprint library. By default, this parameter is left empty. You can customize the configurations based on your business requirements. The value must be a string in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the media fingerprint library.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'The library is a text fingerprint library.'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'FpShotDB' => [ + 'description' => 'The details of the media fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'The library is a text fingerprint library.'."\n", + ], + 'State' => [ + 'description' => 'The status of the media fingerprint library. After the media fingerprint library is created, it enters the **offline** state. After the media fingerprint library is processed at the backend, it enters the **active** state.'."\n", + 'type' => 'string', + 'example' => 'offline', + ], + 'Name' => [ + 'description' => 'The name of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'example-name-****', + ], + 'FpDBId' => [ + 'description' => 'The ID of the media fingerprint library. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'ModelId' => [ + 'description' => 'The model ID of the media fingerprint library.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Config' => [ + 'description' => 'The configurations of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"FpShotDB\\": {\\n \\"Description\\": \\"这是一个文本DNA库\\",\\n \\"State\\": \\"offline\\",\\n \\"Name\\": \\"example-name-****\\",\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"ModelId\\": 11,\\n \\"Config\\": \\"null\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateFpShotDBResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <FpShotDB>\\n <Description>这是一个文本DNA库</Description>\\n <State>offline</State>\\n <Name>example-name-****</Name>\\n <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>\\n <ModelId>11</ModelId>\\n <Config>null</Config>\\n </FpShotDB>\\n</CreateFpShotDBResponse>","errorExample":""}]', + 'title' => 'CreateFpShotDB', + 'summary' => 'Submits a job of creating a media fingerprint library.', + 'description' => '* You can call this operation to submit a job to create a video or text fingerprint library. You can use a text fingerprint library to store fingerprints for text.'."\n" + .'* You can submit a job of creating a text fingerprint library only in the China (Shanghai) region.'."\n" + .'* By default, you can submit up to 10 jobs of creating a video fingerprint library to an ApsaraVideo Media Processing (MPS) queue at a time. If you submit more than 10 jobs at a time, the call may fail.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'ListFpShotDB' => [ + 'summary' => 'Queries media fingerprint libraries.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmtsVN28MX', + 'FEATUREmtsVAD950', + 'FEATUREmtsQLY5GJ', + 'FEATUREmtsMX6OH3', + ], + ], + 'parameters' => [ + [ + 'name' => 'FpDBIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation. You can query up to 10 libraries at a time. Separate multiple library IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'FpShotDBList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShotDB' => [ + 'description' => 'The media fingerprint libraries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the media fingerprint library.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the media fingerprint library. Default value: **offline**. ****Valid values:'."\n" + ."\n" + .'* **offline**: The media fingerprint library is offline.'."\n" + .'* **active**: The media fingerprint library is online.'."\n" + .'* **paused**: The media fingerprint library is paused.'."\n" + .'* **deleted**: The media fingerprint library is deleted.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'Description' => [ + 'description' => 'The description of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'The library is a text fingerprint library.'."\n", + ], + 'Name' => [ + 'description' => 'The name of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => 'test-****', + ], + 'ModelId' => [ + 'description' => 'The model ID of the media fingerprint library. A value of **11** indicates that the library is a text fingerprint library. A value of **12** indicates that the library is a video fingerprint library. A value of **13** indicates that the library is an audio fingerprint library. A value of **14** indicates that the library is an image fingerprint library.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'FpDBId' => [ + 'description' => 'The ID of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'NonExistIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of the media fingerprint libraries that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the media fingerprint libraries that do not exist. If all the queried libraries exist, the response does not contain this parameter.'."\n", + 'type' => 'string', + 'example' => 'ae687c02fe944327ba9631e50da2****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FpShotDBList\\": {\\n \\"FpShotDB\\": [\\n {\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"这是一个文本DNA库\\",\\n \\"Name\\": \\"test-****\\",\\n \\"ModelId\\": 11,\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"ae687c02fe944327ba9631e50da2****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListFpShotDBResponse>\\n <FpShotDBList>\\n <Status>active</Status>\\n <Description>这是一个文本DNA库</Description>\\n <Name>test-****</Name>\\n <ModelId>11</ModelId>\\n <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>\\n </FpShotDBList>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <NonExistIds>ae687c02fe944327ba9631e50da2****</NonExistIds>\\n</ListFpShotDBResponse>","errorExample":""}]', + 'title' => 'ListFpShotDB', + 'description' => '* You can call this operation to query the status and information about the media fingerprint libraries based on the specified IDs.'."\n" + .'* You can query text fingerprint libraries only in the China (Shanghai) region.'."\n" + .'* You can call this operation to query up to 10 media fingerprint libraries.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 500 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'ImportFpShotJob' => [ + 'summary' => 'Submits a job of importing text files to a text fingerprint library.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Object Storage Service (OSS) URL of the text file to be imported to the text fingerprint library. The value must be a JSON object. Example: {"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.flv"}.'."\n" + ."\n" + .'> The OSS bucket must reside in the same region as your MPS service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{“Bucket”:”example-bucket”,“Location”:”oss-cn-shanghai”,“Object”:”example.txt”}', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue. To view the ID of the MPS queue, perform the following steps: Log on to the **MPS console**. In the left-side navigation pane, choose **Global Settings** > **Pipelines**. The MPS queue is associated with a specified Message Service (MNS) topic. You can submit jobs for different services to different MPS queues. If you do not specify this parameter, the job is submitted to the default MPS queue and no MNS topic is associated with the MPS queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ae687c02fe944327ba9631e50da2****', + ], + ], + [ + 'name' => 'FpImportConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job configurations. The value must be a JSON object. Example: `{"SaveType":"onlysave"}`. The `SaveType` field indicates the storage type. Valid values of the SaveType field:'."\n" + ."\n" + .'* **save**: The fingerprints of the text file are saved to the text fingerprint library only if the text file is not duplicated with content in the text fingerprint library.'."\n" + .'* **onlysave**: The fingerprints of the text file are saved to the text fingerprint library.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"SaveType":"onlysave"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user-defined data. The value can contain letters, digits, and special characters. The value can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '\\&UserData={"Chapter":"Ordinary\\*\\*\\*\\*/Ordinary\\*\\*\\*\\*Volume 2/Volume 2 Chapter 47.txt"}'."\n", + ], + ], + [ + 'name' => 'FpDBId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the text fingerprint library to which the text file is imported. You can specify only one job of importing text files to a text fingerprint library at a time. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobId' => [ + 'description' => 'The ID of the import job. We recommend that you save this ID for subsequent operations.'."\n", + 'type' => 'string', + 'example' => 'c074b118ace44395a02063a5ab94****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"c074b118ace44395a02063a5ab94****\\"\\n}","errorExample":""},{"type":"xml","example":"<ImportFpShotJobResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <JobId>c074b118ace44395a02063a5ab94****</JobId>\\n</ImportFpShotJobResponse>","errorExample":""}]', + 'title' => 'ImportFpShotJob', + 'description' => '* You can call this operation to import multiple text files to a text fingerprint library at a time. The system extracts fingerprints from the text files and saves the fingerprints to the text fingerprint library.'."\n" + .'* You can call this operation only in the China (Shanghai) region.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => 'When you call this operation, you must enter the JSON-formatted information about the text files. Each row can contain the information about only one text file. In the information, specify the parameters in the following table.'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|PrimaryKey|String|Yes|The unique primary key of the text file.|'."\n" + .'|Bucket|String|Yes|The OSS bucket in which the text file resides. For more information, see the definition of an [OSS bucket](~~29212~~).|'."\n" + .'|Location|String|Yes|The region in which the data center of the OSS bucket that stores the text file resides. For more information, see the definition of an [OSS region](~~29212~~). Set the value to oss-cn-shanghai.|'."\n" + .'|Object|String|Yes|The OSS object that is used as the input text file. The URL of the OSS object must be encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~) and the definition of an [OSS object](~~29212~~).|'."\n" + .'|UserData|String|No|The custom data. The value must be in the JSON format. You can include the book name, volume number, and chapter number in the custom data. Example: {"Chapter":"Ordinary\\*\\*\\*\\*/Ordinary\\*\\*\\*\\*Volume 2/Volume 2 Chapter 47.txt"}. The custom data can be up to 128 bytes in length.|', + ], + 'ListFpShotFiles' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'FpDBId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media fingerprint library whose files you want to query. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The media files to be returned must be stored after the specified start time. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-09-01T00:00:28Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The media files to be returned must be stored before the specified end time. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-09-08T23:32:56Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'NextPageToken' => [ + 'description' => 'The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + 'FpShotFileList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpShotFile' => [ + 'description' => 'The media fingerprint files. For more information, see the "FpShotFile" section of the [Data types](~~29251~~) topic.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the media fingerprint file.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => 'The unique primary key of the input video.'."\n", + 'type' => 'string', + 'example' => 'fb712a6890464059b1b2ea7c8647****', + ], + 'InputFile' => [ + 'description' => 'The information about the input file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => 'The name of the OSS object that is used as the input file.'."\n", + 'type' => 'string', + 'example' => 'example-****.mp4', + ], + 'Location' => [ + 'description' => 'The ID of the OSS region in which the input file resides.'."\n", + 'type' => 'string', + 'example' => 'oss-cn-beijing', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", + 'type' => 'string', + 'example' => 'example-bucket-****', + ], + ], + ], + 'FileId' => [ + 'description' => 'The ID of the video file.'."\n", + 'type' => 'string', + 'example' => '41e6536e4f2250e2e9bf26cdea19****', + ], + 'StoreTime' => [ + 'description' => 'The time when the media fingerprint file was stored. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n" + ."\n" + .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", + 'type' => 'string', + 'example' => '2022-09-08T23:32:56Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.OutOfRange', + 'errorMessage' => 'The specified parameter %s is out of range.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NextPageToken\\": \\"ae0fd49c0840e14daf0d66a75b83****\\",\\n \\"FpShotFileList\\": {\\n \\"FpShotFile\\": [\\n {\\n \\"PrimaryKey\\": \\"fb712a6890464059b1b2ea7c8647****\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-****.mp4\\",\\n \\"Location\\": \\"oss-cn-beijing\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n },\\n \\"FileId\\": \\"41e6536e4f2250e2e9bf26cdea19****\\",\\n \\"StoreTime\\": \\"2022-09-08T23:32:56Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListFpShotFilesResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <NextPageToken>ae0fd49c0840e14daf0d66a75b83****</NextPageToken>\\n <FpShotFileList>\\n <PrimaryKey>fb712a6890464059b1b2ea7c8647****</PrimaryKey>\\n <InputFile>\\n <Object>example-****.mp4</Object>\\n <Location>oss-cn-beijing</Location>\\n <Bucket>example-bucket-****</Bucket>\\n </InputFile>\\n <FileId>41e6536e4f2250e2e9bf26cdea19****</FileId>\\n <StoreTime>2022-09-08T23:32:56Z</StoreTime>\\n </FpShotFileList>\\n</ListFpShotFilesResponse>","errorExample":""}]', + 'title' => 'ListFpShotFiles', + 'summary' => 'Queries media files in a media fingerprint library.', + 'description' => '* You can call this operation to query media files in a specific media fingerprint library based on the library ID. This operation supports paged queries.'."\n" + .'* You can call this operation only in the China (Beijing), China (Hangzhou), China (Shanghai), and Singapore regions.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitFpFileDeleteJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is submitted. The MPS queue is bound with a notification method. To view the MPS queue ID, log on to the **MPS console** and choose **Global Settings** > **MPS queue and Callback** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ed450ea0bfbd41e29f80a401fb4d****', + ], + ], + [ + 'name' => 'FpDBId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '88c6ca184c0e432bbf5b665e2a15****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The value can contain letters and digits and can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example data', + ], + ], + [ + 'name' => 'FileIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the media files that you want to delete. Separate multiple file IDs with commas (,). You can delete up to 200 media files at a time. You can obtain media file IDs from the response parameters of the [ListFpShotFiles](~~209266~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '41e6536e4f2250e2e9bf26cdea19****', + ], + ], + [ + 'name' => 'PrimaryKeys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The primary keys of the files to be deleted. Separate multiple primary keys with commas (,). You can delete up to 200 primary keys at a time. You can obtain the primary keys of media files from the response parameters of the [ListFpShotFiles](~~209266~~) operation.'."\n" + ."\n" + .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '24e0fba7188fae707e146esa54****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12', + ], + 'JobId' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.DBNotExist', + 'errorMessage' => 'The DNA database does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D127C68E-F1A1-4CE5-A874-8FF724881A12\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitFpFileDeleteJobResponse>\\n <RequestId>D127C68E-F1A1-4CE5-A874-8FF724881A12</RequestId>\\n <JobId>39f8e0bc005e4f309379701645f4****</JobId>\\n</SubmitFpFileDeleteJobResponse>","errorExample":""}]', + 'title' => 'SubmitFpFileDeleteJob', + 'summary' => 'Submits a job of deleting media files from a media fingerprint library.', + 'description' => '## [](#)Limits'."\n" + ."\n" + .'* You can call this operation to delete up to 200 media files from a media fingerprint library at a time.'."\n" + .'* This operation is available in the following regions: China (Beijing), China (Hangzhou), China (Shanghai), and Singapore.'."\n" + ."\n" + .'## [](#qps-)QPS limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFpFileDeleteJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the jobs of deleting media files from a media fingerprint library. You can obtain the job IDs from the response parameters of the [SubmitFpFileDeleteJob](~~209274~~) operation. Separate multiple job IDs with commas (,). If you leave this parameter empty, the system returns the latest 20 jobs that are submitted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd98459323c024947a104f6a50cbf****,c2dc694696f1441591c5012a73c1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12', + ], + 'FpFileDeleteJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpFileDeleteJob' => [ + 'description' => 'The jobs of deleting media files from a media fingerprint library. For more information, see the "FpFileDeleteJob" section of the [Data types](~~93555~~) topic.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T00:33:18Z', + ], + 'Status' => [ + 'description' => 'The status of the job. Valid values: Valid values:'."\n" + ."\n" + .'* **Queuing**: The job is waiting in the queue.'."\n" + .'* **Analysing**: The job is in progress.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T00:34:02Z', + ], + 'UserData' => [ + 'description' => 'The user-defined data.'."\n", + 'type' => 'string', + 'example' => 'example data', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'ServiceUnavailable', + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'PipelineId' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.'."\n", + 'type' => 'string', + 'example' => 'fb712a6890464059b1b2ea7c8647****', + ], + 'FpDBId' => [ + 'description' => 'The ID of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Id' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '25bacf2824614bcf9273dc0744db****', + ], + 'FileIds' => [ + 'description' => 'The ID of the file.'."\n", + 'type' => 'string', + 'example' => '41e6536e4f2250e2e9bf26cdea19****', + ], + ], + ], + ], + ], + ], + 'NonExistIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the jobs that do not exist.'."\n", + 'type' => 'string', + 'example' => 'c2dc694696f1441591c5012a73c1****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D127C68E-F1A1-4CE5-A874-8FF724881A12\\",\\n \\"FpFileDeleteJobList\\": {\\n \\"FpFileDeleteJob\\": [\\n {\\n \\"CreationTime\\": \\"2020-06-30T00:33:18Z\\",\\n \\"Status\\": \\"Success\\",\\n \\"FinishTime\\": \\"2020-06-30T00:34:02Z\\",\\n \\"UserData\\": \\"example data\\",\\n \\"Code\\": \\"ServiceUnavailable\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"PipelineId\\": \\"fb712a6890464059b1b2ea7c8647****\\",\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Id\\": \\"25bacf2824614bcf9273dc0744db****\\",\\n \\"FileIds\\": \\"41e6536e4f2250e2e9bf26cdea19****\\"\\n }\\n ]\\n },\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"c2dc694696f1441591c5012a73c1****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryFpFileDeleteJobListResponse>\\n <RequestId>D127C68E-F1A1-4CE5-A874-8FF724881A12</RequestId>\\n <FpFileDeleteJobList>\\n <CreationTime>2020-06-30T00:33:18Z</CreationTime>\\n <Status>Success</Status>\\n <FinishTime>2020-06-30T00:34:02Z</FinishTime>\\n <UserData>example data</UserData>\\n <Code>ServiceUnavailable</Code>\\n <Message>The request has failed due to a temporary failure of the server.</Message>\\n <PipelineId>fb712a6890464059b1b2ea7c8647****</PipelineId>\\n <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>\\n <Id>25bacf2824614bcf9273dc0744db****</Id>\\n <FileIds>41e6536e4f2250e2e9bf26cdea19****</FileIds>\\n </FpFileDeleteJobList>\\n <NonExistIds>c2dc694696f1441591c5012a73c1****</NonExistIds>\\n</QueryFpFileDeleteJobListResponse>","errorExample":""}]', + 'title' => 'QueryFpFileDeleteJobList', + 'summary' => 'Queries the jobs of deleting media files from a media fingerprint library.', + 'description' => 'You can call this operation to query the specified jobs of deleting media files from a media fingerprint library based on the job IDs. If you do not specify job IDs, the system returns the latest 20 jobs that are submitted.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 500 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitFpDBDeleteJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue. This ID can be used to associate the job with a notification method. To view the MPS queue ID, log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'fb712a6890464059b1b2ea7c8647****', + ], + ], + [ + 'name' => 'FpDBId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data. The value can contain letters and digits and can be up to 128 bytes in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example data', + ], + ], + [ + 'name' => 'DelType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'* **Purge**: clears the media fingerprint library. The content in the library is deleted, but the library is not deleted.'."\n" + .'* **Delete**: deletes the media fingerprint library. Both the library and its content are deleted.'."\n" + .'* Default value: **Purge**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Purge', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4247B23C-26DE-529F-8D9F-FD6811AE979B', + ], + 'JobId' => [ + 'description' => 'The ID of the job. We recommend that you keep this ID for subsequent operation calls.'."\n", + 'type' => 'string', + 'example' => 'd98459323c024947a104f6a50cbf****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4247B23C-26DE-529F-8D9F-FD6811AE979B\\",\\n \\"JobId\\": \\"d98459323c024947a104f6a50cbf****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitFpDBDeleteJobResponse>\\n <RequestId>4247B23C-26DE-529F-8D9F-FD6811AE979B</RequestId>\\n <JobId>d98459323c024947a104f6a50cbf****</JobId>\\n</SubmitFpDBDeleteJobResponse>","errorExample":""}]', + 'title' => 'SubmitFpDBDeleteJob', + 'summary' => 'Submits a job of clearing or deleting a media fingerprint library.', + 'description' => 'You can call this operation to clear or delete the specified media fingerprint library based on the library ID. If you clear a media fingerprint library, the content in the library is deleted, but the library is not deleted. If you delete a media fingerprint library, both the library and the content in the library are deleted. If you do not specify the operation type, the system clears the media fingerprint library by default.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFpDBDeleteJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the jobs of clearing or deleting a media fingerprint library. You can obtain the job IDs from the response parameters of the [SubmitFpDBDeleteJob](~~209341~~) operation. Separate multiple job IDs with commas (,). If you leave this parameter empty, the system returns the latest 20 jobs that are submitted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4247B23C-26DE-529F-8D9F-FD6811AE979B', + ], + 'FpDBDeleteJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FpDBDeleteJob' => [ + 'description' => 'The jobs of deleting a media fingerprint library. For more information, see the "FpDBDeleteJob" section of the [Data types](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/datatypes) topic.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T00:33:18Z', + ], + 'Status' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* **Queuing**: The job is waiting in the queue.'."\n" + .'* **Analysing**: The job is in progress.'."\n" + .'* **Success**: The job is successful.'."\n" + .'* **Fail**: The job fails.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was complete.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T00:34:02Z', + ], + 'DelType' => [ + 'description' => 'The type of the operation.'."\n", + 'type' => 'string', + 'example' => 'Purge', + ], + 'UserData' => [ + 'description' => 'The user-defined data.'."\n", + 'type' => 'string', + 'example' => 'example data', + ], + 'Code' => [ + 'description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'ServiceUnavailable', + ], + 'Message' => [ + 'description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'PipelineId' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.'."\n", + 'type' => 'string', + 'example' => 'fb712a6890464059b1b2ea7c8647****', + ], + 'FpDBId' => [ + 'description' => 'The ID of the media fingerprint library.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Id' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '25bacf2824614bcf9273dc0744db****', + ], + ], + ], + ], + ], + ], + 'NonExistIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'The IDs of the jobs that do not exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the jobs that do not exist. This parameter is not returned if all specified jobs are found.'."\n", + 'type' => 'string', + 'example' => '78dc866518b843259669df58ed30****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4247B23C-26DE-529F-8D9F-FD6811AE979B\\",\\n \\"FpDBDeleteJobList\\": {\\n \\"FpDBDeleteJob\\": [\\n {\\n \\"CreationTime\\": \\"2020-06-30T00:33:18Z\\",\\n \\"Status\\": \\"Success\\",\\n \\"FinishTime\\": \\"2020-06-30T00:34:02Z\\",\\n \\"DelType\\": \\"Purge\\",\\n \\"UserData\\": \\"example data\\",\\n \\"Code\\": \\"ServiceUnavailable\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"PipelineId\\": \\"fb712a6890464059b1b2ea7c8647****\\",\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Id\\": \\"25bacf2824614bcf9273dc0744db****\\"\\n }\\n ]\\n },\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"78dc866518b843259669df58ed30****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryFpDBDeleteJobListResponse>\\n <RequestId>4247B23C-26DE-529F-8D9F-FD6811AE979B</RequestId>\\n <FpDBDeleteJobList>\\n <CreationTime>2020-06-30T00:33:18Z</CreationTime>\\n <Status>Success</Status>\\n <FinishTime>2020-06-30T00:34:02Z</FinishTime>\\n <DelType>Purge</DelType>\\n <UserData>example data</UserData>\\n <PipelineId>fb712a6890464059b1b2ea7c8647****</PipelineId>\\n <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>\\n <Id>25bacf2824614bcf9273dc0744db****</Id>\\n </FpDBDeleteJobList>\\n <NonExistIds>78dc866518b843259669df58ed30****</NonExistIds>\\n</QueryFpDBDeleteJobListResponse>","errorExample":""}]', + 'title' => 'QueryFpDBDeleteJobList', + 'summary' => 'Queries the jobs of clearing or deleting a media fingerprint library.', + 'description' => 'You can call this operation to query the specified jobs of clearing or deleting a media fingerprint library based on the job IDs. If you do not specify job IDs, the system returns the latest 20 jobs that are submitted.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFpShotImportJob' => [ + 'summary' => 'Queries jobs of importing text files to a text fingerprint library.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job IDs. You can obtain the job IDs from the response to the [ImportFpShotJob](~~312262~~) operation. You can specify a maximum of 10 job IDs in a request. Separate multiple job IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '88c6ca184c0e47098a5b665e2a12****,c074b118ace44395a02063a5ab94****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'NonExistIds' => [ + 'description' => 'The job IDs that do not exist. This parameter is not returned if all specified job IDs exist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The job ID that does not exist.'."\n", + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + 'FpShotImportJobList' => [ + 'description' => 'The jobs of importing text files to a text fingerprint library.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the import job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '25bacf2824614bcf9273dc0744db****', + ], + 'FpDBId' => [ + 'description' => 'The ID of the text fingerprint library.'."\n", + 'type' => 'string', + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + 'PipelineId' => [ + 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is submitted.'."\n", + 'type' => 'string', + 'example' => 'ebb51ee30f0b49aba959823fa991****', + ], + 'FpImportConfig' => [ + 'description' => 'The import configuration.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Status' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* Processing: The job is in progress.'."\n" + .'* Fail: The job fails.'."\n" + .'* Success: The job is successful.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => 'The error code returned when the job fails.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'description' => 'The error message returned when the job fails.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'CreateTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T00:33:18Z', + ], + 'FinishTime' => [ + 'description' => 'The time when the job was completed.'."\n", + 'type' => 'string', + 'example' => '2020-06-30T00:34:02Z', + ], + 'UserData' => [ + 'description' => 'The user-defined data.'."\n", + 'type' => 'string', + 'example' => '001', + ], + 'Input' => [ + 'description' => 'The input file.'."\n", + 'type' => 'string', + 'example' => '{\\"Bucket\\":\\"mts-example****\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"Object\\":\\"test-0828/video/test.mp4\\"}', + ], + 'ProcessMessage' => [ + 'description' => 'The processing information of the job.'."\n", + 'type' => 'string', + 'example' => 'http://testbucket.oss-cn-shanghai.aliyuncs.com/932ajjw***32ssoj_importResult.txt', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NonExistIds\\": [\\n \\"88c6ca184c0e47098a5b665e2a12****\\"\\n ],\\n \\"FpShotImportJobList\\": [\\n {\\n \\"Id\\": \\"25bacf2824614bcf9273dc0744db****\\",\\n \\"FpDBId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\",\\n \\"PipelineId\\": \\"ebb51ee30f0b49aba959823fa991****\\",\\n \\"FpImportConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success\\",\\n \\"CreateTime\\": \\"2020-06-30T00:33:18Z\\",\\n \\"FinishTime\\": \\"2020-06-30T00:34:02Z\\",\\n \\"UserData\\": \\"001\\",\\n \\"Input\\": \\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mts-example****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0828/video/test.mp4\\\\\\\\\\\\\\"}\\",\\n \\"ProcessMessage\\": \\"http://testbucket.oss-cn-shanghai.aliyuncs.com/932ajjw***32ssoj_importResult.txt\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListFpShotImportJobResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>\\n <NonExistIds>88c6ca184c0e47098a5b665e2a12****</NonExistIds>\\n <FpShotImportJobList>\\n <Id>25bacf2824614bcf9273dc0744db****</Id>\\n <FpDBId>2288c6ca184c0e47098a5b665e2a12****</FpDBId>\\n <PipelineId>ebb51ee30f0b49aba959823fa991****</PipelineId>\\n <FpImportConfig>\\"\\"</FpImportConfig>\\n <Status>Success</Status>\\n <Code>0</Code>\\n <Message>Success</Message>\\n <CreateTime>2020-06-30T00:33:18Z</CreateTime>\\n <FinishTime>2020-06-30T00:34:02Z</FinishTime>\\n <UserData>001</UserData>\\n <Input>{\\\\\\"Bucket\\\\\\":\\\\\\"mts-example****\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"test-0828/video/test.mp4\\\\\\"}</Input>\\n </FpShotImportJobList>\\n</ListFpShotImportJobResponse>","errorExample":""}]', + 'title' => 'ListFpShotImportJob', + 'description' => 'You can call this operation only in the China (Shanghai) region.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", + ], + 'SubmitCopyrightJob' => [ + 'summary' => 'Submits a job for adding a copyright watermark to a video.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '205603', + 'abilityTreeNodes' => [ + 'FEATUREmtsRH229Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}', + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '水印信息', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'required' => false, + 'example' => '0', + 'format' => 'int64', + ], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'required' => false, + 'example' => '10', + 'format' => 'int64', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'required' => false, + 'example' => '2', + 'format' => 'int64', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CallBack', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/video/test.mp4', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"algoType":"v2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA258E67-09B8-4EAA-8F33-BA567834A2C3\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitCopyrightJob', + ], + 'QueryCopyrightJob' => [ + 'summary' => 'Queries jobs for adding copyright watermarks to videos.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '222519', + 'abilityTreeNodes' => [ + 'FEATUREmtsRH229Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357322', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357325', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2a0697e35a7342859f733a9190c4****', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD811A1', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Callback' => [ + 'title' => '回调url', + 'description' => '', + 'type' => 'string', + 'example' => 'http://callbacktest.com/callback', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357328', + ], + 'Input' => [ + 'title' => '水印视频输入', + 'description' => '', + 'type' => 'string', + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"gambling.mp4"}', + ], + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + 'Level' => [ + 'title' => '水印强度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Message' => [ + 'title' => '水印信息', + 'description' => '', + 'type' => 'string', + 'example' => '平头哥半导体(上海)', + ], + 'Output' => [ + 'title' => '水印视频输出', + 'description' => '', + 'type' => 'string', + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1346693***', + ], + 'Result' => [ + 'title' => '任务结果', + 'description' => '', + 'type' => 'string', + 'example' => '{"Code":"success","Message":"ok"}', + ], + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD811A1\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": [\\n {\\n \\"Callback\\": \\"http://callbacktest.com/callback\\",\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357328,\\n \\"Input\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"gambling.mp4\\\\\\"}\\",\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"Level\\": 2,\\n \\"Message\\": \\"平头哥半导体(上海)\\",\\n \\"Output\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"out.mp4\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0,\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\"\\n }\\n ],\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'QueryCopyrightJob', + ], + 'SubmitTraceAbJob' => [ + 'summary' => 'Submits a job for adding a tracing watermark to an AB video stream.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '222515', + 'abilityTreeNodes' => [ + 'FEATUREmtsGVUB1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}', + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Dir":"out/"}', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'required' => false, + 'example' => '0', + 'format' => 'int64', + ], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'required' => false, + 'example' => '360', + 'format' => 'int64', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'required' => false, + 'example' => '2', + 'format' => 'int64', + ], + ], + [ + 'name' => 'CallBack', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/video/test.mp4', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'CipherBase64ed', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Qh6OdgIMcliQSI1fReOw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '030E2671-806A-52AF-A93C-DA8E308603A6', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务Id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + 'MediaId' => [ + 'title' => '媒体Id', + 'description' => '', + 'type' => 'string', + 'example' => '437bd2b516ffda105d07b12a9a82****', + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"030E2671-806A-52AF-A93C-DA8E308603A6\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"MediaId\\": \\"437bd2b516ffda105d07b12a9a82****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitTraceAbJob', + ], + 'QueryTraceAbJob' => [ + 'summary' => 'Queries jobs for adding tracing watermarks to AB video streams.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222523', + 'abilityTreeNodes' => [ + 'FEATUREmtsGVUB1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '31fa3c9ca8134fb4b0b0f7878301****', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Callback' => [ + 'title' => '回调url', + 'description' => '', + 'type' => 'string', + 'example' => 'http://callbacktest.com/callback', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357325', + ], + 'Input' => [ + 'title' => '水印视频输入', + 'description' => '', + 'type' => 'string', + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}', + ], + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + 'Level' => [ + 'title' => '水印强度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MediaId' => [ + 'title' => '媒体id', + 'description' => '', + 'type' => 'string', + 'example' => '437bd2b516ffda105d07b12a9a82****', + ], + 'Output' => [ + 'title' => '水印视频输出', + 'description' => '', + 'type' => 'string', + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13466****', + ], + 'Result' => [ + 'title' => '任务结果', + 'description' => '', + 'type' => 'string', + 'example' => '{"Code":"success","Message":"ok"}', + ], + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": [\\n {\\n \\"Callback\\": \\"http://callbacktest.com/callback\\",\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357325,\\n \\"Input\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"test.mp4\\\\\\"}\\",\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"Level\\": 2,\\n \\"MediaId\\": \\"437bd2b516ffda105d07b12a9a82****\\",\\n \\"Output\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"out.mp4\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0,\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\"\\n }\\n ],\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'QueryTraceAbJob', + ], + 'SubmitTraceM3u8Job' => [ + 'summary' => 'Submits a job for adding a tracing watermark to an M3U8 video.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222530', + 'abilityTreeNodes' => [ + 'FEATUREmtsGVUB1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '437bd2b516ffda105d07b12a9a82****', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"exampleBucket","Location":"oss-cn-shanghai","Object":"out.m3u8"}', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Trace', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + 'docRequired' => true, + ], + ], + [ + 'name' => 'KeyUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cipher.abc.com'."\n", + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"m3u8Type":"v1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DEB915C5-D001-5C17-AF65-FF8A65DFE432', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DEB915C5-D001-5C17-AF65-FF8A65DFE432\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'SubmitTraceM3u8Job', + ], + 'QueryTraceM3u8Job' => [ + 'summary' => 'Queries jobs for adding tracing watermarks to M3U8 videos.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222524', + 'abilityTreeNodes' => [ + 'FEATUREmtsGVUB1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1527441300'."\n", + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1527441303', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD8****', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357327', + ], + 'MediaId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '437bd2b516ffda105d07b12a9a82****', + ], + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****'."\n", + ], + 'Trace' => [ + 'title' => '水印信息', + 'description' => '', + 'type' => 'string', + 'example' => '平头哥半导体(上海)', + ], + 'Output' => [ + 'title' => '水印视频输出', + 'description' => '', + 'type' => 'string', + 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13466****', + ], + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD8****\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357327,\\n \\"MediaId\\": \\"437bd2b516ffda105d07b12a9a82****\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2a12****\\\\n\\",\\n \\"Trace\\": \\"平头哥半导体(上海)\\",\\n \\"Output\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"out.mp4\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'QueryTraceM3u8Job', + ], + 'SubmitCopyrightExtractJob' => [ + 'summary' => 'Submits a job for extracting a copyright watermark.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222529', + 'abilityTreeNodes' => [ + 'FEATUREmtsRH229Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}', + ], + ], + [ + 'name' => 'CallBack', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback'."\n", + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/video/test.mp4'."\n", + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123'."\n", + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"algoType":"v1"}'."\n" + ."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'ebbfe90c63b54ed4b61acb2f6c44****', + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"ebbfe90c63b54ed4b61acb2f6c44****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitCopyrightExtractJob', + ], + 'QueryCopyrightExtractJob' => [ + 'summary' => 'Queries jobs for extracting copyright watermarks.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222525', + 'abilityTreeNodes' => [ + 'FEATUREmtsRH229Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F24EAE86-5356-528E-A2B1-FEDE269F42DD', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '版权水印信息', + 'description' => '', + 'type' => 'string', + 'example' => 'example water mark'."\n", + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F24EAE86-5356-528E-A2B1-FEDE269F42DD\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Message\\": \\"example water mark\\\\n\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'QueryCopyrightExtractJob', + ], + 'SubmitTraceExtractJob' => [ + 'summary' => 'Submits a job for extracting a tracing watermark.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222528', + 'abilityTreeNodes' => [ + 'FEATUREmtsGVUB1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}'."\n", + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123'."\n", + ], + ], + [ + 'name' => 'CallBack', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/callback'."\n", + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/video/test.mp4'."\n", + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"m3u8Type":"v1"}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A1326BD4-30B1-4CB6-Q123-3330B877B0D4', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1326BD4-30B1-4CB6-Q123-3330B877B0D4\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitTraceExtractJob', + ], + 'QueryTraceExtractJob' => [ + 'summary' => 'Queries jobs for extracting tracing watermarks.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222527', + 'abilityTreeNodes' => [ + 'FEATUREmtsGVUB1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '31fa3c9ca8134fb4b0b0f7878301****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7D9F3008-9316-5817-BFA3-6180D752039D', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Trace' => [ + 'title' => '溯源水印信息', + 'description' => '', + 'type' => 'string', + 'example' => 'example water mark '."\n", + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D9F3008-9316-5817-BFA3-6180D752039D\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Trace\\": \\"example water mark\\\\t\\\\n\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'QueryTraceExtractJob', + ], + 'SubmitImageCopyright' => [ + 'summary' => 'Generates a transparent image watermark.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '209015', + 'abilityTreeNodes' => [ + 'FEATUREmtsRH229Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Bucket":"abc-test","Location":"oss-cn-shanghai","Object":"out.jpeg"}', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '水印信息', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"width":2999, "height":2999, "afa": 3, "type":1, "version":0}', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + ], + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitImageCopyright', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'mts.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'mts.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'mts.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'mts.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'mts.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'mts.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'mts.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'mts.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'mts.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'mts.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'mts.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'mts.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'mts.eu-central-1.aliyuncs.com', + ], + ], +]; |