jellyfin-api/org.jellyfin.sdk.api.operations/PlaylistsApi

PlaylistsApi

class PlaylistsApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun addItemToPlaylist(playlistId: <Error class: unknown class>, ids: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null): Response<Unit>

Adds items to a playlist.

Link copied to clipboard
suspend fun createPlaylist(data: <Error class: unknown class>? = null): Response<<Error class: unknown class>>

For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

Link copied to clipboard
suspend fun createPlaylistDeprecated(name: String? = null, ids: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, mediaType: <Error class: unknown class>? = null, data: <Error class: unknown class>? = null): Response<<Error class: unknown class>>

For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

Link copied to clipboard
suspend fun getPlaylist(playlistId: <Error class: unknown class>): Response<<Error class: unknown class>>

Get a playlist.

Link copied to clipboard
suspend fun getPlaylistItems(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getPlaylistItems(playlistId: <Error class: unknown class>, userId: <Error class: unknown class>? = null, startIndex: Int? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), enableImages: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets the original items of a playlist.

Link copied to clipboard
suspend fun getPlaylistUser(playlistId: <Error class: unknown class>, userId: <Error class: unknown class>): Response<<Error class: unknown class>>

Get a playlist user.

Link copied to clipboard
suspend fun getPlaylistUsers(playlistId: <Error class: unknown class>): Response<List<<Error class: unknown class>>>

Get a playlist's users.

Link copied to clipboard
suspend fun moveItem(playlistId: String, itemId: String, newIndex: Int): Response<Unit>

Moves a playlist item.

Link copied to clipboard
suspend fun removeItemFromPlaylist(playlistId: String, entryIds: Collection<String>? = emptyList()): Response<Unit>

Removes items from a playlist.

Link copied to clipboard
suspend fun removeUserFromPlaylist(playlistId: <Error class: unknown class>, userId: <Error class: unknown class>): Response<Unit>

Remove a user from a playlist's users.

Link copied to clipboard
suspend fun updatePlaylist(playlistId: <Error class: unknown class>, data: <Error class: unknown class>): Response<Unit>

Updates a playlist.

Link copied to clipboard
suspend fun updatePlaylistUser(playlistId: <Error class: unknown class>, userId: <Error class: unknown class>, data: <Error class: unknown class>): Response<Unit>

Modify a user of a playlist's users.