@jellyfin/sdk 0.8.1 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -7
- package/lib/api.d.ts +1 -0
- package/lib/api.js +4 -4
- package/lib/discovery/recommended-server-discovery.js +24 -16
- package/lib/generated-client/api/activity-log-api.js +12 -1
- package/lib/generated-client/api/api-key-api.js +14 -3
- package/lib/generated-client/api/artists-api.d.ts +28 -26
- package/lib/generated-client/api/artists-api.js +26 -15
- package/lib/generated-client/api/audio-api.d.ts +8 -8
- package/lib/generated-client/api/audio-api.js +21 -10
- package/lib/generated-client/api/branding-api.js +14 -3
- package/lib/generated-client/api/channels-api.d.ts +9 -8
- package/lib/generated-client/api/channels-api.js +19 -8
- package/lib/generated-client/api/client-log-api.js +12 -1
- package/lib/generated-client/api/collection-api.js +14 -3
- package/lib/generated-client/api/configuration-api.d.ts +0 -47
- package/lib/generated-client/api/configuration-api.js +16 -71
- package/lib/generated-client/api/dashboard-api.js +13 -2
- package/lib/generated-client/api/devices-api.d.ts +3 -12
- package/lib/generated-client/api/devices-api.js +21 -16
- package/lib/generated-client/api/display-preferences-api.d.ts +22 -22
- package/lib/generated-client/api/display-preferences-api.js +29 -22
- package/lib/generated-client/api/dynamic-hls-api.d.ts +28 -10
- package/lib/generated-client/api/dynamic-hls-api.js +45 -22
- package/lib/generated-client/api/environment-api.js +17 -6
- package/lib/generated-client/api/filter-api.d.ts +9 -8
- package/lib/generated-client/api/filter-api.js +16 -5
- package/lib/generated-client/api/genres-api.d.ts +9 -8
- package/lib/generated-client/api/genres-api.js +16 -5
- package/lib/generated-client/api/hls-segment-api.js +16 -5
- package/lib/generated-client/api/image-api.d.ts +109 -1184
- package/lib/generated-client/api/image-api.js +218 -1056
- package/lib/generated-client/api/instant-mix-api.d.ts +35 -35
- package/lib/generated-client/api/instant-mix-api.js +79 -68
- package/lib/generated-client/api/item-lookup-api.js +22 -11
- package/lib/generated-client/api/item-refresh-api.js +12 -1
- package/lib/generated-client/api/item-update-api.js +14 -3
- package/lib/generated-client/api/items-api.d.ts +333 -1012
- package/lib/generated-client/api/items-api.js +178 -595
- package/lib/generated-client/api/library-api.d.ts +9 -8
- package/lib/generated-client/api/library-api.js +39 -28
- package/lib/generated-client/api/library-structure-api.js +19 -8
- package/lib/generated-client/api/live-tv-api.d.ts +17 -16
- package/lib/generated-client/api/live-tv-api.js +58 -47
- package/lib/generated-client/api/localization-api.js +15 -4
- package/lib/generated-client/api/lyrics-api.d.ts +344 -0
- package/lib/generated-client/api/{dlna-api.js → lyrics-api.js} +165 -125
- package/lib/generated-client/api/media-info-api.d.ts +7 -7
- package/lib/generated-client/api/media-info-api.js +19 -10
- package/lib/generated-client/api/movies-api.js +12 -1
- package/lib/generated-client/api/music-genres-api.d.ts +9 -8
- package/lib/generated-client/api/music-genres-api.js +16 -5
- package/lib/generated-client/api/package-api.js +17 -6
- package/lib/generated-client/api/persons-api.js +13 -2
- package/lib/generated-client/api/playlists-api.d.ts +315 -36
- package/lib/generated-client/api/playlists-api.js +395 -29
- package/lib/generated-client/api/playstate-api.d.ts +41 -68
- package/lib/generated-client/api/playstate-api.js +74 -81
- package/lib/generated-client/api/plugins-api.js +20 -9
- package/lib/generated-client/api/quick-connect-api.d.ts +46 -37
- package/lib/generated-client/api/quick-connect-api.js +67 -50
- package/lib/generated-client/api/remote-image-api.js +14 -3
- package/lib/generated-client/api/scheduled-tasks-api.js +16 -5
- package/lib/generated-client/api/search-api.d.ts +41 -40
- package/lib/generated-client/api/search-api.js +29 -18
- package/lib/generated-client/api/session-api.d.ts +9 -17
- package/lib/generated-client/api/session-api.js +35 -30
- package/lib/generated-client/api/startup-api.js +18 -7
- package/lib/generated-client/api/studios-api.js +13 -2
- package/lib/generated-client/api/subtitle-api.d.ts +7 -7
- package/lib/generated-client/api/subtitle-api.js +33 -22
- package/lib/generated-client/api/suggestions-api.d.ts +14 -13
- package/lib/generated-client/api/suggestions-api.js +24 -13
- package/lib/generated-client/api/sync-play-api.js +32 -21
- package/lib/generated-client/api/system-api.js +21 -10
- package/lib/generated-client/api/time-sync-api.js +12 -1
- package/lib/generated-client/api/tmdb-api.js +12 -1
- package/lib/generated-client/api/trailers-api.d.ts +35 -33
- package/lib/generated-client/api/trailers-api.js +33 -22
- package/lib/generated-client/api/trickplay-api.d.ts +176 -0
- package/lib/generated-client/api/trickplay-api.js +213 -0
- package/lib/generated-client/api/tv-shows-api.d.ts +25 -15
- package/lib/generated-client/api/tv-shows-api.js +32 -15
- package/lib/generated-client/api/universal-audio-api.d.ts +17 -16
- package/lib/generated-client/api/universal-audio-api.js +19 -8
- package/lib/generated-client/api/user-api.d.ts +35 -155
- package/lib/generated-client/api/user-api.js +65 -203
- package/lib/generated-client/api/user-library-api.d.ts +100 -100
- package/lib/generated-client/api/user-library-api.js +136 -125
- package/lib/generated-client/api/user-views-api.d.ts +22 -21
- package/lib/generated-client/api/user-views-api.js +33 -22
- package/lib/generated-client/api/video-attachments-api.js +12 -1
- package/lib/generated-client/api/videos-api.js +18 -7
- package/lib/generated-client/api/years-api.d.ts +15 -13
- package/lib/generated-client/api/years-api.js +19 -8
- package/lib/generated-client/api.d.ts +2 -4
- package/lib/generated-client/base.js +13 -0
- package/lib/generated-client/common.js +11 -0
- package/lib/generated-client/index.js +19 -10
- package/lib/generated-client/models/activity-log-entry-message.d.ts +37 -0
- package/lib/generated-client/models/activity-log-entry-start-message.d.ts +30 -0
- package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +24 -0
- package/lib/generated-client/models/audio-spatial-format.d.ts +21 -0
- package/lib/generated-client/models/audio-spatial-format.js +24 -0
- package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -7
- package/lib/generated-client/models/base-item-dto.d.ts +37 -17
- package/lib/generated-client/models/base-item-person.d.ts +4 -3
- package/lib/generated-client/models/cast-receiver-application.d.ts +29 -0
- package/lib/generated-client/models/client-capabilities-dto.d.ts +17 -20
- package/lib/generated-client/models/client-capabilities.d.ts +16 -19
- package/lib/generated-client/models/collection-type-options.d.ts +9 -9
- package/lib/generated-client/models/collection-type-options.js +9 -9
- package/lib/generated-client/models/collection-type.d.ts +31 -0
- package/lib/generated-client/models/collection-type.js +34 -0
- package/lib/generated-client/models/container-profile.d.ts +1 -1
- package/lib/generated-client/models/create-playlist-dto.d.ts +18 -4
- package/lib/generated-client/models/create-user-by-name.d.ts +1 -1
- package/lib/generated-client/models/device-info.d.ts +6 -0
- package/lib/generated-client/models/device-profile.d.ts +0 -171
- package/lib/generated-client/models/dlna-profile-type.d.ts +1 -0
- package/lib/generated-client/models/dlna-profile-type.js +2 -1
- package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +21 -0
- package/lib/generated-client/models/down-mix-stereo-algorithms.js +24 -0
- package/lib/generated-client/models/encoding-options.d.ts +77 -40
- package/lib/generated-client/models/external-id-media-type.d.ts +1 -0
- package/lib/generated-client/models/external-id-media-type.js +2 -1
- package/lib/generated-client/models/extra-type.d.ts +30 -0
- package/lib/generated-client/models/extra-type.js +33 -0
- package/lib/generated-client/models/force-keep-alive-message.d.ts +36 -0
- package/lib/generated-client/models/general-command-message.d.ts +37 -0
- package/lib/generated-client/models/general-command-type.d.ts +1 -0
- package/lib/generated-client/models/general-command-type.js +2 -1
- package/lib/generated-client/models/get-programs-dto.d.ts +4 -3
- package/lib/generated-client/models/group-info-dto-group-update.d.ts +37 -0
- package/lib/generated-client/models/group-state-update-group-update.d.ts +37 -0
- package/lib/generated-client/models/group-state-update.d.ts +31 -0
- package/lib/generated-client/models/group-update.d.ts +20 -0
- package/lib/generated-client/models/hardware-encoding-type.d.ts +1 -0
- package/lib/generated-client/models/hardware-encoding-type.js +2 -1
- package/lib/generated-client/models/image-format.d.ts +1 -0
- package/lib/generated-client/models/image-format.js +2 -1
- package/lib/generated-client/models/image-resolution.d.ts +27 -0
- package/lib/generated-client/models/{ffmpeg-location.js → image-resolution.js} +12 -7
- package/lib/generated-client/models/inbound-keep-alive-message.d.ts +24 -0
- package/lib/generated-client/models/inbound-web-socket-message.d.ts +23 -0
- package/lib/generated-client/models/index.d.ts +74 -25
- package/lib/generated-client/models/index.js +17 -6
- package/lib/generated-client/models/item-fields.d.ts +1 -2
- package/lib/generated-client/models/item-fields.js +1 -2
- package/lib/generated-client/models/item-sort-by.d.ts +50 -0
- package/lib/generated-client/models/item-sort-by.js +53 -0
- package/lib/generated-client/models/library-changed-message.d.ts +37 -0
- package/lib/generated-client/models/library-options.d.ts +36 -0
- package/lib/generated-client/models/live-tv-options.d.ts +12 -0
- package/lib/generated-client/models/log-file.d.ts +1 -1
- package/lib/generated-client/models/lyric-dto.d.ts +31 -0
- package/lib/generated-client/models/lyric-line.d.ts +29 -0
- package/lib/generated-client/models/lyric-metadata.d.ts +77 -0
- package/lib/generated-client/models/media-source-info.d.ts +3 -2
- package/lib/generated-client/models/media-stream-protocol.d.ts +20 -0
- package/lib/generated-client/models/{header-match-type.js → media-stream-protocol.js} +5 -6
- package/lib/generated-client/models/media-stream-type.d.ts +1 -0
- package/lib/generated-client/models/media-stream-type.js +2 -1
- package/lib/generated-client/models/media-stream.d.ts +27 -6
- package/lib/generated-client/models/media-type.d.ts +23 -0
- package/lib/generated-client/models/{architecture.js → media-type.js} +8 -9
- package/lib/generated-client/models/metadata-editor-info.d.ts +3 -2
- package/lib/generated-client/models/network-configuration.d.ts +50 -116
- package/lib/generated-client/models/outbound-keep-alive-message.d.ts +30 -0
- package/lib/generated-client/models/outbound-web-socket-message.d.ts +44 -0
- package/lib/generated-client/models/parental-rating.d.ts +1 -1
- package/lib/generated-client/models/person-kind.d.ts +43 -0
- package/lib/generated-client/models/person-kind.js +46 -0
- package/lib/generated-client/models/play-message.d.ts +37 -0
- package/lib/generated-client/models/play-queue-update-group-update.d.ts +37 -0
- package/lib/generated-client/models/play-queue-update-reason.d.ts +28 -0
- package/lib/generated-client/models/play-queue-update-reason.js +31 -0
- package/lib/generated-client/models/play-queue-update.d.ts +69 -0
- package/lib/generated-client/models/playback-order.d.ts +20 -0
- package/lib/generated-client/models/{send-to-user-type.js → playback-order.js} +5 -6
- package/lib/generated-client/models/playback-progress-info.d.ts +7 -0
- package/lib/generated-client/models/playback-request-type.d.ts +35 -0
- package/lib/generated-client/models/playback-request-type.js +38 -0
- package/lib/generated-client/models/playback-start-info.d.ts +7 -0
- package/lib/generated-client/models/player-state-info.d.ts +7 -0
- package/lib/generated-client/models/playlist-user-permissions.d.ts +29 -0
- package/lib/generated-client/models/playstate-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-completed-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-failed-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installing-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-uninstalled-message.d.ts +37 -0
- package/lib/generated-client/models/process-priority-class.d.ts +24 -0
- package/lib/generated-client/models/process-priority-class.js +27 -0
- package/lib/generated-client/models/public-system-info.d.ts +1 -0
- package/lib/generated-client/models/refresh-progress-message.d.ts +38 -0
- package/lib/generated-client/models/remote-lyric-info-dto.d.ts +36 -0
- package/lib/generated-client/models/remote-subtitle-info.d.ts +30 -0
- package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +1 -1
- package/lib/generated-client/models/restart-required-message.d.ts +30 -0
- package/lib/generated-client/models/scheduled-task-ended-message.d.ts +37 -0
- package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +37 -0
- package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +30 -0
- package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +24 -0
- package/lib/generated-client/models/search-hint.d.ts +20 -17
- package/lib/generated-client/models/series-status.d.ts +2 -1
- package/lib/generated-client/models/series-status.js +3 -2
- package/lib/generated-client/models/series-timer-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/series-timer-created-message.d.ts +37 -0
- package/lib/generated-client/models/server-configuration.d.ts +45 -0
- package/lib/generated-client/models/server-restarting-message.d.ts +30 -0
- package/lib/generated-client/models/server-shutting-down-message.d.ts +30 -0
- package/lib/generated-client/models/session-info.d.ts +9 -9
- package/lib/generated-client/models/sessions-message.d.ts +37 -0
- package/lib/generated-client/models/sessions-start-message.d.ts +30 -0
- package/lib/generated-client/models/sessions-stop-message.d.ts +24 -0
- package/lib/generated-client/models/string-group-update.d.ts +36 -0
- package/lib/generated-client/models/sync-play-command-message.d.ts +37 -0
- package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +37 -0
- package/lib/generated-client/models/sync-play-queue-item.d.ts +29 -0
- package/lib/generated-client/models/system-info.d.ts +17 -6
- package/lib/generated-client/models/timer-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/timer-created-message.d.ts +37 -0
- package/lib/generated-client/models/transcoding-info.d.ts +3 -2
- package/lib/generated-client/models/transcoding-info.js +15 -0
- package/lib/generated-client/models/transcoding-profile.d.ts +3 -2
- package/lib/generated-client/models/trickplay-info.d.ts +59 -0
- package/lib/generated-client/models/trickplay-options.d.ts +85 -0
- package/lib/generated-client/models/trickplay-scan-behavior.d.ts +20 -0
- package/lib/generated-client/models/{notification-level.js → trickplay-scan-behavior.js} +5 -6
- package/lib/generated-client/models/tuner-host-info.d.ts +6 -0
- package/lib/generated-client/models/update-playlist-dto.d.ts +42 -0
- package/lib/generated-client/models/update-playlist-user-dto.d.ts +23 -0
- package/lib/generated-client/models/update-user-item-data-dto.d.ts +83 -0
- package/lib/generated-client/models/upload-subtitle-dto.d.ts +6 -0
- package/lib/generated-client/models/user-configuration.d.ts +6 -0
- package/lib/generated-client/models/user-data-change-info.d.ts +30 -0
- package/lib/generated-client/models/user-data-changed-message.d.ts +37 -0
- package/lib/generated-client/models/user-deleted-message.d.ts +36 -0
- package/lib/generated-client/models/user-dto.d.ts +1 -0
- package/lib/generated-client/models/user-policy.d.ts +26 -2
- package/lib/generated-client/models/user-updated-message.d.ts +37 -0
- package/lib/generated-client/models/video-range-type.d.ts +27 -0
- package/lib/generated-client/models/video-range-type.js +30 -0
- package/lib/generated-client/models/video-range.d.ts +21 -0
- package/lib/generated-client/models/{device-profile-type.js → video-range.js} +6 -5
- package/lib/generated-client/models/web-socket-message.d.ts +18 -0
- package/lib/node_modules/tslib/tslib.es6.js +9 -2
- package/lib/utils/api/image-api.d.ts +2 -2
- package/lib/utils/api/image-api.js +2 -2
- package/lib/utils/api/image-urls-api.d.ts +55 -0
- package/lib/utils/api/image-urls-api.js +103 -0
- package/lib/utils/api/index.d.ts +2 -4
- package/lib/utils/api/index.js +2 -4
- package/lib/utils/api/{dlna-api.d.ts → lyrics-api.d.ts} +2 -2
- package/lib/utils/api/{dlna-api.js → lyrics-api.js} +4 -4
- package/lib/utils/api/{dlna-server-api.d.ts → trickplay-api.d.ts} +2 -2
- package/lib/utils/api/trickplay-api.js +12 -0
- package/lib/utils/authentication.js +5 -6
- package/lib/utils/index.d.ts +2 -1
- package/lib/utils/index.js +2 -1
- package/lib/utils/versioning.d.ts +9 -0
- package/lib/utils/versioning.js +32 -0
- package/lib/versions.d.ts +2 -2
- package/lib/versions.js +2 -2
- package/package.json +19 -22
- package/lib/generated-client/api/dlna-server-api.js +0 -1088
- package/lib/generated-client/api/image-by-name-api.js +0 -423
- package/lib/generated-client/api/notifications-api.js +0 -484
- package/lib/utils/api/dlna-server-api.js +0 -12
- package/lib/utils/api/image-by-name-api.d.ts +0 -8
- package/lib/utils/api/image-by-name-api.js +0 -12
- package/lib/utils/api/notifications-api.d.ts +0 -8
- package/lib/utils/api/notifications-api.js +0 -12
|
@@ -49,23 +49,11 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
49
49
|
/**
|
|
50
50
|
*
|
|
51
51
|
* @summary Delete the user\'s image.
|
|
52
|
-
* @param {string} userId User Id.
|
|
53
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
54
|
-
* @param {number} [index] (Unused) Image index.
|
|
52
|
+
* @param {string} [userId] User Id.
|
|
55
53
|
* @param {*} [options] Override http request option.
|
|
56
54
|
* @throws {RequiredError}
|
|
57
55
|
*/
|
|
58
|
-
deleteUserImage: (userId
|
|
59
|
-
/**
|
|
60
|
-
*
|
|
61
|
-
* @summary Delete the user\'s image.
|
|
62
|
-
* @param {string} userId User Id.
|
|
63
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
64
|
-
* @param {number} index (Unused) Image index.
|
|
65
|
-
* @param {*} [options] Override http request option.
|
|
66
|
-
* @throws {RequiredError}
|
|
67
|
-
*/
|
|
68
|
-
deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
deleteUserImage: (userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
57
|
/**
|
|
70
58
|
*
|
|
71
59
|
* @summary Get artist image by name.
|
|
@@ -83,15 +71,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
83
71
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
84
72
|
* @param {number} [fillWidth] Width of box to fill.
|
|
85
73
|
* @param {number} [fillHeight] Height of box to fill.
|
|
86
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
87
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
88
74
|
* @param {number} [blur] Optional. Blur image.
|
|
89
75
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
90
76
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
91
77
|
* @param {*} [options] Override http request option.
|
|
92
78
|
* @throws {RequiredError}
|
|
93
79
|
*/
|
|
94
|
-
getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
80
|
+
getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
81
|
/**
|
|
96
82
|
*
|
|
97
83
|
* @summary Get genre image by name.
|
|
@@ -108,8 +94,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
108
94
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
109
95
|
* @param {number} [fillWidth] Width of box to fill.
|
|
110
96
|
* @param {number} [fillHeight] Height of box to fill.
|
|
111
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
112
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
113
97
|
* @param {number} [blur] Optional. Blur image.
|
|
114
98
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
115
99
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -117,7 +101,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
117
101
|
* @param {*} [options] Override http request option.
|
|
118
102
|
* @throws {RequiredError}
|
|
119
103
|
*/
|
|
120
|
-
getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
104
|
+
getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
121
105
|
/**
|
|
122
106
|
*
|
|
123
107
|
* @summary Get genre image by name.
|
|
@@ -135,15 +119,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
135
119
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
136
120
|
* @param {number} [fillWidth] Width of box to fill.
|
|
137
121
|
* @param {number} [fillHeight] Height of box to fill.
|
|
138
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
139
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
140
122
|
* @param {number} [blur] Optional. Blur image.
|
|
141
123
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
142
124
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
143
125
|
* @param {*} [options] Override http request option.
|
|
144
126
|
* @throws {RequiredError}
|
|
145
127
|
*/
|
|
146
|
-
getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
128
|
+
getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
147
129
|
/**
|
|
148
130
|
*
|
|
149
131
|
* @summary Gets the item\'s image.
|
|
@@ -157,9 +139,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
157
139
|
* @param {number} [fillWidth] Width of box to fill.
|
|
158
140
|
* @param {number} [fillHeight] Height of box to fill.
|
|
159
141
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
160
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
161
142
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
162
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
163
143
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
164
144
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
165
145
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -169,7 +149,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
169
149
|
* @param {*} [options] Override http request option.
|
|
170
150
|
* @throws {RequiredError}
|
|
171
151
|
*/
|
|
172
|
-
getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
152
|
+
getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
173
153
|
/**
|
|
174
154
|
*
|
|
175
155
|
* @summary Gets the item\'s image.
|
|
@@ -187,15 +167,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
187
167
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
188
168
|
* @param {number} [fillWidth] Width of box to fill.
|
|
189
169
|
* @param {number} [fillHeight] Height of box to fill.
|
|
190
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
191
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
192
170
|
* @param {number} [blur] Optional. Blur image.
|
|
193
171
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
194
172
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
195
173
|
* @param {*} [options] Override http request option.
|
|
196
174
|
* @throws {RequiredError}
|
|
197
175
|
*/
|
|
198
|
-
getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
176
|
+
getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
199
177
|
/**
|
|
200
178
|
*
|
|
201
179
|
* @summary Gets the item\'s image.
|
|
@@ -210,9 +188,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
210
188
|
* @param {number} [fillWidth] Width of box to fill.
|
|
211
189
|
* @param {number} [fillHeight] Height of box to fill.
|
|
212
190
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
213
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
214
191
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
215
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
216
192
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
217
193
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
218
194
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -221,7 +197,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
221
197
|
* @param {*} [options] Override http request option.
|
|
222
198
|
* @throws {RequiredError}
|
|
223
199
|
*/
|
|
224
|
-
getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
200
|
+
getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
225
201
|
/**
|
|
226
202
|
*
|
|
227
203
|
* @summary Get item image infos.
|
|
@@ -246,8 +222,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
246
222
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
247
223
|
* @param {number} [fillWidth] Width of box to fill.
|
|
248
224
|
* @param {number} [fillHeight] Height of box to fill.
|
|
249
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
250
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
251
225
|
* @param {number} [blur] Optional. Blur image.
|
|
252
226
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
253
227
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -255,7 +229,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
255
229
|
* @param {*} [options] Override http request option.
|
|
256
230
|
* @throws {RequiredError}
|
|
257
231
|
*/
|
|
258
|
-
getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
232
|
+
getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
259
233
|
/**
|
|
260
234
|
*
|
|
261
235
|
* @summary Get music genre image by name.
|
|
@@ -273,15 +247,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
273
247
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
274
248
|
* @param {number} [fillWidth] Width of box to fill.
|
|
275
249
|
* @param {number} [fillHeight] Height of box to fill.
|
|
276
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
277
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
278
250
|
* @param {number} [blur] Optional. Blur image.
|
|
279
251
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
280
252
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
281
253
|
* @param {*} [options] Override http request option.
|
|
282
254
|
* @throws {RequiredError}
|
|
283
255
|
*/
|
|
284
|
-
getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
256
|
+
getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
285
257
|
/**
|
|
286
258
|
*
|
|
287
259
|
* @summary Get person image by name.
|
|
@@ -298,8 +270,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
298
270
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
299
271
|
* @param {number} [fillWidth] Width of box to fill.
|
|
300
272
|
* @param {number} [fillHeight] Height of box to fill.
|
|
301
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
302
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
303
273
|
* @param {number} [blur] Optional. Blur image.
|
|
304
274
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
305
275
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -307,7 +277,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
307
277
|
* @param {*} [options] Override http request option.
|
|
308
278
|
* @throws {RequiredError}
|
|
309
279
|
*/
|
|
310
|
-
getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
280
|
+
getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
311
281
|
/**
|
|
312
282
|
*
|
|
313
283
|
* @summary Get person image by name.
|
|
@@ -325,15 +295,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
325
295
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
326
296
|
* @param {number} [fillWidth] Width of box to fill.
|
|
327
297
|
* @param {number} [fillHeight] Height of box to fill.
|
|
328
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
329
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
330
298
|
* @param {number} [blur] Optional. Blur image.
|
|
331
299
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
332
300
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
333
301
|
* @param {*} [options] Override http request option.
|
|
334
302
|
* @throws {RequiredError}
|
|
335
303
|
*/
|
|
336
|
-
getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
304
|
+
getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
337
305
|
/**
|
|
338
306
|
*
|
|
339
307
|
* @summary Generates or gets the splashscreen.
|
|
@@ -369,8 +337,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
369
337
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
370
338
|
* @param {number} [fillWidth] Width of box to fill.
|
|
371
339
|
* @param {number} [fillHeight] Height of box to fill.
|
|
372
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
373
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
374
340
|
* @param {number} [blur] Optional. Blur image.
|
|
375
341
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
376
342
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -378,7 +344,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
378
344
|
* @param {*} [options] Override http request option.
|
|
379
345
|
* @throws {RequiredError}
|
|
380
346
|
*/
|
|
381
|
-
getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
347
|
+
getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
382
348
|
/**
|
|
383
349
|
*
|
|
384
350
|
* @summary Get studio image by name.
|
|
@@ -396,20 +362,17 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
396
362
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
397
363
|
* @param {number} [fillWidth] Width of box to fill.
|
|
398
364
|
* @param {number} [fillHeight] Height of box to fill.
|
|
399
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
400
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
401
365
|
* @param {number} [blur] Optional. Blur image.
|
|
402
366
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
403
367
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
404
368
|
* @param {*} [options] Override http request option.
|
|
405
369
|
* @throws {RequiredError}
|
|
406
370
|
*/
|
|
407
|
-
getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
371
|
+
getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
408
372
|
/**
|
|
409
373
|
*
|
|
410
374
|
* @summary Get user profile image.
|
|
411
|
-
* @param {string} userId User id.
|
|
412
|
-
* @param {ImageType} imageType Image type.
|
|
375
|
+
* @param {string} [userId] User id.
|
|
413
376
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
414
377
|
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
415
378
|
* @param {number} [maxWidth] The maximum image width to return.
|
|
@@ -421,8 +384,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
421
384
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
422
385
|
* @param {number} [fillWidth] Width of box to fill.
|
|
423
386
|
* @param {number} [fillHeight] Height of box to fill.
|
|
424
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
425
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
426
387
|
* @param {number} [blur] Optional. Blur image.
|
|
427
388
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
428
389
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -430,33 +391,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
430
391
|
* @param {*} [options] Override http request option.
|
|
431
392
|
* @throws {RequiredError}
|
|
432
393
|
*/
|
|
433
|
-
getUserImage: (userId
|
|
434
|
-
/**
|
|
435
|
-
*
|
|
436
|
-
* @summary Get user profile image.
|
|
437
|
-
* @param {string} userId User id.
|
|
438
|
-
* @param {ImageType} imageType Image type.
|
|
439
|
-
* @param {number} imageIndex Image index.
|
|
440
|
-
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
441
|
-
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
442
|
-
* @param {number} [maxWidth] The maximum image width to return.
|
|
443
|
-
* @param {number} [maxHeight] The maximum image height to return.
|
|
444
|
-
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
445
|
-
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
446
|
-
* @param {number} [width] The fixed image width to return.
|
|
447
|
-
* @param {number} [height] The fixed image height to return.
|
|
448
|
-
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
449
|
-
* @param {number} [fillWidth] Width of box to fill.
|
|
450
|
-
* @param {number} [fillHeight] Height of box to fill.
|
|
451
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
452
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
453
|
-
* @param {number} [blur] Optional. Blur image.
|
|
454
|
-
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
455
|
-
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
456
|
-
* @param {*} [options] Override http request option.
|
|
457
|
-
* @throws {RequiredError}
|
|
458
|
-
*/
|
|
459
|
-
getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
394
|
+
getUserImage: (userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
460
395
|
/**
|
|
461
396
|
*
|
|
462
397
|
* @summary Get artist image by name.
|
|
@@ -474,15 +409,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
474
409
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
475
410
|
* @param {number} [fillWidth] Width of box to fill.
|
|
476
411
|
* @param {number} [fillHeight] Height of box to fill.
|
|
477
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
478
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
479
412
|
* @param {number} [blur] Optional. Blur image.
|
|
480
413
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
481
414
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
482
415
|
* @param {*} [options] Override http request option.
|
|
483
416
|
* @throws {RequiredError}
|
|
484
417
|
*/
|
|
485
|
-
headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
418
|
+
headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
486
419
|
/**
|
|
487
420
|
*
|
|
488
421
|
* @summary Get genre image by name.
|
|
@@ -499,8 +432,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
499
432
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
500
433
|
* @param {number} [fillWidth] Width of box to fill.
|
|
501
434
|
* @param {number} [fillHeight] Height of box to fill.
|
|
502
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
503
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
504
435
|
* @param {number} [blur] Optional. Blur image.
|
|
505
436
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
506
437
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -508,7 +439,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
508
439
|
* @param {*} [options] Override http request option.
|
|
509
440
|
* @throws {RequiredError}
|
|
510
441
|
*/
|
|
511
|
-
headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
442
|
+
headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
512
443
|
/**
|
|
513
444
|
*
|
|
514
445
|
* @summary Get genre image by name.
|
|
@@ -526,15 +457,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
526
457
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
527
458
|
* @param {number} [fillWidth] Width of box to fill.
|
|
528
459
|
* @param {number} [fillHeight] Height of box to fill.
|
|
529
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
530
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
531
460
|
* @param {number} [blur] Optional. Blur image.
|
|
532
461
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
533
462
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
534
463
|
* @param {*} [options] Override http request option.
|
|
535
464
|
* @throws {RequiredError}
|
|
536
465
|
*/
|
|
537
|
-
headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
466
|
+
headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
538
467
|
/**
|
|
539
468
|
*
|
|
540
469
|
* @summary Gets the item\'s image.
|
|
@@ -548,9 +477,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
548
477
|
* @param {number} [fillWidth] Width of box to fill.
|
|
549
478
|
* @param {number} [fillHeight] Height of box to fill.
|
|
550
479
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
551
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
552
480
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
553
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
554
481
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
555
482
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
556
483
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -560,7 +487,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
560
487
|
* @param {*} [options] Override http request option.
|
|
561
488
|
* @throws {RequiredError}
|
|
562
489
|
*/
|
|
563
|
-
headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
490
|
+
headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
564
491
|
/**
|
|
565
492
|
*
|
|
566
493
|
* @summary Gets the item\'s image.
|
|
@@ -578,15 +505,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
578
505
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
579
506
|
* @param {number} [fillWidth] Width of box to fill.
|
|
580
507
|
* @param {number} [fillHeight] Height of box to fill.
|
|
581
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
582
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
583
508
|
* @param {number} [blur] Optional. Blur image.
|
|
584
509
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
585
510
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
586
511
|
* @param {*} [options] Override http request option.
|
|
587
512
|
* @throws {RequiredError}
|
|
588
513
|
*/
|
|
589
|
-
headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
514
|
+
headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
590
515
|
/**
|
|
591
516
|
*
|
|
592
517
|
* @summary Gets the item\'s image.
|
|
@@ -601,9 +526,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
601
526
|
* @param {number} [fillWidth] Width of box to fill.
|
|
602
527
|
* @param {number} [fillHeight] Height of box to fill.
|
|
603
528
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
604
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
605
529
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
606
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
607
530
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
608
531
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
609
532
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -612,7 +535,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
612
535
|
* @param {*} [options] Override http request option.
|
|
613
536
|
* @throws {RequiredError}
|
|
614
537
|
*/
|
|
615
|
-
headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
538
|
+
headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
616
539
|
/**
|
|
617
540
|
*
|
|
618
541
|
* @summary Get music genre image by name.
|
|
@@ -629,8 +552,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
629
552
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
630
553
|
* @param {number} [fillWidth] Width of box to fill.
|
|
631
554
|
* @param {number} [fillHeight] Height of box to fill.
|
|
632
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
633
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
634
555
|
* @param {number} [blur] Optional. Blur image.
|
|
635
556
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
636
557
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -638,7 +559,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
638
559
|
* @param {*} [options] Override http request option.
|
|
639
560
|
* @throws {RequiredError}
|
|
640
561
|
*/
|
|
641
|
-
headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
562
|
+
headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
642
563
|
/**
|
|
643
564
|
*
|
|
644
565
|
* @summary Get music genre image by name.
|
|
@@ -656,15 +577,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
656
577
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
657
578
|
* @param {number} [fillWidth] Width of box to fill.
|
|
658
579
|
* @param {number} [fillHeight] Height of box to fill.
|
|
659
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
660
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
661
580
|
* @param {number} [blur] Optional. Blur image.
|
|
662
581
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
663
582
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
664
583
|
* @param {*} [options] Override http request option.
|
|
665
584
|
* @throws {RequiredError}
|
|
666
585
|
*/
|
|
667
|
-
headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
586
|
+
headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
668
587
|
/**
|
|
669
588
|
*
|
|
670
589
|
* @summary Get person image by name.
|
|
@@ -681,8 +600,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
681
600
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
682
601
|
* @param {number} [fillWidth] Width of box to fill.
|
|
683
602
|
* @param {number} [fillHeight] Height of box to fill.
|
|
684
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
685
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
686
603
|
* @param {number} [blur] Optional. Blur image.
|
|
687
604
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
688
605
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -690,7 +607,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
690
607
|
* @param {*} [options] Override http request option.
|
|
691
608
|
* @throws {RequiredError}
|
|
692
609
|
*/
|
|
693
|
-
headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
610
|
+
headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
694
611
|
/**
|
|
695
612
|
*
|
|
696
613
|
* @summary Get person image by name.
|
|
@@ -708,15 +625,13 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
708
625
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
709
626
|
* @param {number} [fillWidth] Width of box to fill.
|
|
710
627
|
* @param {number} [fillHeight] Height of box to fill.
|
|
711
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
712
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
713
628
|
* @param {number} [blur] Optional. Blur image.
|
|
714
629
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
715
630
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
716
631
|
* @param {*} [options] Override http request option.
|
|
717
632
|
* @throws {RequiredError}
|
|
718
633
|
*/
|
|
719
|
-
headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
634
|
+
headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
720
635
|
/**
|
|
721
636
|
*
|
|
722
637
|
* @summary Get studio image by name.
|
|
@@ -733,8 +648,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
733
648
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
734
649
|
* @param {number} [fillWidth] Width of box to fill.
|
|
735
650
|
* @param {number} [fillHeight] Height of box to fill.
|
|
736
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
737
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
738
651
|
* @param {number} [blur] Optional. Blur image.
|
|
739
652
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
740
653
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -742,7 +655,7 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
742
655
|
* @param {*} [options] Override http request option.
|
|
743
656
|
* @throws {RequiredError}
|
|
744
657
|
*/
|
|
745
|
-
headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
658
|
+
headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
746
659
|
/**
|
|
747
660
|
*
|
|
748
661
|
* @summary Get studio image by name.
|
|
@@ -760,20 +673,17 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
760
673
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
761
674
|
* @param {number} [fillWidth] Width of box to fill.
|
|
762
675
|
* @param {number} [fillHeight] Height of box to fill.
|
|
763
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
764
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
765
676
|
* @param {number} [blur] Optional. Blur image.
|
|
766
677
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
767
678
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
768
679
|
* @param {*} [options] Override http request option.
|
|
769
680
|
* @throws {RequiredError}
|
|
770
681
|
*/
|
|
771
|
-
headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
682
|
+
headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
772
683
|
/**
|
|
773
684
|
*
|
|
774
685
|
* @summary Get user profile image.
|
|
775
|
-
* @param {string} userId User id.
|
|
776
|
-
* @param {ImageType} imageType Image type.
|
|
686
|
+
* @param {string} [userId] User id.
|
|
777
687
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
778
688
|
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
779
689
|
* @param {number} [maxWidth] The maximum image width to return.
|
|
@@ -785,8 +695,6 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
785
695
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
786
696
|
* @param {number} [fillWidth] Width of box to fill.
|
|
787
697
|
* @param {number} [fillHeight] Height of box to fill.
|
|
788
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
789
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
790
698
|
* @param {number} [blur] Optional. Blur image.
|
|
791
699
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
792
700
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -794,55 +702,16 @@ export declare const ImageApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
794
702
|
* @param {*} [options] Override http request option.
|
|
795
703
|
* @throws {RequiredError}
|
|
796
704
|
*/
|
|
797
|
-
headUserImage: (userId
|
|
798
|
-
/**
|
|
799
|
-
*
|
|
800
|
-
* @summary Get user profile image.
|
|
801
|
-
* @param {string} userId User id.
|
|
802
|
-
* @param {ImageType} imageType Image type.
|
|
803
|
-
* @param {number} imageIndex Image index.
|
|
804
|
-
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
805
|
-
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
806
|
-
* @param {number} [maxWidth] The maximum image width to return.
|
|
807
|
-
* @param {number} [maxHeight] The maximum image height to return.
|
|
808
|
-
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
809
|
-
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
810
|
-
* @param {number} [width] The fixed image width to return.
|
|
811
|
-
* @param {number} [height] The fixed image height to return.
|
|
812
|
-
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
813
|
-
* @param {number} [fillWidth] Width of box to fill.
|
|
814
|
-
* @param {number} [fillHeight] Height of box to fill.
|
|
815
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
816
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
817
|
-
* @param {number} [blur] Optional. Blur image.
|
|
818
|
-
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
819
|
-
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
820
|
-
* @param {*} [options] Override http request option.
|
|
821
|
-
* @throws {RequiredError}
|
|
822
|
-
*/
|
|
823
|
-
headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
824
|
-
/**
|
|
825
|
-
*
|
|
826
|
-
* @summary Sets the user image.
|
|
827
|
-
* @param {string} userId User Id.
|
|
828
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
829
|
-
* @param {number} [index] (Unused) Image index.
|
|
830
|
-
* @param {any} [body]
|
|
831
|
-
* @param {*} [options] Override http request option.
|
|
832
|
-
* @throws {RequiredError}
|
|
833
|
-
*/
|
|
834
|
-
postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
705
|
+
headUserImage: (userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
835
706
|
/**
|
|
836
707
|
*
|
|
837
708
|
* @summary Sets the user image.
|
|
838
|
-
* @param {string} userId User Id.
|
|
839
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
840
|
-
* @param {number} index (Unused) Image index.
|
|
709
|
+
* @param {string} [userId] User Id.
|
|
841
710
|
* @param {any} [body]
|
|
842
711
|
* @param {*} [options] Override http request option.
|
|
843
712
|
* @throws {RequiredError}
|
|
844
713
|
*/
|
|
845
|
-
|
|
714
|
+
postUserImage: (userId?: string, body?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
846
715
|
/**
|
|
847
716
|
*
|
|
848
717
|
* @summary Set item image.
|
|
@@ -919,23 +788,11 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
919
788
|
/**
|
|
920
789
|
*
|
|
921
790
|
* @summary Delete the user\'s image.
|
|
922
|
-
* @param {string} userId User Id.
|
|
923
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
924
|
-
* @param {number} [index] (Unused) Image index.
|
|
925
|
-
* @param {*} [options] Override http request option.
|
|
926
|
-
* @throws {RequiredError}
|
|
927
|
-
*/
|
|
928
|
-
deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
929
|
-
/**
|
|
930
|
-
*
|
|
931
|
-
* @summary Delete the user\'s image.
|
|
932
|
-
* @param {string} userId User Id.
|
|
933
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
934
|
-
* @param {number} index (Unused) Image index.
|
|
791
|
+
* @param {string} [userId] User Id.
|
|
935
792
|
* @param {*} [options] Override http request option.
|
|
936
793
|
* @throws {RequiredError}
|
|
937
794
|
*/
|
|
938
|
-
|
|
795
|
+
deleteUserImage(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
939
796
|
/**
|
|
940
797
|
*
|
|
941
798
|
* @summary Get artist image by name.
|
|
@@ -953,15 +810,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
953
810
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
954
811
|
* @param {number} [fillWidth] Width of box to fill.
|
|
955
812
|
* @param {number} [fillHeight] Height of box to fill.
|
|
956
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
957
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
958
813
|
* @param {number} [blur] Optional. Blur image.
|
|
959
814
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
960
815
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
961
816
|
* @param {*} [options] Override http request option.
|
|
962
817
|
* @throws {RequiredError}
|
|
963
818
|
*/
|
|
964
|
-
getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
819
|
+
getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
965
820
|
/**
|
|
966
821
|
*
|
|
967
822
|
* @summary Get genre image by name.
|
|
@@ -978,8 +833,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
978
833
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
979
834
|
* @param {number} [fillWidth] Width of box to fill.
|
|
980
835
|
* @param {number} [fillHeight] Height of box to fill.
|
|
981
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
982
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
983
836
|
* @param {number} [blur] Optional. Blur image.
|
|
984
837
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
985
838
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -987,7 +840,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
987
840
|
* @param {*} [options] Override http request option.
|
|
988
841
|
* @throws {RequiredError}
|
|
989
842
|
*/
|
|
990
|
-
getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
843
|
+
getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
991
844
|
/**
|
|
992
845
|
*
|
|
993
846
|
* @summary Get genre image by name.
|
|
@@ -1005,15 +858,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1005
858
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1006
859
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1007
860
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1008
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1009
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1010
861
|
* @param {number} [blur] Optional. Blur image.
|
|
1011
862
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1012
863
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1013
864
|
* @param {*} [options] Override http request option.
|
|
1014
865
|
* @throws {RequiredError}
|
|
1015
866
|
*/
|
|
1016
|
-
getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
867
|
+
getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1017
868
|
/**
|
|
1018
869
|
*
|
|
1019
870
|
* @summary Gets the item\'s image.
|
|
@@ -1027,9 +878,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1027
878
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1028
879
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1029
880
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1030
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1031
881
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
1032
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1033
882
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1034
883
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1035
884
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -1039,7 +888,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1039
888
|
* @param {*} [options] Override http request option.
|
|
1040
889
|
* @throws {RequiredError}
|
|
1041
890
|
*/
|
|
1042
|
-
getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
891
|
+
getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1043
892
|
/**
|
|
1044
893
|
*
|
|
1045
894
|
* @summary Gets the item\'s image.
|
|
@@ -1057,15 +906,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1057
906
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1058
907
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1059
908
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1060
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1061
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1062
909
|
* @param {number} [blur] Optional. Blur image.
|
|
1063
910
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1064
911
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1065
912
|
* @param {*} [options] Override http request option.
|
|
1066
913
|
* @throws {RequiredError}
|
|
1067
914
|
*/
|
|
1068
|
-
getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
915
|
+
getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1069
916
|
/**
|
|
1070
917
|
*
|
|
1071
918
|
* @summary Gets the item\'s image.
|
|
@@ -1080,9 +927,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1080
927
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1081
928
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1082
929
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1083
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1084
930
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
1085
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1086
931
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1087
932
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1088
933
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -1091,7 +936,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1091
936
|
* @param {*} [options] Override http request option.
|
|
1092
937
|
* @throws {RequiredError}
|
|
1093
938
|
*/
|
|
1094
|
-
getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
939
|
+
getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1095
940
|
/**
|
|
1096
941
|
*
|
|
1097
942
|
* @summary Get item image infos.
|
|
@@ -1116,8 +961,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1116
961
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1117
962
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1118
963
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1119
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1120
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1121
964
|
* @param {number} [blur] Optional. Blur image.
|
|
1122
965
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1123
966
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1125,7 +968,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1125
968
|
* @param {*} [options] Override http request option.
|
|
1126
969
|
* @throws {RequiredError}
|
|
1127
970
|
*/
|
|
1128
|
-
getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
971
|
+
getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1129
972
|
/**
|
|
1130
973
|
*
|
|
1131
974
|
* @summary Get music genre image by name.
|
|
@@ -1143,15 +986,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1143
986
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1144
987
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1145
988
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1146
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1147
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1148
989
|
* @param {number} [blur] Optional. Blur image.
|
|
1149
990
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1150
991
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1151
992
|
* @param {*} [options] Override http request option.
|
|
1152
993
|
* @throws {RequiredError}
|
|
1153
994
|
*/
|
|
1154
|
-
getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
995
|
+
getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1155
996
|
/**
|
|
1156
997
|
*
|
|
1157
998
|
* @summary Get person image by name.
|
|
@@ -1168,8 +1009,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1168
1009
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1169
1010
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1170
1011
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1171
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1172
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1173
1012
|
* @param {number} [blur] Optional. Blur image.
|
|
1174
1013
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1175
1014
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1177,7 +1016,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1177
1016
|
* @param {*} [options] Override http request option.
|
|
1178
1017
|
* @throws {RequiredError}
|
|
1179
1018
|
*/
|
|
1180
|
-
getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1019
|
+
getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1181
1020
|
/**
|
|
1182
1021
|
*
|
|
1183
1022
|
* @summary Get person image by name.
|
|
@@ -1195,15 +1034,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1195
1034
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1196
1035
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1197
1036
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1198
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1199
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1200
1037
|
* @param {number} [blur] Optional. Blur image.
|
|
1201
1038
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1202
1039
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1203
1040
|
* @param {*} [options] Override http request option.
|
|
1204
1041
|
* @throws {RequiredError}
|
|
1205
1042
|
*/
|
|
1206
|
-
getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1043
|
+
getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1207
1044
|
/**
|
|
1208
1045
|
*
|
|
1209
1046
|
* @summary Generates or gets the splashscreen.
|
|
@@ -1239,8 +1076,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1239
1076
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1240
1077
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1241
1078
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1242
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1243
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1244
1079
|
* @param {number} [blur] Optional. Blur image.
|
|
1245
1080
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1246
1081
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1248,7 +1083,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1248
1083
|
* @param {*} [options] Override http request option.
|
|
1249
1084
|
* @throws {RequiredError}
|
|
1250
1085
|
*/
|
|
1251
|
-
getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1086
|
+
getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1252
1087
|
/**
|
|
1253
1088
|
*
|
|
1254
1089
|
* @summary Get studio image by name.
|
|
@@ -1266,20 +1101,17 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1266
1101
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1267
1102
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1268
1103
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1269
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1270
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1271
1104
|
* @param {number} [blur] Optional. Blur image.
|
|
1272
1105
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1273
1106
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1274
1107
|
* @param {*} [options] Override http request option.
|
|
1275
1108
|
* @throws {RequiredError}
|
|
1276
1109
|
*/
|
|
1277
|
-
getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1110
|
+
getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1278
1111
|
/**
|
|
1279
1112
|
*
|
|
1280
1113
|
* @summary Get user profile image.
|
|
1281
|
-
* @param {string} userId User id.
|
|
1282
|
-
* @param {ImageType} imageType Image type.
|
|
1114
|
+
* @param {string} [userId] User id.
|
|
1283
1115
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1284
1116
|
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
1285
1117
|
* @param {number} [maxWidth] The maximum image width to return.
|
|
@@ -1291,8 +1123,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1291
1123
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1292
1124
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1293
1125
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1294
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1295
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1296
1126
|
* @param {number} [blur] Optional. Blur image.
|
|
1297
1127
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1298
1128
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1300,33 +1130,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1300
1130
|
* @param {*} [options] Override http request option.
|
|
1301
1131
|
* @throws {RequiredError}
|
|
1302
1132
|
*/
|
|
1303
|
-
getUserImage(userId
|
|
1304
|
-
/**
|
|
1305
|
-
*
|
|
1306
|
-
* @summary Get user profile image.
|
|
1307
|
-
* @param {string} userId User id.
|
|
1308
|
-
* @param {ImageType} imageType Image type.
|
|
1309
|
-
* @param {number} imageIndex Image index.
|
|
1310
|
-
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1311
|
-
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
1312
|
-
* @param {number} [maxWidth] The maximum image width to return.
|
|
1313
|
-
* @param {number} [maxHeight] The maximum image height to return.
|
|
1314
|
-
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1315
|
-
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1316
|
-
* @param {number} [width] The fixed image width to return.
|
|
1317
|
-
* @param {number} [height] The fixed image height to return.
|
|
1318
|
-
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1319
|
-
* @param {number} [fillWidth] Width of box to fill.
|
|
1320
|
-
* @param {number} [fillHeight] Height of box to fill.
|
|
1321
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1322
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1323
|
-
* @param {number} [blur] Optional. Blur image.
|
|
1324
|
-
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1325
|
-
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1326
|
-
* @param {*} [options] Override http request option.
|
|
1327
|
-
* @throws {RequiredError}
|
|
1328
|
-
*/
|
|
1329
|
-
getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1133
|
+
getUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1330
1134
|
/**
|
|
1331
1135
|
*
|
|
1332
1136
|
* @summary Get artist image by name.
|
|
@@ -1344,15 +1148,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1344
1148
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1345
1149
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1346
1150
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1347
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1348
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1349
1151
|
* @param {number} [blur] Optional. Blur image.
|
|
1350
1152
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1351
1153
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1352
1154
|
* @param {*} [options] Override http request option.
|
|
1353
1155
|
* @throws {RequiredError}
|
|
1354
1156
|
*/
|
|
1355
|
-
headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1157
|
+
headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1356
1158
|
/**
|
|
1357
1159
|
*
|
|
1358
1160
|
* @summary Get genre image by name.
|
|
@@ -1369,8 +1171,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1369
1171
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1370
1172
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1371
1173
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1372
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1373
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1374
1174
|
* @param {number} [blur] Optional. Blur image.
|
|
1375
1175
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1376
1176
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1378,7 +1178,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1378
1178
|
* @param {*} [options] Override http request option.
|
|
1379
1179
|
* @throws {RequiredError}
|
|
1380
1180
|
*/
|
|
1381
|
-
headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1181
|
+
headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1382
1182
|
/**
|
|
1383
1183
|
*
|
|
1384
1184
|
* @summary Get genre image by name.
|
|
@@ -1396,15 +1196,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1396
1196
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1397
1197
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1398
1198
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1399
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1400
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1401
1199
|
* @param {number} [blur] Optional. Blur image.
|
|
1402
1200
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1403
1201
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1404
1202
|
* @param {*} [options] Override http request option.
|
|
1405
1203
|
* @throws {RequiredError}
|
|
1406
1204
|
*/
|
|
1407
|
-
headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1205
|
+
headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1408
1206
|
/**
|
|
1409
1207
|
*
|
|
1410
1208
|
* @summary Gets the item\'s image.
|
|
@@ -1418,9 +1216,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1418
1216
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1419
1217
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1420
1218
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1421
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1422
1219
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
1423
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1424
1220
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1425
1221
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1426
1222
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -1430,7 +1226,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1430
1226
|
* @param {*} [options] Override http request option.
|
|
1431
1227
|
* @throws {RequiredError}
|
|
1432
1228
|
*/
|
|
1433
|
-
headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
1229
|
+
headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1434
1230
|
/**
|
|
1435
1231
|
*
|
|
1436
1232
|
* @summary Gets the item\'s image.
|
|
@@ -1448,15 +1244,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1448
1244
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1449
1245
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1450
1246
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1451
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1452
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1453
1247
|
* @param {number} [blur] Optional. Blur image.
|
|
1454
1248
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1455
1249
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1456
1250
|
* @param {*} [options] Override http request option.
|
|
1457
1251
|
* @throws {RequiredError}
|
|
1458
1252
|
*/
|
|
1459
|
-
headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1253
|
+
headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1460
1254
|
/**
|
|
1461
1255
|
*
|
|
1462
1256
|
* @summary Gets the item\'s image.
|
|
@@ -1471,9 +1265,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1471
1265
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1472
1266
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1473
1267
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1474
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1475
1268
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
1476
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1477
1269
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1478
1270
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1479
1271
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -1482,7 +1274,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1482
1274
|
* @param {*} [options] Override http request option.
|
|
1483
1275
|
* @throws {RequiredError}
|
|
1484
1276
|
*/
|
|
1485
|
-
headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
1277
|
+
headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1486
1278
|
/**
|
|
1487
1279
|
*
|
|
1488
1280
|
* @summary Get music genre image by name.
|
|
@@ -1499,8 +1291,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1499
1291
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1500
1292
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1501
1293
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1502
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1503
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1504
1294
|
* @param {number} [blur] Optional. Blur image.
|
|
1505
1295
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1506
1296
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1508,7 +1298,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1508
1298
|
* @param {*} [options] Override http request option.
|
|
1509
1299
|
* @throws {RequiredError}
|
|
1510
1300
|
*/
|
|
1511
|
-
headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1301
|
+
headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1512
1302
|
/**
|
|
1513
1303
|
*
|
|
1514
1304
|
* @summary Get music genre image by name.
|
|
@@ -1526,15 +1316,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1526
1316
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1527
1317
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1528
1318
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1529
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1530
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1531
1319
|
* @param {number} [blur] Optional. Blur image.
|
|
1532
1320
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1533
1321
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1534
1322
|
* @param {*} [options] Override http request option.
|
|
1535
1323
|
* @throws {RequiredError}
|
|
1536
1324
|
*/
|
|
1537
|
-
headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1325
|
+
headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1538
1326
|
/**
|
|
1539
1327
|
*
|
|
1540
1328
|
* @summary Get person image by name.
|
|
@@ -1551,8 +1339,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1551
1339
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1552
1340
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1553
1341
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1554
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1555
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1556
1342
|
* @param {number} [blur] Optional. Blur image.
|
|
1557
1343
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1558
1344
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1560,7 +1346,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1560
1346
|
* @param {*} [options] Override http request option.
|
|
1561
1347
|
* @throws {RequiredError}
|
|
1562
1348
|
*/
|
|
1563
|
-
headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1349
|
+
headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1564
1350
|
/**
|
|
1565
1351
|
*
|
|
1566
1352
|
* @summary Get person image by name.
|
|
@@ -1578,15 +1364,13 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1578
1364
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1579
1365
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1580
1366
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1581
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1582
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1583
1367
|
* @param {number} [blur] Optional. Blur image.
|
|
1584
1368
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1585
1369
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1586
1370
|
* @param {*} [options] Override http request option.
|
|
1587
1371
|
* @throws {RequiredError}
|
|
1588
1372
|
*/
|
|
1589
|
-
headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1373
|
+
headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1590
1374
|
/**
|
|
1591
1375
|
*
|
|
1592
1376
|
* @summary Get studio image by name.
|
|
@@ -1603,8 +1387,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1603
1387
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1604
1388
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1605
1389
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1606
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1607
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1608
1390
|
* @param {number} [blur] Optional. Blur image.
|
|
1609
1391
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1610
1392
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1612,7 +1394,7 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1612
1394
|
* @param {*} [options] Override http request option.
|
|
1613
1395
|
* @throws {RequiredError}
|
|
1614
1396
|
*/
|
|
1615
|
-
headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1397
|
+
headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1616
1398
|
/**
|
|
1617
1399
|
*
|
|
1618
1400
|
* @summary Get studio image by name.
|
|
@@ -1630,20 +1412,17 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1630
1412
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1631
1413
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1632
1414
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1633
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1634
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1635
1415
|
* @param {number} [blur] Optional. Blur image.
|
|
1636
1416
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1637
1417
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1638
1418
|
* @param {*} [options] Override http request option.
|
|
1639
1419
|
* @throws {RequiredError}
|
|
1640
1420
|
*/
|
|
1641
|
-
headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1421
|
+
headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1642
1422
|
/**
|
|
1643
1423
|
*
|
|
1644
1424
|
* @summary Get user profile image.
|
|
1645
|
-
* @param {string} userId User id.
|
|
1646
|
-
* @param {ImageType} imageType Image type.
|
|
1425
|
+
* @param {string} [userId] User id.
|
|
1647
1426
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1648
1427
|
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
1649
1428
|
* @param {number} [maxWidth] The maximum image width to return.
|
|
@@ -1655,8 +1434,6 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1655
1434
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1656
1435
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1657
1436
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1658
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1659
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1660
1437
|
* @param {number} [blur] Optional. Blur image.
|
|
1661
1438
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1662
1439
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1664,55 +1441,16 @@ export declare const ImageApiFp: (configuration?: Configuration) => {
|
|
|
1664
1441
|
* @param {*} [options] Override http request option.
|
|
1665
1442
|
* @throws {RequiredError}
|
|
1666
1443
|
*/
|
|
1667
|
-
headUserImage(userId
|
|
1668
|
-
/**
|
|
1669
|
-
*
|
|
1670
|
-
* @summary Get user profile image.
|
|
1671
|
-
* @param {string} userId User id.
|
|
1672
|
-
* @param {ImageType} imageType Image type.
|
|
1673
|
-
* @param {number} imageIndex Image index.
|
|
1674
|
-
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1675
|
-
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
1676
|
-
* @param {number} [maxWidth] The maximum image width to return.
|
|
1677
|
-
* @param {number} [maxHeight] The maximum image height to return.
|
|
1678
|
-
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1679
|
-
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1680
|
-
* @param {number} [width] The fixed image width to return.
|
|
1681
|
-
* @param {number} [height] The fixed image height to return.
|
|
1682
|
-
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1683
|
-
* @param {number} [fillWidth] Width of box to fill.
|
|
1684
|
-
* @param {number} [fillHeight] Height of box to fill.
|
|
1685
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1686
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1687
|
-
* @param {number} [blur] Optional. Blur image.
|
|
1688
|
-
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1689
|
-
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1690
|
-
* @param {*} [options] Override http request option.
|
|
1691
|
-
* @throws {RequiredError}
|
|
1692
|
-
*/
|
|
1693
|
-
headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1694
|
-
/**
|
|
1695
|
-
*
|
|
1696
|
-
* @summary Sets the user image.
|
|
1697
|
-
* @param {string} userId User Id.
|
|
1698
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
1699
|
-
* @param {number} [index] (Unused) Image index.
|
|
1700
|
-
* @param {any} [body]
|
|
1701
|
-
* @param {*} [options] Override http request option.
|
|
1702
|
-
* @throws {RequiredError}
|
|
1703
|
-
*/
|
|
1704
|
-
postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1444
|
+
headUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1705
1445
|
/**
|
|
1706
1446
|
*
|
|
1707
1447
|
* @summary Sets the user image.
|
|
1708
|
-
* @param {string} userId User Id.
|
|
1709
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
1710
|
-
* @param {number} index (Unused) Image index.
|
|
1448
|
+
* @param {string} [userId] User Id.
|
|
1711
1449
|
* @param {any} [body]
|
|
1712
1450
|
* @param {*} [options] Override http request option.
|
|
1713
1451
|
* @throws {RequiredError}
|
|
1714
1452
|
*/
|
|
1715
|
-
|
|
1453
|
+
postUserImage(userId?: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1716
1454
|
/**
|
|
1717
1455
|
*
|
|
1718
1456
|
* @summary Set item image.
|
|
@@ -1789,23 +1527,11 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1789
1527
|
/**
|
|
1790
1528
|
*
|
|
1791
1529
|
* @summary Delete the user\'s image.
|
|
1792
|
-
* @param {string} userId User Id.
|
|
1793
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
1794
|
-
* @param {number} [index] (Unused) Image index.
|
|
1795
|
-
* @param {*} [options] Override http request option.
|
|
1796
|
-
* @throws {RequiredError}
|
|
1797
|
-
*/
|
|
1798
|
-
deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: any): AxiosPromise<void>;
|
|
1799
|
-
/**
|
|
1800
|
-
*
|
|
1801
|
-
* @summary Delete the user\'s image.
|
|
1802
|
-
* @param {string} userId User Id.
|
|
1803
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
1804
|
-
* @param {number} index (Unused) Image index.
|
|
1530
|
+
* @param {string} [userId] User Id.
|
|
1805
1531
|
* @param {*} [options] Override http request option.
|
|
1806
1532
|
* @throws {RequiredError}
|
|
1807
1533
|
*/
|
|
1808
|
-
|
|
1534
|
+
deleteUserImage(userId?: string, options?: any): AxiosPromise<void>;
|
|
1809
1535
|
/**
|
|
1810
1536
|
*
|
|
1811
1537
|
* @summary Get artist image by name.
|
|
@@ -1823,15 +1549,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1823
1549
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1824
1550
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1825
1551
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1826
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1827
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1828
1552
|
* @param {number} [blur] Optional. Blur image.
|
|
1829
1553
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1830
1554
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1831
1555
|
* @param {*} [options] Override http request option.
|
|
1832
1556
|
* @throws {RequiredError}
|
|
1833
1557
|
*/
|
|
1834
|
-
getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1558
|
+
getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
1835
1559
|
/**
|
|
1836
1560
|
*
|
|
1837
1561
|
* @summary Get genre image by name.
|
|
@@ -1848,8 +1572,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1848
1572
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1849
1573
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1850
1574
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1851
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1852
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1853
1575
|
* @param {number} [blur] Optional. Blur image.
|
|
1854
1576
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1855
1577
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1857,7 +1579,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1857
1579
|
* @param {*} [options] Override http request option.
|
|
1858
1580
|
* @throws {RequiredError}
|
|
1859
1581
|
*/
|
|
1860
|
-
getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1582
|
+
getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
1861
1583
|
/**
|
|
1862
1584
|
*
|
|
1863
1585
|
* @summary Get genre image by name.
|
|
@@ -1875,15 +1597,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1875
1597
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1876
1598
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1877
1599
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1878
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1879
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1880
1600
|
* @param {number} [blur] Optional. Blur image.
|
|
1881
1601
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1882
1602
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1883
1603
|
* @param {*} [options] Override http request option.
|
|
1884
1604
|
* @throws {RequiredError}
|
|
1885
1605
|
*/
|
|
1886
|
-
getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1606
|
+
getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
1887
1607
|
/**
|
|
1888
1608
|
*
|
|
1889
1609
|
* @summary Gets the item\'s image.
|
|
@@ -1897,9 +1617,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1897
1617
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1898
1618
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1899
1619
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1900
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1901
1620
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
1902
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1903
1621
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1904
1622
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1905
1623
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -1909,7 +1627,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1909
1627
|
* @param {*} [options] Override http request option.
|
|
1910
1628
|
* @throws {RequiredError}
|
|
1911
1629
|
*/
|
|
1912
|
-
getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
1630
|
+
getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
1913
1631
|
/**
|
|
1914
1632
|
*
|
|
1915
1633
|
* @summary Gets the item\'s image.
|
|
@@ -1927,15 +1645,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1927
1645
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1928
1646
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1929
1647
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1930
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1931
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1932
1648
|
* @param {number} [blur] Optional. Blur image.
|
|
1933
1649
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1934
1650
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
1935
1651
|
* @param {*} [options] Override http request option.
|
|
1936
1652
|
* @throws {RequiredError}
|
|
1937
1653
|
*/
|
|
1938
|
-
getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1654
|
+
getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
1939
1655
|
/**
|
|
1940
1656
|
*
|
|
1941
1657
|
* @summary Gets the item\'s image.
|
|
@@ -1950,9 +1666,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1950
1666
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1951
1667
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1952
1668
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
1953
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1954
1669
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
1955
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1956
1670
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
1957
1671
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
1958
1672
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -1961,7 +1675,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1961
1675
|
* @param {*} [options] Override http request option.
|
|
1962
1676
|
* @throws {RequiredError}
|
|
1963
1677
|
*/
|
|
1964
|
-
getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
1678
|
+
getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
1965
1679
|
/**
|
|
1966
1680
|
*
|
|
1967
1681
|
* @summary Get item image infos.
|
|
@@ -1986,8 +1700,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1986
1700
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
1987
1701
|
* @param {number} [fillWidth] Width of box to fill.
|
|
1988
1702
|
* @param {number} [fillHeight] Height of box to fill.
|
|
1989
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
1990
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
1991
1703
|
* @param {number} [blur] Optional. Blur image.
|
|
1992
1704
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
1993
1705
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -1995,7 +1707,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1995
1707
|
* @param {*} [options] Override http request option.
|
|
1996
1708
|
* @throws {RequiredError}
|
|
1997
1709
|
*/
|
|
1998
|
-
getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1710
|
+
getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
1999
1711
|
/**
|
|
2000
1712
|
*
|
|
2001
1713
|
* @summary Get music genre image by name.
|
|
@@ -2013,15 +1725,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2013
1725
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2014
1726
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2015
1727
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2016
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2017
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2018
1728
|
* @param {number} [blur] Optional. Blur image.
|
|
2019
1729
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2020
1730
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2021
1731
|
* @param {*} [options] Override http request option.
|
|
2022
1732
|
* @throws {RequiredError}
|
|
2023
1733
|
*/
|
|
2024
|
-
getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1734
|
+
getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2025
1735
|
/**
|
|
2026
1736
|
*
|
|
2027
1737
|
* @summary Get person image by name.
|
|
@@ -2038,8 +1748,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2038
1748
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2039
1749
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2040
1750
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2041
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2042
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2043
1751
|
* @param {number} [blur] Optional. Blur image.
|
|
2044
1752
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2045
1753
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2047,7 +1755,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2047
1755
|
* @param {*} [options] Override http request option.
|
|
2048
1756
|
* @throws {RequiredError}
|
|
2049
1757
|
*/
|
|
2050
|
-
getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1758
|
+
getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2051
1759
|
/**
|
|
2052
1760
|
*
|
|
2053
1761
|
* @summary Get person image by name.
|
|
@@ -2065,15 +1773,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2065
1773
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2066
1774
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2067
1775
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2068
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2069
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2070
1776
|
* @param {number} [blur] Optional. Blur image.
|
|
2071
1777
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2072
1778
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2073
1779
|
* @param {*} [options] Override http request option.
|
|
2074
1780
|
* @throws {RequiredError}
|
|
2075
1781
|
*/
|
|
2076
|
-
getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1782
|
+
getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2077
1783
|
/**
|
|
2078
1784
|
*
|
|
2079
1785
|
* @summary Generates or gets the splashscreen.
|
|
@@ -2109,8 +1815,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2109
1815
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2110
1816
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2111
1817
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2112
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2113
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2114
1818
|
* @param {number} [blur] Optional. Blur image.
|
|
2115
1819
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2116
1820
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2118,7 +1822,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2118
1822
|
* @param {*} [options] Override http request option.
|
|
2119
1823
|
* @throws {RequiredError}
|
|
2120
1824
|
*/
|
|
2121
|
-
getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1825
|
+
getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2122
1826
|
/**
|
|
2123
1827
|
*
|
|
2124
1828
|
* @summary Get studio image by name.
|
|
@@ -2136,20 +1840,17 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2136
1840
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2137
1841
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2138
1842
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2139
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2140
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2141
1843
|
* @param {number} [blur] Optional. Blur image.
|
|
2142
1844
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2143
1845
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2144
1846
|
* @param {*} [options] Override http request option.
|
|
2145
1847
|
* @throws {RequiredError}
|
|
2146
1848
|
*/
|
|
2147
|
-
getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1849
|
+
getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2148
1850
|
/**
|
|
2149
1851
|
*
|
|
2150
1852
|
* @summary Get user profile image.
|
|
2151
|
-
* @param {string} userId User id.
|
|
2152
|
-
* @param {ImageType} imageType Image type.
|
|
1853
|
+
* @param {string} [userId] User id.
|
|
2153
1854
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
2154
1855
|
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
2155
1856
|
* @param {number} [maxWidth] The maximum image width to return.
|
|
@@ -2161,8 +1862,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2161
1862
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2162
1863
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2163
1864
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2164
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2165
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2166
1865
|
* @param {number} [blur] Optional. Blur image.
|
|
2167
1866
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2168
1867
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2170,33 +1869,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2170
1869
|
* @param {*} [options] Override http request option.
|
|
2171
1870
|
* @throws {RequiredError}
|
|
2172
1871
|
*/
|
|
2173
|
-
getUserImage(userId
|
|
2174
|
-
/**
|
|
2175
|
-
*
|
|
2176
|
-
* @summary Get user profile image.
|
|
2177
|
-
* @param {string} userId User id.
|
|
2178
|
-
* @param {ImageType} imageType Image type.
|
|
2179
|
-
* @param {number} imageIndex Image index.
|
|
2180
|
-
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
2181
|
-
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
2182
|
-
* @param {number} [maxWidth] The maximum image width to return.
|
|
2183
|
-
* @param {number} [maxHeight] The maximum image height to return.
|
|
2184
|
-
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
2185
|
-
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
2186
|
-
* @param {number} [width] The fixed image width to return.
|
|
2187
|
-
* @param {number} [height] The fixed image height to return.
|
|
2188
|
-
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2189
|
-
* @param {number} [fillWidth] Width of box to fill.
|
|
2190
|
-
* @param {number} [fillHeight] Height of box to fill.
|
|
2191
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2192
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2193
|
-
* @param {number} [blur] Optional. Blur image.
|
|
2194
|
-
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2195
|
-
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2196
|
-
* @param {*} [options] Override http request option.
|
|
2197
|
-
* @throws {RequiredError}
|
|
2198
|
-
*/
|
|
2199
|
-
getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
1872
|
+
getUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2200
1873
|
/**
|
|
2201
1874
|
*
|
|
2202
1875
|
* @summary Get artist image by name.
|
|
@@ -2214,15 +1887,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2214
1887
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2215
1888
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2216
1889
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2217
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2218
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2219
1890
|
* @param {number} [blur] Optional. Blur image.
|
|
2220
1891
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2221
1892
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2222
1893
|
* @param {*} [options] Override http request option.
|
|
2223
1894
|
* @throws {RequiredError}
|
|
2224
1895
|
*/
|
|
2225
|
-
headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1896
|
+
headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2226
1897
|
/**
|
|
2227
1898
|
*
|
|
2228
1899
|
* @summary Get genre image by name.
|
|
@@ -2239,8 +1910,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2239
1910
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2240
1911
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2241
1912
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2242
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2243
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2244
1913
|
* @param {number} [blur] Optional. Blur image.
|
|
2245
1914
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2246
1915
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2248,7 +1917,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2248
1917
|
* @param {*} [options] Override http request option.
|
|
2249
1918
|
* @throws {RequiredError}
|
|
2250
1919
|
*/
|
|
2251
|
-
headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1920
|
+
headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2252
1921
|
/**
|
|
2253
1922
|
*
|
|
2254
1923
|
* @summary Get genre image by name.
|
|
@@ -2266,15 +1935,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2266
1935
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2267
1936
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2268
1937
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2269
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2270
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2271
1938
|
* @param {number} [blur] Optional. Blur image.
|
|
2272
1939
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2273
1940
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2274
1941
|
* @param {*} [options] Override http request option.
|
|
2275
1942
|
* @throws {RequiredError}
|
|
2276
1943
|
*/
|
|
2277
|
-
headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1944
|
+
headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2278
1945
|
/**
|
|
2279
1946
|
*
|
|
2280
1947
|
* @summary Gets the item\'s image.
|
|
@@ -2288,9 +1955,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2288
1955
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2289
1956
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2290
1957
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
2291
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2292
1958
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
2293
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2294
1959
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
2295
1960
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
2296
1961
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -2300,7 +1965,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2300
1965
|
* @param {*} [options] Override http request option.
|
|
2301
1966
|
* @throws {RequiredError}
|
|
2302
1967
|
*/
|
|
2303
|
-
headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
1968
|
+
headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2304
1969
|
/**
|
|
2305
1970
|
*
|
|
2306
1971
|
* @summary Gets the item\'s image.
|
|
@@ -2318,15 +1983,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2318
1983
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2319
1984
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2320
1985
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2321
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2322
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2323
1986
|
* @param {number} [blur] Optional. Blur image.
|
|
2324
1987
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2325
1988
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2326
1989
|
* @param {*} [options] Override http request option.
|
|
2327
1990
|
* @throws {RequiredError}
|
|
2328
1991
|
*/
|
|
2329
|
-
headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
1992
|
+
headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2330
1993
|
/**
|
|
2331
1994
|
*
|
|
2332
1995
|
* @summary Gets the item\'s image.
|
|
@@ -2341,9 +2004,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2341
2004
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2342
2005
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2343
2006
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
2344
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2345
2007
|
* @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
2346
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2347
2008
|
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
2348
2009
|
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
2349
2010
|
* @param {number} [blur] Optional. Blur image.
|
|
@@ -2352,7 +2013,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2352
2013
|
* @param {*} [options] Override http request option.
|
|
2353
2014
|
* @throws {RequiredError}
|
|
2354
2015
|
*/
|
|
2355
|
-
headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string,
|
|
2016
|
+
headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2356
2017
|
/**
|
|
2357
2018
|
*
|
|
2358
2019
|
* @summary Get music genre image by name.
|
|
@@ -2369,8 +2030,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2369
2030
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2370
2031
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2371
2032
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2372
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2373
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2374
2033
|
* @param {number} [blur] Optional. Blur image.
|
|
2375
2034
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2376
2035
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2378,7 +2037,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2378
2037
|
* @param {*} [options] Override http request option.
|
|
2379
2038
|
* @throws {RequiredError}
|
|
2380
2039
|
*/
|
|
2381
|
-
headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
2040
|
+
headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2382
2041
|
/**
|
|
2383
2042
|
*
|
|
2384
2043
|
* @summary Get music genre image by name.
|
|
@@ -2396,15 +2055,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2396
2055
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2397
2056
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2398
2057
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2399
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2400
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2401
2058
|
* @param {number} [blur] Optional. Blur image.
|
|
2402
2059
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2403
2060
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2404
2061
|
* @param {*} [options] Override http request option.
|
|
2405
2062
|
* @throws {RequiredError}
|
|
2406
2063
|
*/
|
|
2407
|
-
headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
2064
|
+
headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2408
2065
|
/**
|
|
2409
2066
|
*
|
|
2410
2067
|
* @summary Get person image by name.
|
|
@@ -2421,8 +2078,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2421
2078
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2422
2079
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2423
2080
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2424
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2425
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2426
2081
|
* @param {number} [blur] Optional. Blur image.
|
|
2427
2082
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2428
2083
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2430,7 +2085,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2430
2085
|
* @param {*} [options] Override http request option.
|
|
2431
2086
|
* @throws {RequiredError}
|
|
2432
2087
|
*/
|
|
2433
|
-
headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
2088
|
+
headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2434
2089
|
/**
|
|
2435
2090
|
*
|
|
2436
2091
|
* @summary Get person image by name.
|
|
@@ -2448,15 +2103,13 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2448
2103
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2449
2104
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2450
2105
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2451
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2452
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2453
2106
|
* @param {number} [blur] Optional. Blur image.
|
|
2454
2107
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2455
2108
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2456
2109
|
* @param {*} [options] Override http request option.
|
|
2457
2110
|
* @throws {RequiredError}
|
|
2458
2111
|
*/
|
|
2459
|
-
headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
2112
|
+
headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2460
2113
|
/**
|
|
2461
2114
|
*
|
|
2462
2115
|
* @summary Get studio image by name.
|
|
@@ -2473,8 +2126,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2473
2126
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2474
2127
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2475
2128
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2476
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2477
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2478
2129
|
* @param {number} [blur] Optional. Blur image.
|
|
2479
2130
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2480
2131
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2482,7 +2133,7 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2482
2133
|
* @param {*} [options] Override http request option.
|
|
2483
2134
|
* @throws {RequiredError}
|
|
2484
2135
|
*/
|
|
2485
|
-
headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
2136
|
+
headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2486
2137
|
/**
|
|
2487
2138
|
*
|
|
2488
2139
|
* @summary Get studio image by name.
|
|
@@ -2500,20 +2151,17 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2500
2151
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2501
2152
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2502
2153
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2503
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2504
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2505
2154
|
* @param {number} [blur] Optional. Blur image.
|
|
2506
2155
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2507
2156
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2508
2157
|
* @param {*} [options] Override http request option.
|
|
2509
2158
|
* @throws {RequiredError}
|
|
2510
2159
|
*/
|
|
2511
|
-
headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number,
|
|
2160
|
+
headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2512
2161
|
/**
|
|
2513
2162
|
*
|
|
2514
2163
|
* @summary Get user profile image.
|
|
2515
|
-
* @param {string} userId User id.
|
|
2516
|
-
* @param {ImageType} imageType Image type.
|
|
2164
|
+
* @param {string} [userId] User id.
|
|
2517
2165
|
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
2518
2166
|
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
2519
2167
|
* @param {number} [maxWidth] The maximum image width to return.
|
|
@@ -2525,8 +2173,6 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2525
2173
|
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2526
2174
|
* @param {number} [fillWidth] Width of box to fill.
|
|
2527
2175
|
* @param {number} [fillHeight] Height of box to fill.
|
|
2528
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2529
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2530
2176
|
* @param {number} [blur] Optional. Blur image.
|
|
2531
2177
|
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2532
2178
|
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
@@ -2534,55 +2180,16 @@ export declare const ImageApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2534
2180
|
* @param {*} [options] Override http request option.
|
|
2535
2181
|
* @throws {RequiredError}
|
|
2536
2182
|
*/
|
|
2537
|
-
headUserImage(userId
|
|
2538
|
-
/**
|
|
2539
|
-
*
|
|
2540
|
-
* @summary Get user profile image.
|
|
2541
|
-
* @param {string} userId User id.
|
|
2542
|
-
* @param {ImageType} imageType Image type.
|
|
2543
|
-
* @param {number} imageIndex Image index.
|
|
2544
|
-
* @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
2545
|
-
* @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
|
|
2546
|
-
* @param {number} [maxWidth] The maximum image width to return.
|
|
2547
|
-
* @param {number} [maxHeight] The maximum image height to return.
|
|
2548
|
-
* @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
|
|
2549
|
-
* @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
|
|
2550
|
-
* @param {number} [width] The fixed image width to return.
|
|
2551
|
-
* @param {number} [height] The fixed image height to return.
|
|
2552
|
-
* @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
2553
|
-
* @param {number} [fillWidth] Width of box to fill.
|
|
2554
|
-
* @param {number} [fillHeight] Height of box to fill.
|
|
2555
|
-
* @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2556
|
-
* @param {boolean} [addPlayedIndicator] Optional. Add a played indicator.
|
|
2557
|
-
* @param {number} [blur] Optional. Blur image.
|
|
2558
|
-
* @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
|
|
2559
|
-
* @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
|
|
2560
|
-
* @param {*} [options] Override http request option.
|
|
2561
|
-
* @throws {RequiredError}
|
|
2562
|
-
*/
|
|
2563
|
-
headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>;
|
|
2564
|
-
/**
|
|
2565
|
-
*
|
|
2566
|
-
* @summary Sets the user image.
|
|
2567
|
-
* @param {string} userId User Id.
|
|
2568
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
2569
|
-
* @param {number} [index] (Unused) Image index.
|
|
2570
|
-
* @param {any} [body]
|
|
2571
|
-
* @param {*} [options] Override http request option.
|
|
2572
|
-
* @throws {RequiredError}
|
|
2573
|
-
*/
|
|
2574
|
-
postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: any): AxiosPromise<void>;
|
|
2183
|
+
headUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>;
|
|
2575
2184
|
/**
|
|
2576
2185
|
*
|
|
2577
2186
|
* @summary Sets the user image.
|
|
2578
|
-
* @param {string} userId User Id.
|
|
2579
|
-
* @param {ImageType} imageType (Unused) Image type.
|
|
2580
|
-
* @param {number} index (Unused) Image index.
|
|
2187
|
+
* @param {string} [userId] User Id.
|
|
2581
2188
|
* @param {any} [body]
|
|
2582
2189
|
* @param {*} [options] Override http request option.
|
|
2583
2190
|
* @throws {RequiredError}
|
|
2584
2191
|
*/
|
|
2585
|
-
|
|
2192
|
+
postUserImage(userId?: string, body?: any, options?: any): AxiosPromise<void>;
|
|
2586
2193
|
/**
|
|
2587
2194
|
*
|
|
2588
2195
|
* @summary Set item image.
|
|
@@ -2685,44 +2292,7 @@ export interface ImageApiDeleteUserImageRequest {
|
|
|
2685
2292
|
* @type {string}
|
|
2686
2293
|
* @memberof ImageApiDeleteUserImage
|
|
2687
2294
|
*/
|
|
2688
|
-
readonly userId
|
|
2689
|
-
/**
|
|
2690
|
-
* (Unused) Image type.
|
|
2691
|
-
* @type {ImageType}
|
|
2692
|
-
* @memberof ImageApiDeleteUserImage
|
|
2693
|
-
*/
|
|
2694
|
-
readonly imageType: ImageType;
|
|
2695
|
-
/**
|
|
2696
|
-
* (Unused) Image index.
|
|
2697
|
-
* @type {number}
|
|
2698
|
-
* @memberof ImageApiDeleteUserImage
|
|
2699
|
-
*/
|
|
2700
|
-
readonly index?: number;
|
|
2701
|
-
}
|
|
2702
|
-
/**
|
|
2703
|
-
* Request parameters for deleteUserImageByIndex operation in ImageApi.
|
|
2704
|
-
* @export
|
|
2705
|
-
* @interface ImageApiDeleteUserImageByIndexRequest
|
|
2706
|
-
*/
|
|
2707
|
-
export interface ImageApiDeleteUserImageByIndexRequest {
|
|
2708
|
-
/**
|
|
2709
|
-
* User Id.
|
|
2710
|
-
* @type {string}
|
|
2711
|
-
* @memberof ImageApiDeleteUserImageByIndex
|
|
2712
|
-
*/
|
|
2713
|
-
readonly userId: string;
|
|
2714
|
-
/**
|
|
2715
|
-
* (Unused) Image type.
|
|
2716
|
-
* @type {ImageType}
|
|
2717
|
-
* @memberof ImageApiDeleteUserImageByIndex
|
|
2718
|
-
*/
|
|
2719
|
-
readonly imageType: ImageType;
|
|
2720
|
-
/**
|
|
2721
|
-
* (Unused) Image index.
|
|
2722
|
-
* @type {number}
|
|
2723
|
-
* @memberof ImageApiDeleteUserImageByIndex
|
|
2724
|
-
*/
|
|
2725
|
-
readonly index: number;
|
|
2295
|
+
readonly userId?: string;
|
|
2726
2296
|
}
|
|
2727
2297
|
/**
|
|
2728
2298
|
* Request parameters for getArtistImage operation in ImageApi.
|
|
@@ -2814,18 +2384,6 @@ export interface ImageApiGetArtistImageRequest {
|
|
|
2814
2384
|
* @memberof ImageApiGetArtistImage
|
|
2815
2385
|
*/
|
|
2816
2386
|
readonly fillHeight?: number;
|
|
2817
|
-
/**
|
|
2818
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2819
|
-
* @type {boolean}
|
|
2820
|
-
* @memberof ImageApiGetArtistImage
|
|
2821
|
-
*/
|
|
2822
|
-
readonly cropWhitespace?: boolean;
|
|
2823
|
-
/**
|
|
2824
|
-
* Optional. Add a played indicator.
|
|
2825
|
-
* @type {boolean}
|
|
2826
|
-
* @memberof ImageApiGetArtistImage
|
|
2827
|
-
*/
|
|
2828
|
-
readonly addPlayedIndicator?: boolean;
|
|
2829
2387
|
/**
|
|
2830
2388
|
* Optional. Blur image.
|
|
2831
2389
|
* @type {number}
|
|
@@ -2929,18 +2487,6 @@ export interface ImageApiGetGenreImageRequest {
|
|
|
2929
2487
|
* @memberof ImageApiGetGenreImage
|
|
2930
2488
|
*/
|
|
2931
2489
|
readonly fillHeight?: number;
|
|
2932
|
-
/**
|
|
2933
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
2934
|
-
* @type {boolean}
|
|
2935
|
-
* @memberof ImageApiGetGenreImage
|
|
2936
|
-
*/
|
|
2937
|
-
readonly cropWhitespace?: boolean;
|
|
2938
|
-
/**
|
|
2939
|
-
* Optional. Add a played indicator.
|
|
2940
|
-
* @type {boolean}
|
|
2941
|
-
* @memberof ImageApiGetGenreImage
|
|
2942
|
-
*/
|
|
2943
|
-
readonly addPlayedIndicator?: boolean;
|
|
2944
2490
|
/**
|
|
2945
2491
|
* Optional. Blur image.
|
|
2946
2492
|
* @type {number}
|
|
@@ -3056,18 +2602,6 @@ export interface ImageApiGetGenreImageByIndexRequest {
|
|
|
3056
2602
|
* @memberof ImageApiGetGenreImageByIndex
|
|
3057
2603
|
*/
|
|
3058
2604
|
readonly fillHeight?: number;
|
|
3059
|
-
/**
|
|
3060
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3061
|
-
* @type {boolean}
|
|
3062
|
-
* @memberof ImageApiGetGenreImageByIndex
|
|
3063
|
-
*/
|
|
3064
|
-
readonly cropWhitespace?: boolean;
|
|
3065
|
-
/**
|
|
3066
|
-
* Optional. Add a played indicator.
|
|
3067
|
-
* @type {boolean}
|
|
3068
|
-
* @memberof ImageApiGetGenreImageByIndex
|
|
3069
|
-
*/
|
|
3070
|
-
readonly addPlayedIndicator?: boolean;
|
|
3071
2605
|
/**
|
|
3072
2606
|
* Optional. Blur image.
|
|
3073
2607
|
* @type {number}
|
|
@@ -3153,24 +2687,12 @@ export interface ImageApiGetItemImageRequest {
|
|
|
3153
2687
|
* @memberof ImageApiGetItemImage
|
|
3154
2688
|
*/
|
|
3155
2689
|
readonly tag?: string;
|
|
3156
|
-
/**
|
|
3157
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3158
|
-
* @type {boolean}
|
|
3159
|
-
* @memberof ImageApiGetItemImage
|
|
3160
|
-
*/
|
|
3161
|
-
readonly cropWhitespace?: boolean;
|
|
3162
2690
|
/**
|
|
3163
2691
|
* Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
3164
2692
|
* @type {ImageFormat}
|
|
3165
2693
|
* @memberof ImageApiGetItemImage
|
|
3166
2694
|
*/
|
|
3167
2695
|
readonly format?: ImageFormat;
|
|
3168
|
-
/**
|
|
3169
|
-
* Optional. Add a played indicator.
|
|
3170
|
-
* @type {boolean}
|
|
3171
|
-
* @memberof ImageApiGetItemImage
|
|
3172
|
-
*/
|
|
3173
|
-
readonly addPlayedIndicator?: boolean;
|
|
3174
2696
|
/**
|
|
3175
2697
|
* Optional. Percent to render for the percent played overlay.
|
|
3176
2698
|
* @type {number}
|
|
@@ -3298,18 +2820,6 @@ export interface ImageApiGetItemImage2Request {
|
|
|
3298
2820
|
* @memberof ImageApiGetItemImage2
|
|
3299
2821
|
*/
|
|
3300
2822
|
readonly fillHeight?: number;
|
|
3301
|
-
/**
|
|
3302
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3303
|
-
* @type {boolean}
|
|
3304
|
-
* @memberof ImageApiGetItemImage2
|
|
3305
|
-
*/
|
|
3306
|
-
readonly cropWhitespace?: boolean;
|
|
3307
|
-
/**
|
|
3308
|
-
* Optional. Add a played indicator.
|
|
3309
|
-
* @type {boolean}
|
|
3310
|
-
* @memberof ImageApiGetItemImage2
|
|
3311
|
-
*/
|
|
3312
|
-
readonly addPlayedIndicator?: boolean;
|
|
3313
2823
|
/**
|
|
3314
2824
|
* Optional. Blur image.
|
|
3315
2825
|
* @type {number}
|
|
@@ -3401,24 +2911,12 @@ export interface ImageApiGetItemImageByIndexRequest {
|
|
|
3401
2911
|
* @memberof ImageApiGetItemImageByIndex
|
|
3402
2912
|
*/
|
|
3403
2913
|
readonly tag?: string;
|
|
3404
|
-
/**
|
|
3405
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3406
|
-
* @type {boolean}
|
|
3407
|
-
* @memberof ImageApiGetItemImageByIndex
|
|
3408
|
-
*/
|
|
3409
|
-
readonly cropWhitespace?: boolean;
|
|
3410
2914
|
/**
|
|
3411
2915
|
* Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
3412
2916
|
* @type {ImageFormat}
|
|
3413
2917
|
* @memberof ImageApiGetItemImageByIndex
|
|
3414
2918
|
*/
|
|
3415
2919
|
readonly format?: ImageFormat;
|
|
3416
|
-
/**
|
|
3417
|
-
* Optional. Add a played indicator.
|
|
3418
|
-
* @type {boolean}
|
|
3419
|
-
* @memberof ImageApiGetItemImageByIndex
|
|
3420
|
-
*/
|
|
3421
|
-
readonly addPlayedIndicator?: boolean;
|
|
3422
2920
|
/**
|
|
3423
2921
|
* Optional. Percent to render for the percent played overlay.
|
|
3424
2922
|
* @type {number}
|
|
@@ -3547,18 +3045,6 @@ export interface ImageApiGetMusicGenreImageRequest {
|
|
|
3547
3045
|
* @memberof ImageApiGetMusicGenreImage
|
|
3548
3046
|
*/
|
|
3549
3047
|
readonly fillHeight?: number;
|
|
3550
|
-
/**
|
|
3551
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3552
|
-
* @type {boolean}
|
|
3553
|
-
* @memberof ImageApiGetMusicGenreImage
|
|
3554
|
-
*/
|
|
3555
|
-
readonly cropWhitespace?: boolean;
|
|
3556
|
-
/**
|
|
3557
|
-
* Optional. Add a played indicator.
|
|
3558
|
-
* @type {boolean}
|
|
3559
|
-
* @memberof ImageApiGetMusicGenreImage
|
|
3560
|
-
*/
|
|
3561
|
-
readonly addPlayedIndicator?: boolean;
|
|
3562
3048
|
/**
|
|
3563
3049
|
* Optional. Blur image.
|
|
3564
3050
|
* @type {number}
|
|
@@ -3674,18 +3160,6 @@ export interface ImageApiGetMusicGenreImageByIndexRequest {
|
|
|
3674
3160
|
* @memberof ImageApiGetMusicGenreImageByIndex
|
|
3675
3161
|
*/
|
|
3676
3162
|
readonly fillHeight?: number;
|
|
3677
|
-
/**
|
|
3678
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3679
|
-
* @type {boolean}
|
|
3680
|
-
* @memberof ImageApiGetMusicGenreImageByIndex
|
|
3681
|
-
*/
|
|
3682
|
-
readonly cropWhitespace?: boolean;
|
|
3683
|
-
/**
|
|
3684
|
-
* Optional. Add a played indicator.
|
|
3685
|
-
* @type {boolean}
|
|
3686
|
-
* @memberof ImageApiGetMusicGenreImageByIndex
|
|
3687
|
-
*/
|
|
3688
|
-
readonly addPlayedIndicator?: boolean;
|
|
3689
3163
|
/**
|
|
3690
3164
|
* Optional. Blur image.
|
|
3691
3165
|
* @type {number}
|
|
@@ -3790,26 +3264,14 @@ export interface ImageApiGetPersonImageRequest {
|
|
|
3790
3264
|
*/
|
|
3791
3265
|
readonly fillHeight?: number;
|
|
3792
3266
|
/**
|
|
3793
|
-
* Optional.
|
|
3794
|
-
* @type {
|
|
3267
|
+
* Optional. Blur image.
|
|
3268
|
+
* @type {number}
|
|
3795
3269
|
* @memberof ImageApiGetPersonImage
|
|
3796
3270
|
*/
|
|
3797
|
-
readonly
|
|
3271
|
+
readonly blur?: number;
|
|
3798
3272
|
/**
|
|
3799
|
-
* Optional.
|
|
3800
|
-
* @type {
|
|
3801
|
-
* @memberof ImageApiGetPersonImage
|
|
3802
|
-
*/
|
|
3803
|
-
readonly addPlayedIndicator?: boolean;
|
|
3804
|
-
/**
|
|
3805
|
-
* Optional. Blur image.
|
|
3806
|
-
* @type {number}
|
|
3807
|
-
* @memberof ImageApiGetPersonImage
|
|
3808
|
-
*/
|
|
3809
|
-
readonly blur?: number;
|
|
3810
|
-
/**
|
|
3811
|
-
* Optional. Apply a background color for transparent images.
|
|
3812
|
-
* @type {string}
|
|
3273
|
+
* Optional. Apply a background color for transparent images.
|
|
3274
|
+
* @type {string}
|
|
3813
3275
|
* @memberof ImageApiGetPersonImage
|
|
3814
3276
|
*/
|
|
3815
3277
|
readonly backgroundColor?: string;
|
|
@@ -3916,18 +3378,6 @@ export interface ImageApiGetPersonImageByIndexRequest {
|
|
|
3916
3378
|
* @memberof ImageApiGetPersonImageByIndex
|
|
3917
3379
|
*/
|
|
3918
3380
|
readonly fillHeight?: number;
|
|
3919
|
-
/**
|
|
3920
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
3921
|
-
* @type {boolean}
|
|
3922
|
-
* @memberof ImageApiGetPersonImageByIndex
|
|
3923
|
-
*/
|
|
3924
|
-
readonly cropWhitespace?: boolean;
|
|
3925
|
-
/**
|
|
3926
|
-
* Optional. Add a played indicator.
|
|
3927
|
-
* @type {boolean}
|
|
3928
|
-
* @memberof ImageApiGetPersonImageByIndex
|
|
3929
|
-
*/
|
|
3930
|
-
readonly addPlayedIndicator?: boolean;
|
|
3931
3381
|
/**
|
|
3932
3382
|
* Optional. Blur image.
|
|
3933
3383
|
* @type {number}
|
|
@@ -4110,18 +3560,6 @@ export interface ImageApiGetStudioImageRequest {
|
|
|
4110
3560
|
* @memberof ImageApiGetStudioImage
|
|
4111
3561
|
*/
|
|
4112
3562
|
readonly fillHeight?: number;
|
|
4113
|
-
/**
|
|
4114
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4115
|
-
* @type {boolean}
|
|
4116
|
-
* @memberof ImageApiGetStudioImage
|
|
4117
|
-
*/
|
|
4118
|
-
readonly cropWhitespace?: boolean;
|
|
4119
|
-
/**
|
|
4120
|
-
* Optional. Add a played indicator.
|
|
4121
|
-
* @type {boolean}
|
|
4122
|
-
* @memberof ImageApiGetStudioImage
|
|
4123
|
-
*/
|
|
4124
|
-
readonly addPlayedIndicator?: boolean;
|
|
4125
3563
|
/**
|
|
4126
3564
|
* Optional. Blur image.
|
|
4127
3565
|
* @type {number}
|
|
@@ -4237,18 +3675,6 @@ export interface ImageApiGetStudioImageByIndexRequest {
|
|
|
4237
3675
|
* @memberof ImageApiGetStudioImageByIndex
|
|
4238
3676
|
*/
|
|
4239
3677
|
readonly fillHeight?: number;
|
|
4240
|
-
/**
|
|
4241
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4242
|
-
* @type {boolean}
|
|
4243
|
-
* @memberof ImageApiGetStudioImageByIndex
|
|
4244
|
-
*/
|
|
4245
|
-
readonly cropWhitespace?: boolean;
|
|
4246
|
-
/**
|
|
4247
|
-
* Optional. Add a played indicator.
|
|
4248
|
-
* @type {boolean}
|
|
4249
|
-
* @memberof ImageApiGetStudioImageByIndex
|
|
4250
|
-
*/
|
|
4251
|
-
readonly addPlayedIndicator?: boolean;
|
|
4252
3678
|
/**
|
|
4253
3679
|
* Optional. Blur image.
|
|
4254
3680
|
* @type {number}
|
|
@@ -4279,13 +3705,7 @@ export interface ImageApiGetUserImageRequest {
|
|
|
4279
3705
|
* @type {string}
|
|
4280
3706
|
* @memberof ImageApiGetUserImage
|
|
4281
3707
|
*/
|
|
4282
|
-
readonly userId
|
|
4283
|
-
/**
|
|
4284
|
-
* Image type.
|
|
4285
|
-
* @type {ImageType}
|
|
4286
|
-
* @memberof ImageApiGetUserImage
|
|
4287
|
-
*/
|
|
4288
|
-
readonly imageType: ImageType;
|
|
3708
|
+
readonly userId?: string;
|
|
4289
3709
|
/**
|
|
4290
3710
|
* Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
4291
3711
|
* @type {string}
|
|
@@ -4352,18 +3772,6 @@ export interface ImageApiGetUserImageRequest {
|
|
|
4352
3772
|
* @memberof ImageApiGetUserImage
|
|
4353
3773
|
*/
|
|
4354
3774
|
readonly fillHeight?: number;
|
|
4355
|
-
/**
|
|
4356
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4357
|
-
* @type {boolean}
|
|
4358
|
-
* @memberof ImageApiGetUserImage
|
|
4359
|
-
*/
|
|
4360
|
-
readonly cropWhitespace?: boolean;
|
|
4361
|
-
/**
|
|
4362
|
-
* Optional. Add a played indicator.
|
|
4363
|
-
* @type {boolean}
|
|
4364
|
-
* @memberof ImageApiGetUserImage
|
|
4365
|
-
*/
|
|
4366
|
-
readonly addPlayedIndicator?: boolean;
|
|
4367
3775
|
/**
|
|
4368
3776
|
* Optional. Blur image.
|
|
4369
3777
|
* @type {number}
|
|
@@ -4389,127 +3797,6 @@ export interface ImageApiGetUserImageRequest {
|
|
|
4389
3797
|
*/
|
|
4390
3798
|
readonly imageIndex?: number;
|
|
4391
3799
|
}
|
|
4392
|
-
/**
|
|
4393
|
-
* Request parameters for getUserImageByIndex operation in ImageApi.
|
|
4394
|
-
* @export
|
|
4395
|
-
* @interface ImageApiGetUserImageByIndexRequest
|
|
4396
|
-
*/
|
|
4397
|
-
export interface ImageApiGetUserImageByIndexRequest {
|
|
4398
|
-
/**
|
|
4399
|
-
* User id.
|
|
4400
|
-
* @type {string}
|
|
4401
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4402
|
-
*/
|
|
4403
|
-
readonly userId: string;
|
|
4404
|
-
/**
|
|
4405
|
-
* Image type.
|
|
4406
|
-
* @type {ImageType}
|
|
4407
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4408
|
-
*/
|
|
4409
|
-
readonly imageType: ImageType;
|
|
4410
|
-
/**
|
|
4411
|
-
* Image index.
|
|
4412
|
-
* @type {number}
|
|
4413
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4414
|
-
*/
|
|
4415
|
-
readonly imageIndex: number;
|
|
4416
|
-
/**
|
|
4417
|
-
* Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
4418
|
-
* @type {string}
|
|
4419
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4420
|
-
*/
|
|
4421
|
-
readonly tag?: string;
|
|
4422
|
-
/**
|
|
4423
|
-
* Determines the output format of the image - original,gif,jpg,png.
|
|
4424
|
-
* @type {ImageFormat}
|
|
4425
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4426
|
-
*/
|
|
4427
|
-
readonly format?: ImageFormat;
|
|
4428
|
-
/**
|
|
4429
|
-
* The maximum image width to return.
|
|
4430
|
-
* @type {number}
|
|
4431
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4432
|
-
*/
|
|
4433
|
-
readonly maxWidth?: number;
|
|
4434
|
-
/**
|
|
4435
|
-
* The maximum image height to return.
|
|
4436
|
-
* @type {number}
|
|
4437
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4438
|
-
*/
|
|
4439
|
-
readonly maxHeight?: number;
|
|
4440
|
-
/**
|
|
4441
|
-
* Optional. Percent to render for the percent played overlay.
|
|
4442
|
-
* @type {number}
|
|
4443
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4444
|
-
*/
|
|
4445
|
-
readonly percentPlayed?: number;
|
|
4446
|
-
/**
|
|
4447
|
-
* Optional. Unplayed count overlay to render.
|
|
4448
|
-
* @type {number}
|
|
4449
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4450
|
-
*/
|
|
4451
|
-
readonly unplayedCount?: number;
|
|
4452
|
-
/**
|
|
4453
|
-
* The fixed image width to return.
|
|
4454
|
-
* @type {number}
|
|
4455
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4456
|
-
*/
|
|
4457
|
-
readonly width?: number;
|
|
4458
|
-
/**
|
|
4459
|
-
* The fixed image height to return.
|
|
4460
|
-
* @type {number}
|
|
4461
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4462
|
-
*/
|
|
4463
|
-
readonly height?: number;
|
|
4464
|
-
/**
|
|
4465
|
-
* Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
4466
|
-
* @type {number}
|
|
4467
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4468
|
-
*/
|
|
4469
|
-
readonly quality?: number;
|
|
4470
|
-
/**
|
|
4471
|
-
* Width of box to fill.
|
|
4472
|
-
* @type {number}
|
|
4473
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4474
|
-
*/
|
|
4475
|
-
readonly fillWidth?: number;
|
|
4476
|
-
/**
|
|
4477
|
-
* Height of box to fill.
|
|
4478
|
-
* @type {number}
|
|
4479
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4480
|
-
*/
|
|
4481
|
-
readonly fillHeight?: number;
|
|
4482
|
-
/**
|
|
4483
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4484
|
-
* @type {boolean}
|
|
4485
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4486
|
-
*/
|
|
4487
|
-
readonly cropWhitespace?: boolean;
|
|
4488
|
-
/**
|
|
4489
|
-
* Optional. Add a played indicator.
|
|
4490
|
-
* @type {boolean}
|
|
4491
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4492
|
-
*/
|
|
4493
|
-
readonly addPlayedIndicator?: boolean;
|
|
4494
|
-
/**
|
|
4495
|
-
* Optional. Blur image.
|
|
4496
|
-
* @type {number}
|
|
4497
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4498
|
-
*/
|
|
4499
|
-
readonly blur?: number;
|
|
4500
|
-
/**
|
|
4501
|
-
* Optional. Apply a background color for transparent images.
|
|
4502
|
-
* @type {string}
|
|
4503
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4504
|
-
*/
|
|
4505
|
-
readonly backgroundColor?: string;
|
|
4506
|
-
/**
|
|
4507
|
-
* Optional. Apply a foreground layer on top of the image.
|
|
4508
|
-
* @type {string}
|
|
4509
|
-
* @memberof ImageApiGetUserImageByIndex
|
|
4510
|
-
*/
|
|
4511
|
-
readonly foregroundLayer?: string;
|
|
4512
|
-
}
|
|
4513
3800
|
/**
|
|
4514
3801
|
* Request parameters for headArtistImage operation in ImageApi.
|
|
4515
3802
|
* @export
|
|
@@ -4600,18 +3887,6 @@ export interface ImageApiHeadArtistImageRequest {
|
|
|
4600
3887
|
* @memberof ImageApiHeadArtistImage
|
|
4601
3888
|
*/
|
|
4602
3889
|
readonly fillHeight?: number;
|
|
4603
|
-
/**
|
|
4604
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4605
|
-
* @type {boolean}
|
|
4606
|
-
* @memberof ImageApiHeadArtistImage
|
|
4607
|
-
*/
|
|
4608
|
-
readonly cropWhitespace?: boolean;
|
|
4609
|
-
/**
|
|
4610
|
-
* Optional. Add a played indicator.
|
|
4611
|
-
* @type {boolean}
|
|
4612
|
-
* @memberof ImageApiHeadArtistImage
|
|
4613
|
-
*/
|
|
4614
|
-
readonly addPlayedIndicator?: boolean;
|
|
4615
3890
|
/**
|
|
4616
3891
|
* Optional. Blur image.
|
|
4617
3892
|
* @type {number}
|
|
@@ -4715,18 +3990,6 @@ export interface ImageApiHeadGenreImageRequest {
|
|
|
4715
3990
|
* @memberof ImageApiHeadGenreImage
|
|
4716
3991
|
*/
|
|
4717
3992
|
readonly fillHeight?: number;
|
|
4718
|
-
/**
|
|
4719
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4720
|
-
* @type {boolean}
|
|
4721
|
-
* @memberof ImageApiHeadGenreImage
|
|
4722
|
-
*/
|
|
4723
|
-
readonly cropWhitespace?: boolean;
|
|
4724
|
-
/**
|
|
4725
|
-
* Optional. Add a played indicator.
|
|
4726
|
-
* @type {boolean}
|
|
4727
|
-
* @memberof ImageApiHeadGenreImage
|
|
4728
|
-
*/
|
|
4729
|
-
readonly addPlayedIndicator?: boolean;
|
|
4730
3993
|
/**
|
|
4731
3994
|
* Optional. Blur image.
|
|
4732
3995
|
* @type {number}
|
|
@@ -4842,18 +4105,6 @@ export interface ImageApiHeadGenreImageByIndexRequest {
|
|
|
4842
4105
|
* @memberof ImageApiHeadGenreImageByIndex
|
|
4843
4106
|
*/
|
|
4844
4107
|
readonly fillHeight?: number;
|
|
4845
|
-
/**
|
|
4846
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4847
|
-
* @type {boolean}
|
|
4848
|
-
* @memberof ImageApiHeadGenreImageByIndex
|
|
4849
|
-
*/
|
|
4850
|
-
readonly cropWhitespace?: boolean;
|
|
4851
|
-
/**
|
|
4852
|
-
* Optional. Add a played indicator.
|
|
4853
|
-
* @type {boolean}
|
|
4854
|
-
* @memberof ImageApiHeadGenreImageByIndex
|
|
4855
|
-
*/
|
|
4856
|
-
readonly addPlayedIndicator?: boolean;
|
|
4857
4108
|
/**
|
|
4858
4109
|
* Optional. Blur image.
|
|
4859
4110
|
* @type {number}
|
|
@@ -4939,24 +4190,12 @@ export interface ImageApiHeadItemImageRequest {
|
|
|
4939
4190
|
* @memberof ImageApiHeadItemImage
|
|
4940
4191
|
*/
|
|
4941
4192
|
readonly tag?: string;
|
|
4942
|
-
/**
|
|
4943
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
4944
|
-
* @type {boolean}
|
|
4945
|
-
* @memberof ImageApiHeadItemImage
|
|
4946
|
-
*/
|
|
4947
|
-
readonly cropWhitespace?: boolean;
|
|
4948
4193
|
/**
|
|
4949
4194
|
* Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
4950
4195
|
* @type {ImageFormat}
|
|
4951
4196
|
* @memberof ImageApiHeadItemImage
|
|
4952
4197
|
*/
|
|
4953
4198
|
readonly format?: ImageFormat;
|
|
4954
|
-
/**
|
|
4955
|
-
* Optional. Add a played indicator.
|
|
4956
|
-
* @type {boolean}
|
|
4957
|
-
* @memberof ImageApiHeadItemImage
|
|
4958
|
-
*/
|
|
4959
|
-
readonly addPlayedIndicator?: boolean;
|
|
4960
4199
|
/**
|
|
4961
4200
|
* Optional. Percent to render for the percent played overlay.
|
|
4962
4201
|
* @type {number}
|
|
@@ -5084,18 +4323,6 @@ export interface ImageApiHeadItemImage2Request {
|
|
|
5084
4323
|
* @memberof ImageApiHeadItemImage2
|
|
5085
4324
|
*/
|
|
5086
4325
|
readonly fillHeight?: number;
|
|
5087
|
-
/**
|
|
5088
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5089
|
-
* @type {boolean}
|
|
5090
|
-
* @memberof ImageApiHeadItemImage2
|
|
5091
|
-
*/
|
|
5092
|
-
readonly cropWhitespace?: boolean;
|
|
5093
|
-
/**
|
|
5094
|
-
* Optional. Add a played indicator.
|
|
5095
|
-
* @type {boolean}
|
|
5096
|
-
* @memberof ImageApiHeadItemImage2
|
|
5097
|
-
*/
|
|
5098
|
-
readonly addPlayedIndicator?: boolean;
|
|
5099
4326
|
/**
|
|
5100
4327
|
* Optional. Blur image.
|
|
5101
4328
|
* @type {number}
|
|
@@ -5187,24 +4414,12 @@ export interface ImageApiHeadItemImageByIndexRequest {
|
|
|
5187
4414
|
* @memberof ImageApiHeadItemImageByIndex
|
|
5188
4415
|
*/
|
|
5189
4416
|
readonly tag?: string;
|
|
5190
|
-
/**
|
|
5191
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5192
|
-
* @type {boolean}
|
|
5193
|
-
* @memberof ImageApiHeadItemImageByIndex
|
|
5194
|
-
*/
|
|
5195
|
-
readonly cropWhitespace?: boolean;
|
|
5196
4417
|
/**
|
|
5197
4418
|
* Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
|
|
5198
4419
|
* @type {ImageFormat}
|
|
5199
4420
|
* @memberof ImageApiHeadItemImageByIndex
|
|
5200
4421
|
*/
|
|
5201
4422
|
readonly format?: ImageFormat;
|
|
5202
|
-
/**
|
|
5203
|
-
* Optional. Add a played indicator.
|
|
5204
|
-
* @type {boolean}
|
|
5205
|
-
* @memberof ImageApiHeadItemImageByIndex
|
|
5206
|
-
*/
|
|
5207
|
-
readonly addPlayedIndicator?: boolean;
|
|
5208
4423
|
/**
|
|
5209
4424
|
* Optional. Percent to render for the percent played overlay.
|
|
5210
4425
|
* @type {number}
|
|
@@ -5320,18 +4535,6 @@ export interface ImageApiHeadMusicGenreImageRequest {
|
|
|
5320
4535
|
* @memberof ImageApiHeadMusicGenreImage
|
|
5321
4536
|
*/
|
|
5322
4537
|
readonly fillHeight?: number;
|
|
5323
|
-
/**
|
|
5324
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5325
|
-
* @type {boolean}
|
|
5326
|
-
* @memberof ImageApiHeadMusicGenreImage
|
|
5327
|
-
*/
|
|
5328
|
-
readonly cropWhitespace?: boolean;
|
|
5329
|
-
/**
|
|
5330
|
-
* Optional. Add a played indicator.
|
|
5331
|
-
* @type {boolean}
|
|
5332
|
-
* @memberof ImageApiHeadMusicGenreImage
|
|
5333
|
-
*/
|
|
5334
|
-
readonly addPlayedIndicator?: boolean;
|
|
5335
4538
|
/**
|
|
5336
4539
|
* Optional. Blur image.
|
|
5337
4540
|
* @type {number}
|
|
@@ -5447,18 +4650,6 @@ export interface ImageApiHeadMusicGenreImageByIndexRequest {
|
|
|
5447
4650
|
* @memberof ImageApiHeadMusicGenreImageByIndex
|
|
5448
4651
|
*/
|
|
5449
4652
|
readonly fillHeight?: number;
|
|
5450
|
-
/**
|
|
5451
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5452
|
-
* @type {boolean}
|
|
5453
|
-
* @memberof ImageApiHeadMusicGenreImageByIndex
|
|
5454
|
-
*/
|
|
5455
|
-
readonly cropWhitespace?: boolean;
|
|
5456
|
-
/**
|
|
5457
|
-
* Optional. Add a played indicator.
|
|
5458
|
-
* @type {boolean}
|
|
5459
|
-
* @memberof ImageApiHeadMusicGenreImageByIndex
|
|
5460
|
-
*/
|
|
5461
|
-
readonly addPlayedIndicator?: boolean;
|
|
5462
4653
|
/**
|
|
5463
4654
|
* Optional. Blur image.
|
|
5464
4655
|
* @type {number}
|
|
@@ -5562,18 +4753,6 @@ export interface ImageApiHeadPersonImageRequest {
|
|
|
5562
4753
|
* @memberof ImageApiHeadPersonImage
|
|
5563
4754
|
*/
|
|
5564
4755
|
readonly fillHeight?: number;
|
|
5565
|
-
/**
|
|
5566
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5567
|
-
* @type {boolean}
|
|
5568
|
-
* @memberof ImageApiHeadPersonImage
|
|
5569
|
-
*/
|
|
5570
|
-
readonly cropWhitespace?: boolean;
|
|
5571
|
-
/**
|
|
5572
|
-
* Optional. Add a played indicator.
|
|
5573
|
-
* @type {boolean}
|
|
5574
|
-
* @memberof ImageApiHeadPersonImage
|
|
5575
|
-
*/
|
|
5576
|
-
readonly addPlayedIndicator?: boolean;
|
|
5577
4756
|
/**
|
|
5578
4757
|
* Optional. Blur image.
|
|
5579
4758
|
* @type {number}
|
|
@@ -5689,18 +4868,6 @@ export interface ImageApiHeadPersonImageByIndexRequest {
|
|
|
5689
4868
|
* @memberof ImageApiHeadPersonImageByIndex
|
|
5690
4869
|
*/
|
|
5691
4870
|
readonly fillHeight?: number;
|
|
5692
|
-
/**
|
|
5693
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5694
|
-
* @type {boolean}
|
|
5695
|
-
* @memberof ImageApiHeadPersonImageByIndex
|
|
5696
|
-
*/
|
|
5697
|
-
readonly cropWhitespace?: boolean;
|
|
5698
|
-
/**
|
|
5699
|
-
* Optional. Add a played indicator.
|
|
5700
|
-
* @type {boolean}
|
|
5701
|
-
* @memberof ImageApiHeadPersonImageByIndex
|
|
5702
|
-
*/
|
|
5703
|
-
readonly addPlayedIndicator?: boolean;
|
|
5704
4871
|
/**
|
|
5705
4872
|
* Optional. Blur image.
|
|
5706
4873
|
* @type {number}
|
|
@@ -5804,18 +4971,6 @@ export interface ImageApiHeadStudioImageRequest {
|
|
|
5804
4971
|
* @memberof ImageApiHeadStudioImage
|
|
5805
4972
|
*/
|
|
5806
4973
|
readonly fillHeight?: number;
|
|
5807
|
-
/**
|
|
5808
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5809
|
-
* @type {boolean}
|
|
5810
|
-
* @memberof ImageApiHeadStudioImage
|
|
5811
|
-
*/
|
|
5812
|
-
readonly cropWhitespace?: boolean;
|
|
5813
|
-
/**
|
|
5814
|
-
* Optional. Add a played indicator.
|
|
5815
|
-
* @type {boolean}
|
|
5816
|
-
* @memberof ImageApiHeadStudioImage
|
|
5817
|
-
*/
|
|
5818
|
-
readonly addPlayedIndicator?: boolean;
|
|
5819
4974
|
/**
|
|
5820
4975
|
* Optional. Blur image.
|
|
5821
4976
|
* @type {number}
|
|
@@ -5931,18 +5086,6 @@ export interface ImageApiHeadStudioImageByIndexRequest {
|
|
|
5931
5086
|
* @memberof ImageApiHeadStudioImageByIndex
|
|
5932
5087
|
*/
|
|
5933
5088
|
readonly fillHeight?: number;
|
|
5934
|
-
/**
|
|
5935
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
5936
|
-
* @type {boolean}
|
|
5937
|
-
* @memberof ImageApiHeadStudioImageByIndex
|
|
5938
|
-
*/
|
|
5939
|
-
readonly cropWhitespace?: boolean;
|
|
5940
|
-
/**
|
|
5941
|
-
* Optional. Add a played indicator.
|
|
5942
|
-
* @type {boolean}
|
|
5943
|
-
* @memberof ImageApiHeadStudioImageByIndex
|
|
5944
|
-
*/
|
|
5945
|
-
readonly addPlayedIndicator?: boolean;
|
|
5946
5089
|
/**
|
|
5947
5090
|
* Optional. Blur image.
|
|
5948
5091
|
* @type {number}
|
|
@@ -5973,13 +5116,7 @@ export interface ImageApiHeadUserImageRequest {
|
|
|
5973
5116
|
* @type {string}
|
|
5974
5117
|
* @memberof ImageApiHeadUserImage
|
|
5975
5118
|
*/
|
|
5976
|
-
readonly userId
|
|
5977
|
-
/**
|
|
5978
|
-
* Image type.
|
|
5979
|
-
* @type {ImageType}
|
|
5980
|
-
* @memberof ImageApiHeadUserImage
|
|
5981
|
-
*/
|
|
5982
|
-
readonly imageType: ImageType;
|
|
5119
|
+
readonly userId?: string;
|
|
5983
5120
|
/**
|
|
5984
5121
|
* Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
5985
5122
|
* @type {string}
|
|
@@ -6046,18 +5183,6 @@ export interface ImageApiHeadUserImageRequest {
|
|
|
6046
5183
|
* @memberof ImageApiHeadUserImage
|
|
6047
5184
|
*/
|
|
6048
5185
|
readonly fillHeight?: number;
|
|
6049
|
-
/**
|
|
6050
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
6051
|
-
* @type {boolean}
|
|
6052
|
-
* @memberof ImageApiHeadUserImage
|
|
6053
|
-
*/
|
|
6054
|
-
readonly cropWhitespace?: boolean;
|
|
6055
|
-
/**
|
|
6056
|
-
* Optional. Add a played indicator.
|
|
6057
|
-
* @type {boolean}
|
|
6058
|
-
* @memberof ImageApiHeadUserImage
|
|
6059
|
-
*/
|
|
6060
|
-
readonly addPlayedIndicator?: boolean;
|
|
6061
5186
|
/**
|
|
6062
5187
|
* Optional. Blur image.
|
|
6063
5188
|
* @type {number}
|
|
@@ -6083,127 +5208,6 @@ export interface ImageApiHeadUserImageRequest {
|
|
|
6083
5208
|
*/
|
|
6084
5209
|
readonly imageIndex?: number;
|
|
6085
5210
|
}
|
|
6086
|
-
/**
|
|
6087
|
-
* Request parameters for headUserImageByIndex operation in ImageApi.
|
|
6088
|
-
* @export
|
|
6089
|
-
* @interface ImageApiHeadUserImageByIndexRequest
|
|
6090
|
-
*/
|
|
6091
|
-
export interface ImageApiHeadUserImageByIndexRequest {
|
|
6092
|
-
/**
|
|
6093
|
-
* User id.
|
|
6094
|
-
* @type {string}
|
|
6095
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6096
|
-
*/
|
|
6097
|
-
readonly userId: string;
|
|
6098
|
-
/**
|
|
6099
|
-
* Image type.
|
|
6100
|
-
* @type {ImageType}
|
|
6101
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6102
|
-
*/
|
|
6103
|
-
readonly imageType: ImageType;
|
|
6104
|
-
/**
|
|
6105
|
-
* Image index.
|
|
6106
|
-
* @type {number}
|
|
6107
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6108
|
-
*/
|
|
6109
|
-
readonly imageIndex: number;
|
|
6110
|
-
/**
|
|
6111
|
-
* Optional. Supply the cache tag from the item object to receive strong caching headers.
|
|
6112
|
-
* @type {string}
|
|
6113
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6114
|
-
*/
|
|
6115
|
-
readonly tag?: string;
|
|
6116
|
-
/**
|
|
6117
|
-
* Determines the output format of the image - original,gif,jpg,png.
|
|
6118
|
-
* @type {ImageFormat}
|
|
6119
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6120
|
-
*/
|
|
6121
|
-
readonly format?: ImageFormat;
|
|
6122
|
-
/**
|
|
6123
|
-
* The maximum image width to return.
|
|
6124
|
-
* @type {number}
|
|
6125
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6126
|
-
*/
|
|
6127
|
-
readonly maxWidth?: number;
|
|
6128
|
-
/**
|
|
6129
|
-
* The maximum image height to return.
|
|
6130
|
-
* @type {number}
|
|
6131
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6132
|
-
*/
|
|
6133
|
-
readonly maxHeight?: number;
|
|
6134
|
-
/**
|
|
6135
|
-
* Optional. Percent to render for the percent played overlay.
|
|
6136
|
-
* @type {number}
|
|
6137
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6138
|
-
*/
|
|
6139
|
-
readonly percentPlayed?: number;
|
|
6140
|
-
/**
|
|
6141
|
-
* Optional. Unplayed count overlay to render.
|
|
6142
|
-
* @type {number}
|
|
6143
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6144
|
-
*/
|
|
6145
|
-
readonly unplayedCount?: number;
|
|
6146
|
-
/**
|
|
6147
|
-
* The fixed image width to return.
|
|
6148
|
-
* @type {number}
|
|
6149
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6150
|
-
*/
|
|
6151
|
-
readonly width?: number;
|
|
6152
|
-
/**
|
|
6153
|
-
* The fixed image height to return.
|
|
6154
|
-
* @type {number}
|
|
6155
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6156
|
-
*/
|
|
6157
|
-
readonly height?: number;
|
|
6158
|
-
/**
|
|
6159
|
-
* Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
|
|
6160
|
-
* @type {number}
|
|
6161
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6162
|
-
*/
|
|
6163
|
-
readonly quality?: number;
|
|
6164
|
-
/**
|
|
6165
|
-
* Width of box to fill.
|
|
6166
|
-
* @type {number}
|
|
6167
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6168
|
-
*/
|
|
6169
|
-
readonly fillWidth?: number;
|
|
6170
|
-
/**
|
|
6171
|
-
* Height of box to fill.
|
|
6172
|
-
* @type {number}
|
|
6173
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6174
|
-
*/
|
|
6175
|
-
readonly fillHeight?: number;
|
|
6176
|
-
/**
|
|
6177
|
-
* Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
|
|
6178
|
-
* @type {boolean}
|
|
6179
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6180
|
-
*/
|
|
6181
|
-
readonly cropWhitespace?: boolean;
|
|
6182
|
-
/**
|
|
6183
|
-
* Optional. Add a played indicator.
|
|
6184
|
-
* @type {boolean}
|
|
6185
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6186
|
-
*/
|
|
6187
|
-
readonly addPlayedIndicator?: boolean;
|
|
6188
|
-
/**
|
|
6189
|
-
* Optional. Blur image.
|
|
6190
|
-
* @type {number}
|
|
6191
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6192
|
-
*/
|
|
6193
|
-
readonly blur?: number;
|
|
6194
|
-
/**
|
|
6195
|
-
* Optional. Apply a background color for transparent images.
|
|
6196
|
-
* @type {string}
|
|
6197
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6198
|
-
*/
|
|
6199
|
-
readonly backgroundColor?: string;
|
|
6200
|
-
/**
|
|
6201
|
-
* Optional. Apply a foreground layer on top of the image.
|
|
6202
|
-
* @type {string}
|
|
6203
|
-
* @memberof ImageApiHeadUserImageByIndex
|
|
6204
|
-
*/
|
|
6205
|
-
readonly foregroundLayer?: string;
|
|
6206
|
-
}
|
|
6207
5211
|
/**
|
|
6208
5212
|
* Request parameters for postUserImage operation in ImageApi.
|
|
6209
5213
|
* @export
|
|
@@ -6215,19 +5219,7 @@ export interface ImageApiPostUserImageRequest {
|
|
|
6215
5219
|
* @type {string}
|
|
6216
5220
|
* @memberof ImageApiPostUserImage
|
|
6217
5221
|
*/
|
|
6218
|
-
readonly userId
|
|
6219
|
-
/**
|
|
6220
|
-
* (Unused) Image type.
|
|
6221
|
-
* @type {ImageType}
|
|
6222
|
-
* @memberof ImageApiPostUserImage
|
|
6223
|
-
*/
|
|
6224
|
-
readonly imageType: ImageType;
|
|
6225
|
-
/**
|
|
6226
|
-
* (Unused) Image index.
|
|
6227
|
-
* @type {number}
|
|
6228
|
-
* @memberof ImageApiPostUserImage
|
|
6229
|
-
*/
|
|
6230
|
-
readonly index?: number;
|
|
5222
|
+
readonly userId?: string;
|
|
6231
5223
|
/**
|
|
6232
5224
|
*
|
|
6233
5225
|
* @type {any}
|
|
@@ -6235,37 +5227,6 @@ export interface ImageApiPostUserImageRequest {
|
|
|
6235
5227
|
*/
|
|
6236
5228
|
readonly body?: any;
|
|
6237
5229
|
}
|
|
6238
|
-
/**
|
|
6239
|
-
* Request parameters for postUserImageByIndex operation in ImageApi.
|
|
6240
|
-
* @export
|
|
6241
|
-
* @interface ImageApiPostUserImageByIndexRequest
|
|
6242
|
-
*/
|
|
6243
|
-
export interface ImageApiPostUserImageByIndexRequest {
|
|
6244
|
-
/**
|
|
6245
|
-
* User Id.
|
|
6246
|
-
* @type {string}
|
|
6247
|
-
* @memberof ImageApiPostUserImageByIndex
|
|
6248
|
-
*/
|
|
6249
|
-
readonly userId: string;
|
|
6250
|
-
/**
|
|
6251
|
-
* (Unused) Image type.
|
|
6252
|
-
* @type {ImageType}
|
|
6253
|
-
* @memberof ImageApiPostUserImageByIndex
|
|
6254
|
-
*/
|
|
6255
|
-
readonly imageType: ImageType;
|
|
6256
|
-
/**
|
|
6257
|
-
* (Unused) Image index.
|
|
6258
|
-
* @type {number}
|
|
6259
|
-
* @memberof ImageApiPostUserImageByIndex
|
|
6260
|
-
*/
|
|
6261
|
-
readonly index: number;
|
|
6262
|
-
/**
|
|
6263
|
-
*
|
|
6264
|
-
* @type {any}
|
|
6265
|
-
* @memberof ImageApiPostUserImageByIndex
|
|
6266
|
-
*/
|
|
6267
|
-
readonly body?: any;
|
|
6268
|
-
}
|
|
6269
5230
|
/**
|
|
6270
5231
|
* Request parameters for setItemImage operation in ImageApi.
|
|
6271
5232
|
* @export
|
|
@@ -6407,16 +5368,7 @@ export declare class ImageApi extends BaseAPI {
|
|
|
6407
5368
|
* @throws {RequiredError}
|
|
6408
5369
|
* @memberof ImageApi
|
|
6409
5370
|
*/
|
|
6410
|
-
deleteUserImage(requestParameters
|
|
6411
|
-
/**
|
|
6412
|
-
*
|
|
6413
|
-
* @summary Delete the user\'s image.
|
|
6414
|
-
* @param {ImageApiDeleteUserImageByIndexRequest} requestParameters Request parameters.
|
|
6415
|
-
* @param {*} [options] Override http request option.
|
|
6416
|
-
* @throws {RequiredError}
|
|
6417
|
-
* @memberof ImageApi
|
|
6418
|
-
*/
|
|
6419
|
-
deleteUserImageByIndex(requestParameters: ImageApiDeleteUserImageByIndexRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5371
|
+
deleteUserImage(requestParameters?: ImageApiDeleteUserImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6420
5372
|
/**
|
|
6421
5373
|
*
|
|
6422
5374
|
* @summary Get artist image by name.
|
|
@@ -6551,16 +5503,7 @@ export declare class ImageApi extends BaseAPI {
|
|
|
6551
5503
|
* @throws {RequiredError}
|
|
6552
5504
|
* @memberof ImageApi
|
|
6553
5505
|
*/
|
|
6554
|
-
getUserImage(requestParameters
|
|
6555
|
-
/**
|
|
6556
|
-
*
|
|
6557
|
-
* @summary Get user profile image.
|
|
6558
|
-
* @param {ImageApiGetUserImageByIndexRequest} requestParameters Request parameters.
|
|
6559
|
-
* @param {*} [options] Override http request option.
|
|
6560
|
-
* @throws {RequiredError}
|
|
6561
|
-
* @memberof ImageApi
|
|
6562
|
-
*/
|
|
6563
|
-
getUserImageByIndex(requestParameters: ImageApiGetUserImageByIndexRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
5506
|
+
getUserImage(requestParameters?: ImageApiGetUserImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
6564
5507
|
/**
|
|
6565
5508
|
*
|
|
6566
5509
|
* @summary Get artist image by name.
|
|
@@ -6677,16 +5620,7 @@ export declare class ImageApi extends BaseAPI {
|
|
|
6677
5620
|
* @throws {RequiredError}
|
|
6678
5621
|
* @memberof ImageApi
|
|
6679
5622
|
*/
|
|
6680
|
-
headUserImage(requestParameters
|
|
6681
|
-
/**
|
|
6682
|
-
*
|
|
6683
|
-
* @summary Get user profile image.
|
|
6684
|
-
* @param {ImageApiHeadUserImageByIndexRequest} requestParameters Request parameters.
|
|
6685
|
-
* @param {*} [options] Override http request option.
|
|
6686
|
-
* @throws {RequiredError}
|
|
6687
|
-
* @memberof ImageApi
|
|
6688
|
-
*/
|
|
6689
|
-
headUserImageByIndex(requestParameters: ImageApiHeadUserImageByIndexRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
5623
|
+
headUserImage(requestParameters?: ImageApiHeadUserImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
6690
5624
|
/**
|
|
6691
5625
|
*
|
|
6692
5626
|
* @summary Sets the user image.
|
|
@@ -6695,16 +5629,7 @@ export declare class ImageApi extends BaseAPI {
|
|
|
6695
5629
|
* @throws {RequiredError}
|
|
6696
5630
|
* @memberof ImageApi
|
|
6697
5631
|
*/
|
|
6698
|
-
postUserImage(requestParameters
|
|
6699
|
-
/**
|
|
6700
|
-
*
|
|
6701
|
-
* @summary Sets the user image.
|
|
6702
|
-
* @param {ImageApiPostUserImageByIndexRequest} requestParameters Request parameters.
|
|
6703
|
-
* @param {*} [options] Override http request option.
|
|
6704
|
-
* @throws {RequiredError}
|
|
6705
|
-
* @memberof ImageApi
|
|
6706
|
-
*/
|
|
6707
|
-
postUserImageByIndex(requestParameters: ImageApiPostUserImageByIndexRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5632
|
+
postUserImage(requestParameters?: ImageApiPostUserImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6708
5633
|
/**
|
|
6709
5634
|
*
|
|
6710
5635
|
* @summary Set item image.
|