Methods
(static) AppearsOnList(id) → {dynamic}
Get list of albums an artist appears on
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) ArtistOverview(name) → {dynamic}
Music Artist Data
| Name | Type | Description |
|---|---|---|
name | string |
- Source
- Type:
- dynamic
(static) AudioItem(id) → {dynamic}
Get Songs that are on an Album
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) AudioStream(id) → {dynamic}
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) BackdropImage(id) → {dynamic}
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) CreateArtistMix(id) → {dynamic}
Get Instant Mix based on item
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) CreateInstantMix(id) → {dynamic}
Get Instant Mix based on item
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) GetIntroVideos(id) → {dynamic}
Get Intro Videos for an item
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) GetSongsByArtist(id, paramsopt) → {dynamic}
Get list of songs belonging to an artist
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | string | |||
params | object | <optional> | {} |
- Source
- Type:
- dynamic
(static) ItemDetailsMetaData(id) → {dynamic}
MetaData for an item detail screen — includes People, Genres, and Studios in addition to Chapters and Trickplay. Use this instead of ItemMetaData() when populating a detail view.
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) ItemMetaData(id, fieldsopt) → {dynamic}
MetaData about an item — returns a JellyfinBaseItem node.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | string | |||
fields | string | <optional> | "Chapters,Trickplay" | Comma-separated Jellyfin fields to request. Defaults to Chapters and Trickplay only. |
- Source
- Type:
- dynamic
(static) ItemPostPlaybackInfo(id, mediaSourceIdopt, audioTrackIndexopt, subtitleTrackIndexopt, startTimeTicksopt, videoMetadataopt, bypassDoviPreservationopt, forceTranscodingopt) → {dynamic}
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | string | |||
mediaSourceId | string | <optional> | "" | |
audioTrackIndex | integer | <optional> | -1 | |
subtitleTrackIndex | integer | <optional> | SubtitleSelection.none | |
startTimeTicks | longinteger | <optional> | 0& | |
videoMetadata | dynamic | <optional> | invalid | |
bypassDoviPreservation | boolean | <optional> | false | |
forceTranscoding | boolean | <optional> | false |
- Source
- Type:
- dynamic
(static) MusicAlbumList(id) → {dynamic}
Get list of albums belonging to an artist
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) MusicSongList(id) → {dynamic}
Get Songs that are on an Album
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) PlaylistItemList(id) → {dynamic}
Get Items that are under the provided item
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) TVSeasons(id) → {dynamic}
Seasons for a TV Show
| Name | Type | Description |
|---|---|---|
id | string |
- Source
- Type:
- dynamic
(static) applyMediaSourceToPostData(postData, mediaSourceId, forceTranscoding) → {void}
applyMediaSourceToPostData: Applies the media source ID or live TV retry flags to a postData object. Live TV is detected by an empty mediaSourceId. On the first attempt, direct play is not disabled so the server can evaluate compatibility (matching web client behaviour). On retry, forceTranscoding=true sets EnableDirectPlay=false so the server provides a transcode URL instead.
| Name | Type | Description |
|---|---|---|
postData | object | The request body assoc array to modify |
mediaSourceId | string | Media source ID, or "" for live TV |
forceTranscoding | boolean | True when retrying with forced transcoding |
- Source
- Type:
- void
(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).
| Name | Type | Description |
|---|---|---|
deviceProfile | object | |
channelCount | integer |
- Source
- Type:
- void
(static) searchMedia(query) → {dynamic}
Search across all libraries
| Name | Type | Description |
|---|---|---|
query | string |
- Source
- Type:
- dynamic
(static) useTranscodeAudioStream(playbackInfo) → {dynamic}
| Name | Type | Description |
|---|---|---|
playbackInfo | dynamic |
- Source
- Type:
- dynamic