@jellyfin/sdk
    Preparing search index...

    Interface LibraryApiGetThemeSongsRequest

    Request parameters for getThemeSongs operation in LibraryApi.

    LibraryApiGetThemeSongsRequest

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

    Properties

    inheritFromParent? itemId sortBy? sortOrder? userId?

    Properties

    inheritFromParent?: boolean

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

    LibraryApiGetThemeSongs

    itemId: string

    The item id.

    LibraryApiGetThemeSongs

    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.

    LibraryApiGetThemeSongs

    sortOrder?: SortOrder[]

    Optional. Sort Order - Ascending, Descending.

    LibraryApiGetThemeSongs

    userId?: string

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

    LibraryApiGetThemeSongs

    Settings

    Member Visibility

    On This Page

    Properties