jellyfin-model/org.jellyfin.sdk.model.api.request/GetThemeSongsRequest

GetThemeSongsRequest

data class GetThemeSongsRequest(val itemId: UUID, val userId: UUID? = null, val inheritFromParent: Boolean? = false, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null)

Get theme songs for an item.

Constructors

Link copied to clipboard
constructor(itemId: UUID, userId: UUID? = null, inheritFromParent: Boolean? = false, sortBy: Collection<ItemSortBy>? = null, sortOrder: Collection<SortOrder>? = null)

Properties

Link copied to clipboard
val inheritFromParent: Boolean? = false

Optional. Determines whether or not parent items should be searched for theme media.

Link copied to clipboard
val itemId: UUID

The item id.

Link copied to clipboard
val sortBy: Collection<ItemSortBy>? = null

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

Link copied to clipboard
val sortOrder: Collection<SortOrder>? = null

Optional. Sort Order - Ascending, Descending.

Link copied to clipboard
val userId: UUID? = null

Optional. Filter by user id, and attach user data.