ApsaraVideo VOD:Online editing data types - old editor

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.

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 size of the timeline ruler.

This parameter is optional if the timeline is used only for video production.

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.

VideoTracks

VideoTrack[]

The video tracks.

Parameter

Type

Description

Count

Int

The total number of video clips.

Duration

String

The total duration of video tracks.

VideoTrackClips

VideoTrackClip[]

The video clips.

Parameter

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 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:

• Video

• Image

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

Specifies whether the video clip is cropped. Valid values: true and false.

This parameter is optional if the timeline is used only for video production.

TextFlag

Boolean

Specifies 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

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.

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.

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.

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.

Width

Int

The width of the stream from which the video clip is edited. Unit: pixels.

This parameter is optional if the timeline is used only for video production without special effects, such as banner text and masks.

Height

Int

The height of the stream from which the video clip is edited. Unit: pixels.

This parameter is optional if the timeline is used only for video production without special effects, such as banner text and masks.

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 from which the video clip is edited.

This parameter is optional if the timeline is used only for video production.

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.

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.

Parameter

Type

Description

Type

String

The type of the effect. Valid values:

• Text: Adds banner text to the video clip.

• DeWatermark: Masks a specific part of the video clip.

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.

• If the value is an integer, the values range from 8 to 4096. Unit: pixels.

• If the value is a decimal number, the values range between 0 and 1 and indicates the ratio of the width of the effect area to the width of the output video. The decimal number can be accurate to 4 decimal places, such as 0.9999. Excessive digits are automatically deleted.

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.

• If the value is an integer, the values range from 8 to 4096. Unit: pixels.

• If the value is a decimal number, the values range between 0 and 1 and indicate the ratio of the height of the effect area to the height of the output video. The decimal number can be accurate to 4 decimal places, such as 0.9999. Excessive digits are automatically deleted.

Width

Int

The width of the area where the effect is added. The value can be an integer or a decimal.

• If the value is an integer, the values range from 8 to 4096. Unit: pixels.

• If the value is a decimal number, the values range between 0 and 1 and indicate the ratio of the width of the effect area to the width of the output video. The decimal number can be accurate to 4 decimal places, such as 0.9999. Excessive digits are automatically deleted.

Height

Int

The height of the area where the effect is added. The value can be an integer or a decimal.

• If the value is an integer, the values range from 8 to 4096. Unit: pixels.

• If the value is a decimal number, the values range between 0 and 1 and indicate the ratio of the height of the effect area to the height of the output video. The decimal number can be accurate to 4 decimal places, such as 0.9999. Excessive digits are automatically deleted.

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

FontFace

The appearance of the font.

FontColor

String

The color of the font. The value must start with a number sign (#) 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.

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.

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 UTF-8.

Description

String

The description of the produced video. The value can be up to 1,024 bytes in length and must be encoded in UTF-8.

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.

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 a request 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 a request 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 address of the produced file. This parameter is required if the produced file is stored in a region other than China (Shanghai).

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.

Valid value

Description

Remarks

Normal

The online editing project is in the draft status.

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.