Skip to main content
PUT
/
livetv
/
dvrs
/
{dvrId}
/
prefs
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.DVRs.SetDVRPreferences(ctx, operations.SetDVRPreferencesRequest{
        DvrID: 116357,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}
{
  "MediaContainer": {
    "MediaContainer": {
      "identifier": "<string>",
      "offset": 123,
      "size": 123,
      "totalSize": 123,
      "status": 123
    },
    "DVR": [
      {
        "Device": [
          {
            "ChannelMapping": [
              {
                "channelKey": "<string>",
                "deviceIdentifier": "<string>",
                "enabled": "<string>",
                "lineupIdentifier": "<string>"
              }
            ],
            "key": "<string>",
            "lastSeenAt": 123,
            "make": "<string>",
            "model": "<string>",
            "modelNumber": "<string>",
            "protocol": "<string>",
            "sources": "<string>",
            "state": "<string>",
            "status": "<string>",
            "tuners": "<string>",
            "uri": "<string>",
            "uuid": "<string>"
          }
        ],
        "key": "<string>",
        "language": "<string>",
        "lineup": "<string>",
        "uuid": "<string>"
      }
    ]
  }
}

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"

Path Parameters

dvrId
integer
required

The ID of the DVR.

Query Parameters

name
string

Set the name preference to the provided value

Response

200 - application/json

OK

MediaContainer
object