@jellyfin/sdk
    Preparing search index...

    Interface StudiosApiGetStudiosRequest

    Request parameters for getStudios operation in StudiosApi.

    StudiosApiGetStudiosRequest

    interface StudiosApiGetStudiosRequest {
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        excludeItemTypes?: BaseItemKind[];
        fields?: ItemFields[];
        imageTypeLimit?: number;
        includeItemTypes?: BaseItemKind[];
        isFavorite?: boolean;
        limit?: number;
        nameLessThan?: string;
        nameStartsWith?: string;
        nameStartsWithOrGreater?: string;
        parentId?: string;
        searchTerm?: string;
        startIndex?: number;
        userId?: string;
    }
    Index

    Properties

    enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeItemTypes? fields? imageTypeLimit? includeItemTypes? isFavorite? limit? nameLessThan? nameStartsWith? nameStartsWithOrGreater? parentId? searchTerm? startIndex? userId?

    Properties

    enableImages?: boolean

    Optional, include image information in output.

    StudiosApiGetStudios

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    StudiosApiGetStudios

    enableTotalRecordCount?: boolean

    Total record count.

    StudiosApiGetStudios

    enableUserData?: boolean

    Optional, include user data.

    StudiosApiGetStudios

    excludeItemTypes?: BaseItemKind[]

    Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

    StudiosApiGetStudios

    fields?: ItemFields[]

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

    StudiosApiGetStudios

    imageTypeLimit?: number

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

    StudiosApiGetStudios

    includeItemTypes?: BaseItemKind[]

    Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

    StudiosApiGetStudios

    isFavorite?: boolean

    Optional filter by items that are marked as favorite, or not.

    StudiosApiGetStudios

    limit?: number

    Optional. The maximum number of records to return.

    StudiosApiGetStudios

    nameLessThan?: string

    Optional filter by items whose name is equally or lesser than a given input string.

    StudiosApiGetStudios

    nameStartsWith?: string

    Optional filter by items whose name is sorted equally than a given input string.

    StudiosApiGetStudios

    nameStartsWithOrGreater?: string

    Optional filter by items whose name is sorted equally or greater than a given input string.

    StudiosApiGetStudios

    parentId?: string

    Specify this to localize the search to a specific item or folder. Omit to use the root.

    StudiosApiGetStudios

    searchTerm?: string

    Optional. Search term.

    StudiosApiGetStudios

    startIndex?: number

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

    StudiosApiGetStudios

    userId?: string

    User id.

    StudiosApiGetStudios

    Settings

    Member Visibility

    On This Page

    Properties