@jellyfin/sdk
    Preparing search index...

    Interface PlaylistsApiGetPlaylistItemsRequest

    Request parameters for getPlaylistItems operation in PlaylistsApi.

    PlaylistsApiGetPlaylistItemsRequest

    interface PlaylistsApiGetPlaylistItemsRequest {
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        fields?: ItemFields[];
        imageTypeLimit?: number;
        limit?: number;
        playlistId: string;
        startIndex?: number;
        userId?: string;
    }
    Index

    Properties

    enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? limit? playlistId startIndex? userId?

    Properties

    enableImages?: boolean

    Optional. Include image information in output.

    PlaylistsApiGetPlaylistItems

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    PlaylistsApiGetPlaylistItems

    enableUserData?: boolean

    Optional. Include user data.

    PlaylistsApiGetPlaylistItems

    fields?: ItemFields[]

    Optional. Specify additional fields of information to return in the output.

    PlaylistsApiGetPlaylistItems

    imageTypeLimit?: number

    Optional. The max number of images to return, per image type.

    PlaylistsApiGetPlaylistItems

    limit?: number

    Optional. The maximum number of records to return.

    PlaylistsApiGetPlaylistItems

    playlistId: string

    The playlist id.

    PlaylistsApiGetPlaylistItems

    startIndex?: number

    Optional. The record index to start at. All items with a lower index will be dropped from the results.

    PlaylistsApiGetPlaylistItems

    userId?: string

    User id.

    PlaylistsApiGetPlaylistItems

    Settings

    Member Visibility

    On This Page

    Properties