All Products
Search

This Product

    Intelligent Media Services:Data types for the media asset library

    Document Center

    Intelligent Media Services:Data types for the media asset library

    Last Updated:Jan 14, 2026

    This topic describes the data types involved in the media asset library of Intelligent Media Services (IMS).

    MediaInfo

    Media asset content

    Field name

    Type

    Description

    MediaId

    String

    The ID of the media asset, which is globally unique.

    MediaBasicInfo

    MediaBasicInfo

    The basic information about the media asset, including the title and the description.

    FileInfoList

    FileInfo[]

    The file information about the media asset. A media asset may contain multiple entries of file information.

    AiRoughDataList

    AiRoughData[]

    The original result from AI.

    MediaBasicInfo

    Basic information about the media asset

    Field name

    Type

    Description

    MediaId

    String

    The ID of the media asset, which is globally unique. The value must be a 32-bit UUID.

    InputURL

    String

    The URL of the media asset that you want to register. The Object Storage Service (OSS) URL is supported.

    MediaType

    String

    The type of the media asset. Valid values:

    • Image

    • video

    • audio

    • text text

    BusinessType

    String

    The business type of the media asset. Default value: general.

    • Valid values if you set the MediaType parameter to video:

      • opening

      • ending

    • Valid values if you set the MediaType parameter to image:

      • default

      • cover

    • Valid values if you set the MediaType parameter to text:

      • Captions

      • Font

    • Valid values if you set the MediaType parameter to material:

      • watermark

    • general

    Source

    String

    File storage backend

    - oss: OSS bucket

    - vod: ApsaraVideo VOD

    Biz

    String

    The service to which the media asset belongs.

    - ICE (Intelligent Media Services)

    - VOD: ApsaraVideo VOD

    - LIVE: ApsaraVideo Live

    - MTS: ApsaraVideo Media Processing (MTS)

    UploadSource

    String

    Source for uploading media assets

    - console

    - General

    Title

    String

    The title. If you leave this parameter empty, a title is automatically generated based on the date.

    - The value can be up to 128 bytes in length.

    - The value is encoded in UTF-8.

    Description

    String

    The description of the media asset.

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

    - The value is encoded in UTF-8.

    CateId

    Long

    The category ID.

    CateName

    String

    The category name.

    MediaTags

    String

    The tags.

    - You can specify up to 16 tags.

    - Multiple tags are separated with commas (,).

    - Each tag can be up to 32 bytes in length.

    - The value is encoded in UTF-8.

    CoverURL

    String

    The URL of the thumbnail.

    - The value can be up to 128 bytes in length.

    - The value is encoded in UTF-8.

    UserData

    String

    The user data.

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

    - The value is encoded in UTF-8.

    Status

    String

    The status of the media asset. Valid values:

    - Init: The media asset is not ready.

    - Preparing: The media asset is being prepared, such as being registered or modified and composed.

    - PrepareFail: The media asset fails to be prepared. For example, the information about the source file failed to be obtained.

    - Normal: The media asset is ready.

    - Uploading: The source file is being uploaded.

    - UploadSucc: The source file is uploaded.

    - UploadFail: The source file fails to be uploaded.

    - Transcoding: The source file is being transcoded.

    - TranscodeFail: The source file fails to be transcoded.

    - Under review

    - Blocked by review

    CreateTime

    String

    The time when the media asset was created. Format:

    "yyyy-MM-dd'T'HH:mm:ss'Z'".

    ModifiedTime

    String

    The time when the media asset was modified. Format:

    "yyyy-MM-dd'T'HH:mm:ss'Z'".

    DeletedTime

    String

    The time when the media asset was deleted. Format:

    "yyyy-MM-dd'T'HH:mm:ss'Z'".

    SpriteImages

    String

    The configuration and address of the sprite.

    List<SnapshotDTO> -> json String

    FileInfo

    File information

    Field name

    Type

    Description

    FileBasicInfo

    FileBasicInfo

    The basic information about the file, including the duration and the size.

    AudioStreamInfoList

    AudioStreamInfo[]

    The information about the audio tracks. A media asset may have multiple audio tracks.

    VideoStreamInfoList

    VideoStreamInfo[]

    The information about the video tracks. A media asset may have multiple video tracks.

    SubtitleStreamInfoList

    SubtitleStreamInfo[]

    The information about the subtitle tracks. A media asset may have multiple subtitle tracks.

    AiRoughData

    Original data from AI

    Field name

    Type

    Description

    Type

    String

    Specifies the AI type. Valid values:

    • Face

    • ASR: speech recognition

    • OCR: text recognition

    • Label: object or landmark recognition

    • VideoSummary: video synopsis

    • Delogo: masking

    • Crop

    • H2V: horizontal to vertical

    • Matting: image matting

    • Color: color analysis

    • VideoCover: static thumbnail

    • Beat: rhythm detection

    Result

    String

    The original result from AI. If the size of the original result does not exceed 16 KB, the result is directly returned. If the size of the original result exceeds 16 KB, the result is written to an OSS object, and the URL of the OSS object is returned.

    FileBasicInfo

    File basic information

    Field name

    Type

    Description

    FileName

    String

    The file name.

    FileStatus

    String

    The file status.

    FileType

    String

    The file type. Valid values:

    • source_file: source file

    • transcode_file: secondary processing file

    FileSize

    String

    The file size. Unit: bytes.

    FileUrl

    String

    The OSS URL of the file.

    Region

    String

    The region in which the file resides.

    FormatName

    String

    The encapsulation format.

    Duration

    String

    The duration. Unit: seconds.

    Bitrate

    String

    The bitrate. Unit: Kbit/s.

    Width

    String

    The width. Unit: pixels.

    Height

    String

    The height. Unit: pixels.

    AudioStreamInfo

    Audio stream information

    Field Name

    Type

    Description

    Index

    String

    The sequence number of the audio stream.

    CodecName

    String

    The short name of the codec format.

    CodecLongName

    String

    The full name of the codec format.

    CodecTimeBase

    String

    The codec time base.

    CodecTagString

    String

    The tag string of the codec format.

    CodecTag

    String

    The tag of the codec format.

    Profile

    String

    The codec profile.

    SampleFmt

    String

    The sampling format.

    SampleRate

    String

    The sampling rate. Unit: Hz.

    Channels

    String

    The number of sound channels.

    ChannelLayout

    String

    The output layout of sound channels.

    Timebase

    String

    The time base.

    StartTime

    String

    The start time.

    Duration

    String

    The duration. Unit: seconds.

    Bitrate

    String

    The bitrate. Unit: Kbit/s.

    Fps

    String

    The audio frame rate.

    NumFrames

    String

    The total number of frames.

    Lang

    String

    The language.

    VideoStreamInfo

    Video stream information

    Field name

    Type

    Description

    Index

    String

    The sequence number of the video stream.

    CodecName

    String

    The short name of the codec format.

    CodecLongName

    String

    The full name of the codec format.

    Profile

    String

    Codec profile

    CodecTimeBase

    String

    The codec time base.

    CodecTagString

    String

    The tag string of the codec format.

    CodecTag

    String

    The tag of the codec format.

    Width

    String

    The width. Unit: pixels.

    Height

    String

    The height. Unit: pixels.

    HasBFrames

    String

    Specifies whether the video stream contains bidirectional frames (B-frames).

    Sar

    String

    Encoded signal resolution

    Dar

    String

    The display aspect ratio (DAR).

    PixFmt

    String

    The pixel format.

    Level

    String

    The codec level.

    Fps

    String

    The video frame rate.

    AvgFPS

    String

    The average frame rate.

    Timebase

    String

    The time base.

    StartTime

    String

    The start time.

    Duration

    String

    The duration. Unit: seconds.

    Bitrate

    String

    The bitrate. Unit: Kbit/s.

    NumFrames

    String

    The total number of frames.

    Lang

    String

    The language.

    Rotate

    String

    Rotate

    Nb_frames

    String

    The total number of frames.

    SubtitleStreamInfo

    Subtitle stream information

    Field name

    Type

    Description

    Index

    String

    The sequence number of the subtitle stream.

    CodecName

    String

    The short name of the codec format.

    CodecLongName

    String

    The full name of the codec format.

    CodecTimeBase

    String

    The codec time base.

    CodecTagString

    String

    The tag string of the codec format.

    CodecTag

    String

    The tag of the codec format.

    Timebase

    String

    The time base.

    StartTime

    String

    The start time.

    Duration

    String

    The duration. Unit: seconds.

    Lang

    String

    The language.

    MediaTag

    Media asset tags

    Field name

    Type

    Description

    MediaTagId

    String

    The tag ID.

    MediaTagNameEnglish

    String

    The tag name in English.

    MediaTagNameChinese

    String

    The tag name in Chinese.

    SnapshotDTO

    Snapshot information

    Field name

    Type

    Description

    Config

    String

    The snapshot configuration is specified as a JSON string in the SnapshotConfig parameter.

    SnapshotUrlList

    List

    The list of authenticated snapshot URLs.

    Count

    String

    The number of snapshots. If the snapshots are sprites, set the parameter to the number of large images that are spliced.

    SnapshotUrlRegular

    String

    The file name rule of the snapshot. For a common snapshot, the placeholder is {Count}. For a sprite, the placeholder is {TileCount}.

    SnapshotConfig

    Snapshot configuration

    Field name

    Type

    Description

    FrameType

    String

    The frame type of the snapshots. Valid values: intra and normal.

    Num

    String

    The number of snapshots to be captured.

    Interval

    String

    The snapshot interval. The value must be greater than or equal to 0. Unit: seconds. If you set this parameter to 0, snapshots are captured at even intervals based on the video duration divided by the number of snapshots.

    Time

    Long

    The point in time when the first snapshot is captured. Unit: milliseconds.

    Width

    String

    The width of the snapshot. Valid values: [8,4096]. Unit: pixels. By default, the width of the source video is used.

    Height

    String

    The height of each snapshot. Valid values: [8,4096]. Unit: pixels. By default, the height of the source video is used.

    SpriteSnapshotConfig

    SpriteSnapshotConfig

    The sprite configuration.

    SpriteSnapshotConfig

    Sprite configuration

    Field name

    Type

    Description

    CellWidth

    String

    The width of the icon. If the width or height of the icon is configured, the icon retains the aspect ratio of the original image of the icon. The default value is the width of the output snapshot.

    CellHeight

    String

    The height of the icon. If the width or height of the icon is configured, the icon retains the aspect ratio of the original image of the icon. The default value is the height of the output snapshot.

    Padding

    String

    The spacing between two adjacent icons. Default value: 0. Unit: pixels.

    Margin

    String

    The margin width. Default: 0. Unit: pixels.

    Columns

    String

    The number of columns that the tiled icon contains. The value must be an integer. Valid values:(0,10000]. Default value: 10.

    Lines

    String

    The number of rows that the tiled icon contains. The value must be an integer. Valid values:(0,10000]. Default value: 10.

    Color

    String

    The background color. You can specify a color keyword or random value for this parameter. Default value: black. For example, if you want to set the background color to black, you can specify the color keyword in one of the following formats: Black, black, and #000000.

    IsKeepCellPic

    String

    Specifies whether to retain a single icon. Valid values: true and false. Default value: true.