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

GetThemeSongsRequest

@Serializable

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

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

Properties

inheritFromParent

@SerialName(value = "inheritFromParent")

val inheritFromParent: Boolean?

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

itemId

@SerialName(value = "itemId")

val itemId: UUID

The item id.

sortBy

@SerialName(value = "sortBy")

val sortBy: Collection<ItemSortBy>?

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.

sortOrder

@SerialName(value = "sortOrder")

val sortOrder: Collection<SortOrder>?

Optional. Sort Order - Ascending, Descending.

userId

@SerialName(value = "userId")

val userId: UUID?

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