This topic describes data types.

AliyunProperties

Property parameters

ParameterTypeDescription
FormatAliyunFormatInfoThe format information.
StreamsAliyunStreamsInfoThe stream information.

AliyunFormatInfo

Format information parameters

ParameterTypeDescription
NumStreamsStringThe total number of media streams.
NumProgramsStringThe total number of program streams.
FormatNameStringThe short name of the container format.
FormatLongNameStringThe full name of the container format.
StartTimeStringThe start time.
DurationStringThe total duration.
SizeStringThe size of the file.
BitrateStringThe total bitrate.

AliyunStreamsInfo

Stream information parameters

ParameterTypeDescription
VideoStreamListAliyunVideoStream[]The list of video streams.
AudioStreamListAliyunAudioStream[]The list of audio streams.
SubtitleStreamListAliyunSubtitleStream[]The list of subtitle streams.

AliyunVideoStream

Video stream information parameters

ParameterTypeDescription
IndexStringThe sequence number of the video stream. The value indicates the position of the video stream in all video streams.
CodecNameStringThe short name of the encoding format.
CodecLongNameStringThe full name of the encoding format.
ProfileStringThe codec profile.
CodecTimeBaseStringThe codec time base.
CodecTagStringStringThe tag string of the encoding format.
CodecTagStringThe tag of the encoding format.
WidthStringThe former number in the video resolution. The number indicates the video width.
HeightStringThe latter number in the video resolution. The number indicates the video height.
HasBFramesStringSpecifies whether the video stream contains bidirectional frames (B-frames).
SarStringThe sample aspect ratio (SAR).
DarStringThe display aspect ratio (DAR).
PixFmtStringThe pixel format.
LevelStringThe codec level.
FpsStringThe frame rate, which is a number.
AvgFPSStringThe average frame rate.
TimebaseStringThe time base.
StartTimeStringThe start time.
DurationStringThe duration.
BitrateStringThe bitrate.
NumFramesStringThe total number of frames.
LangStringThe language.

For more information, see FFmpeg documentation and ISO-639.

RotateStringThe video rotation angle.

AliyunAudioStream

Audio stream information parameters

ParameterTypeDescription
IndexStringThe sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.
CodecNameStringThe short name of the encoding format.
CodecLongNameStringThe full name of the encoding format.
CodecTimeBaseStringThe codec time base.
CodecTagStringStringThe tag string of the encoding format.
CodecTagStringThe tag of the encoding format.
SampleFmtStringThe sampling format.
SamplerateStringThe sampling rate.
ChannelsStringThe number of sound channels.
ChannelLayoutStringThe output layout of the sound channels.
TimebaseStringThe time base.
StartTimeStringThe start time.
DurationStringThe duration.
BitrateStringThe bitrate.
NumFramesStringThe total number of frames.
LangStringThe language.

For more information, see FFmpeg documentation and ISO-639.

AliyunSubtitleStream

Subtitle stream information parameters

ParameterTypeDescription
IndexStringThe sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.
LangStringThe language.

For more information, see FFmpeg documentation and ISO-639.

AliyunTemplate

Transcoding template parameters

ParameterTypeDescription
IdStringThe ID of the transcoding template.
NameStringThe name of the template.
ContainerAliyunContainerThe container configuration.
AudioAliyunAudioCodecThe audio codec configuration.
VideoAliyunVideoCodecThe video codec configuration.
TransConfigAliyunTransConfigThe general transcoding configuration.
MuxConfigAliyunMuxConfigThe transmuxing configuration.
StateStringThe status of the template. Valid values: Normal and Deleted.

AliyunContainer

Container parameter

ParameterTypeDescription
FormatStringThe container format.

Valid values: flv, mp4, ts, m3u8, gif, mp3, ogg, and flac.

AliyunAudioCodec

Audio codec parameters

ParameterTypeDescription
CodecStringThe audio codec format.
  • Valid values: aac, mp3, vorbis, and flac.
  • Default value: aac.
ProfileStringThe codec profile of the audio file.

Valid values when the Codec parameter is set to aac: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.

SamplerateStringThe sampling rate.
  • Valid values: 22050, 32000, 44100, 48000, and 96000.
  • Unit: Hz.
  • Default value: 44100.
