Workflow activity types are listed as follows: Start, Transcode, Snapshot, Analysis, Cover, Summary, Censor, Report, UploadVerify, GenerateMasterPlayList, AudioGroup, SubtitleGroup and PackageConfig. This document introduces the parameters supported by the following activity types:

Start activity

You can set the trigger conditions and overall configurations of the Media workflow. This activity acquires media information. If the acquisition fails, directly jump to perform Report activity.
Name Type Required Description
InputFile String Yes Input position. For more information, see Matching rule for workflow file.

Example: {“Bucket”: “example-001”,”Location”: “oss-cn-hangzhou”, “ObjectPrefix”: “test/“}.

PipelineId String Yes ID of the MPS queue, which is global.

In the workflow scenario, the message configuration for the MPS queue is invalid, but the message configuration of the QueueName/TopicName is valid.

MessageType String No Message Type.
  • Range: Queue and Topic.
  • Default value: Queue.
QueueName String No Name of the Message Service queue, which is global.
TopicName String No Topic name, which is global.
RoleName String No Authorization role name, which is global.

Default value: AliyunMTSDefaultRole

Transcode activity

Name Type Required Description
Outputs String No Optional while extracting subtitles.
  • For more information, see Output.
  • Example: [{“OutputObject”:”transcode%2F%7BObjectPrefix%7D%2F%7BFileName%7D. %7BExtName%7D”,”TemplateId”: “S00000001-000070”}]。
OutputBucket String No Output bucket.

Output bucket. During HLS package, it is overwritten by the Bucket in PackageConfig.

OutputLocation String No Output region.

During HLS package, it is overwritten by the Location in PackageConfig.

MultiBitrateVideoStream String No During HLS package, this parameter is required while extracting video streams.
  • For more information about this parameter, see MultiBitrateVideoStream.
  • Example: {“URI”: “c/d/video1.m3u8”}.
ExtXMedia String No During HLS package, this parameter is requried while extracting audio streams or subtitle streams.
  • For more information about this parameter, see ExtXMedia.
  • Example: {“Name”: “english”,”Language”: “en-US”,”URI”:”c/d/audio-1.m3u8”}.
WebVTTSubtitleURL String No HLS package exclusive parameter, subtitle address,
  • which currently only supports WebVTT subtitle file, must comply with URL standard, and can overwrite subtitle address while calling AddMedia.
  • Example: http://test.oss-cn-hangzhou.aliyuncs.com/subtitles-en.vtt.
Representation String No During DASH package, it is required to be set when extract audio stream, video stream, or subtitle stream.
  • For more information, see Representation.
  • Example: {\”Id\”:\”480p\”, \”URI\”:\”videoSD/xx.mpd\”}.
InputConfig String No Dash package exclusive parameter, and is required to be set when extract sutitle streams.
  • For more information, see InputConfig.
  • Example: ”{\”Format\”:\”vtt\”,\”InputFile\”:{\”URL\”:\”http://subtitlebucket.oss-cn-hangzhou.aliyuncs.com/subtitle/subtitle-en.vtt\"}}"

Screenshot activity

Name Type Required Description
SnapshotConfig String Yes
  • For more information, see SnapshotConfig.
  • 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 Whether the screenshot is set as the media cover,
  • only for a single screenshot.
  • Range: true, false.
  • Default value: false.

Analysis activity

Name Type Required Description
KeepOnlyHighestDefinition String No Whether to keep only the highest definition analysis results.
  • Range: True, False.
  • Default value: False.

Report activity

Name Type Required Description
PublishType String No Media publication type.
Range: Auto, Manual, and TranscodeCompletedAuto.
  • Auto: the media set is automatically published after the workflow is executed.
  • Manual: the media set is not published.
  • TranscodeCompletedAuto: the media set is automatically published after any Transcode activity is completed (use the message configuration of the Start node to notify users of transcoding completion and use the Play Service to play the activity output).

Default value: Manual.

Note When the type is TranscodeCompletedAuto, the message will not be sent if the status of the transcoding activity is Skipping.

PackageConfig activity

Name Type Required Description
Output String Yes JSON string.
Example: {“Bucket”:”output”,”Location”:”oss-cn-hangzhou”,”MasterPlayListName”:”a/b/c.m3u8”}.
Note Placeholders that can be used in MasterPlayListName:
  • {ObjectPrefix}: the original file path not including Bucket information,
  • {FileName}: the original file name not including extension,
  • {ExtName}: extension of the original file,
  • {RunId}: the ID of the workflow execution,
  • {MediaId}: the MediaID processed by the workflow.
All these placeholders can be dynamically replaced.
Protocol String Yes Value: hls, dash

SubtitleGroup activity

Name Type Required Description
GroupId String No Group ID.
  • HLS package exclusive parameters, required.
  • The length cannot exceed 32 characters.
AdaptationSet String No
  • DASH packages exclusive parameters, required. For more information, see AdaptationSet
  • Example: ”{\”Lang\”:\”english\”, \”Group\”:\”SubtitleENGroup\”}”

AudioGroup activity

Name Type Required Description
GroupId String No Group ID.
  • Hls package exclusive parameters, required.
  • The length cannot exceed 32 characters;
AdaptationSet String No
  • DASH package exclusive parameters, required. For more information, see AdaptationSet.
  • Example: ”{\”Lang\”:\”english\”, \”Group\”:\”AudioGroupEnglish\”}”, one language one subtitle group.

VideoGroup activity

Name Type Required Description
AdaptationSet String No
  • DASH package exclusive parameters, required. For more information, see AdaptationSet.
  • Example: ”AdaptationSet”: “{\”Group\”:\”VideoGroup\”}”

GenerateMasterPlayList activity

Name Type Required Description
MasterPlayList String No
  • HLS exclusive parameters, required. Multi-bitstream list. For more information, see MasterPlayList .
  • Example: {“MultiBitrateVideoStreams”: [{“RefActivityName”: “video-1”,”ExtXStreamInf”: {“BandWidth”: “111110”,”Audio”: “auds”,”Subtitles”: “subs” }}]}.