Module: Items

Methods

(static) AppearsOnList(id) → {dynamic}

Get list of albums an artist appears on

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 60

Returns:

Type:: dynamic

(static) ArtistOverview(name) → {dynamic}

Music Artist Data

Parameters:

Name	Type	Description
`name`	string

Source: source/api/Items.bs, line 42

Returns:

Type:: dynamic

(static) AudioItem(id) → {dynamic}

Get Songs that are on an Album

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 97

Returns:

Type:: dynamic

(static) AudioStream(id) → {dynamic}

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 132

Returns:

Type:: dynamic

(static) BackdropImage(id) → {dynamic}

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 148

Returns:

Type:: dynamic

(static) CreateArtistMix(id) → {dynamic}

Get Instant Mix based on item

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 115

Returns:

Type:: dynamic

(static) CreateInstantMix(id) → {dynamic}

Get Instant Mix based on item

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 106

Returns:

Type:: dynamic

(static) GetIntroVideos(id) → {dynamic}

Get Intro Videos for an item

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 124

Returns:

Type:: dynamic

(static) GetSongsByArtist(id, paramsopt) → {dynamic}

Get list of songs belonging to an artist

Parameters:

Name	Type	Attributes	Default	Description
`id`	string
`params`	object	<optional>	{}

Source: source/api/Items.bs, line 70

Returns:

Type:: dynamic

(static) ItemMetaData(id) → {dynamic}

MetaData about an item

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 33

Returns:

Type:: dynamic

(static) ItemPostPlaybackInfo(id, mediaSourceIdopt, audioTrackIndexopt, subtitleTrackIndexopt, startTimeTicksopt, videoMetadataopt) → {dynamic}

Parameters:

Name	Type	Attributes	Default
`id`	string
`mediaSourceId`	string	<optional>	""
`audioTrackIndex`	integer	<optional>	-1
`subtitleTrackIndex`	integer	<optional>	SubtitleSelection.none
`startTimeTicks`	longinteger	<optional>	0&
`videoMetadata`	dynamic	<optional>	invalid

Source: source/api/Items.bs, line 15

Returns:

Type:: dynamic

(static) MusicAlbumList(id) → {dynamic}

Get list of albums belonging to an artist

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 51

Returns:

Type:: dynamic

(static) MusicSongList(id) → {dynamic}

Get Songs that are on an Album

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 88

Returns:

Type:: dynamic

(static) PlaylistItemList(id) → {dynamic}

Get Items that are under the provided item

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 79

Returns:

Type:: dynamic

(static) TVEpisodes(showId, seasonId) → {dynamic}

Returns a list of TV Shows for a given TV Show and season Accepts strings for the TV Show Id and the season Id

Parameters:

Name	Type	Description
`showId`	string
`seasonId`	string

Source: source/api/Items.bs, line 168

Returns:

Type:: dynamic

(static) TVSeasonExtras(seasonId) → {dynamic}

Returns a list of extra features for a TV Show season Accepts a string that is a TV Show season id

Parameters:

Name	Type	Description
`seasonId`	string

Source: source/api/Items.bs, line 178

Returns:

Type:: dynamic

(static) TVSeasons(id) → {dynamic}

Seasons for a TV Show

Parameters:

Name	Type	Description
`id`	string

Source: source/api/Items.bs, line 157

Returns:

Type:: dynamic

(static) removeUnsupportedAacFromProfile(deviceProfile, channelCount) → {void}

Removes AAC from the device profile codec list to prevent stereo downmix of multichannel audio. Also handles unsupported AAC profiles (Main, HE-AAC). For stereo sources (≤2ch), also removes surround passthrough codecs (eac3, ac3, dts) so transcoding falls through to MP3 (better compatibility + smaller files).

Parameters:

Name	Type	Description
`deviceProfile`	object
`channelCount`	integer

Source: source/api/Items.bs, line 191

Returns:

Type:: void

(static) searchMedia(query) → {dynamic}

Search across all libraries

Parameters:

Name	Type	Description
`query`	string

Source: source/api/Items.bs, line 24

Returns:

Type:: dynamic

(static) useTranscodeAudioStream(playbackInfo) → {dynamic}

Parameters:

Name	Type	Description
`playbackInfo`	dynamic

Source: source/api/Items.bs, line 140

Returns:

Type:: dynamic