Skip to main content

ReportableSong

Stentor API Reference

Stentor API Reference / stentor-models/src / ReportableSong

Interface: ReportableSong

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

Song that is reportable

Extends​

Extended by​

Properties​

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.

Inherited from​

Song.subtitle

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.

Inherited from​

Song.description

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

Inherited from​

Song.image

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

Inherited from​

Song.backgroundImage

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​

Song.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​

Song.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​

Song.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​

Song.visuals

playedId?​

optional playedId: string

Defined in: packages/stentor-models/src/Media/Reportable.ts:12

An ID representing a playback of the playable.

Inherited from​

Reportable.playedId

type​

type: "Song"

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

The type of media.

Inherited from​

Song.type

title​

title: string

Defined in: packages/stentor-models/src/Media/Song.ts:10

Title (or name) of the audio.

This is typically the track title or podcast episode name.

Inherited from​

Song.title

artist?​

optional artist: string

Defined in: packages/stentor-models/src/Media/Song.ts:11

Inherited from​

Song.artist

album?​

optional album: string

Defined in: packages/stentor-models/src/Media/Song.ts:12

Inherited from​

Song.album