Interface AudioFile

This represents a song. An array of these may be passed to Player.playAudioFiles for playback.

Hierarchy

  • AudioFile

Properties

artist durationInSeconds? extra favorited? id liked? release track

Properties

artist

artist: {
    id: string;
    name: string;
}

The performing artist for this song

Type declaration

  • id: string

    internal adaptr artist id

  • name: string

    name of artist

Optional durationInSeconds

durationInSeconds?: number

The duration of the song, in seconds

extra

extra: {
    artwork150x150?: string;
    artwork640?: string;
    trim_end?: number;
    trim_start?: number;
}

Extra metadata about the song.

Type declaration

  • Optional artwork150x150?: string

    URL to a 150x150 pixel image for this track (typically the album cover)

  • Optional artwork640?: string

    URL to an image for this track (typically the album cover) where the largest dimension is 640 pixels

  • Optional trim_end?: number

    number of seconds to trim form the end of the song when trimming is enabled

  • Optional trim_start?: number

    number of seconds to trim from the start of the song when trimming is enabled

Optional favorited

favorited?: boolean

When true, this indicates the audio file has been favorited

id

id: string

Optional liked

liked?: boolean

When true, this indicates the user has liked this song. When false, the user disliked this song at some point. When not present, the user hasn't indicated any preference for the song.

release

release: {
    id: string;
    title: string;
}

The album the song appears on

Type declaration

  • id: string

    internal adaptr track id

  • title: string

    title of release

track

track: {
    id: string;
    title: string;
}

The name of the song

Type declaration

  • id: string

    internal adaptr track id

  • title: string

    title of track/song

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc