@jellyfin/sdk
    Preparing search index...

    Interface RemoteImageApiGetRemoteImagesRequest

    Request parameters for getRemoteImages operation in RemoteImageApi.

    RemoteImageApiGetRemoteImagesRequest

    interface RemoteImageApiGetRemoteImagesRequest {
        includeAllLanguages?: boolean;
        itemId: string;
        limit?: number;
        providerName?: string;
        startIndex?: number;
        type?: ImageType;
    }
    Index

    Properties

    includeAllLanguages? itemId limit? providerName? startIndex? type?

    Properties

    includeAllLanguages?: boolean

    Optional. Include all languages.

    RemoteImageApiGetRemoteImages

    itemId: string

    Item Id.

    RemoteImageApiGetRemoteImages

    limit?: number

    Optional. The maximum number of records to return.

    RemoteImageApiGetRemoteImages

    providerName?: string

    Optional. The image provider to use.

    RemoteImageApiGetRemoteImages

    startIndex?: number

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

    RemoteImageApiGetRemoteImages

    type?: ImageType

    The image type.

    RemoteImageApiGetRemoteImages

    Settings

    Member Visibility

    On This Page

    Properties