BitrateStringThe audio bitrate of the output file.
  • Valid values: [8,1000].
  • Unit: Kbit/s.
  • Default value: 128.
ChannelsStringThe number of sound channels.
  • Valid values: 1, 2, 3, 4, 5, 6, 7, and 8.
  • Default value: 2.

AliyunVideoCodec

Video codec parameters

ParameterTypeDescription
CodecStringThe video codec format.
  • Valid values: H.264 and H.265.
  • Default value: H.264.
ProfileStringThe codec profile.
Valid values: baseline, main, and high.
  • baseline: applicable to mobile devices.
  • main: applicable to standard-definition devices.
  • high: applicable to high-definition devices.
  • Default value: high.
BitrateStringThe average bitrate of the video.
  • Valid values: [10,50000].
  • Unit: Kbit/s.
CrfStringThe constant rate factor, which is the default quality control setting.
  • Valid values: [0,51].
  • Default value when the Codec parameter is set to H.264: 23. Default value when the Codec parameter is set to H.265: 26.
  • If this parameter is specified, the setting of the Bitrate parameter is invalid.
WidthStringThe width.
  • Valid values: [128,4096].
  • Unit: pixel.
  • Default value: the original width of the video.
HeightStringThe height.
  • Valid values: [128,4096].
  • Unit: pixel.
  • Default value: the original height of the video.
FpsStringThe frame rate.
  • Valid values: (0,60].
  • The value is 60 if the frame rate of the input file exceeds 60.
  • Default value: the frame rate of the input file.
GopStringThe maximum number of frames between two keyframes.
  • Valid values: [1,1080000].
  • Default value: 250.
PresetStringThe preset video algorithm.
  • Valid values: veryfast, fast, medium, slow, and slower.
  • Default value: medium.
ScanModeStringThe scan mode.

Valid values: interlaced and progressive.

BufsizeStringThe size of the buffer.
  • Valid values: [1000,128000].
  • Unit: KB.
  • Default value: 6000.
MaxrateStringThe maximum video bitrate.
  • Valid values: [10,50000].
  • Unit: Kbit/s.
BitrateBndAliyunBitrateBndThe average bitrate range of the video.
PixFmtStringThe pixel format for video color encoding.

Valid values: standard pixel formats such as yuv420p and yuvj420p.

AliyunTransConfig

General transcoding parameter

ParameterTypeDescription
TransModeStringThe transcoding mode.
  • Valid values: onepass, twopass, and CBR.
  • Default value: onepass.

AliyunBitrateBnd

Average bitrate range parameters

ParameterTypeDescription
MaxStringThe upper limit of the total bitrate.
  • Valid values: [10,50000].
  • Unit: Kbit/s.
MinStringThe lower limit of the total bitrate.
  • Valid values: [10,50000].
  • Unit: Kbit/s.

AliyunOSSFile

Object Storage Service (OSS) object parameters
ParameterTypeDescription
BucketStringThe name of the OSS bucket.

The value must be 3 to 63 bytes in size.

LocationStringThe ID of the OSS region.

The value can be up to 64 bytes in size.

ObjectStringThe name of the OSS object.

The value can be up to 1,024 bytes in size.

AliyunJob

Job parameters
ParameterTypeDescription
JobIdStringThe ID of the job.
InputAliyunJobInputThe information about the job input.
OutputAliyunOutputThe information about the job output.
StateStringThe status of the job.
  • Submitted: The job has been submitted.
  • Transcoding: Transcoding is ongoing.
  • TranscodeSuccess: Transcoding succeeds.
  • TranscodeFail: Transcoding fails.
  • TranscodeCancelled: Transcoding is canceled.
CodeStringThe error code returned when the transcoding job fails.
MessageStringThe error message returned when the transcoding job fails.
PercentStringThe transcoding progress.

Valid values: [0,100].

UserDataStringThe custom data.
PipelineIdStringThe ID of the pipeline.
CreationTimeStringThe time when the job was created.
MNSMessageResultAliyunMNSMessageResultThe message sent by Message Service (MNS) to notify the user of the job result.

AliyunJobInput

Transcoding job input parameters
ParameterTypeDescription
BucketStringThe name of the OSS bucket of the job input.

The value must be 3 to 63 bytes in size.

LocationStringThe ID of the OSS region of the job input.

The value can be up to 64 bytes in size.

