- Source
Methods
(static) AppearsOnList(id) → {dynamic}
Get list of albums an artist appears on
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) ArtistOverview(name) → {dynamic}
Music Artist Data
Parameters:
| Name | Type | Description |
|---|---|---|
name | string |
- Source
Returns:
- Type:
- dynamic
(static) AudioItem(id) → {dynamic}
Get Songs that are on an Album
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) AudioStream(id) → {dynamic}
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) BackdropImage(id) → {dynamic}
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) CreateArtistMix(id) → {dynamic}
Get Instant Mix based on item
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) CreateInstantMix(id) → {dynamic}
Get Instant Mix based on item
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) GetIntroVideos(id) → {dynamic}
Get Intro Videos for an item
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
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
Returns:
- Type:
- dynamic
(static) ItemGetPlaybackInfo(id, startTimeTicksopt) → {dynamic}
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | string | |||
startTimeTicks | longinteger | <optional> | 0 |
- Source
Returns:
- Type:
- dynamic
(static) ItemMetaData(id) → {dynamic}
MetaData about an item
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) ItemPostPlaybackInfo(id, mediaSourceIdopt, audioTrackIndexopt, subtitleTrackIndexopt, startTimeTicksopt, forceMp3opt) → {dynamic}
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | string | |||
mediaSourceId | string | <optional> | "" | |
audioTrackIndex | integer | <optional> | -1 | |
subtitleTrackIndex | integer | <optional> | -1 | |
startTimeTicks | longinteger | <optional> | 0 | |
forceMp3 | boolean | <optional> | false |
- Source
Returns:
- Type:
- dynamic
(static) MusicAlbumList(id) → {dynamic}
Get list of albums belonging to an artist
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) MusicSongList(id) → {dynamic}
Get Songs that are on an Album
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) PlaylistItemList(id) → {dynamic}
Get Items that are under the provided item
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) TVEpisodeShuffleList(show_id) → {dynamic}
Parameters:
| Name | Type | Description |
|---|---|---|
show_id | string |
- Source
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
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
Returns:
- Type:
- dynamic
(static) TVSeasons(id) → {dynamic}
Seasons for a TV Show
Parameters:
| Name | Type | Description |
|---|---|---|
id | string |
- Source
Returns:
- Type:
- dynamic
(static) forceMp3Audio(deviceProfile) → {void}
updates the device profile we send the server to force mp3 audio transcoding instead of the default aac
Parameters:
| Name | Type | Description |
|---|---|---|
deviceProfile | object |
- Source
Returns:
- Type:
- void
(static) searchMedia(query) → {dynamic}
Search across all libraries
Parameters:
| Name | Type | Description |
|---|---|---|
query | string |
- Source
Returns:
- Type:
- dynamic
(static) useTranscodeAudioStream(playbackInfo) → {dynamic}
Parameters:
| Name | Type | Description |
|---|---|---|
playbackInfo | dynamic |
- Source
Returns:
- Type:
- dynamic