plexjava/docs/sdks/devices/README.md

Devices

(devices())

Overview

Media grabbers provide ways for media to be obtained for a given protocol. The simplest ones are stream and download. More complex grabbers can have associated devices

Network tuners can present themselves on the network using the Simple Service Discovery Protocol and Plex Media Server will discover them. The following XML is an example of the data returned from SSDP. The deviceType, serviceType, and serviceId values must remain as they are in the example in order for PMS to properly discover the device. Other less-obvious fields are described in the parameters section below.

Example SSDP output

<root xmlns="urn:schemas-upnp-org:device-1-0">
    <specVersion>
        <major>1</major>
        <minor>0</minor>
    </specVersion>
    <device>
        <deviceType>urn:plex-tv:device:Media:1</deviceType>
        <friendlyName>Turing Hopper 3000</friendlyName>
        <manufacturer>Plex, Inc.</manufacturer>
        <manufacturerURL>https://plex.tv/</manufacturerURL>
        <modelDescription>Turing Hopper 3000 Media Grabber</modelDescription>
        <modelName>Plex Media Grabber</modelName>
        <modelNumber>1</modelNumber>
        <modelURL>https://plex.tv</modelURL>
        <UDN>uuid:42fde8e4-93b6-41e5-8a63-12d848655811</UDN>
        <serviceList>
            <service>
                <URLBase>http://10.0.0.5:8088</URLBase>
                <serviceType>urn:plex-tv:service:MediaGrabber:1</serviceType>
                <serviceId>urn:plex-tv:serviceId:MediaGrabber</serviceId>
            </service>
        </serviceList>
    </device>
</root>

• UDN: (string) A UUID for the device. This should be unique across models of a device at minimum.
• URLBase: (string) The base HTTP URL for the device from which all of the other endpoints are hosted.

Available Operations

• getAvailableGrabbers - Get available grabbers
• listDevices - Get all devices
• addDevice - Add a device
• discoverDevices - Tell grabbers to discover devices
• removeDevice - Remove a device
• getDeviceDetails - Get device details
• modifyDevice - Enable or disable a device
• setChannelmap - Set a device's channel mapping
• getDevicesChannels - Get a device's channels
• setDevicePreferences - Set device preferences
• stopScan - Tell a device to stop scanning for channels
• scan - Tell a device to scan for channels
• getThumb - Get device thumb

getAvailableGrabbers

Get available grabbers visible to the server

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetAvailableGrabbersRequest;
import dev.plexapi.sdk.models.operations.GetAvailableGrabbersResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetAvailableGrabbersRequest req = GetAvailableGrabbersRequest.builder()
                .protocol("livetv")
                .build();

        GetAvailableGrabbersResponse res = sdk.devices().getAvailableGrabbers()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetAvailableGrabbersRequest	✔️	The request object to use for the request.

Response

GetAvailableGrabbersResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

listDevices

Get the list of all devices present

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.ListDevicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        ListDevicesResponse res = sdk.devices().listDevices()
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Response

ListDevicesResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

addDevice

This endpoint adds a device to an existing grabber. The device is identified, and added to the correct grabber.

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.AddDeviceRequest;
import dev.plexapi.sdk.models.operations.AddDeviceResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        AddDeviceRequest req = AddDeviceRequest.builder()
                .uri("http://10.0.0.5")
                .build();

        AddDeviceResponse res = sdk.devices().addDevice()
                .request(req)
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	AddDeviceRequest	✔️	The request object to use for the request.

Response

AddDeviceResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

discoverDevices

Tell grabbers to discover devices

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.DiscoverDevicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        DiscoverDevicesResponse res = sdk.devices().discoverDevices()
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Response

DiscoverDevicesResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

removeDevice

Remove a devices by its id along with its channel mappings

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.RemoveDeviceRequest;
import dev.plexapi.sdk.models.operations.RemoveDeviceResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        RemoveDeviceRequest req = RemoveDeviceRequest.builder()
                .deviceId(685908L)
                .build();

        RemoveDeviceResponse res = sdk.devices().removeDevice()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	RemoveDeviceRequest	✔️	The request object to use for the request.

