@jellyfin/sdk/lib/utils/api/image-urls-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
import type { ImageApiGetSplashscreenRequest } from '../../generated-client/api/image-api';
import { ImageApi } from '../../generated-client/api/image-api';
import type { BaseItemDto } from '../../generated-client/models/base-item-dto';
import { ImageType } from '../../generated-client/models/image-type';
import type { UserDto } from '../../generated-client/models/user-dto';
import type { ImageRequestParameters } from '../../models/api/image-request-parameters';
/**
 * ImageUrlsApi - ImageApi with URL utility methods
 * @export
 * @class ImageUrlsApi
 * @extends {ImageApi}
 */
export declare class ImageUrlsApi extends ImageApi {
    /**
     * Get an Item image URL for a given Item ID.
     * @param itemId The Item ID.
     * @param [imageType=ImageType.Primary] An optional Image Type.
     * @param [params={}] Additional request parameters.
     * @returns The image URL.
     */
    getItemImageUrlById(itemId: string, imageType?: ImageType, params?: ImageRequestParameters): string;
    /**
     * Get an Item image URL with automatic `tag` param handling.
     * @param item The Item.
     * @param [imageType] An optional Image Type (Primary by default).
     * @param [params={}] Additional request parameters.
     * @returns The Item image URL.
     */
    getItemImageUrl(item?: BaseItemDto, imageType?: ImageType, params?: ImageRequestParameters): string | undefined;
    /**
     * Get an Item's backdrop image URLs.
     * @param item The Item.
     * @param [params={}] Additional request parameters.
     * @returns An array of backdrop image URLs.
     */
    getItemBackdropImageUrls(item?: BaseItemDto, params?: ImageRequestParameters): string[];
    /**
     * Get the splash screen image URL.
     * @param [params={}] Additional request parameters.
     * @returns The splash screen image URL.
     */
    getSplashscreenImageUrl(params?: ImageApiGetSplashscreenRequest): string;
    /**
     * Get a User's primary image URL.
     * @param user The User.
     * @param [params={}] Additional request parameters.
     * @returns The User's primary image URL.
     */
    getUserImageUrl(user?: UserDto, params?: ImageRequestParameters): string | undefined;
}