Module: Items

Methods

---

<static> AppearsOnList(id)

Get list of albums an artist appears on

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 61

Returns:

Type

dynamic

---

<static> ArtistOverview(name)

Music Artist Data

Parameters:

Name	Type	Description
name	string

Source:

• source/api/Items.brs, line 45

Returns:

Type

dynamic

---

<static> AudioItem(id)

Get Songs that are on an Album

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 93

Returns:

Type

dynamic

---

<static> AudioStream(id)

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 124

Returns:

Type

dynamic

---

<static> BackdropImage(id)

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 138

Returns:

Type

dynamic

---

<static> CreateArtistMix(id)

Get Instant Mix based on item

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 109

Returns:

Type

dynamic

---

<static> CreateInstantMix(id)

Get Instant Mix based on item

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 101

Returns:

Type

dynamic

---

<static> GetIntroVideos(id)

Get Intro Videos for an item

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 117

Returns:

Type

dynamic

---

<static> GetSongsByArtist(id)

Get list of songs belonging to an artist

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 69

Returns:

Type

dynamic

---

<static> ItemGetPlaybackInfo(id [, startTimeTicks])

Parameters:

Name	Type	Argument	Default	Description
id	string
startTimeTicks	longinteger	<optional>	0

Source:

• source/api/Items.brs, line 10

Returns:

Type

dynamic

---

<static> ItemMetaData(id)

MetaData about an item

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 37

Returns:

Type

dynamic

---

<static> ItemPostPlaybackInfo(id [, mediaSourceId] [, audioTrackIndex] [, subtitleTrackIndex] [, startTimeTicks])

Parameters:

Name	Type	Argument	Default	Description
id	string
mediaSourceId	string	<optional>	""
audioTrackIndex	integer	<optional>	-1
subtitleTrackIndex	integer	<optional>	-1
startTimeTicks	longinteger	<optional>	0

Source:

• source/api/Items.brs, line 21

Returns:

Type

dynamic

---

<static> MusicAlbumList(id)

Get list of albums belonging to an artist

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 53

Returns:

Type

dynamic

---

<static> MusicSongList(id)

Get Songs that are on an Album

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 85

Returns:

Type

dynamic

---

<static> PlaylistItemList(id)

Get Items that are under the provided item

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 77

Returns:

Type

dynamic

---

<static> TVEpisodeShuffleList(show_id)

Parameters:

Name	Type	Description
show_id	string

Source:

• source/api/Items.brs, line 172

Returns:

Type

dynamic

---

<static> TVEpisodes(showId, seasonId)

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.brs, line 156

Returns:

Type

dynamic

---

<static> TVSeasonExtras(seasonId)

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.brs, line 165

Returns:

Type

dynamic

---

<static> TVSeasons(id)

Seasons for a TV Show

Parameters:

Name	Type	Description
id	string

Source:

• source/api/Items.brs, line 146

Returns:

Type

dynamic

---

<static> searchMedia(query)

Search across all libraries

Parameters:

Name	Type	Description
query	string

Source:

• source/api/Items.brs, line 29

Returns:

Type

dynamic

---

<static> useTranscodeAudioStream(playbackInfo)

Parameters:

Name	Type	Description
playbackInfo	dynamic

Source:

• source/api/Items.brs, line 131

Returns:

Type

dynamic