@jellyfin/sdk
    Preparing search index...

    Interface InstantMixApiGetInstantMixFromAlbumRequest

    Request parameters for getInstantMixFromAlbum operation in InstantMixApi.

    InstantMixApiGetInstantMixFromAlbumRequest

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

    Properties

    enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? itemId limit? userId?

    Properties

    enableImages?: boolean

    Optional. Include image information in output.

    InstantMixApiGetInstantMixFromAlbum

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    InstantMixApiGetInstantMixFromAlbum

    enableUserData?: boolean

    Optional. Include user data.

    InstantMixApiGetInstantMixFromAlbum

    fields?: ItemFields[]

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

    InstantMixApiGetInstantMixFromAlbum

    imageTypeLimit?: number

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

    InstantMixApiGetInstantMixFromAlbum

    itemId: string

    The item id.

    InstantMixApiGetInstantMixFromAlbum

    limit?: number

    Optional. The maximum number of records to return.

    InstantMixApiGetInstantMixFromAlbum

    userId?: string

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

    InstantMixApiGetInstantMixFromAlbum

    Settings

    Member Visibility

    On This Page

    Properties