Function StudiosApiFp

Returns {
    getStudio(name: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
    getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
}

• getStudio:function

  • getStudio(name, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>

  • Parameters

    • name: string

      Studio name.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>

    Summary

    Gets a studio by name.

    Throws

• getStudios:function

  • getStudios(startIndex?, limit?, searchTerm?, parentId?, fields?, excludeItemTypes?, includeItemTypes?, isFavorite?, enableUserData?, imageTypeLimit?, enableImageTypes?, userId?, nameStartsWithOrGreater?, nameStartsWith?, nameLessThan?, enableImages?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • OptionalstartIndex: number

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

      Optional. The maximum number of records to return.
    • OptionalsearchTerm: string

      Optional. Search term.
    • OptionalparentId: string

      Specify this to localize the search to a specific item or folder. Omit to use the root.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalexcludeItemTypes: BaseItemKind[]

      Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
    • OptionalincludeItemTypes: BaseItemKind[]

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

      Optional filter by items that are marked as favorite, or not.
    • OptionalenableUserData: boolean

      Optional, include user data.
    • OptionalimageTypeLimit: number

      Optional, the max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • OptionaluserId: string

      User id.
    • OptionalnameStartsWithOrGreater: string

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

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

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

      Optional, include image information in output.
    • OptionalenableTotalRecordCount: boolean

      Total record count.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Gets all studios from a given item, folder, or the entire library.

    Throws