ObjectStringThe name of the OSS object of the job input.

The value can be up to 1,024 bytes in size.

AudioAliyunInputAudioThe audio configuration of the input media file.
ContainerAliyunInputContainerThe container configuration of the input media file.

AliyunInputContainer

Container configuration parameter for the input media file
Note This parameter is required when the input file is in the ADPCM or PCM format.
ParameterTypeDescription
FormatStringThe audio format of the input media file.
  • Valid values: alaw, f32be, f32le, f64be, f64le, mulaw, s16be, s16le, s24be, s24le, s32be, s32le, s8, u16be, u16le, u24be, u24le, u32be, u32le, and u8.

AliyunInputAudio

Audio configuration parameters for the input media file
Note This parameter is required when the input file is in the ADPCM or PCM format.
ParameterTypeDescription
ChannelsStringThe number of sound channels of the input media file.

Valid values: [1,8].

SamplerateStringThe audio sampling rate of the input media file.
  • Valid values: [0,320000].
  • Unit: Hz.

AliyunOutput

Job output parameters
ParameterTypeDescription
OutputFileAliyunOSSFileThe information about the output file.
TemplateIdStringThe ID of the template.
WaterMarkListAliyunWaterMark[ ]The list of watermarks.
ClipAliyunClipThe information about the media clip.
RotateStringThe video rotation angle.

Valid values: [0,360).

PropertiesAliyunPropertiesThe media properties.
PriorityStringThe priority of the job in the corresponding pipeline.
  • Valid values: [1,10].
  • A value of 10 indicates the highest priority.
  • Default value: 6.
ContainerAliyunContainerThe container configuration.

If this parameter is specified, the parameter setting of the AliyunContainer parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

VideoAliyunVideoCodecThe video codec configuration.

If this parameter is specified, the parameter setting of the AliyunVideoCodec parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

AudioAliyunAudioCodecThe audio codec configuration.

If this parameter is specified, the parameter setting of the AliyunAudioCodec parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

TransConfigAliyunTransConfigThe general transcoding configuration.

If this parameter is specified, the parameter setting of the AliyunTransConfig parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

MuxConfigAliyunMuxConfigThe transmuxing configuration.

If this parameter is specified, the parameter setting of the AliyunMuxConfig parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

UserDataStringThe custom data.

AliyunClip

Clip parameter
ParameterTypeDescription
TimeSpanAliyunTimeSpanThe time span of the clip.

AliyunTimeSpan

Clip time span parameters
ParameterTypeDescription
SeekStringThe start time.
DurationStringThe length of the clip.
EndStringThe length of the ending part to cut off.
  • For example, a value of 5.23 indicates that the last 5.23 seconds of the media file are cut off.
  • If you specify this parameter, the Duration parameter is invalid.

AliyunMuxConfig

Transmuxing parameter
ParameterTypeDescription
SegmentAliyunSegmentThe segment configuration.

AliyunSegment

Segment configuration parameter
ParameterTypeDescription
DurationStringThe length of the segment.
  • Valid values: [1,60].
  • Unit: seconds.

AliyunJobResult

Job submission result parameters
ParameterTypeDescription
SuccessStringIndicates whether the job was successfully submitted.

Valid values: true and false.

CodeStringThe error code returned when the job fails to be created.
MessageStringThe error message returned when the job fails to be created.
JobAliyunJobThe information about the job.

If the job fails to be submitted, no job ID is generated.

AliyunWaterMark

Job output parameters
ParameterTypeDescription
InputFileAliyunOSSFileThe watermark input file.
WaterMarkTemplateIdStringThe ID of the watermark template.

AliyunWaterMarkTemplate

Watermark template parameters
ParameterTypeDescription
IdStringThe ID of the watermark template.
NameStringThe name of the watermark template.
WidthNumberThe width.
  • Valid values: [8,4096].
  • Unit: pixel.
HeightNumberThe height.
  • Valid values: [8,4096].
  • Unit: pixel.
DxNumberThe horizontal offset.
  • Valid values: [-4096,4096].
  • Unit: pixel.
DyNumberThe vertical offset.
  • Valid values: [-4096,4096].
  • Unit: pixel.
ReferPosStringThe position of the watermark.
  • Valid values: TopRight, TopLeft, BottomRight, and BottomLeft.
