Home > APIs > AppServer API > Examples > Asset Management > Asset Properties
Asset Properties
Asset Properties
Below are the asset properties you can query using IMediaMgr.GetProperty function. See Get Asset Properties for example code showing how to get one or more asset properties.
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| AspectRatio | BSTR | System.String | Returns a string representing the asset's aspect ration. Return values include:"4:3", "16:9" |
|
| AspectRatioConversion | BSTR | System.String | Returns a string indicating the aspect ratio conversion type: Return values include: "Default", "Bars", "Halfbars", "Crop", "Stretch", "Mixed" |
|
| AssetType | BSTR | System.String | String indicates the asset type. Values include "Clip", "Program", "List" |
|
| Attributes1 | long | int | Returns an int that is a bitfield of movie properties. | |
| Attributes2 | long | System.Int32 | Returns an int that is a bitfield of more movie properties. | |
| AudioFormat | BSTR | System.String | Returns a string indicating the audio format. Return values include:"AC3", "Dolby E", "Data", "PCM", "Mixed" |
|
| Bin | BSTR | System.String | Returns a string name of the bin that contains the asset. | e |
| BinId | BSTR | System.String | Returns a string that is the bin's UUID. This is the same as the GroupId property. | |
| BPix | long | System.Int32 | Returns an int indicating the number of B pictures per I and P pictures in a GOP. This is for LGOP MPEG assets only. | |
| Construction | BSTR | System.String | Indicates the asset’s construction status. Values include:"CodecConstruction", "CopyConstruction", "StreamConstruction", "RestoreConstruction", and "DoneConstruction". |
|
| ContinuousRecord | VARIANT_BOOL | System.Boolean | Returns a Boolean indicating whether the asset is a continuous recording. | |
| Created | DATE | System.DateTime | Returns a DateTime when the asset was created. | |
| DropFrame | VARIANT_BOOL | System.Boolean | Returns a Boolean indicating whether the asset's timecode media is drop-frame. | |
| EventCount | long | System.Int32 | Returns an int value indicating the number of events in the List. (valid if the asset is a List). | e |
| FieldsPerFrame | long | System.Int32 | Returns a int indicating the number of fields per frame. | |
| FileLength | long | System.Int32 | Difference between maxMarkOut and minMarkIn properties. | e |
| FileLengthStr | BSTR | System.String | Timecode string representation of the difference between maxMarkOut and minMarkIn properties. | e |
| FirstTimecodeMask | long | System.Int32 | Cached timecode value from the start of the first timecode media file. Timecode is represented as a 32 bit mask. | |
| GroupId | BSTR | System.String | Returns a string that is the group's UUID. This is the same as the BinId property. | |
| HiDef | VARIANT_BOOL | System.Boolean | Returns a Boolean indicating if the asset is an MPEG high definition format. | |
| IPix | long | System.Int32 | Returns an int indicating the number of I pictures per GOP. This is for LGOP MPEG assets only. | |
| IsInUse | VARIANT_BOOL | System.Boolean | VARIANT_TRUE if the movie is locked, has another writable instance open, is under construction, or is loaded on the system processing the property query. | |
| LastTimecodeMask | long | System.Int32 | Cached timecode value from the end of the last timecode media file. Timecode is represented as a 32 bit mask. | |
| LengthStr | BSTR | System.String | String representing the MaxLength value converted to timecode. A ‘;’ character before the frame value indicates dropframe. | |
| Locked | VARIANT_BOOL | System.Boolean | Returns a Boolean indicating if the asset is locked. | |
| MarkIn | long | System.Int32 | Asset mark in value. Does not necessarily reflect media marks. | |
| MarkInStr | BSTR | System.String | String representation of the timecode from the start of the first timecode media file on the first timecode track. A ‘;’ or ‘,’ character before the frame value indicates dropframe. | |
| MarkOut | long | System.Int32 | Asset mark out value. Does not necessarily reflect media marks. | |
| MarkOutStr | BSTR | System.String | String representation of the timecode from the end of the last timecode media file on the first timecode track. Note that this value is one frame greater than the last playable timecode frame. A ‘;’ or ‘,’ character before the frame value indicates dropframe. | |
| MaxLength | long | System.Int32 | Number of fields in longest track (the sum of all media durations). | |
| MaxMarkOut | long | System.Int32 | This is the largest value the mark out can be set to and still show media on all tracks. | e |
| MaxMarkOutStr | BSTR | System.String | This is a string representation of the smallest timecode value the mark in can be set to and still show media on all tracks. The timecode value is mathematically calculated using the firstTimecode property. | e |
| MinLength | long | System.Int32 | Returns a int value that is the number of fields in the shortest track. | |
| MinMarkIn | long | System.Int32 | This is the smallest value the mark in can be set to and still show media on all tracks. | e |
| MinMarkInStr | BSTR | System.String | This is a string representation of the smallest timecode value the mark in can be set to and still show media on all tracks. The timecode value is mathematically calculated using the firstTimecode property. | e |
| Modified | DATE | System.DateTime | Date last modified. | |
| MovieId | BSTR | System.String | 32 character unique identifier (UUID) | |
| MovieSize | long | System.UInt32 | The sum of media file sizes and user data in megabytes (MB). If the movie only references a portion of a file, then only a percent of the file size value is used. | e, x |
| Name | BSTR | System.String | Asset name | |
| NumA | long | System.Int32 | Returns an int value that is number of audio tracks. | |
| NumAncData | long | System.Int32 | Returns an int value that is number of ancillary data tracks. | |
| NumT | long | System.Int32 | Returns an int value that is number of timecode tracks. | |
| NumV | long | System.Int32 | Returns an int value that is number of video tracks. | |
| PPix | long | System.Int32 | Returns an int indicating the number of P pictures per I pictures in a GOP. This is for LGOP MPEG assets only. | |
| ReadOnly | VARIANT_BOOL | System.Boolean | Returns a Boolean indicating if the asset is locked or is a read-only instance (which can happen if some other application has the asset already open for writing). Applications can only lock and unlock assets.ReadOnly is merely reflects the current state of the asset. | |
| ReferenceStandard | long | System.Int32 | Returns an int value indicating the reference standard. All 59.95/29.97Hz formats report NTSC = 0: Format525_29_97Hz_2To1 = 0, Format525_29_97Hz_1To1 = 0, Format525_59_94Hz_1To1 = 0, Format720_59_94Hz_1To1 = 0, Format720_25Hz_1To1, Format720_29_97Hz_1To1 = 0, Format1080_29_97Hz_2To1 = 0, Format1080_29_97Hz_1To1 = 0, Format1440x1080_29_97Hz_2To1 = 0, FormatMixed_29_97HzRef = 0All 50/25 Hz formats report PAL = 1: Format625_25Hz_2To1 = 1, Format625_25Hz_1To1 = 1, Format625_50Hz_1To1 = 1, Format720_50Hz_1To1 = 1, Format720_25Hz_1To1 = 1, Format1080_25Hz_2To1 = 1, Format1080_25Hz_1To1 = 1, Format1440x1080_25Hz_2To1 = 1, FormatMixed_25HzRef = 1 |
|
| ReferenceStandardStr | BSTR | System.String | Returns a string indicating the reference standard. Return values include:"Format525_60Hz_2To1", "Format625_50Hz_2To1", "Format720_59_94Hz_1To1", "Format720_60Hz_1To1", "Format1080_23_98Hz_1To1", "Format1080_24Hz_1To1", "Format1080_25Hz_1To1", "Format1080_29_97Hz_1To1", "Format1080_30Hz_1To1", "Format1080_25Hz_2To1", "Format1080_29_97Hz_2To1", "Format1080_30Hz_2To1", "Format1035_30Hz_2To1", "Format1035_29_97Hz_2To1", "Format720_50Hz_1To1", "Format525_59_94Hz_1To1", "Format525_60Hz_1To1", "Format525_29_97Hz_1To1", "Format525_30Hz_1To1", "Format625_50Hz_1To1", "Format625_25Hz_1To1", "Format720_29_97Hz_1To1", "Format720_30Hz_1To1", "Format720_25Hz_1To1", "Format1440x1080_29_97Hz_2To1", "Format1440x1080_25Hz_2To1", "FormatXga_59_94Hz_1To1", "FormatXga_50Hz_1To1", "FormatWxga_59_94Hz_1To1", "FormatWxga_50Hz_1To1", "FormatWsxga_59_94Hz_1To1", "FormatWsxga_50Hz_1To1", "FormatMixed_29_97HzRef", "FormatMixed_25HzRef", "Unknown Video Format", "Invalid Video Format" |
|
| Repeat | VARIANT_BOOL | System.Boolean | Returns a Boolean indicating if the asset is a List and it has the "repeat" property set. | |
| SectionCount | long | System.Int32 | Number of sections in a List asset. | e |
| Size | long | System.Int32 | Returns an int value indicating the asset's data size. | |
| StartTimecode | long | System.Int32 | Arbitrary starting timecode for a List asset. Timecode is represented as a 32 bit mask. | e |
| StartTimecodeStr | BSTR | System.String | Returns an int value that is the starting timecode of a List asset. Timecode is represented as a 32-bit mask. | e |
| Summary | BSTR | System.String | Returns a string that is the summary of the asset structure. This string is used by utility programs like ViewMovie. (Note: summary written in English.) | e, x |
| ThumbnailImage | BYTE SAFEARRAY | System.Object[] | Returns an array of bytes containing the asset's thumbnail image. You should call MediaMgr.GetThumbnail() instead. | e |
| ThumbnailMark | long | System.Int32 | Returns an int value that is the thumbnail's mark value. This value is relative to the asset's mark in value. For example, if the thumbnail is taken 32 fields into a clip whose mark in value is 100, then the thumbnail mark value would be 132. | e |
| UnderConstruction | VARIANT_BOOL~ | System.Boolean | VARIANT_TRUE if the asset is under any type of construction. | |
| URI | BSTR | System.String | Asset identifier in URI format. The URI string takes the following form: edl/cmf///// |
e |
| Version | long | System.Int32 | Version of this property list. Currently set to 1. | |
| VideoCompressionType | BSTR | System.String | Returns a string indicating the video compression type. Return values include:"Mixed Mpeg HD/SD", "Mixed MpegSD/DV", "Mixed DV HD/SD", "Mixed DV", "MpegHiDef", "DVCAM", "DVCPRO25", "DVCPRO50", "DVCPROHD", "Jpeg", "MpegD10", "MpegStdDef", "Unknown" |
|
| VideoFormat | long | System.Int32 | Asset video format. Returns an int value that is one of these enumerate values:Format525_29_97Hz_2To1 = 0, Format525_29_98Hz_2To1 = 0, Format525_60Hz_2To1 = 0, Format625_25Hz_2To1 = 1, Format625_50Hz_2To1 = 1, Format720_59_94Hz_1To1 = 2, Format720_60Hz_1To1 = 3, Format1080_23_98Hz_1To1 = 4, Format1080_24Hz_1To1 = 5, Format1080_25Hz_1To1 = 6, Format1080_29_97Hz_1To1 = 7, Format1080_30Hz_1To1 = 8, Format1080_25Hz_2To1 = 9, Format1080_29_97Hz_2To1 = 10, Format1080_30Hz_2To1 = 11, Format1035_30Hz_2To1 = 12, Format1035_29_97Hz_2To1 = 13, Format720_50Hz_1To1 = 14, Format525_59_94Hz_1To1 = 15, Format525_60Hz_1To1 = 16, Format525_29_97Hz_1To1 = 17, Format525_30Hz_1To1 = 18, Format625_50Hz_1To1 = 19, Format625_25Hz_1To1 = 20, Format720_29_97Hz_1To1 = 21, Format720_30Hz_1To1 = 22, Format720_25Hz_1To1 = 23, Format1440x1080_29_97Hz_2To1 = 24, Format1440x1080_30Hz_2To1 = 25, Format1440x1080_25Hz_2To1 = 26, FormatXga_59_94Hz_1To1 = 27, FormatXga_50Hz_1To1 = 28, FormatWxga_59_94Hz_1To1 = 29, FormatWxga_50Hz_1To1 = 30, FormatWsxga_59_94Hz_1To1, FormatWsxga_50Hz_1To1, FormatMixed_29_97HzRef = 0xf0, FormatMixed_25HzRef = 0xf1, VideoFormat_NA = 0xfe, VideoFormatInvalid = 0xff |
|
| VideoFormatStr | BSTR | System.String | Returns a string that is the asset's video format. Values include:"Format525_60Hz_2To1", "Format625_50Hz_2To1", "Format720_59_94Hz_1To1", "Format720_60Hz_1To1", "Format1080_23_98Hz_1To1", "Format1080_24Hz_1To1", "Format1080_25Hz_1To1", "Format1080_29_97Hz_1To1", "Format1080_30Hz_1To1", "Format1080_25Hz_2To1", "Format1080_29_97Hz_2To1", "Format1080_30Hz_2To1", "Format1035_30Hz_2To1", "Format1035_29_97Hz_2To1", "Format720_50Hz_1To1", "Format525_59_94Hz_1To1", "Format525_60Hz_1To1", "Format525_29_97Hz_1To1", "Format525_30Hz_1To1", "Format625_50Hz_1To1", "Format625_25Hz_1To1", "Format720_29_97Hz_1To1", "Format720_30Hz_1To1", "Format720_25Hz_1To1", "Format1440x1080_29_97Hz_2To1", "Format1440x1080_30Hz_2To1", "Format1440x1080_25Hz_2To1", "FormatXga_59_94Hz_1To1", "FormatXga_50Hz_1To1", "FormatWxga_59_94Hz_1To1", "FormatWxga_50Hz_1To1", "FormatWsxga_59_94Hz_1To1", "FormatWsxga_50Hz_1To1", "FormatMixed_29_97HzRef", "FormatMixed_25HzRef","Unknown Video Format", "Invalid Video Format" |
|
| volume | BSTR | System.String | Returns a string indicating the volume name (e.g. "V:") associated with the asset's bin. | e |
| XML | BSTR | System.String | Returns a string that is an XML representation of the movie. | e, x |
Notes:
e – Best performance with one of the Editor interfaces (ISimpleEditor, IEventEditor). Properties with this note can still be obtained by IMediaMgr::GetProperty, but extra database transactions have to be made that makes these properties more expensive.
x – Expensive. This properties should only be obtained occasionally and as a result of a user request, rather than on a timer.
