Class KodiPlaylistNamespace

Index

Constructors

Methods

Add Clear GetItems GetPlaylists GetProperties Insert Remove Swap

Constructors

constructor

new KodiPlaylistNamespace(sendMessage: ISendMessage): KodiPlaylistNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiPlaylistNamespace
- Defined in namespaces/playlist.ts:35

Methods

Add

Add(
playlistid: string,
item: PlaylistMediaItem | PlaylistMediaItem[],
): Promise<string>
Adds item(s) to the specified playlist.
Parameters
- playlistid: string
  The ID of the playlist to add items to.
- item: PlaylistMediaItem | PlaylistMediaItem[]
  The media item or items to add.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/playlist.ts:46

Clear

Clear(playlistid: string): Promise<string>
Clears all items from the specified playlist.
Parameters
- playlistid: string
  The ID of the playlist to clear.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/playlist.ts:60

GetItems

GetItems(
    playlistid: string,
    properties?: string[],
    limits?: ListLimits,
    sort?: ListSort,
): Promise<PlaylistGetItemsResponse>
Retrieves all items from the specified playlist with optional filtering and pagination.
Parameters
- playlistid: string
  The ID of the playlist to retrieve items from.
- Optionalproperties: string[]
  Optional list of properties to retrieve for each item.
- Optionallimits: ListLimits
  Optional pagination limits.
- Optionalsort: ListSort
  Optional sorting options.
Returns Promise<PlaylistGetItemsResponse>
A promise resolving to a list of playlist items and pagination details.
- Defined in namespaces/playlist.ts:73

GetPlaylists

GetPlaylists(): Promise<PlaylistGetPlaylistsResponse>
Retrieves all existing playlists.

Returns Promise<PlaylistGetPlaylistsResponse>
A promise resolving to a list of playlists.
- Defined in namespaces/playlist.ts:93

GetProperties

GetProperties(
playlistid: string,
properties: string[],
): Promise<PlaylistGetPropertiesResponse>
Retrieves the values of the specified properties for a playlist.
Parameters
- playlistid: string
  The ID of the playlist.
- properties: string[]
  The list of properties to retrieve.
Returns Promise<PlaylistGetPropertiesResponse>
A promise resolving to the requested properties and their values.
- Defined in namespaces/playlist.ts:104

Insert

Insert(
    playlistid: string,
    position: number,
    item: PlaylistMediaItem | PlaylistMediaItem[],
): Promise<string>
Inserts item(s) into the specified playlist at the given position.
Parameters
- playlistid: string
  The ID of the playlist to insert items into.
- position: number
  The position at which to insert the items.
- item: PlaylistMediaItem | PlaylistMediaItem[]
  The media item or items to insert.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/playlist.ts:120

Remove

Remove(playlistid: string, position: number): Promise<string>
Removes an item from the specified playlist at the given position.
Parameters
- playlistid: string
  The ID of the playlist to remove the item from.
- position: number
  The position of the item to remove.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/playlist.ts:136

Swap

Swap(playlistid: string, position1: number, position2: number): Promise<string>
Swaps two items within the specified playlist.
Parameters
- playlistid: string
  The ID of the playlist containing the items.
- position1: number
  The position of the first item to swap.
- position2: number
  The position of the second item to swap.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/playlist.ts:152