TypeStringThe type of the watermark.
Valid values: Image and Text.
Note Set the value to Image.
StateStringThe status of the watermark template.

Valid values: Normal and Deleted.

AliyunPipeline

Pipeline parameters
ParameterTypeDescription
IdStringThe ID of the pipeline.
NameStringThe name of the pipeline.
SpeedStringThe type of the pipeline.
  • Valid values: Boost, Standard, NarrowBandHDV2, AIVideoCover, AIVideoRecogni, AIVideoSummary, AIVideoPorn, AIAudioKWS, and AIAudioASR.
  • Default value: Standard.
StateStringThe status of the pipeline.
Valid values: Active and Paused.
  • Active: Jobs in the pipeline are scheduled to the transcoding system.
  • Paused: Jobs in the pipeline are no longer scheduled to the transcoding system. All jobs in the pipeline remain in the Submitted state. Ongoing jobs are not affected.
NotifyConfigStringThe MNS notification configuration.

AliyunMediaInfoJob

Media information analysis job parameters
ParameterTypeDescription
IdStringThe ID of the metadata analysis job.
InputAliyunOSSFileThe information about the job input.
StateStringThe status of the job.

Valid values: Analyzing, Success, and Fail.

CodeStringThe error code returned when the metadata analysis job fails.
MessageStringThe error message returned when the metadata analysis job fails.
PropertiesAliyunPropertiesThe media properties.
UserDataStringThe custom data.
CreationTimeStringThe time when the job was created.

AliyunAnalysisJob

Template analysis job parameters
ParameterTypeDescription
IdStringThe ID of the template analysis job.
InputAliyunOSSFileThe information about the job input.
AnalysisConfigAliyunAnalysisConfigThe job configuration.
TemplateListAliyunTemplate[ ]The list of matched preset templates.
StateStringThe status of the job.

Valid values: Submitted, Analyzing, Success, and Fail.

CodeStringThe error code returned when the template analysis job fails.
MessageStringThe error message returned when the template analysis job fails.
PercentStringThe transcoding progress.

Valid values: [0,100].

PriorityStringThe priority of the job in the corresponding pipeline.
  • Valid values: [1,10].
  • A value of 10 indicates the highest priority.
  • Default value: 10.
UserDataStringThe custom data.
PipelineIdStringThe ID of the pipeline.
CreationTimeStringThe time when the job was created.
MNSMessageResultAliyunMNSMessageResultThe message sent by MNS to notify the user of the job result.

AliyunSnapshotJob

Snapshot job parameters
ParameterTypeDescription
IdStringThe ID of the snapshot job.
InputAliyunOSSFileThe information about the job input.
SnapshotConfigAliyunSnapshotConfigThe snapshot configuration.
CountStringThe number of snapshots that were taken.
StateStringThe status of the snapshot job.

Valid values: Snapshoting, Success, and Fail.

CodeStringThe error code returned when the snapshot job fails.
MessageStringThe error message returned when the snapshot job fails.
UserDataStringThe custom data.
MNSMessageResultAliyunMNSMessageResultThe message sent by MNS to notify the user of the job result.

AliyunSnapshotConfig

Snapshot configuration parameters
ParameterTypeDescription
OutputFileStringThe OSS output file of the snapshot job.
TileOutputFileStringThe OSS output file of the tiling job.
TimeStringThe start time for taking snapshots.

Unit: milliseconds.

IntervalStringThe interval for taking snapshots.
  • If this parameter is specified, snapshots are taken at intervals. The interval must be greater than 0.
  • Unit: seconds.
  • Default value: 10.
NumStringThe number of snapshots to take.

If this parameter is specified, snapshots are taken at intervals.

WidthStringThe width of the output snapshot.

Valid values: [8,4096].

HeightStringThe height of the output snapshot.

Valid values: [8,4096].

FrameTypeStringThe type of the snapshot. Valid values:
  • normal: normal frame
  • intra: I-frame

Default value: normal.

TileOutStringThe tiling configuration.

AliyunFailReason

Failure cause parameters
ParameterTypeDescription
CodeStringThe error code returned when the job fails.
MessageStringThe error message returned when the job fails.

AliyunMNSMessageResult

