plexgo/docs/sdks/dvrs/README.md

DVRs

(DVRs)

Overview

The DVR provides means to watch and record live TV. This section of endpoints describes how to setup the DVR itself

Available Operations

• ListDVRs - Get DVRs
• CreateDVR - Create a DVR
• DeleteDVR - Delete a single DVR
• GetDVR - Get a single DVR
• DeleteLineup - Delete a DVR Lineup
• AddLineup - Add a DVR Lineup
• SetDVRPreferences - Set DVR preferences
• StopDVRReload - Tell a DVR to stop reloading program guide
• ReloadGuide - Tell a DVR to reload program guide
• TuneChannel - Tune a channel on a DVR
• RemoveDeviceFromDVR - Remove a device from an existing DVR
• AddDeviceToDVR - Add a device to an existing DVR

ListDVRs

Get the list of all available DVRs

Example Usage

package main

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

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

    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.DVRs.ListDVRs(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListDVRsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

CreateDVR

Creation of a DVR, after creation of a devcie and a lineup is selected

Example Usage

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.CreateDVR(ctx, operations.CreateDVRRequest{
        Lineup: plexgo.Pointer("lineup://tv.plex.providers.epg.onconnect/USA-HI51418-DEFAULT"),
        DeviceQueryParameter: []string{
            "d",
            "e",
            "v",
            "i",
            "c",
            "e",
            "[",
            "]",
            "=",
            "d",
            "e",
            "v",
            "i",
            "c",
            "e",
            ":",
            "/",
            "/",
            "t",
            "v",
            ".",
            "p",
            "l",
            "e",
            "x",
            ".",
            "g",
            "r",
            "a",
            "b",
            "b",
            "e",
            "r",
            "s",
            ".",
            "h",
            "d",
            "h",
            "o",
            "m",
            "e",
            "r",
            "u",
            "n",
            "/",
            "1",
            "0",
            "5",
            "3",
            "C",
            "0",
            "C",
            "A",
        },
        Language: plexgo.Pointer("eng"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.DvrRequestHandlerSlashGetResponses200 != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.CreateDVRRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.CreateDVRResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

DeleteDVR

Delete a single DVR by its id (key)

Example Usage

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.DeleteDVR(ctx, operations.DeleteDVRRequest{
        DvrID: 855088,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.DeleteDVRRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteDVRResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

GetDVR

Get a single DVR by its id (key)

Example Usage

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.GetDVR(ctx, operations.GetDVRRequest{
        DvrID: 973518,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.GetDVRRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetDVRResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

DeleteLineup

Deletes a DVR device's lineup.

Example Usage

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.DeleteLineup(ctx, operations.DeleteLineupRequest{
        DvrID: 454470,
        Lineup: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.DeleteLineupRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteLineupResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

AddLineup

Add a lineup to a DVR device's set of lineups.

Example Usage

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.AddLineup(ctx, operations.AddLineupRequest{
        DvrID: 945235,
        Lineup: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.AddLineupRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.AddLineupResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

SetDVRPreferences

Set DVR preferences by name avd value

Example Usage

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
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.SetDVRPreferencesRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SetDVRPreferencesResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

StopDVRReload

Tell a DVR to stop reloading program guide

Example Usage

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.StopDVRReload(ctx, operations.StopDVRReloadRequest{
        DvrID: 348053,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.StopDVRReloadRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.StopDVRReloadResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

ReloadGuide

Tell a DVR to reload program guide

Example Usage

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.ReloadGuide(ctx, operations.ReloadGuideRequest{
        DvrID: 140753,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ReloadGuideRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ReloadGuideResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

TuneChannel

Tune a channel on a DVR to the provided channel

Example Usage

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.TuneChannel(ctx, operations.TuneChannelRequest{
        DvrID: 834281,
        Channel: "2.1",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.MediaContainerWithMetadata != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.TuneChannelRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TuneChannelResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

RemoveDeviceFromDVR

Remove a device from an existing DVR

Example Usage

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.RemoveDeviceFromDVR(ctx, operations.RemoveDeviceFromDVRRequest{
        DvrID: 945416,
        DeviceID: 260761,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.RemoveDeviceFromDVRRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RemoveDeviceFromDVRResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

AddDeviceToDVR

Add a device to an existing DVR

Example Usage

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.AddDeviceToDVR(ctx, operations.AddDeviceToDVRRequest{
        DvrID: 334755,
        DeviceID: 852930,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.AddDeviceToDVRRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.AddDeviceToDVRResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*