Response

RemoveDeviceResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getDeviceDetails

Get a device's details by its id

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetDeviceDetailsRequest;
import dev.plexapi.sdk.models.operations.GetDeviceDetailsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetDeviceDetailsRequest req = GetDeviceDetailsRequest.builder()
                .deviceId(170949L)
                .build();

        GetDeviceDetailsResponse res = sdk.devices().getDeviceDetails()
                .request(req)
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetDeviceDetailsRequest	✔️	The request object to use for the request.

Response

GetDeviceDetailsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

modifyDevice

Enable or disable a device by its id

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.ModifyDeviceRequest;
import dev.plexapi.sdk.models.operations.ModifyDeviceResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.BoolInt;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        ModifyDeviceRequest req = ModifyDeviceRequest.builder()
                .deviceId(879135L)
                .enabled(BoolInt.True)
                .build();

        ModifyDeviceResponse res = sdk.devices().modifyDevice()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ModifyDeviceRequest	✔️	The request object to use for the request.

Response

ModifyDeviceResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

setChannelmap

Set a device's channel mapping

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        SetChannelmapRequest req = SetChannelmapRequest.builder()
                .deviceId(937661L)
                .channelMapping(ChannelMapping.builder()
                    .build())
                .channelMappingByKey(ChannelMappingByKey.builder()
                    .build())
                .channelsEnabled(List.of(
                    "4",
                    "6",
                    ".",
                    "1",
                    ",",
                    "4",
                    "4",
                    ".",
                    "1",
                    ",",
                    "4",
                    "5",
                    ".",
                    "1"))
                .build();

        SetChannelmapResponse res = sdk.devices().setChannelmap()
                .request(req)
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	SetChannelmapRequest	✔️	The request object to use for the request.

Response

SetChannelmapResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getDevicesChannels

Get a device's channels by its id

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetDevicesChannelsRequest;
import dev.plexapi.sdk.models.operations.GetDevicesChannelsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetDevicesChannelsRequest req = GetDevicesChannelsRequest.builder()
                .deviceId(517209L)
                .build();

        GetDevicesChannelsResponse res = sdk.devices().getDevicesChannels()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetDevicesChannelsRequest	✔️	The request object to use for the request.

Response

GetDevicesChannelsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

setDevicePreferences

Set device preferences by its id

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.SetDevicePreferencesRequest;
import dev.plexapi.sdk.models.operations.SetDevicePreferencesResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        SetDevicePreferencesRequest req = SetDevicePreferencesRequest.builder()
                .deviceId(420973L)
                .build();

        SetDevicePreferencesResponse res = sdk.devices().setDevicePreferences()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	SetDevicePreferencesRequest	✔️	The request object to use for the request.

Response

SetDevicePreferencesResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

stopScan

Tell a device to stop scanning for channels

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.StopScanRequest;
import dev.plexapi.sdk.models.operations.StopScanResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        StopScanRequest req = StopScanRequest.builder()
                .deviceId(576494L)
                .build();

        StopScanResponse res = sdk.devices().stopScan()
                .request(req)
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	StopScanRequest	✔️	The request object to use for the request.

Response

StopScanResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

scan

Tell a device to scan for channels

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.ScanRequest;
import dev.plexapi.sdk.models.operations.ScanResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        ScanRequest req = ScanRequest.builder()
                .deviceId(57391L)
                .source("Cable")
                .build();

        ScanResponse res = sdk.devices().scan()
                .request(req)
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ScanRequest	✔️	The request object to use for the request.

Response

ScanResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getThumb

Get a device's thumb for display to the user

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetThumbRequest;
import dev.plexapi.sdk.models.operations.GetThumbResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetThumbRequest req = GetThumbRequest.builder()
                .deviceId(960617L)
                .versionPathParameter(1025L)
                .build();

        GetThumbResponse res = sdk.devices().getThumb()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	GetThumbRequest	✔️	The request object to use for the request.

Response

GetThumbResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*