Skip to main content

Audio

Stentor API Reference

Stentor API Reference / stentor-models/src / Audio

Interface: Audio

Defined in: packages/stentor-models/src/Media/Audio.ts:15

Playable media designed for hands-free & eyes-free consumption.

This interface cannot be implemented directly.

See the following:

Extends​

Extended by​

Properties​

type​

type: AudioType

Defined in: packages/stentor-models/src/Media/Audio.ts:16

The type of media.

Overrides​

PlayableMedia.type

title?​

optional title: string

Defined in: packages/stentor-models/src/Media/Audio.ts:23

Title (or name) of the audio.

This is typically the track title or podcast episode name.

subtitle?​

optional subtitle: string

Defined in: packages/stentor-models/src/Media/Audio.ts:30

Subtitle for the audio.

This is typically the category or artist name.

description?​

optional description: string

Defined in: packages/stentor-models/src/Media/Audio.ts:37

Description of the audio

Max length is 160 characters, limited by Google.

image?​

optional image: string

Defined in: packages/stentor-models/src/Media/Audio.ts:43

Image for the audio, typically the album art.

Dimensions must be square, minimum 480 by 480 pixels

backgroundImage?​

optional backgroundImage: string

Defined in: packages/stentor-models/src/Media/Audio.ts:49

When applicable (Alexa), the background image for display surfaces.

Minimum dimensions are 1024 by 640 pixels

url​

url: string

Defined in: packages/stentor-models/src/Media/Playable.ts:9

The URL for the playable object.

Inherited from​

Playable.url

id?​

optional id: string

Defined in: packages/stentor-models/src/Media/Playable.ts:13

An ID for the playable object.

Inherited from​

PlayableMedia.id

token?​

optional token: string

Defined in: packages/stentor-models/src/Media/Playable.ts:17

A token for the playable object that represents a unique playback of the track.

Inherited from​

PlayableMedia.token

length?​

optional length: number

Defined in: packages/stentor-models/src/Media/Playable.ts:23

The length of the playable object in milliseconds.

A length of -1 denotes the playable has no end.

Inherited from​

PlayableMedia.length

visuals?​

optional visuals: Visuals

Defined in: packages/stentor-models/src/Media/Playable.ts:29

Things to show on screens if the device is capable of showing.

This is used primarily on Google for media cards.

Inherited from​

PlayableMedia.visuals