Parameters in the message sent by MNS to notify the user of the job result
ParameterTypeDescription
ErrorCodeStringThe error code returned when the job fails.
ErrorMessageStringThe error message returned when the job fails.
MessageIdStringThe ID of the success message.

Activity

Media workflow activity parameters
ParameterTypeDescription
NameStringThe name of the workflow activity.
Note The name of an activity in a media workflow is unique.
TypeStringThe type of the media workflow activity.

Valid values: Start, Snapshot, Transcode, Analysis, and Report.

JobIdStringThe job ID, such as the analysis job ID, transcoding job ID, or snapshot job ID, generated when the activity is executed.
StateStringThe status of the activity.
Valid values: Running, Success, Fail, and Skipped.
  • A value of Skipped indicates that the activity is skipped.
  • For example, the high-definition and standard-definition transcoding activities are 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.
StartTimeStringThe start time of the activity.
EndTimeStringThe end time of the activity.
CodeStringThe error code returned when the activity fails.

The specific error code appears if the activity status is Fail.

MessageStringThe error message returned when the activity fails.

The detailed error message appears if the activity status is Fail.

MediaWorkflow

Media workflow parameters
ParameterTypeDescription
MediaWorkflowIdStringThe ID of the media workflow.
NameStringThe name of the media workflow.
TopologyStringThe topology of the media workflow.
StateStringThe status of the media workflow.

Valid values: Inactive, Active, and Deleted.

CreationTimeStringThe time when the media workflow was created.

InputFile

Input file parameters
ParameterTypeDescription
BucketStringThe name of the OSS bucket.
LocationStringThe ID of the OSS region.
ObjectStringThe name of the OSS object.

MediaWorkflowExecutionInput

Input file parameters for executing the media workflow
ParameterTypeDescription
InputFileInputFileThe input file of the media workflow.
UserDataStringThe custom data.

MediaWorkflowExecution

Media workflow execution instance parameters
ParameterTypeDescription
RunIdStringThe ID of the execution instance.
InputMediaWorkflowExecutionInputThe input file of the media workflow.
MediaWorkflowIdStringThe ID of the media workflow.
NameStringThe name of the media workflow.
MediaIdStringThe ID of the media file.

This media file ID is associated with all information generated by the media workflow.

ActivityListActivityThe list of activities that are executed in the media workflow.
StateStringThe status of the execution instance.
  • Valid values: Running, Completed, and Fail.
  • A value of Completed indicates that the execution instance is complete. For the information about whether each activity, such as Transcode or Snapshot, is successful, check the status of the activity.
CreationTimeStringThe time when the execution instance was created.

MediaInfo

Media information parameters
ParameterTypeDescription
FormatFormatInfoThe format information.
StreamsStreamsInfoThe stream information.

FormatInfo

Container and general information parameters
ParameterTypeDescription
NumStreamsStringThe total number of media streams.
NumProgramsStringThe total number of program streams.
FormatNameStringThe short name of the container format.
FormatLongNameStringThe full name of the container format.
StartTimeStringThe start time.
DurationStringThe total duration.
SizeStringThe size of the file.
BitrateStringThe total bitrate.

StreamsInfo

Stream information parameters
ParameterTypeDescription
VideoStreamListVideoStream[]The list of video streams.

The list contains a maximum of four items.

AudioStreamListAudioStream[]The list of audio streams.

The list contains a maximum of four items.

SubtitleStreamListSubtitleStream[]The list of subtitle streams.

The list contains a maximum of four items.

VideoStream

Video stream information parameters
ParameterTypeDescription
IndexStringThe sequence number of the video stream.

The value indicates the position of the video stream in all video streams.

CodecNameStringThe short name of the encoding format.
CodecLongNameStringThe full name of the encoding format.
ProfileStringThe codec profile.
CodecTimeBaseStringThe codec time base.
CodecTagStringStringThe tag string of the encoding format.
CodecTagStringThe tag of the encoding format.
WidthStringThe former number in the video resolution. The number indicates the video width.
HeightStringThe latter number in the video resolution. The number indicates the video height.
HasBFramesStringSpecifies whether the video stream contains B-frames.
SarStringThe SAR.
DarStringThe DAR.
PixFmtStringThe pixel format.
LevelStringThe codec level.
FpsStringThe frame rate of the output file.
AvgFPSStringThe average frame rate.
TimebaseStringThe time base.
StartTimeStringThe start time.
DurationStringThe duration.
NumFramesStringThe total number of frames.
LangStringThe language.
NetworkCostNetworkCostThe network bandwidth consumption.

