ApsaraVideo VOD uses the following data types for online editing API operations.
Timeline: timeline information
|
Name |
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 size of the timeline ruler. This parameter is optional if the timeline is used only for video production. |
|
CurrentPosition |
Float |
The 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. |
|
VideoTracks |
The list of video tracks. |
VideoTrack: video track information
|
Name |
Type |
Description |
|
Count |
Int |
The total number of video clips. |
|
Duration |
String |
The total duration of the video track. |
|
VideoTrackClips |
The list of video clips. |
VideoTrackClip: video clip information
|
Name |
Type |
Description |
|
Id |
String |
The ID of the video clip. This parameter is optional if the timeline is used only for video production. If the timeline is used for editing, this parameter must be unique within the timeline. |
|
VideoId |
String |
The ID of the material that corresponds to the video clip. |
|
Type |
String |
The type of the video clip. Valid values:
The default value is Video. |
|
Title |
String |
The title of the video clip. By default, this is the same as the title of the source material. |
|
Index |
Int |
The order of the video clip in the timeline. The value starts from 0. |
|
CutFlag |
Boolean |
Whether the video clip is cut. Valid values: true and false. This parameter is optional if the timeline is used only for video production. |
|
TextFlag |
Boolean |
Whether banner text is added to the video clip. Valid values: true and false. This parameter is optional if the timeline is used only for video production. |
|
DeWatermarkFlag |
Boolean |
Whether the video clip is masked. Valid values: true and false. This parameter is optional if the timeline is used only for video production. |
|
URL |
String |
The URL of the stream used for video editing. This parameter is optional if the timeline is used only for video production. |
|
CoverURL |
String |
The thumbnail URL of the video clip. By default, this is the same as the thumbnail URL of the source material. This parameter is optional if the timeline is used only for video production. |
|
SpriteURLs |
String |
The sprite URLs of the video clip. Separate multiple URLs with a comma (,). This parameter is optional if the timeline is used only for video production. |
|
Width |
Int |
The width of the stream used for video editing. Unit: px. This parameter is optional if the timeline is used only for video production and no effects, such as banner text or masking, are added. |
|
Height |
Int |
The height of the stream used for video editing. Unit: px. This parameter is optional if the timeline is used only for video production and no effects, such as banner text or masking, are added. |
|
Fps |
Float |
The frame rate of the video clip. This parameter is optional if the timeline is used only for video production. |
|
Bitrate |
Float |
The bitrate of the stream used for video editing. This parameter is optional if the timeline is used only for video production. |
|
In |
Float |
The in-point of the video clip relative to the source material. Unit: seconds. The value is accurate to four decimal places. |
|
Out |
Float |
The out-point of the video clip relative to the source material. 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 full duration of the source material that corresponds to the video clip. Unit: seconds. The value is accurate to four decimal places. This parameter is optional if the timeline is used only for video production. |
|
TimelineIn |
Float |
The in-point of the video clip relative to the timeline. Unit: seconds. The value is accurate to four decimal places. |
|
TimelineOut |
Float |
The out-point of the video clip relative to the timeline. Unit: seconds. The value is accurate to four decimal places. |
|
Effects |
Effect[] |
The list of effects for the video clip. |
Effect: effect information
|
Name |
Type |
Description |
|
Type |
String |
The type of the effect. Valid values:
|
|
Name |
String |
The name of the effect. |
|
SubType |
String |
The child class of the effect. If you set Type to DeWatermark, set SubType to Delogo_Blur. |
|
In |
Float |
The in-point of the effect relative to the video clip. Unit: seconds. The value is accurate to four decimal places. |
|
Out |
Float |
The out-point of the effect relative to the video clip. Unit: seconds. The value is accurate to four decimal places. |
|
TimelineIn |
Float |
The in-point of the effect relative to the timeline. Unit: seconds. The value is accurate to four decimal places. |
|
TimelineOut |
Float |
The out-point of the effect relative to the timeline. Unit: seconds. The value is accurate to four decimal places. |
|
X |
String |
The x-coordinate offset relative to the top-left corner of the video. The value can be an integer or a decimal.
|
|
Y |
String |
The y-coordinate offset relative to the top-left corner of the video. The value can be an integer or a decimal.
|
|
Width |
Int |
The width of the effect area. The value can be in one of two forms:
|
|
Height |
Int |
The height of the effect area. The value can be an integer or a decimal.
|
|
FEWidth |
Float |
The actual display width of the video during editing. Unit: px. |
|
FEHeight |
Float |
The actual display height of the video during editing. Unit: px. |
|
Font |
String |
The font. Set the value to SimSun. |
|
FontFace |
The appearance of the font. |
|
|
FontColor |
String |
The font color. The value starts with # followed by a hexadecimal value. For example: #ffffff. |
|
FontSize |
Int |
The font size. |
|
FontColorOpacity |
Float |
The font opacity. Valid values: 0 to 1. A value of 1 means opaque, and 0 means fully transparent. |
|
Content |
String |
The content of the banner text. |
FontFace: font style
|
Name |
Type |
Description |
|
Bold |
Boolean |
Bold. |
|
Italic |
Boolean |
Italic. |
|
Underline |
Boolean |
Underline. |