Interface LibraryApiGetThemeMediaRequest

Request parameters for getThemeMedia operation in LibraryApi.

Export

LibraryApiGetThemeMediaRequest

interface LibraryApiGetThemeMediaRequest {
    inheritFromParent?: boolean;
    itemId: string;
    sortBy?: ItemSortBy[];
    sortOrder?: SortOrder[];
    userId?: string;
}

Properties

inheritFromParent? itemId sortBy? sortOrder? userId?

Properties

Optional ReadonlyinheritFromParent

inheritFromParent?: boolean

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

Memberof

LibraryApiGetThemeMedia

ReadonlyitemId

itemId: string

The item id.

Memberof

LibraryApiGetThemeMedia

Optional ReadonlysortBy

sortBy?: 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.

Memberof

LibraryApiGetThemeMedia

Optional ReadonlysortOrder

sortOrder?: SortOrder[]

Optional. Sort Order - Ascending, Descending.

Memberof

LibraryApiGetThemeMedia

Optional ReadonlyuserId

userId?: string

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

Memberof

LibraryApiGetThemeMedia

Settings

Member Visibility

On This Page

Properties