NetworkCost

Video network bandwidth consumption parameters
ParameterTypeDescription
PreloadTimeStringThe amount of preload time.
CostBandwidthStringThe maximum bandwidth that was consumed.
AvgBitrateStringThe average bitrate.

AudioStream

Audio stream information parameters
ParameterTypeDescription
IndexStringThe sequence number of the audio stream.

The value indicates the position of the audio stream in all audio streams.

CodecNameStringThe short name of the encoding format.
CodecLongNameStringThe full name of the encoding format.
CodecTimeBaseStringThe codec time base.
CodecTagStringStringThe tag string of the encoding format.
CodecTagStringThe tag of the encoding format.
SampleFmtStringThe sampling format.
SamplerateStringThe sampling rate.
ChannelsStringThe number of sound channels.
ChannelLayoutStringThe output layout of the sound channels.
TimebaseStringThe time base.
StartTimeStringThe start time.
DurationStringThe duration.
BitrateStringThe bitrate.
NumFramesStringThe total number of frames.
LangStringThe language.

SubtitleStream

Subtitle stream information parameters
ParameterTypeDescription
IndexStringThe sequence number of the subtitle stream.

The value indicates the position of the subtitle stream in all subtitle streams.

LangStringThe language.

Media

Media parameters
ParameterTypeDescription
MediaIdStringThe ID of the media file.
FileFileThe input file.
TitleStringThe title of the media file.
DescriptionStringThe description of the media file.
CateIdStringThe ID of the category to which the media file belongs.
CateNameStringThe name of the category.
TagsString[]The tags of the media file.
RiskFactorStringThe risk factor.
  • Valid values: [0,1].
  • A higher risk factor indicates a higher possibility of pornography and violence involved in the media file.
  • The recognition accuracy is 80%.
CoverURLStringThe URL of the thumbnail.
PublishStateStringThe publishing status of the media file.
Valid values:
  • Initiated: The media file is in the initial state.
  • UnPublish: The media file has not been published, and the playback permission on the OSS object is Private.
  • Published: The media file has been published, and the playback permission on the OSS object is Default.
  • Deleted: The media file has been deleted.
RunIdListString[]The list of media workflow execution instances.
CreationTimeStringThe time when the media file was created.
DurationStringThe duration.
FormatStringThe format.
SizeStringThe size.
BitrateStringThe bitrate.
FpsStringThe frame rate.
WidthStringThe width.
HeightStringThe height.
PlayListPlay[]The playlist.
SnapshotListSnapshot[]The snapshot list.
MediaInfoMediaInfoThe media information.

Category

Category parameters
ParameterTypeDescription
CateIdStringThe ID of the category.
ParentIdStringThe ID of the parent category.

The value for the top-level category is -1.

CateNameStringThe name of the category.
LevelStringThe level of the category.

The value for the top-level category is 0.

File

File parameters
ParameterTypeDescription
URLStringThe URL of the file.
StateStringThe status of the file.

Valid values: Normal and Deleted.

Play

Playback information parameters
ParameterTypeDescription
MediaWorkflowIdStringThe ID of the workflow that generates the playback file.
MediaWorkflowNameStringThe name of the workflow that generates the playback file.
ActivityNameStringThe name of the workflow activity.
DurationStringThe duration.
FormatStringThe format.
SizeStringThe size.
BitrateStringThe bitrate.
FpsStringThe frame rate.
WidthStringThe width.
HeightStringThe height.
FileFileThe playback file.

Snapshot

Snapshot information parameters
ParameterTypeDescription
MediaWorkflowIdStringThe ID of the workflow that generates the snapshot.
MediaWorkflowNameStringThe name of the workflow that generates the snapshot.
ActivityNameStringThe name of the workflow activity that generates the snapshot.
FileFileThe snapshot.
TypeStringThe type of the snapshot.

Valid values: Single and Sequence.

CountNumberThe number of snapshots.

This parameter is valid only when the Type parameter is set to Sequence.

MediaBucket

Media bucket parameters
ParameterTypeDescription
BucketStringThe name of the media bucket.
TypeStringThe type of the media bucket.

Valid values: Input

and Output.