This page defines common query parameters that can be used when querying an aa:asset resource.
attributes
Only when called with ?embed=attributes.
A comma separated list of attribute names that shall be returned in the embedded aa:attributes resource. See Query parameters for aa:attributes for details.
embed
A comma separated list of resources to be embedded into the resulting resource. Possible values:
-
asset-model: embed datamodel:assetmodel with the custom attributes.
-
attributes: embed aa:attributes with the custom attributes.
-
keyframes: embed aa:keyframes with the keyframe information.
-
referencing-items: embed loc:referencing-items with the location items that reference the asset.
-
thumb: embed aa:thumb with the thumbnail image information.
-
time-based: embed aa:time-based with the time-based Meta data.
exclude-multi-value
Only when called with ?embed=attributes and when ?attributes is not given or empty.
If true, all attributes except multi-value attributes are returned.
If not given or false, all attributes are returned.
See Query parameters for aa:attributes for details.
lang
Specifies the language or locale for localizable information, if supported. The value must be a must be a valid IETF BCP 47 language tag.
-
If missing or empty, labels for language "en" will be returned.
-
If there is no label for the given language tag, the response will automatically fall back to another label (usually the English one), but return it with the given language tag. Example: If the caller asks for ?lang=fr and there is no French label, then the response will contain "fr" as language tag, but a fallback label as value:
{
"labels": {
"fr": "English label"
}
}thumbnailWidth and thumbnailHeight
Specifies the thumbnailWidth and thumbnailHeight for the thumbnail to be generated, if supported.
MediaCentral Production Management
-
If both parameters are specified, their arguments will literally be applied as "width"- and "height"-arguments in the thumbnail image URL to request the head frame.
-
If only thumbnailWidth is specified, then thumbnailWidth will be applied as "width"-argument and "height" will be completed with a value to keep the thumb in 16:9 aspect.
-
If only thumbnailHeight is specified, then thumbnailHeight will be applied as "height"-argument and "width" will be completed with a value to keep the thumb in 16:9 aspect.
-
If none of these parameters is specified, MediaCentral Production Management’s defaults are applied.
The resulting thumbnail image will not necessarily perfectly reflect the values specified in thumbnailWidth and thumbnailHeight. Instead the backend can select other dimensions with a better fit depending on the original footage. However, the resulting thumbnail will always fit in the bounding box defined by the specified thumbnailWidth and thumbnailHeight.
MediaCentral Asset Management
thumbnailWidth and thumbnailHeight are ignored.