mirror of
https://github.com/jellyfin/jellyfin-web
synced 2025-03-30 19:56:21 +00:00
move function to get backdrop image to api-client utils
This commit is contained in:
parent
5df5f6cdb2
commit
8ec943bc30
4 changed files with 57 additions and 58 deletions
55
src/utils/jellyfin-apiclient/BackdropImage.ts
Normal file
55
src/utils/jellyfin-apiclient/BackdropImage.ts
Normal file
|
@ -0,0 +1,55 @@
|
|||
import { BaseItemDto } from '@jellyfin/sdk/lib/generated-client';
|
||||
import { randomInt } from '../number';
|
||||
import { ApiClient } from 'jellyfin-apiclient';
|
||||
|
||||
export interface ScaleImageOptions {
|
||||
maxWidth?: number;
|
||||
width?: number;
|
||||
maxHeight?: number;
|
||||
height?: number;
|
||||
fillWidth?: number;
|
||||
fillHeight?: number;
|
||||
quality?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the url of the first or a random backdrop image of an item.
|
||||
* If the item has no backdrop image, the url of the first or a random backdrop image of the parent item is returned.
|
||||
* Falls back to the primary image (cover) of the item, if neither the item nor it's parent have at least one backdrop image.
|
||||
* Returns undefined if no usable image was found.
|
||||
* @param apiClient The ApiClient to generate the url.
|
||||
* @param item The item for which the backdrop image is requested.
|
||||
* @param random If set to true and the item has more than one backdrop, a random image is returned.
|
||||
* @param options Optional; allows to scale the backdrop image.
|
||||
* @returns The url of the first or a random backdrop image of the provided item.
|
||||
*/
|
||||
export const getItemBackdropImageUrl = (apiClient: ApiClient, item: BaseItemDto, random = false, options: ScaleImageOptions = {}): string | undefined => {
|
||||
let imgUrl;
|
||||
|
||||
if (item.BackdropImageTags?.length) {
|
||||
const backdropImgIndex = random ? randomInt(0, item.BackdropImageTags.length - 1) : 0;
|
||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
||||
imgUrl = apiClient.getScaledImageUrl(item.Id!, {
|
||||
type: 'Backdrop',
|
||||
index: backdropImgIndex,
|
||||
tag: item.BackdropImageTags[backdropImgIndex],
|
||||
...options
|
||||
});
|
||||
} else if (item.ParentBackdropItemId && item.ParentBackdropImageTags?.length) {
|
||||
const backdropImgIndex = random ? randomInt(0, item.ParentBackdropImageTags.length - 1) : 0;
|
||||
imgUrl = apiClient.getScaledImageUrl(item.ParentBackdropItemId, {
|
||||
type: 'Backdrop',
|
||||
index: backdropImgIndex,
|
||||
tag: item.ParentBackdropImageTags[backdropImgIndex],
|
||||
...options
|
||||
});
|
||||
} else if (item.ImageTags?.Primary) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
||||
imgUrl = apiClient.getScaledImageUrl(item.Id!, {
|
||||
type: 'Primary',
|
||||
tag: item.ImageTags.Primary,
|
||||
...options
|
||||
});
|
||||
}
|
||||
return imgUrl;
|
||||
};
|
Loading…
Add table
Add a link
Reference in a new issue