Methods supported for media workflows - ApsaraVideo Media Processing

This topic describes the methods supported for media workflows and the supported parameters.

Start

You can configure trigger conditions and global settings for media workflows. The start method obtains media information. If the media information fails to be obtained, the subsequent methods are skipped until the report method is called.


Parameter	Type	Required	Description
InputFile	String	Yes	The information about the input file, including the Object Storage Service (OSS) bucket in which the input file is stored, the region where the bucket is deployed, and the prefix of the input file. Example: {"Bucket": "example-001","Location": "oss-cn-hangzhou", "ObjectPrefix": "test"}. For more information about how the matching rules trigger media workflows, see Workflow triggering rules for media files.
PipelineId	String	Yes	The ID of the pipeline. This is a global parameter. In a media workflow, the value of QueueName or TopicName specified for the workflow takes effect.
MessageType	String	No	The type of the message. Valid values: Queue and Topic. Default value: Queue.
QueueName	String	No	The name of the queue. This is a global parameter.
TopicName	String	No	The name of the topic. This is a global parameter.
RoleName	String	No	The name of the authorized RAM role. This is a global parameter. Default value: AliyunMTSDefaultRole.

Transcode


Parameter	Type	Required	Description
Outputs	String	No	This parameter is optional for extracting subtitle streams. For more information, see Parameter details. Example: [{"OutputObject":"transcode%2F%7BObjectPrefix%7D%2F%7BFileName%7D.%7BExtName%7D","TemplateId": "S00000001-000070"}].
OutputBucket	String	No	The OSS bucket in which the output file is stored. The Bucket configuration in PackageConfig takes precedence over the OutputBucket configuration during HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH) packaging.
OutputLocation	String	No	The region where the output bucket is deployed. The Location configuration in PackageConfig takes precedence over the OutputLocation configuration during HLS and DASH packaging.
MultiBitrateVideoStream	String	No	This parameter is required for extracting video streams during HLS packaging. For more information, see Parameter details. Example: {"URI": "c/d/video1.m3u8"}.
ExtXMedia	String	No	This parameter is required for extracting audio or subtitle streams during HLS packaging. For more information, see Parameter details. Example: {"Name": "english","Language": "en-US","URI":"c/d/audio-1.m3u8"}.
WebVTTSubtitleURL	String	No	The URL of the subtitles. This parameter is supported only for HLS packaging. Only Web Video Text Tracks (WebVTT) subtitle files are supported. The subtitle URL must comply with the URL standard. The subtitle URL is overwritten when you call AddMedia. Example: http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com/subtitles**-en.vtt.
Representation	String	No	This parameter is required for extracting audio, video, or subtitle streams during DASH packaging. For more information, see Parameter details. Example: {\"Id\":\"480p\", \"URI\":\"videoSD/xx.mpd\"}.
InputConfig	String	No	This parameter is supported only for DASH packaging and is required for extracting subtitle streams. For more information, see Parameter details. Example: "{\"Format\":\"vtt\",\"InputFile\":{\"URL\":\"http://example-Bucket-**.oss-cn-hangzhou.aliyuncs.com/subtitle/subtitle**-en.vtt\"}}".

Screenshot


Parameter	Type	Required	Description
SnapshotConfig	String	Yes	For more information, see Parameter details. Example: {"OutputFile": {"Bucket": "example-001", "Location": "oss-cn-hangzhou", "Object":"snapshot%2F%7BObjectPrefix%7D%2F%7BFileName%7D.%7BExtName%7D%2F1.jpg"},"Time": "5"}.
MediaCover	String	No	Specifies whether to set the snapshot as the media thumbnail. This parameter is supported only for a single snapshot. Valid values: true and false. Default value: false.

Analysis


Parameter	Type	Required	Description
KeepOnlyHighestDefinition	String	No	Specifies whether to retain only the analysis results for videos in the highest definition. Valid values: True and False. Default value: False.

Report


Parameter	Type	Required	Description
PublishType	String	No	The publishing type of the media file. Valid values: Auto, Manual, and TranscodeCompletedAuto. Auto indicates that the media file is automatically published after the workflow is complete. Manual indicates that the media file is not published. TranscodeCompletedAuto indicates that the media file is automatically published after a transcoding event is complete. You can configure message settings in the start method to notify users when transcoding events are complete. Users can then play the output media file. Default value: Manual. Note ApsaraVideo Media Processing processes media files in a workflow and uses Security Token Service (STS) to grant permissions to RAM users. This allows users to configure how media files are published. If this parameter is set to TranscodeCompletedAuto and the transcode method is skipped, no message is sent to the users.

PackageConfig


Parameter	Type	Required	Description
Output	String	Yes	The JSON string that contains information about the output file. Example: {"Bucket":"output","Location":"oss-cn-hangzhou","MasterPlayListName":"a/b/c.m3u8"}. Note Supported placeholders in MasterPlayListName: {ObjectPrefix}: the directory of the output file. The bucket information is not included. {FileName}: the name of the output file. The file name extension is not included. {ExtName}: the file name extension of the output file. {RunId}: the ID of the workflow execution instance. {MediaId}: the ID of the media file that is processed in the workflow. All placeholders can be dynamically replaced.
Protocol	String	Yes	Valid values: hls and dash.

SubtitleGroup


Parameter	Type	Required	Description
GroupId	String	No	The ID of the group. This parameter is required only for HLS packaging. The ID can be up to 32 bytes in length.
AdaptationSet	String	No	This parameter is required only for DASH packaging. For more information, see Parameter details. Example: "{\"Lang\":\"english\", \"Group\":\"SubtitleENGroup\"}".

AudioGroup


Parameter	Type	Required	Description
GroupId	String	No	The ID of the group. This parameter is required only for HLS packaging. The ID can be up to 32 bytes in length.
AdaptationSet	String	No	This parameter is required only for DASH packaging. For more information, see Parameter details. Example: "{\"Lang\":\"english\", \"Group\":\"AudioGroupEnglish\"}". Files in a language are stored in the AudioGroup folder.

VideoGroup


Parameter	Type	Required	Description
AdaptationSet	String	No	This parameter is required only for DASH packaging. For more information, see Parameter details. Example: "AdaptationSet":"{\"Group\":\"VideoGroup\"}".

GenerateMasterPlayList


Parameter	Type	Required	Description
MasterPlayList	String	No	The list of multi-bitrate video streams. This parameter is required only for HLS packaging. For more information, see Parameter details. Example: {"MultiBitrateVideoStreams": [{"RefActivityName": "video-1","ExtXStreamInf": {"BandWidth": "111110","Audio": "auds","Subtitles": "subs"}}]}.