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 generated/namespaces/playlist.ts:27

Methods

Add

Add(params: PlaylistAddParams): Promise<string>
Add item(s) to playlist
Parameters
- params: PlaylistAddParams
Returns Promise<string>
string
- Defined in generated/namespaces/playlist.ts:37

Clear

Clear(params: PlaylistClearParams): Promise<string>
Clear playlist
Parameters
- params: PlaylistClearParams
Returns Promise<string>
string
- Defined in generated/namespaces/playlist.ts:46

GetItems

GetItems<P extends readonly (keyof ListItemAll)[]>(
    params: {
        limits?: ListLimits;
        playlistid: number;
        properties: P;
        sort?: ListSort;
    },
): Promise<Pick<ListItemAll, Extract<P[number], keyof ListItemAll>>[]>
Type Parameters
- P extends readonly (keyof ListItemAll)[]
Parameters
- params: { limits?: ListLimits; playlistid: number; properties: P; sort?: ListSort }
Returns Promise<Pick<ListItemAll, Extract<P[number], keyof ListItemAll>>[]>
- Defined in generated/namespaces/playlist.ts:50
GetItems(params: PlaylistGetItemsParams): Promise<ListItemAll[]>
Get all items from playlist
Parameters
- params: PlaylistGetItemsParams
Returns Promise<ListItemAll[]>
PlaylistGetItemsResponse
- Defined in generated/namespaces/playlist.ts:59

GetPlaylists

GetPlaylists(): Promise<unknown[]>
Returns all existing playlists

Returns Promise<unknown[]>
unknown[]
- Defined in generated/namespaces/playlist.ts:68

GetProperties

GetProperties<P extends readonly (keyof PlaylistPropertyValue)[]>(
    params: { playlistid: number; properties: P },
): Promise<
    Pick<
        PlaylistPropertyValue,
        Extract<P[number], keyof PlaylistPropertyValue>,
    >,
>
Type Parameters
- P extends readonly (keyof PlaylistPropertyValue)[]
Parameters
- params: { playlistid: number; properties: P }
Returns Promise<
    Pick<
        PlaylistPropertyValue,
        Extract<P[number], keyof PlaylistPropertyValue>,
    >,
>
- Defined in generated/namespaces/playlist.ts:72
GetProperties(
params: PlaylistGetPropertiesParams,
): Promise<PlaylistPropertyValue>
Retrieves the values of the given properties
Parameters
- params: PlaylistGetPropertiesParams
Returns Promise<PlaylistPropertyValue>
PlaylistPropertyValue
- Defined in generated/namespaces/playlist.ts:79

Insert

Insert(params: PlaylistInsertParams): Promise<string>
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).
Parameters
- params: PlaylistInsertParams
Returns Promise<string>
string
- Defined in generated/namespaces/playlist.ts:91

Remove

Remove(params: PlaylistRemoveParams): Promise<string>
Remove item from playlist. Does not work for picture playlists (aka slideshows).
Parameters
- params: PlaylistRemoveParams
Returns Promise<string>
string
- Defined in generated/namespaces/playlist.ts:101

Swap

Swap(params: PlaylistSwapParams): Promise<string>
Swap items in the playlist. Does not work for picture playlists (aka slideshows).
Parameters
- params: PlaylistSwapParams
Returns Promise<string>
string
- Defined in generated/namespaces/playlist.ts:112