plexjs/docs/models/operations/getimagerequest.md

GetImageRequest

Example Usage

import { GetImageRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";

let value: GetImageRequest = {
  topLeft: "3f280a",
  topRight: "6b4713",
  bottomRight: "0f2a43",
  bottomLeft: "1c425d",
  width: 1920,
  height: 1080,
  noise: BoolInt.True,
};

Fields

Field	Type	Required	Description	Example
accepts	shared.Accepts	➖	Indicates the client accepts the indicated media types
clientIdentifier	string	➖	An opaque identifier unique to the client	abc123
product	string	➖	The name of the client product	Plex for Roku
version	string	➖	The version of the client application	2.4.1
platform	string	➖	The platform of the client	Roku
platformVersion	string	➖	The version of the platform	4.3 build 1057
device	string	➖	A relatively friendly name for the client device	Roku 3
model	string	➖	A potentially less friendly identifier for the device model	4200X
deviceVendor	string	➖	The device vendor	Roku
deviceName	string	➖	A friendly name for the client	Living Room TV
marketplace	string	➖	The marketplace on which the client application is distributed	googlePlay
topLeft	string	➖	The base color (hex) for the top left quadrant.	3f280a
topRight	string	➖	The base color (hex) for the top right quadrant.	6b4713
bottomRight	string	➖	The base color (hex) for the bottom right quadrant.	0f2a43
bottomLeft	string	➖	The base color (hex) for the bottom left quadrant.	1c425d
width	number	➖	Width in pixels for the image.	1920
height	number	➖	Height in pixels for the image.	1080
noise	shared.BoolInt	➖	Whether to add noise to the ouput image. Noise can reduce color banding with the gradients. Image sizes with noise will be larger.	1