Interface AudioBlock

An NPF audio type content block.

interface AudioBlock {
    album?: string;
    artist?: string;
    attribution?: Attribution;
    embed_html?: string;
    embed_url?: string;
    media?: Media[];
    metadata?: Record<string, unknown>;
    poster?: VisualMedia[];
    provider?: string;
    title?: string;
    type: "audio";
    url?: string;
}

Properties

album?: string

The album from which the audio asset originated.

artist?: string

The artist of the audio asset.

attribution?: Attribution

Optional attribution information about where the audio track came from.

embed_html?: string

HTML code that could be used to embed this audio track into a webpage.

embed_url?: string

A URL to the embeddable content to use as an iframe.

media?: Media[]

The Media to use for the audio block. Either this, url, or both will always be set.

metadata?: Record<string, unknown>

Optional provider-specific metadata about the audio track.

poster?: VisualMedia[]

An image media object to use as a "poster" for the audio track, usually album art.

provider?: string

The provider of the audio source, whether it's tumblr for native audio or a trusted third party.

title?: string

The title of the audio asset.

type
url?: string

The URL to use for the audio block. Either this, media, or both will always be set.