Skip to main content
GET
/
services
/
ultrablur
/
image
PlexGO
package main

import(
	"context"
	"github.com/LukeHagar/plexgo/models/components"
	"github.com/LukeHagar/plexgo"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithAccepts(components.AcceptsApplicationXML),
        plexgo.WithClientIdentifier("abc123"),
        plexgo.WithProduct("Plex for Roku"),
        plexgo.WithVersion("2.4.1"),
        plexgo.WithPlatform("Roku"),
        plexgo.WithPlatformVersion("4.3 build 1057"),
        plexgo.WithDevice("Roku 3"),
        plexgo.WithModel("4200X"),
        plexgo.WithDeviceVendor("Roku"),
        plexgo.WithDeviceName("Living Room TV"),
        plexgo.WithMarketplace("googlePlay"),
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.UltraBlur.GetImage(ctx, operations.GetImageRequest{
        TopLeft: plexgo.Pointer("3f280a"),
        TopRight: plexgo.Pointer("6b4713"),
        BottomRight: plexgo.Pointer("0f2a43"),
        BottomLeft: plexgo.Pointer("1c425d"),
        Width: plexgo.Pointer[int64](1920),
        Height: plexgo.Pointer[int64](1080),
        Noise: components.BoolIntOne.ToPointer(),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ResponseStream != nil {
        // handle response
    }
}
This response does not have an example.

Authorizations

​
X-Plex-Token
string
header
required

The token which identifies the user accessing the PMS. This can be either:

  • A traditional access token obtained from plex.tv
  • A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

  • Short-lived tokens (7 days expiration)
  • Public-key cryptography (ED25519)
  • Better clock synchronization
  • Individual device revocation capability

Headers

​
accepts
enum<string>
default:application/xml

Indicates the client accepts the indicated media types

Available options:
application/json,
application/xml
​
X-Plex-Client-Identifier
string
required

An opaque identifier unique to the client

Example:

"abc123"

​
X-Plex-Product
string

The name of the client product

Example:

"Plex for Roku"

​
X-Plex-Version
string

The version of the client application

Example:

"2.4.1"

​
X-Plex-Platform
string

The platform of the client

Example:

"Roku"

​
X-Plex-Platform-Version
string

The version of the platform

Example:

"4.3 build 1057"

​
X-Plex-Device
string

A relatively friendly name for the client device

Example:

"Roku 3"

​
X-Plex-Model
string

A potentially less friendly identifier for the device model

Example:

"4200X"

​
X-Plex-Device-Vendor
string

The device vendor

Example:

"Roku"

​
X-Plex-Device-Name
string

A friendly name for the client

Example:

"Living Room TV"

​
X-Plex-Marketplace
string

The marketplace on which the client application is distributed

Example:

"googlePlay"

Query Parameters

​
topLeft
string

The base color (hex) for the top left quadrant.

​
topRight
string

The base color (hex) for the top right quadrant.

​
bottomRight
string

The base color (hex) for the bottom right quadrant.

​
bottomLeft
string

The base color (hex) for the bottom left quadrant.

​
width
integer

Width in pixels for the image.

Required range: 320 <= x <= 3840
​
height
integer

Height in pixels for the image.

Required range: 240 <= x <= 2160
​
noise
enum<integer>

Whether to add noise to the ouput image. Noise can reduce color banding with the gradients. Image sizes with noise will be larger.

Available options:
0,
1

Response

OK

The response is of type file.