Interface MediaObject

Many content blocks and their components include media objects which link directly to media assets. These media objects share a common JSON object format.

See

Media objects documentation.

interface MediaObject {
    cropped?: boolean;
    has_original_dimensions?: boolean;
    height?: number;
    original_dimensions_missing?: boolean;
    type?: string;
    url: string;
    width?: number;
}

Properties

cropped? has_original_dimensions? height? original_dimensions_missing? type? url width?

Properties

Optionalcropped

cropped?: boolean

This indicates whether this media object is a cropped version of the original media

Optionalhas_original_dimensions

has_original_dimensions?: boolean

This indicates whether this media object has the same dimensions as the original media

Optionalheight

height?: number

The height of the media asset, if that makes sense (for images and videos, but not for audio)

Optionaloriginal_dimensions_missing

original_dimensions_missing?: boolean

For display purposes, this indicates whether the dimensions are defaults

Optionaltype

type?: string

The MIME type of the media asset, or a best approximation will be made based on the given URL

Example

"image/jpg"

url

url: string

The canonical URL of the media asset

Optionalwidth

width?: number

The width of the media asset, if that makes sense (for images and videos, but not for audio)

Settings

Member Visibility

On This Page

Properties