This topic describes the basic data types of the ApsaraVideo VOD API.
Video: the information about a video
Parameter | Type | Description |
VideoId | String | The ID of the video. |
Title | String | The title of the video. |
Description | String | The description of the video. |
Duration | Float | The duration of the video. Unit: seconds. |
CoverURL | String | The thumbnail URL of the video. |
String | The status of the video. | |
CreationTime | String | The time when the video was created. The time must be in UTC. |
Size | Long | The size of the source video file. Unit: bytes. |
Snapshots | String[] | The URL array of video snapshots. |
CateId | Long | The category ID of the video. |
CateName | String | The category of the video. |
Tags | String | The tags of the video. Multiple tags are separated by commas (,). |
TemplateGroupId | String | The ID of the transcoding template group that was used to transcode the video. |
StorageLocation | String | The URL of the Object Storage Service (OSS) bucket where the video file is stored. |
String | The ID of the application. |
VideoBase: the basic information about a video
Parameter | Type | Description |
VideoId | String | The ID of the video. |
Title | String | The title of the video. |
Duration | String | The duration of the video. Unit: seconds. |
CoverURL | String | The URL of the video thumbnail. |
String | The status of the video. | |
CreationTime | String | The time when the video was created. The time must be in UTC. |
MediaType | MediaType | The type of the media asset. Valid values:
|
By default, the playback operation returns a URL of an accelerated domain name. If no domain name is specified, the playback operation returns an OSS URL. In this case, only the URL of an MP4 file can be used for playback.
Media: the information about a media asset
Parameter | Type | Description |
MediaId | String | The ID of the media asset. |
CreationTime | String | The time when the media asset was created. The time must be in UTC. |
MediaType | String | The type of the media asset. Valid values:
|
Video | The information about the video. | |
Audio | The information about the audio. | |
Image | The information about the image. | |
AttachedMedia | The information about the auxiliary media asset. |
PlayInfo: the playback information about a video stream
Parameter | Type | Description |
Bitrate | String | The bitrate of the video stream. Unit: Kbit/s. |
Definition | String | The quality of the video stream. Valid values:
|
Specification | String | The output specifications of a transcoded audio or video stream. For more information about this parameter, see the "Specification" section of the Parameters for media assets topic. |
Duration | String | The duration of the video stream. Unit: seconds. |
Encrypt | Long | Indicates whether the video stream is encrypted. Valid values:
|
EncryptType | String | The type of encryption that was performed on the video stream. Valid values:
|
PlayURL | String | The playback URL of the video stream. |
Format | String | The format of the video stream. If the media asset is a video file, the following values are supported:
If the media asset is an audio-only file, the valid value is mp3. |
Fps | String | The frame rate of the video stream. Unit: FPS. |
Size | Long | The size of the video stream. Unit: bytes. |
Width | Long | The width of the video stream. Unit: pixels. |
Height | Long | The height of the video stream. Unit: pixels. |
StreamType | String | The type of the media stream.
|
JobId | String | The ID of the job that was used to transcode the media stream. This ID uniquely identifies a media stream. |
WatermarkId | String | The ID of the watermark that is associated with the media stream. |
Status | String | The status of the video stream. Valid values:
|
NarrowBandType | String | The type of Narrowband HD™ transcoding. Valid values:
This parameter takes effect only when a definition that is available in the built-in Narrowband HD™ 1.0 transcoding template is specified. For more information, see TranscodeTemplate: the configurations of a transcoding template. |
CreationTime | String | The time when the media stream was created. The time must be in UTC. |
ModificationTime | String | The time when the media stream was updated. The time must be in UTC. |
VideoMeta: the metadata of a video
Parameter | Type | Description |
VideoId | String | The ID of the video. |
Title | String | The title of the video. |
Duration | Float | The duration of the video. Unit: seconds. |
CoverURL | String | The URL of the video thumbnail. |
String | The status of the video. |
Status: the status of a video
Valid value | Description | Remarks |
Uploading | The video is being uploaded. | This is the initial status of a video. It indicates that the video is being uploaded. |
UploadFail | The video fails to be uploaded. | This value is temporarily not used because videos are uploaded in resumable mode and ApsaraVideo VOD cannot determine whether a resumable upload fails. |
UploadSucc | The video is uploaded. | None. |
Transcoding | The video is being transcoded. | None. |
TranscodeFail | The video fails to be transcoded. | Transcoding failures are usually caused by errors in the source file. To troubleshoot a transcoding failure, you can obtain the error message from the TranscodeComplete event notification. For more information about the event notification, see TranscodeComplete. For more information about troubleshooting transcoding failures, see FAQ about transcoding. |
Checking | The video is being reviewed. | You can perform the following operations to review the video before it is published: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Review > Settings. Set the Process parameter to Review Before Publish. Then, the status of the video changes to Reviewing after the video is transcoded. In this case, the video can be played only in the ApsaraVideo VOD console. |
Blocked | The video is blocked. | A video that is being reviewed is blocked. |
Normal | The video can be played. | A video in the Normal state can be played. |
ProduceFail | The video fails to be produced. | None. |
Status: the status of an image
Valid value | Description | Remarks |
Uploading | The image is being uploaded. | This is the initial status of an image. It indicates that the image is being uploaded. |
Normal | The image is uploaded. | If an image is in this state, the image is uploaded. |
UploadFail | The image fails to be uploaded. | If an image is in this state, the image fails to be uploaded. |
Category: the category information about a media asset
Parameter | Type | Description |
CateId | Long | The category ID of the video. |
CateName | String | The name of the category. The value can be up to 64 bytes in length and is encoded in the UTF-8 format. |
ParentId | Long | The ID of the parent category. The parent category ID of a level 1 category is -1. |
Level | Long | The level of the category. A value of 0 indicates a level 1 category. |
Mezzanine: the information about a source file
Parameter | Type | Description |
VideoId | String | The ID of the video file. |
FileName | String | The name of the file. |
Duration | String | The duration of the source file. Unit: seconds. |
Status | String | The status of the source file. |
CreationTime | String | The time when the source file was created. The time must be in UTC. |
Height | Long | The height of the source file. Unit: pixels. |
Width | Long | The width of the source file. Unit: pixels. |
Fps | String | The frame rate of the source file. Unit: FPS. |
FileURL | String | The URL of the source file. |
Bitrate | String | The bitrate of the source file. Unit: Kbit/s. |
Size | Long | The size of the source file. Unit: bytes. |
OutputType | String | The type of the playback URL for the output file. Valid values:
|
VideoStreamList | The information about each video stream. | |
AudioStreamList | The information about each audio stream. |
VideoStream: the information about a video stream
Parameter | Type | Description |
Index | String | The sequence number of the video stream. The value indicates the position of the video stream in all video streams. |
CodecName | String | The short name of the encoding format. |
CodecLongName | String | The full name of the encoding format. |
Profile | String | The codec profile. |
CodecTimeBase | String | The codec time base. |
CodecTagString | String | The tag string of the encoding format. |
CodecTag | String | The tag of the encoding format. |
Width | Long | The width of the video in pixels. |
Height | Long | The height of the video in pixels. |
HasBFrames | String | Indicates whether the video stream contains bidirectional frames (B-frames). |
Sar | String | The sample aspect ratio (SAR). |
Dar | String | The display aspect ratio (DAR). |
PixFmt | String | The pixel format. |
Level | String | The codec level. |
Fps | String | The frame rate of the output file. |
AvgFPS | String | The average frame rate. |
Timebase | String | The time base. |
StartTime | String | The start point in time. |
Duration | String | The duration of the video. |
NumFrames | String | The total number of frames. |
Lang | String | The language. |
Rotate | String | The rotation angle of the video. Valid values: [0, 360). |
AudioStream: the information about an audio stream
Parameter | Type | Description |
Index | String | The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams. |
CodecName | String | The short name of the encoding format. |
CodecLongName | String | The full name of the encoding format. |
CodecTimeBase | String | The codec time base. |
CodecTagString | String | The tag string of the encoding format. |
CodecTag | String | The tag of the encoding format. |
SampleFmt | String | The sampling format. |
SampleRate | String | The sampling rate. |
Channels | String | The number of sound channels. |
ChannelLayout | String | The output layout of the sound channels. |
Timebase | String | The time base. |
StartTime | String | The start point in time. |
Duration | String | The duration of the audio. |
Bitrate | String | The bitrate. |
NumFrames | String | The total number of frames. |
Lang | String | The language. |
Status: the status of a source file
Valid value | Description | Remarks |
Uploading | The file is being uploaded. | This is the initial status of a source file. It indicates that the file is being uploaded. |
Normal | The file is uploaded. | A source file in this state is uploaded. |
UploadFail | The file fails to be uploaded. | A source file in this state fails to be uploaded. |
Deleted | The file is deleted. | A source file in this state is deleted. |
LiveRecordVideo: the information about a live-to-VOD file
Parameter | Type | Description |
StreamName | String | The name of the live stream. |
DomainName | String | The domain name. |
AppName | String | The name of the application. |
PlaylistId | String | The ID of the playlist. |
RecordStartTime | String | The time when the recording starts. |
RecordEndTime | String | The time when the recording ends. |
Video | Video | The information about the video. |
TopPlayVideoStatis: the daily playback statistics on one of the top videos
Parameter | Type | Description |
VideoId | String | The ID of the video file. |
PlayDuration | String | The playback duration of the video. Unit: milliseconds. |
Title | String | The title of the video. |
VV | String | The number of video views. |
UV | String | The number of unique visitors. |
VideoPlayStatisDetail: the daily playback statistics on a specific video
Parameter | Type | Description |
Date | String | The date in the yyyyMMdd format. Example: 20170120. |
PlayDuration | String | The playback duration of the video. Unit: milliseconds. |
Title | String | The title of the video. |
VV | String | The number of video views. |
UV | String | The number of unique visitors. |
PlayRange | String | The distribution of the playback duration. |
UserPlayStatisTotals: the statistics on total playbacks per day
Parameter | Type | Description |
Date | String | The date in the yyyyMMdd format. Example: 20170120. |
PlayDuration | String | The playback duration of the video. Unit: milliseconds. |
PlayRange | String | The distribution of the playback duration. |
VV | VV | The total number of video views. |
UV | UV | The total number of unique visitors. |
UserPlayStatisAvgs: the statistics on average playbacks per day
Parameter | Type | Description |
Date | String | The date in the yyyyMMdd format. Example: 20170120. |
AvgPlayDuration | String | The average playback duration of the video. Unit: milliseconds. |
AvgPlayCount | String | The average number of video views. |
VV
Indicates the statistics on video playbacks that use ApsaraVideo Player SDKs.
Parameter | Type | Description |
Android | String | The total number of video views played by using ApsaraVideo Player SDK for Android. |
iOS | String | The total number of video views played by using ApsaraVideo Player SDK for iOS. |
Flash | String | The total number of video views played by using the Flash player. |
HTML5 | String | The total number of video views played by using the HTML5 player. |
UV
Indicates the statistics on video playbacks that use ApsaraVideo Player SDKs.
Parameter | Type | Description |
Android | String | The total number of unique visitors who use ApsaraVideo Player SDK for Android. |
iOS | String | The total number of unique visitors who use ApsaraVideo Player SDK for iOS. |
Flash | String | The total number of unique visitors who use the Flash player. |
HTML5 | String | The total number of unique visitors who use the HTML5 player. |
EditingProject: the information about an online editing project
Parameter | Type | Description |
ProjectId | String | The ID of the online editing project. |
Title | String | The title of the online editing project. |
CreationTime | String | The time when the online editing project was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For example, a value of 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017. |
ModifiedTime | String | The time when the online editing project was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For example, a value of 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017. |
Status | String | The status of the online editing project. |
Description | String | The description of the online editing project. |
Timeline | String | The timeline of the online editing project. The value is a JSON string. |
Duration | String | The duration of the online editing project. The duration must be the same as that of the timeline. |
CoverURL | String | The thumbnail URL of the online editing project. |
Timeline: the information about the timeline of an online editing project
Parameter | Type | Description |
Id | String | The ID of the online editing project. |
Title | String | The title of the online editing project. |
CreationTime | String | The time when the timeline was created. |
ModifiedTime | String | The time when the timeline was last modified. |
Duration | Float | The total duration of the timeline. Unit: seconds. The value is accurate to four decimal places. |
CurrentRuler | Float | The current scale of the timeline. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
CurrentPosition | Float | The current position of the playhead for the online editing project. Unit: seconds. The value is accurate to four decimal places. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
VideoTracks | The video tracks. |
VideoTrack: the information about a video track
Parameter | Type | Description |
Count | Int | The total number of video clips. |
Duration | String | The total duration of video tracks. |
VideoTrackClips | The video clips. |
VideoTrackClip: the information about a video clip
Parameter | Type | Description |
Id | String | The ID of the video clip. This parameter is optional if the timeline is used only for video production and not for data storage during editing. If the timeline is used to edit data, you must set this parameter to a unique value within the timeline. |
VideoId | String | The video ID of the clip. |
Type | String | The type of the clip. Valid values:
Default value: Video. |
Title | String | The title of the video clip. The title must be the same as that of the video. |
Index | Int | The sequence number of the video clip in the timeline. Sequence numbers start from zero. |
CutFlag | Boolean | Indicates whether the video clip is cropped. Valid values: true and false. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
TextFlag | Boolean | Indicates whether a part of the video clip is masked. Valid values: true and false. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
DeWatermarkFlag | Boolean | Specifies whether a part of the video clip is masked. Valid values: true and false. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
URL | String | The URL of the stream that is used to edit the video clip. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
CoverURL | String | The thumbnail URL of the video clip. By default, this thumbnail URL is the same as that of the video. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
SpriteURLs | String | The sprite snapshot URLs of the video clip. Separate multiple URLs with commas (,). This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
Width | Int | The width of the stream that is used to edit the video clip. Unit: pixels. This parameter is optional if the timeline is used only for video production without special effects, such as banners and masks, and not for data storage during editing. |
Height | Int | The height of the stream that is used to edit the video clip. Unit: pixels. This parameter is optional if the timeline is used only for video production without special effects, such as banners and masks, and not for data storage during editing. |
Fps | Float | The frame rate of the video clip. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
Bitrate | Float | The bitrate of the stream that is used to edit the video clip. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
In | Float | The start time of the video clip in the video. Unit: seconds. The value is accurate to four decimal places. |
Out | Float | The end time of the video clip in the video. Unit: seconds. The value is accurate to four decimal places. |
Duration | Float | The duration of the video clip. Unit: seconds. The value is accurate to four decimal places. |
VirginDuration | Float | The total duration of the video to which the video clip belongs. Unit: seconds. The value is accurate to four decimal places. This parameter is optional if the timeline is used only for video production and not for data storage during editing. |
TimelineIn | Float | The start time of the video clip in the timeline. Unit: seconds. The value is accurate to four decimal places. |
TimelineOut | Float | The end time of the video clip in the timeline. Unit: seconds. The value is accurate to four decimal places. |
Effects | Effect[] | The effects added to the video clip. |
Effect: the information about an effect
Parameter | Type | Description |
Type | String | The type of the effect. Valid values:
|
Name | String | The name of the effect. |
SubType | String | The subtype of the effect. If the Type parameter is set to DeWatermark, this parameter is set to Delogo_Blur. |
In | Float | The start time of the effect added to the video clip. Unit: seconds. The value is accurate to four decimal places. |
Out | Float | The end time of the effect added to the video clip. Unit: seconds. The value is accurate to four decimal places. |
TimelineIn | Float | The start time of the effect in the timeline. Unit: seconds. The value is accurate to four decimal places. |
TimelineOut | Float | The end time of the effect in the timeline. Unit: seconds. The value is accurate to four decimal places. |
X | String | The X coordinate of the effect. The upper-left corner of the video image is used as the coordinate origin. The value can be an integer or a decimal.
|
Y | String | The Y coordinate of the effect. The upper-left corner of the video image is used as the coordinate origin. The value can be an integer or a decimal.
|
Width | Int | The width of the area where the effect added. The value can be an integer or a decimal.
|
Height | Int | The height of the area where the effect is added. The value can be an integer or a decimal.
|
FEWidth | Float | The displayed width of the video image during editing. Unit: pixels. |
FEHeight | Float | The displayed height of the video image during editing. Unit: pixels. |
Font | String | The font. Set the value to SimSun. |
FontFace | The appearance of the font. | |
FontColor | String | The color of the font. The value must start with a number sign (#) and in the hexadecimal format. Example: #ffffff. |
FontSize | Int | The size of the font. |
FontColorOpacity | Float | The transparency of the font. Valid values: 0 to 1. 1 indicates that the font is not transparent and 0 indicates that the font is completely transparent. |
Content | String | The content of the banner text. |
FontFace: the font style
Parameter | Type | Description |
Bold | Boolean | Indicates whether the font is bold. |
Italic | Boolean | Indicates whether the font is italic. |
Underline | Boolean | Indicates whether the font is underlined. |
MediaMetadata: the metadata of a media resource
Parameter | Type | Description |
Title | String | The title of the produced video. The value can be up to 128 bytes in length and must be encoded in the UTF-8 format. |
Description | String | The description of the produced video. The value can be up to 1,024 bytes in length and must be encoded in the UTF-8 format. |
CoverURL | String | The URL of the custom thumbnail for the produced video. |
CateId | String | The category ID of the produced video. Perform the following operations to modify or view the category ID: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > Media Management > Categories. |
Tags | String | The tags of the produced video. Each tag name can be up to 32 bytes in length. You can specify a maximum of 16 tags. Separate multiple tags with commas (,). The string must be encoded in the UTF-8 format. |
ProduceConfig: the configurations of video production
Parameter | Type | Description |
TemplateGroupId | String | The ID of the transcoding template group that is used to transcode produced videos. The produced video files are used as the source files for transcoding. The transcoding process is similar to that is performed after a file is uploaded. This parameter is optional. If you leave this parameter empty, the default template group is used for transcoding. If you specify this parameter, the specified template group is used for transcoding. To view the template group ID, go to the Transcoding Template Groups page in the ApsaraVideo VOD console. |
TemplateId | String | The ID of the template that is used for video production. The produced media file is used as the source file of the media resources. This parameter is optional. If you leave this parameter empty, ApsaraVideo VOD uses the built-in online editing template for video production. If a video file is produced, the encoding format of the built-in template is H.264, and the container format is MP4. If you want to create custom parameters for video production, submit an application on Yida. For example, if you want to produce animated stickers, intelligently produce subtitles, edit videos based on the M3U8 playlists, or use custom production parameters, submit an application on Yida to apply for a specific template. |
Width | Integer | The width of the produced video. Unit: pixels. This parameter is optional. The default width is the maximum width of the source files of the video clips that are used in the timeline. For example, three video clips are used in the timeline. The resolutions of their source files are 1280 × 720 pixels, 1920 × 1080 pixels, and 720 × 1280 pixels. In this case, the output resolution of the produced video is 1920 × 1280 pixels. |
Height | Integer | The height of the produced video. Unit: pixels. This parameter is optional. The default width is the maximum width of the source files of the video clips that are used in the timeline. For example, three video clips are used in the timeline. The resolutions of their source files are 1280 × 720 pixels, 1920 × 1080 pixels, and 720 × 1280 pixels. In this case, the output resolution of the produced video is 1920 × 1280 pixels. |
StorageLocation | String | The storage location of the produced file. This parameter is required if the produced file is stored in a region other than China (Shanghai). |
Material: the information about a material for an online editing project
Materials for an online editing project can be materials from media assets or videos in the media library.
Parameter | Type | Description |
MaterialId | String | The ID of the material. |
Title | String | The title of the material. |
Description | String | The description of the material. |
Duration | Float | The duration of the material. Unit: seconds. The value is accurate to four decimal places. |
CoverURL | String | The thumbnail URL of the material. |
Status | String | The status of the material. |
CreationTime | String | The time when the material was created. The time is displayed in UTC. |
Size | Long | The size of the source file. Unit: bytes. |
CateId | Long | The category ID of the material. |
CateName | String | The category name of the material. |
Tags | String | The tags of the material. Multiple tags are separated by commas (,). |
Snapshots | String[] | The URLs of material snapshots. The value is an array. |
Sprites | String[] | The URLs of material sprite snapshots. The value is an array. |
ProjectStatus: the status of an online editing project
Valid value | Description | Remarks |
Normal | The online editing project is being edited. | This is the initial status of an online editing project. |
Producing | Video production is being performed. | None. |
Produced | Video production is successful. | None. |
ProduceFaile | The video fails to be produced. | None. |
TranscodeJob: the information about a transcoding job
Parameter | Type | Description |
JobId | String | The ID of the job. |
SnapshotJob: the information about a snapshot job
Parameter | Type | Description |
JobId | String | The ID of the job. |
MediaSnapshot: the media snapshot data
Parameter | Type | Description |
JobId | String | The ID of the snapshot job. |
CreationTime | String | The time when the snapshot job was created. The time is displayed in UTC. |
Total | Long | The total number of snapshots. |
Regular | String | The rule used to generate snapshot URLs. |
Snapshots | Snapshot[] | The snapshot data. |
Snapshot: the information about a snapshot
Parameter | Type | Description |
Index | String | The index of the snapshot. |
Url | String | The URL of the snapshot. |
WatermarkInfo: the information about a watermark
Parameter | Type | Required | Description |
CreationTime | String | Yes | The time when the watermark was added. |
Name | String | Yes | The name of the watermark. |
IsDefault | String | Yes | Indicates whether the default watermark is used. Valid values:
|
Type | String | Yes | The type of the watermark. Valid values:
|
WatermarkId | String | Yes | The ID of the watermark. |
FileUrl | String | No | The OSS URL or CDN URL of the watermark file. This parameter does not apply to text watermarks. |
WatermarkConfig | Yes | The configurations such as the position and effect of the text watermark or image watermark. The value is a JSON string. |
VodTemplateInfo: the information about a template
Field | Type | Description |
Name | String | The name of the template. |
VodTemplateId | String | The ID of the template. |
TemplateType | String | The type of the template. Valid values:
|
IsDefault | String | Indicates whether the default template is used. Valid values:
|
TemplateConfig | JSON | The detailed configurations of the template. The value is a JSON string.
|
CreationTime | String | The time when the template was created. The time is displayed in UTC. |
ModifyTime | String | The time when the template was last modified. The time is displayed in UTC. |
DynamicImageTemplateConfig: the configurations of an animated sticker template
Field | Type | Description |
Name | String | The name of the template. |
Video | The display configurations of the animated sticker. | |
Container | The format of animated stickers. | |
Clip | The configurations used to generate an animated sticker from a video clip. | |
SetDefaultCover | String | Indicates whether the animated sticker is used as the thumbnail. Valid values:
|
Video: the display configurations of an animated sticker
Valid value | Type | Required | Description |
Width | String | Yes | The width of the animated sticker. Valid values: [128, 4096]. |
Height | String | Yes | The height of the animated sticker. Valid values: [128, 4096]. |
Fps | String | Yes | The frame rate of the animated sticker. Valid values: (0, 60] |
Container: the format of an animated sticker
Valid value | Type | Required | Description |
Format | String | Yes | The format of the animated sticker. Valid values: webp and gif. |
Clip: the configurations used to generate an animated sticker from a video clip
Valid value | Type | Required | Description |
TimeSpan | Yes | The time parameters used to generate the animated sticker. |
TimeSpan: the time parameters used to generate a animated sticker
Valid value | Type | Required | Description |
Seek | String | Yes | The start time of the video clip. Values in the following formats are supported:
|
Duration | String | Yes | The duration of the video clip. Values in the following formats are supported:
|
End | String | Yes | The duration of the remaining part of the video after the video clip is cropped. Values in the following formats are supported:
|
TranscodeTemplateGroup: the information about a transcoding template group
Field | Type | Required | Description |
Name | String | Yes | The name of the transcoding template group. |
TranscodeTemplateGroupId | String | Yes | The ID of the transcoding template group. |
IsDefault | String | Yes | Indicates whether the default transcoding template group is used.
|
CreationTime | String | Yes | The time when the transcoding template group was created. |
ModifyTime | String | Yes | The time when the transcoding template group was last modified. |
TranscodeTemplateList | Yes | The information about the transcoding templates. |
TranscodeTemplate: the configurations of a transcoding template
Parameter | Type | Required | Description |
Type | String | No | The type of the transcoding template. Valid values:
Default value: Normal. |
Video | Yes | The transcoding configurations of the video stream. The value is a JSON string. | |
Audio | Yes | The transcoding configurations of the audio stream. The value is a JSON string. | |
Definition | String | Yes | The definition of the transcoding template. Valid values for the definition of a regular transcoding template:
Note
Valid values for the definition of a Narrowband HD™ 1.0 transcoding template:
Note
|
Container | Yes | The format of the container that is used to encapsulate audio and video streams. The value is a JSON string. | |
MuxConfig | No | The transcoding segment configuration. You must set this parameter if the Format parameter is set to HLS. The value is a JSON string. | |
TransConfig | No | The conditional transcoding configurations. You can specify this parameter if you need to determine the basic logic based on the bitrate and resolution of the source file before the transcoded video is generated. The value is a JSON string. | |
TranscodeFileRegular | String | No | The custom path used to store the output files. Note
Example {MediaId}/watermark-{PlayDefinition}: During transcoding, ApsaraVideo VOD replaces {MediaId} with the video ID and {PlayDefinition} with the definition. For example, the video ID can be 8ff5cc93f6da4079a47a77bf71d, and the definition can be fd. Output path example8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4: ApsaraVideo VOD automatically adds the file name extension, such as .mp4, .m3u8, or .flv. |
Clip | No | The video cropping configurations. The value must be a JSON string. For example, you can set this parameter to extract 5 seconds of content from a video to generate a new video. | |
Rotate | String | No | The rotation angle of the video. Valid values: [0, 360]. For example, if you set this parameter to 180, the video image is turned upside down. |
EncryptSetting | No | The encryption configuration for transcoding. | |
PackageSetting | No | The packaging configurations. Only HLS packaging and Dynamic Adaptive Streaming over HTTP (DASH) packaging are supported. The value is a JSON string. | |
SubtitleList | No | The subtitle configurations. The value is a JSON string. | |
WatermarkIds | String[] | No | The ID of the associated watermark. You can associate a maximum of four watermark IDs. USER_DEFAULT_WATERMARK indicates the ID of the default watermark. |
TranscodeTemplateId | String | No | The ID of the transcoding template. You must set this parameter when you modify a transcoding template. |
TemplateName | String | No | The name of the transcoding template. You must set this parameter when you create a transcoding template. |
Example of the TranscodeTemplate parameter
{
"Type":"VideoPackage",
"Video":{
"Codec":"H.264",
"Bitrate":"900",
"Width":"960",
"Remove":"false",
"Fps":"30"
},
"Audio":{
"Codec":"AAC",
"Bitrate":"128",
"Samplerate":"44100"
},
"Container":{
"Format":"m3u8"
},
"MuxConfig":{
"Segment":{
"Duration":"6"
}
},
"EncryptSetting":{
"EncryptType":"AliyunVoDEncryption"
},
"PackageSetting":{
"PackageType":"HLSPackage"
"PackageConfig":{
"BandWidth":"900000"
}
},
"SubtitleUrl": "http://outin-40564284ef058b2163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e-cn.ass",
"CharEncode": "UTF-8",
"WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
"Definition":"SD",
"TemplateName":"test"
}
Video: the transcoding configurations of a video stream
In general, you need only to set the Codec, Bitrate, Height, and Width parameters and set the Remove parameter to false.
We recommend that you set either the Width or Height parameter for the output video file. This ensures that the aspect ratio of the output video file is the same as that of the source file.
Parameter | Type | Required | Description |
Codec | String | Yes | The encoding format of the video. Valid values: H.264 and H.265. |
Remove | String | Yes | indicates whether to delete the video stream. Valid values:
Default value: false. |
Bitrate | String | No | The bitrate of the output video file. If you leave this parameter empty, the bitrate is specified based on the value of the Crf parameter. Unit: Kbit/s. Valid values: [10, 50000]. |
Height | String | No | The image height of the output video file. The value must be a multiple of 2. If you leave this parameter empty, the image height of the source file is used. Unit: pixels. Valid values: [128, 4096]. |
Width | String | No | The image width of the output video file. The value must be a multiple of 2. If you leave this parameter empty, the image width of the source file is used. Unit: pixels. Valid values: [128, 4096]. |
Fps | String | No | The frame rate of the output video file. If you leave this parameter empty, the frame rate of the source file is used. Unit: FPS. Valid values: (0, 60]. |
Gop | String | No | The size of a group of pictures (GOP). Unit: frame. Valid values: [1, 100000]. |
LongShortMode | String | No | Indicates whether to enable auto-rotate screen. The image width of the output video file corresponds to the long side of the source file or the image height of the source file in portrait mode. The image height of the output video file corresponds to the short side of the source file or the image width of the source file in portrait mode. Valid values:
Default value: true. This feature is applicable to videos in portrait mode. We recommend that you enable this feature. |
Crf | String | No | The bitrate quality control factor. If you specify this parameter, the Bitrate parameter becomes invalid. A greater value indicates the poorer image quality and a smaller size of the output video file. A smaller value indicates the better image quality, a larger size, and a longer transcoding duration of the output video file. Valid values: [0, 51]. Default value: 26. We recommend that you do not modify this parameter. |
Profile | String | No | The codec profile. Valid values:
Default value: high. This parameter is valid only if H.264 encoding is performed. Best practices If multiple definitions exist, we recommend that you set this parameter to baseline to ensure normal playback on low-end devices. Set this parameter to main or high for other definitions. |
Preset | String | No | The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium. This parameter is valid only if H.264 encoding is performed. We recommend that you do not modify this parameter. |
ScanMode | String | No | The scan mode. Valid values:
|
Bufsize | String | No | The size of the buffer. Unit: KB. Valid values: [1000, 128000]. Default value: 6000. |
Maxrate | String | No | The maximum video bitrate. Unit: Kbit/s. Valid values: [1000, 50000]. |
PixFmt | String | No | The pixel format. Standard pixel formats such as yuv420p and yuvj420p are supported. yuv420p or the original color format is used by default. |
Example of the Video parameter
{
"Codec":"H.264",
"Bitrate":"128",
"Remove":"false",
"Width":"640",
"Fps":"30"
}
Audio: the transcoding configurations of an audio stream
In general, you need only to set the Codec and Bitrate parameters and set the Remove parameter to false.
Parameter | Type | Required | Description |
Codec | String | Yes | The encoding format of the audio file. Valid values: AAC and MP3. |
Bitrate | String | Yes | The bitrate of the output audio file. Unit: Kbit/s. Valid values: [8, 1000]. |
Remove | String | Yes | Indicates whether to delete the audio stream. Valid values:
Default value: false. |
Samplerate | String | Yes | The sample rate. Unit: Hz. Valid values: 22050, 32000, 44100, 48000, and 96000. Default value: 44100. If the container format for the video files is FLV and the encoding format for the audio files is MP3, this parameter cannot be set to 32000, 48000, or 96000. If the encoding format for the audio files is MP3, this parameter cannot be set to 96000. |
Channels | String | No | The number of sound tracks. Default value: 2.
|
Profile | String | No | The codec profile of the audio. If the Codec parameter is set to AAC, the valid values include aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld. |
Volume | No | The volume. |
Example of the Audio parameter
{
"Codec":"AAC",
"Bitrate":"128",
"Remove":"false",
"Samplerate":"44100"
}
Container: the container format
Parameter | Type | Required | Description |
Format | String | Yes | The container format.
|
Example of the Container parameter
{
"Format":"mp4"
}
MuxConfig: the segment configuration for HLS
You must specify this parameter if the container format is M3U8.
Parameter | Type | Required | Description |
Segment | Yes | The segment configuration. The value must be a JSON object. |
Segment: the configuration of a segment
Parameter | Type | Required | Description |
Duration | String | Yes | The duration of the TS segment. The value must be an integer. Valid values: [1, 60]. Unit: seconds. Example: {"Duration":"10"}. |
Example of the MuxConfig parameter
{
"Segment":{
"Duration":"10"
}
}
TransConfig: conditional transcoding configurations
Parameter | Type | Required | Description |
TransMode | String | No | The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass. |
IsCheckReso | String | No | Specifies whether to check the resolution of the source file. Then, ApsaraVideo VOD determines whether to use the resolution of the source file for transcoding based on the check result. Valid values:
Default value: false. |
IsCheckResoFail | String | No | Specifies whether to check the resolution of the source file for a transcoding failure. Valid values:
Default value: false. |
IsCheckVideoBitrate | String | No | Specifies whether to check the video stream bitrate of the source file. Then, ApsaraVideo VOD determines whether to use the video stream bitrate of the source file for transcoding based on the check result. Valid values:
Default value: false. |
IsCheckVideoBitrateFail | String | No | Specifies whether to check the video stream bitrate of the source file for a transcoding failure. Valid values:
Default value: false. If the IsCheckVideoBitrate parameter is specified, the value of IsCheckVideoBitrate prevails. |
IsCheckAudioBitrate | String | No | Specifies whether to check the audio stream bitrate of the source file. Then, ApsaraVideo VOD determines whether to use the audio stream bitrate of the source file for transcoding based on the check result. Valid values:
Default value: false. |
IsCheckAudioBitrateFail | String | No | Specifies whether to check the audio stream bitrate of the source file for a transcoding failure. Valid values:
Default value: false. If the IsCheckVideoBitrate parameter is specified, the value of IsCheckVideoBitrate prevails. |
Example of the TransConfig parameter
{
"IsCheckReso":"true",
"IsCheckResoFail":"false",
"IsCheckVideoBitrate":"false",
"IsCheckVideoBitrateFail":"false",
"IsCheckAudioBitrate":"false",
"IsCheckAudioBitrateFail":"false"
}
Clip: video cropping configurations
Parameter | Type | Required | Description |
TimeSpan | Yes | The time parameters used to crop a video. |
TimeSpan: the time parameters used to crop a video
Parameter | Type | Required | Description |
Seek | String | Yes | The start time of the video clip. Values in the following formats are supported:
We recommend that you use Format 1. |
Duration | String | No | The duration of the video clip. Values in the following formats are supported:
We recommend that you use Format 1. |
End | String | No | The duration of the remaining part of the video after the video clip is cropped. Values in the following formats are supported:
We recommend that you use Format 1. Note
|
Note: You can specify either the Duration or End parameter.
EncryptSetting: the encryption configuration for transcoding
You must set the EncryptType parameter to AliyunVoDEncryption and call the SubmitTranscodeJobs operation to start the HLS encryption.
Parameter | Type | Required | Description |
EncryptType | String | Yes | The encryption type. Set the value to AliyunVoDEncryption. This parameter is valid only for the M3U8 (HLS) format. |
Example of the EncryptSetting parameter
{
"EncryptType":"AliyunVoDEncryption"
}
PackageSetting: packaging configurations for transcoding
You cannot package video and audio streams after you extract them from files.
Only HLS packaging is supported.
Parameter | Type | Required | Description |
PackageType | String | Yes | The packaging type. Set the value to HLSPackage. |
PackageConfig | No | The packaging configurations. You must specify this parameter if a video stream packaging template is used for transcoding. | |
SubtitleExtractConfigList | No | The subtitle packaging configurations. You can specify this parameter only when a subtitle packaging template is used for transcoding. |
PackageConfig: video packaging configurations
You can set this parameter only if the PackageType parameter is set to HLSPackage.
Parameter | Type | Required | Description |
BandWidth | String | Yes | The maximum bandwidth. You must specify this parameter for HLS packaging. Unit: bit/s. You can specify this parameter only if a video stream packaging template is used for transcoding. |
Example of the PackageSetting parameter
Sample code for configuring a video stream packaging template:
{
"PackageType":"HLSPackage",
"PackageConfig":{
"BandWidth":"400000"
}
}
SubtitleExtractConfig: subtitle packaging configurations
Parameter | Type | Required | Description |
SubtitleUrlList | String[] | Yes | The URL of the subtitle file. Only HTTP OSS URLs are supported. HTTP CDN URLs and HTTPS URLs are not supported. Note
|
Language | String | Yes | The tag of the subtitle language, such as en-US. For more information, see RFC 5646. |
Format | String | Yes | The format of subtitle files. Only .vtt files are supported. Sample file name: subtitle.vtt. |
Name | String | Yes | The display name of the subtitle in the player, such as Chinese and English. |
Example of the SubtitlePackage parameter
Sample code for configuring a subtitle packaging template:
{
"PackageType": "HLSPackage",
"SubtitleExtractConfigList": [
{
"SubtitleUrlList": [
"http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d69ca-eng.vtt"
],
"Language": "en-US",
"Format": "vtt",
"Name": "English"
},
{
"SubtitleUrlList": [
"http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5e87e-jpn.vtt"
],
"Language": "ja",
"Format": "vtt",
"Name": "Japanese"
},
{
"SubtitleUrlList": [
"http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8bff3-cn.vtt"
],
"Language": "cn",
"Format": "vtt",
"Name": "Chinese"
}
]
}
SubtitleConfig: subtitle configurations
Parameter | Type | Required | Description |
SubtitleUrl | String | Yes | The OSS URL of the subtitle file. HTTPS URLs and CDN URLs are not supported. Supported subtitle formats: srt and ass. Note The subtitle file and source video file must be stored in the same bucket in the same region, such as the China (Shanghai) region. |
CharEnc | String | Yes | The encoding format. Valid values:
Default value: UTF-8. |
For more information about how to upload a subtitle file, see CreateUploadAttachedMedia and Upload OSS objects.
Example of the SubtitleConfig parameter
{
"SubtitleUrl": "http://outin-40564284ef058b2d300163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e.ass",
"CharEncode": "UTF-8"
}
Volume: the volume configurations
Parameter | Type | Required | Description |
Method | String | No | The volume adjustment method. Valid values: auto, dynamic, and linear. |
IntegratedLoudnessTarget | String | No | The new volume. Valid values: [-70, -5]. This parameter is valid only if the Method parameter is set to dynamic. Default value: -6. |
TruePeak | String | No | The maximum volume. Valid values: [-9, 0]. This parameter is valid only if the Method parameter is set to dynamic. Default value: -1. |
LoudnessRangeTarget | String | No | The range of the volume. Valid values: [1, 20]. This parameter is valid only if the Method parameter is set to dynamic. Default value: 8. |
Example of the Volume parameter
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"auto",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Supported combinations of container formats and audio encoding formats
Container | Audio Codecs |
mp3 | MP3 |
mp4 | AAC |
ogg | VORBIS and FLAC |
flac | FLAC |
Supported combinations of container formats, audio encoding formats, and video encoding formats
Container | Video Codecs | Audio Codecs |
flv | H.264 | AAC and MP3 |
mp4 | H.264 and H.265 | AAC and MP3 |
ts | H.264 and H.265 | AAC and MP3 |
m3u8 | H.264 and H.265 | AAC and MP3 |
gif | GIF | Not supported |
Supported combinations of video encoding formats and video stream parameters
Video Codecs | H.264 | H.265 | GIF |
Profile | Supported | × | × |
Bitrate | Supported | Supported | × |
Crf | Supported | Supported | × |
Width | Supported | Supported | Supported |
Height | Supported | Supported | Supported |
Fps | Supported | Supported | Supported |
Gop | Supported | Supported | × |
Preset | Supported | × | × |
ScanMode | Supported | Supported | Supported |
Bufsize | Supported | Supported | × |
Maxrate | Supported | Supported | × |
PixFmt | Supported | Supported | bgr8 |
TranscodeSummary: the transcoding summaries
Parameter | Type | Description |
VideoId | String | The ID of the video file. |
TranscodeTemplateGroupId | String | The ID of the transcoding template group. |
TranscodeStatus | String | The transcoding status. Valid values:
|
TranscodeJobInfoSummaryList | The summaries of transcoding jobs. | |
CreationTime | String | The time when the transcoding task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
CompleteTime | String | The time when the transcoding task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
TranscodeJobInfoSummary: the summary of a transcoding job
Parameter | Type | Description |
TranscodeTemplateId | String | The ID of the transcoding template. |
Width | String | The image width of the output video. Unit: pixels. |
Height | String | The image height of the output video. Unit: pixels. |
Duration | String | The duration of the output video. Unit: seconds. |
Filesize | String | The size of the output video file. Unit: bytes. |
Bitrate | String | The average bitrate of the output video. Unit: Kbit/s. |
Fps | String | The frame rate of the output video. Unit: frames per second. |
Format | String | The container format of the output video. |
WatermarkIdList | String[] | The IDs of the watermarks that are applied to the output video. |
TranscodeProgress | Long | The transcoding progress. Valid values: [0, 100]. |
TranscodeJobStatus | String | The status of the transcoding job. Valid values:
|
CreationTime | String | The time when the transcoding job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
CompleteTime | String | The time when the transcoding job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
ErrorCode | String | The error code returned when the transcoding job failed. |
ErrorMessage | String | The error message returned when the transcoding job failed. |
TranscodeTask: the information about a transcoding task
Parameter | Type | Description |
TranscodeTaskId | String | The ID of the transcoding task. |
TranscodeTemplateGroupId | String | The ID of the transcoding template group. |
VideoId | String | The ID of the video file. |
TaskStatus | String | The status of the transcoding task. Valid values:
|
CreationTime | String | The time when the transcoding task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
CompleteTime | String | The time when the transcoding task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Trigger | String | The type of the trigger. Valid values:
|
TranscodeJobInfoList | The information about transcoding jobs. |
TranscodeJobInfo: the information about a transcoding job
Parameter | Type | Description |
TranscodeTaskId | String | The ID of the transcoding task. |
TranscodeJobId | String | The ID of the transcoding job. |
VideoId | String | The ID of the video file. |
TranscodeProgress | Long | The progress of the transcoding job. Valid values: [0, 100]. |
TranscodeJobStatus | String | The status of the transcoding job. Valid values:
|
Priority | String | The priority of the transcoding task. |
Definition | String | The definition. Note This parameter indicates the definition that is configured in the transcoding template and does not indicate the actual resolution of the output video. |
TranscodeTemplateId | String | The ID of the transcoding template. |
CreationTime | String | The time when the transcoding job was created. |
CompleteTime | String | The time when the transcoding job was complete. |
InputFileUrl | String | The OSS URL of the source file. |
OutputFile | The information about the output file. | |
ErrorCode | String | The error code returned when the transcoding job failed. |
ErrorMessage | String | The error message returned when the transcoding job failed. |
OutputFile: the information about an output file after transcoding
Parameter | Type | Description |
OutputFileUrl | String | The OSS URL of the output file. |
Format | String | The container format of the output file. |
Width | String | The image width of the output file. Unit: pixels. |
Height | String | The image height of the output file. Unit: pixels. |
Duration | String | The duration of the output file. Unit: seconds. |
Bitrate | String | The average bitrate of the output file. Unit: Kbit/s. |
Fps | String | The frame rate of the output file. Unit: frames per second. |
Filesize | Long | The size of the output file. Unit: bytes. |
EncryptType | String | The encryption type that is used for the output file. The value is a JSON string. |
WatermarkIdList | String | The IDs of the watermarks that are applied to the output file. |
VideoStreamList | String | The video streams. For more information, see VideoStream: the information about a video stream. |
AudioStreamList | String | The audio streams. For more information, see AudioStream: the information about an audio stream. |
ImageInfo: the information about an image
Parameter | Type | Description |
ImageId | String | The ID of the image. |
URL | String | The URL of the image. If a domain name for CDN is specified, a CDN URL is returned. Otherwise, an OSS URL is returned. |
Title | String | The title of the image. |
Tags | String | The tags of the image. |
ImageType | String | The type of the image. |
CateId | Long | The ID of the category to which the image belongs. |
CateName | String | The name of the category. |
Description | String | The description of the auxiliary media asset. |
StorageLocation | String | The storage location. |
Mezzanine | The information about the source image file. | |
CreationTime | String | The time when the image was created. The time must be in UTC. |
String | The status of the image. | |
String | The ID of the application. |
Mezzanine: the information about a mezzanine image file
Parameter | Type | Description |
FileURL | String | The OSS URL of the source image file. |
OriginalFileName | String | The name of the source image file. |
FileSize | Long | The size of the source image file. Unit: bytes. |
Width | Integer | The width of the source image file. Unit: pixels. |
Height | Integer | The height of the source image file. Unit: pixels. |
DynamicImage: the information about an animated sticker
Parameter | Type | Description |
VideoId | String | The ID of the video file. |
DynamicImageId | String | The ID of the animated sticker. |
FileURL | String | The URL of the animated sticker file. |
Width | String | The width of the animated sticker. |
Height | String | The height of the animated sticker. |
Duration | String | The duration of the animated sticker. |
Format | String | The format of the animated sticker. Valid values: gif and webp. |
FileSize | String | The size of the animated sticker file. |
Fps | String | The frame rate of the animated sticker. |
URLUploadInfo: the information about a URL-based upload job
Parameter | Type | Description |
JobId | String | The ID of the upload job. |
UploadURL | String | The URL of the video to be uploaded. |
MediaId | String | The ID of the video to be uploaded. |
String | The status of the video. | |
String | The status of the URL-based upload job. | |
CreationTime | String | The time when the job was created. |
CompleteTime | Long | The time when the job was complete. |
UserData | String | The custom configurations. |
ErrorCode | String | The error code returned when the job fails. |
ErrorMessage | String | The error message returned when the job fails. |
Status: the status of a URL-based upload job
Valid value | Description |
PENDING | The upload job is submitted and is to be processed. |
PROCESSING | The upload job is being processed. |
DOWNLOADING | The file is being downloaded. |
DOWNLOAD_SUCCESS | The file is downloaded. |
DOWNLOAD_FAIL | The file fails to be downloaded. |
UPLOADING | The file is being uploaded. |
UPLOAD_SUCCESS | The file is uploaded. |
UPLOAD_FAIL | The file fails to be uploaded. |
SUCCESS | The upload job is successful, and the callback is complete. |
AttachedMediaInfo: the information about an auxiliary media asset
Parameter | Type | Description |
MediaId | String | The ID of the auxiliary media asset. |
URL | String | The URL of the auxiliary media asset. If a domain name for CDN is specified, a CDN URL is returned. Otherwise, an OSS URL is returned. |
Title | String | The title of the auxiliary media asset. |
Tags | String | The tags of the auxiliary media asset. |
Type | String | The type of the auxiliary media asset. |
Categories | Category[] | The categories. |
Description | String | The description of the auxiliary media asset. |
StorageLocation | String | The storage location. |
CreationTime | String | The time when the auxiliary media asset was created. The time must be in UTC. |
ModificationTime | String | The time when the auxiliary media asset was last modified. The time must be in UTC. |
String | The status of the auxiliary media asset. | |
AppId | String | The ID of the application. |
Status: the status of an auxiliary media asset
Valid value | Description | Remarks |
Uploading | The auxiliary media asset is being uploaded. | This is the initial status of an auxiliary media asset. It indicates that the auxiliary media asset is being uploaded. |
Normal | The auxiliary media asset is uploaded. | An auxiliary media asset in this state is uploaded. |
UploadFail | The auxiliary media asset failed to be uploaded. | An auxiliary media asset in this state fails to be uploaded. |
MessageCallback: the configurations of an event notification
Parameter | Type | Description |
CallbackType | String | The callback method. Valid values: HTTP and MNS. |
CallbackURL | String | The callback URL. This parameter is returned only for HTTP callbacks. |
MnsEndpoint | String | The public endpoint of Message Service (MNS). This parameter is returned only for MNS callbacks. |
MnsQueueName | String | The name of the MNS queue. This parameter is returned only for MNS callbacks. |
EventTypeList | String | The type of the callback event. |
AuthSwitch | String | Indicates whether callback authentication is enabled. This parameter is returned only for HTTP callbacks. Valid values:
|
AuthKey | String | The cryptographic key. This parameter is returned only for HTTP callbacks. |
AppInfo: the information about an application
Parameter | Type | Description |
AppId | String | The ID of the application. |
AppName | String | The name of the application. |
Description | String | The description of the application. |
Type | String | The type of the application. Valid values: System and Custom. |
Status | String | The status of the application. Valid values: Normal and Disable. |
CreationTime | String | The time when the application was created. The time is displayed in UTC. |
ModificationTime | String | The time when the application was last modified. The time is displayed in UTC. |
AppPolicy: the information about an application policy
Parameter | Type | Description |
AppId | String | The ID of the application. |
PolicyType | String | The type of the policy. Valid values: System and Custom. |
PolicyName | String | The name of the policy. |
CreationTime | String | The time when the policy was created. The time is displayed in UTC. |
Description | String | The description of the policy. |