diff --git a/docs/legacy/plex/Activities.md b/docs/legacy/plex/Activities.md index 755ac54..3c2629a 100644 --- a/docs/legacy/plex/Activities.md +++ b/docs/legacy/plex/Activities.md @@ -14,14 +14,14 @@ Activities are optional cancellable. If cancellable, they may be cancelled via t ### Get all activities [GET /activities] + Response 200 (application/xml) - - +```xml + - +``` ### Cancel a running activity [DELETE /activities/{activity}] + Parameters diff --git a/docs/legacy/plex/AutoUpdates.md b/docs/legacy/plex/AutoUpdates.md index dd4c60b..ba9b2c6 100644 --- a/docs/legacy/plex/AutoUpdates.md +++ b/docs/legacy/plex/AutoUpdates.md @@ -8,11 +8,11 @@ Updates to the status can be observed via the Event API. + Response 200 (application/xml;charset=utf-8) + Body - +```xml - +``` ### Checking for updates [PUT /updater/check] + Parameters diff --git a/docs/legacy/plex/Library/All.md b/docs/legacy/plex/Library/All.md index e77be00..7f88abc 100644 --- a/docs/legacy/plex/Library/All.md +++ b/docs/legacy/plex/Library/All.md @@ -17,7 +17,7 @@ Description for GET method (action) placeholder. + Response 200 (text/xml;charset=utf-8) + body - +```xml - +``` ### Set the fields of the filtered items [PUT /library/sections/{sectionId}/all{?type,filters,field%2Evalue,field%2Elocked,title%2Evalue,artist%2Etitle%2Evalue,artist%2Etitle%2Eid,album%2Etitle%2Evalue,album%2Etitle%2Eid}] N.B. `field` in a parameter, represents any valid field for an item. @@ -117,5 +117,6 @@ Description for response placeholder. + body + Response 400 (text/html) - +```html Bad Request

400 Bad Request

+``` diff --git a/docs/legacy/plex/Library/Auto Complete.md b/docs/legacy/plex/Library/Auto Complete.md index 64271d0..12afeb6 100644 --- a/docs/legacy/plex/Library/Auto Complete.md +++ b/docs/legacy/plex/Library/Auto Complete.md @@ -22,7 +22,7 @@ Returns a set of items from the filtered items whose {field} starts with {field} Example returning items + Body - +```xml - +``` + Request With genre.query=a (text/xml) + Response 200 (text/xml;charset=utf-8) @@ -63,10 +63,11 @@ Example returning tags Accept: text/xml + Body - +```xml +``` \ No newline at end of file diff --git a/docs/legacy/plex/Library/Common.md b/docs/legacy/plex/Library/Common.md index ac23803..e3c4aac 100644 --- a/docs/legacy/plex/Library/Common.md +++ b/docs/legacy/plex/Library/Common.md @@ -15,19 +15,19 @@ attributes of the items selected by the provided filter + Response 200 (text/xml;charset=utf-8) + Body - +```xml - +``` + Request All filtered items are common (text/xml) + Response 200 (text/xml;charset=utf-8) + Body - +```xml @@ -46,17 +46,18 @@ attributes of the items selected by the provided filter - +``` + Response 400 (text/html) In response to missing the type parameter. + Body - +```html Bad Request

400 Bad Request

- +``` + Response 404 (text/html) In response to a non-existant sectionId. + Body - +```html Not Found

404 Not Found

+``` \ No newline at end of file diff --git a/docs/legacy/plex/Library/Hashes.md b/docs/legacy/plex/Library/Hashes.md index ff7394d..0451c17 100644 --- a/docs/legacy/plex/Library/Hashes.md +++ b/docs/legacy/plex/Library/Hashes.md @@ -15,7 +15,7 @@ This resource returns hash values for local files. + Response 200 (text/xml;charset=utf-8) + body - +```xml @@ -24,3 +24,4 @@ This resource returns hash values for local files. +``` \ No newline at end of file diff --git a/docs/legacy/plex/Library/Ingest.md b/docs/legacy/plex/Library/Ingest.md index 5232afa..556d6e5 100644 --- a/docs/legacy/plex/Library/Ingest.md +++ b/docs/legacy/plex/Library/Ingest.md @@ -13,7 +13,8 @@ Note that any of the parameters passed to the metadata details endpoint (e.g. `i + ingestNonMatches: `1` (boolean, optional) - Whether or not non matching media should be stored. Defaults to 0. + Response 200 (application/xml) - +```xml +``` \ No newline at end of file diff --git a/docs/legacy/plex/Library/Matches.md b/docs/legacy/plex/Library/Matches.md index eaa4564..2a51aac 100644 --- a/docs/legacy/plex/Library/Matches.md +++ b/docs/legacy/plex/Library/Matches.md @@ -89,7 +89,7 @@ The following hints are required: + Response 200 (application/xml) - ``` + ```xml diff --git a/docs/legacy/plex/Library/Play Queues.md b/docs/legacy/plex/Library/Play Queues.md index 8f17b6c..2e69082 100644 --- a/docs/legacy/plex/Library/Play Queues.md +++ b/docs/legacy/plex/Library/Play Queues.md @@ -41,11 +41,11 @@ The media container itself has a few special attributes: Otherwise begins the play queue on the beginning of the show or season. + Response 200 (application/xml) - +```xml - +``` ### Retrieve a play queue [GET /playQueues/{playQueue}{?own,center,window,includeBefore,includeAfter}] Retrieves the play queue, centered at current item. This can be treated as a regular container by play queue-oblivious clients, but they may wish to request a large window onto the queue since they won't know to refresh. @@ -59,12 +59,12 @@ Retrieves the play queue, centered at current item. This can be treated as a reg + includeAfter: 1 (boolean, optional) - whether to include the items after the center (if 0, center is not included either), defaults to 1. + Response 200 (application/xml) - +```xml ... - +``` ### Add a generator or playlist to a play queue [PUT /playQueues/{playQueue}{?uri,playlistID,next}] Adds an item to a play queue (e.g. party mode). Increments the version of the play queue. Takes the following parameters (`uri` and `playlistID` are mutually exclusive). Returns the modified play queue. @@ -76,12 +76,12 @@ Adds an item to a play queue (e.g. party mode). Increments the version of the pl + next: 0 (boolean, optional) - play this item next (defaults to 0 - queueing at the end of manually queued items). + Response 200 (application/xml) - +```xml ... - +``` ### Delete an item from a play queue [DELETE /playQueues/{playQueue}/items/{playQueueItemID}] Deletes an item in a play queue. Increments the version of the play queue. Returns the modified play queue. @@ -91,12 +91,12 @@ Deletes an item in a play queue. Increments the version of the play queue. Retur + playQueueItemID: 123123 (string) - The play queue item ID to delete. + Response 200 (application/xml) - +```xml ... - +``` ### Clear a play queue [DELETE /playQueues/{playQueue}/items] Deletes all items in the play queue, and increases the version of the play queue. @@ -105,10 +105,10 @@ Deletes all items in the play queue, and increases the version of the play queue + playQueue: 101 (string) - The ID of the play queue. + Response 200 (application/xml) - +```xml - +``` ### Move an item in a play queue [PUT /playQueues/{playQueue}/items/{playQueueItemID}/move{?after}] Moves an item in a play queue, and increases the version of the play queue. Returns the modified play queue. @@ -119,12 +119,12 @@ Moves an item in a play queue, and increases the version of the play queue. Retu + after: 123 (string, optional) - the play queue item ID to insert the new item after. If not present, moves to the beginning. + Response 200 (application/xml) - +```xml ... - +``` ### Shuffle a play queue [PUT /playQueues/{playQueue}/shuffle] Shuffle a play queue (or reshuffles if already shuffled). The currently selected item is maintained. Note that this is currently only supported for play queues *without* an Up Next area. Returns the modified play queue. @@ -133,12 +133,12 @@ Shuffle a play queue (or reshuffles if already shuffled). The currently selected + playQueue: 101 (string) - The ID of the play queue. + Response 200 (application/xml) - +```xml ... - +``` ### Unshuffle a play queue [PUT /playQueues/{playQueue}/unshuffle] Unshuffles a play queue and restores "natural order". Note that this is currently only supported for play queues *without* an Up Next area. Returns the modified play queue. @@ -147,8 +147,9 @@ Unshuffles a play queue and restores "natural order". Note that this is currentl + playQueue: 101 (string) - The ID of the play queue. + Response 200 (application/xml) - +```xml ... +``` \ No newline at end of file diff --git a/docs/legacy/plex/Library/Playlists.md b/docs/legacy/plex/Library/Playlists.md index 6f690be..d26e908 100644 --- a/docs/legacy/plex/Library/Playlists.md +++ b/docs/legacy/plex/Library/Playlists.md @@ -22,12 +22,12 @@ Gets a list of playlists and playlist folders for a user. General filters are pe + smart: `0` (boolean, optional) - optional, type of playlists to return (default is all). + Response 200 (application/xml) - +```xml - +``` ### Create a Playlist [POST /playlists?{title,type,smart,uri,playQueueID}] Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: @@ -45,11 +45,11 @@ If you're creating a smart playlist, you must pass `smart=1` and use the `uri=.. + playQueueID: `123` (integer, optional) - the play queue to copy to a playlist. + Response 200 (application/xml) - +```xml - +``` ### Retrieve Playlist [GET /playlists/{playlistID}] Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item: @@ -60,11 +60,11 @@ Smart playlist details contain the `content` attribute. This is the content URI + playlistID: `123` (integer) - the ID of the playlist. + Response 200 (application/xml) - +```xml - +``` ### Retrieve Playlist Contents [GET /playlists/{playlistID}/items{?type}] Gets the contents if a playlist. Should be paged by clients via standard mechanisms. By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter. For example, you could use this to display a list of recently added albums vis a smart playlist. Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items. @@ -74,11 +74,11 @@ Gets the contents if a playlist. Should be paged by clients via standard mechani + type: `8` (integer) - the metadata type of the item to return. + Response 200 (application/xml) - +```xml - +``` ### Delete a Playlist [DELETE /playlists/{playlistID}] Deletes a playlist. @@ -114,11 +114,11 @@ Clears a playlist, only works with dumb playlists. Returns the playlist. + playlistID: `123` (integer) - the ID of the playlist. + Response 200 - +```xml - +``` ### Adding to a Playlist [PUT /playlists/{playlistID}/items?{uri,playQueueID}] Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. @@ -128,11 +128,11 @@ Adds a generator to a playlist, same parameters as the POST above. With a dumb p + playQueueID: `123` (integer, optional) - the play queue to add to a playlist. + Response 200 (application/xml) - +```xml - +``` ### Moving items in a playlist [PUT /playlists/{playlistID}/items/{playlistItemID}/move{?after}] Moves an item in a playlist. Only works with dumb playlists. diff --git a/docs/legacy/plex/Library/Search.md b/docs/legacy/plex/Library/Search.md index 65827b3..9fe7089 100644 --- a/docs/legacy/plex/Library/Search.md +++ b/docs/legacy/plex/Library/Search.md @@ -22,7 +22,7 @@ This request is intended to be very fast, and called as the user types. + Default: `3` + Response 200 (application/xml) - +```xml @@ -31,7 +31,7 @@ This request is intended to be very fast, and called as the user types. - +``` ### Perform a search tailored to voice input [GET /hubs/search/voice{?query,type,limit}] This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint. It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint. Whenever possible, clients should limit the search to the appropriate type. @@ -45,7 +45,7 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu + Default: `3` + Response 200 (application/xml) - +```xml +``` \ No newline at end of file diff --git a/docs/legacy/plex/Library/Sections.md b/docs/legacy/plex/Library/Sections.md index 593a6eb..4319bb7 100644 --- a/docs/legacy/plex/Library/Sections.md +++ b/docs/legacy/plex/Library/Sections.md @@ -32,7 +32,7 @@ Returns details for the library. This can be thought of as an interstitial endpo + Default: `0` + Response 200 (application/xml) - +```xml @@ -75,3 +75,4 @@ Returns details for the library. This can be thought of as an interstitial endpo +``` \ No newline at end of file diff --git a/docs/legacy/plex/Media Feedback.md b/docs/legacy/plex/Media Feedback.md index c962d51..8b484f0 100644 --- a/docs/legacy/plex/Media Feedback.md +++ b/docs/legacy/plex/Media Feedback.md @@ -48,13 +48,17 @@ Additional child elements include: + Body Normal response: + ```xml + ``` Admin terminated session: +```xml - +``` Bandwidth changes included: - +```xml + @@ -70,6 +74,7 @@ Additional child elements include: +``` ### Marking items watched [GET /:/scrobble{?key,uri,identifier}] diff --git a/docs/legacy/plex/Media Providers/DVR.md b/docs/legacy/plex/Media Providers/DVR.md index 8f8baae..61fbbf3 100644 --- a/docs/legacy/plex/Media Providers/DVR.md +++ b/docs/legacy/plex/Media Providers/DVR.md @@ -15,14 +15,14 @@ Once you have configured devices and picked a lineup, you can create a DVR. + Response 200 (application/xml) - + " - + " ### Get a single DVR [GET /livetv/dvrs/{dvr}] @@ -31,9 +31,9 @@ Once you have configured devices and picked a lineup, you can create a DVR. + Response 200 (application/xml) - + " - + " ### Delete a DVR [DELETE /livetv/dvrs/{dvr}] @@ -50,9 +50,9 @@ Once you have configured devices and picked a lineup, you can create a DVR. + Response 200 (application/xml) - + " - + " ### Remove a device from an existing DVR [DELETE /livetv/dvrs/{dvr}/devices/{device}"] @@ -62,9 +62,9 @@ Once you have configured devices and picked a lineup, you can create a DVR. + Response 200 (application/xml) - + " - + " ### Set DVR preferences [PUT /livetv/dvrs/{dvr}/prefs{?name}] @@ -74,13 +74,13 @@ Once you have configured devices and picked a lineup, you can create a DVR. + Response 200 (application/xml) - + " - + " ### Tell a DVR to reload program guide [POST /livetv/dvrs/{dvr}/reloadGuide] diff --git a/docs/legacy/plex/Media Providers/Devices.md b/docs/legacy/plex/Media Providers/Devices.md index 6dde842..27eaab3 100644 --- a/docs/legacy/plex/Media Providers/Devices.md +++ b/docs/legacy/plex/Media Providers/Devices.md @@ -7,7 +7,7 @@ + Response 200 (application/xml) - + " @@ -15,7 +15,7 @@ - + " ### Enable or disable a device [PUT /media/grabbers/devices/{device}{?enabled}] @@ -25,7 +25,7 @@ + Response 200 (application/xml) - + "" ### Set device preferences [PUT /media/grabbers/devices/{device}/prefs{?name}] @@ -42,10 +42,10 @@ + Response 200 (application/xml) - + " - + " ### Set a device's channel mapping [PUT /media/grabbers/devices/{device}/channelmap{?channelMapping,channelsEnabled}] @@ -57,7 +57,7 @@ + Response 200 (application/xml) - + "" ### Tell a device to scan for channels [POST /media/grabbers/devices/{device}/scan{?source}] @@ -73,7 +73,7 @@ + Body - + "" ### Tell a device to stop scanning for channels [DELETE /media/grabbers/devices/{device}/scan] @@ -82,4 +82,4 @@ + Response 200 (application/xml) - + "" diff --git a/docs/legacy/plex/Media Providers/EPG.md b/docs/legacy/plex/Media Providers/EPG.md index a50625c..ec25888 100644 --- a/docs/legacy/plex/Media Providers/EPG.md +++ b/docs/legacy/plex/Media Providers/EPG.md @@ -12,11 +12,11 @@ This endpoint returns a list of countries which EPG data is available for. There + Response 200 (application/xml) - + " - + " ### Get all languages [GET /livetv/epg/languages] @@ -24,11 +24,11 @@ Returns a list of all possible languages for EPG data. + Response 200 (application/xml) - + " - + " ### Get regions for a country [GET /livetv/epg/countries/{country}/{epgIdentifier}/regions] @@ -38,10 +38,10 @@ Returns a list of all possible languages for EPG data. + Response 200 (application/xml) - + " - + " ### Get lineups for a region [GET /livetv/epg/countries/{country}/{epgIdentifier}/regions/{region}/lineups{?country,region}] @@ -60,9 +60,9 @@ Returns the list of lineups for a given country, EPG provider, and region. There + Response 200 (application/xml) - + " - + " ### Get lineups for a country via postal code [GET /livetv/epg/countries/{country}/{epgIdentifier}/lineups{?postalCode}] @@ -75,11 +75,11 @@ Returns a list of lineups for a given country, EPG provider and postal code. + Response 200 (application/xml) - + " - + " ### Get channels for a lineup [GET /livetv/epg/channels{?lineup}] @@ -88,10 +88,10 @@ Returns a list of lineups for a given country, EPG provider and postal code. + Response 200 (application/xml) - + " - + " ### Compute the best channel map, given device and lineup [GET /livetv/epg/channelmap{?device,lineup}] @@ -101,9 +101,9 @@ Returns a list of lineups for a given country, EPG provider and postal code. + Response 200 (application/xml) - + " - + " ### Compute the best lineup, given lineup group and device [GET /livetv/epg/lineup{?device,lineupGroup}] @@ -119,5 +119,5 @@ Returns a list of lineups for a given country, EPG provider and postal code. + Body - + "" diff --git a/docs/legacy/plex/Media Providers/Live.md b/docs/legacy/plex/Media Providers/Live.md index dafe337..4617dba 100644 --- a/docs/legacy/plex/Media Providers/Live.md +++ b/docs/legacy/plex/Media Providers/Live.md @@ -20,7 +20,7 @@ Note that when successfully started, the reply will also include an Activity hea + Response 200 (application/xml) - + " - + " ### Cancel an existing grab [DELETE /media/grabbers/operations/{uuid}] @@ -72,7 +72,7 @@ This endpoint cancels an existing media grab (recording). It can be used to reso + Response 200 (application/xml) - + " - + " ### Get particular session [GET /livetv/sessions/{session}] diff --git a/docs/legacy/plex/Media Providers/Media Grabbers.md b/docs/legacy/plex/Media Providers/Media Grabbers.md index 27ad3f7..78f05e5 100644 --- a/docs/legacy/plex/Media Providers/Media Grabbers.md +++ b/docs/legacy/plex/Media Providers/Media Grabbers.md @@ -9,29 +9,29 @@ Media grabbers provide ways for media to be obtained for a given protocol. The s + Response 200 (application/xml) - + " - + " ### Get all devices [GET /media/grabbers/devices] + Response 200 (application/xml) - + " - + " ### Tell grabbers to discover devices [POST /media/grabbers/devices/discover] + Response 200 (application/xml) - + " - + " ### Add a device [POST /media/grabbers/devices{?uri}] @@ -42,9 +42,9 @@ This endpoint adds a device to an existing grabber. The device is identified, an + Response 200 (application/xml) - + " - + " ### Remove a device [DELETE /media/grabbers/devices/{device}] @@ -53,7 +53,7 @@ This endpoint adds a device to an existing grabber. The device is identified, an + Response 200 (application/xml) - + "" + Response 404 @@ -67,7 +67,7 @@ This endpoint adds a device to an existing grabber. The device is identified, an + Response 200 (application/xml) - + " @@ -75,7 +75,7 @@ This endpoint adds a device to an existing grabber. The device is identified, an - + " ### Enable or disable a device [PUT /media/grabbers/devices/{device}{?enabled}] @@ -84,7 +84,7 @@ This endpoint adds a device to an existing grabber. The device is identified, an + Response 200 (application/xml) - + "" ### Get a device's channels [GET /media/grabbers/devices/{device}/channels] @@ -93,10 +93,10 @@ This endpoint adds a device to an existing grabber. The device is identified, an + Response 200 (application/xml) - + " - + " ### Get metadata item for tuned channel [GET /media/grabbers/devices/{device}/channels/{channel}] @@ -108,7 +108,7 @@ This endpoint can be used with the transcoder start and decision endpoints. + Response 200 (application/xml) - + " - + " + Response 404: Channel not currently tuned @@ -141,7 +141,7 @@ This endpoint can be used with the transcoder start and decision endpoints. + Response 200 (application/xml) - + "" ### Tell a device to scan for channels [POST /media/grabbers/devices/{device}/scan{?source}] @@ -157,7 +157,7 @@ This endpoint can be used with the transcoder start and decision endpoints. + Body - + "" ### Tell a device to stop scanning for channels [DELETE /media/grabbers/devices/{device}/scan] @@ -166,4 +166,4 @@ This endpoint can be used with the transcoder start and decision endpoints. + Response 200 (application/xml) - + "" diff --git a/docs/legacy/plex/Media Providers/Media Subscriptions.md b/docs/legacy/plex/Media Providers/Media Subscriptions.md index d7edfeb..e54d794 100644 --- a/docs/legacy/plex/Media Providers/Media Subscriptions.md +++ b/docs/legacy/plex/Media Providers/Media Subscriptions.md @@ -6,7 +6,7 @@ + type: `2` - The type of the thing we're subscribing too (e.g. show, season). + Response 200 (application/xml) - +```xml +``` ### Create a subscription [POST /media/subscriptions/{?targetLibrarySectionID,targetSectionLocationID,type,hints,prefs}] @@ -30,7 +31,7 @@ + `params[source]=server://0123456789abcdef0123456789abcdef01234567/com.plexapp.plugins.library`: Required for downloads to indicate the source of the downloaded content. + Response 200 (application/xml) - +```xml @@ -50,20 +51,20 @@ - +``` ### Get all subscriptions [GET /media/subscriptions/{?includeGrabs}] + Parameters + includeGrabs: `1` (optional) - Whether or not to include all the scheduled grabs for each subcription. + Response 200 (application/xml) - +```xml - +``` ### Get a single subscription [GET /media/subscriptions/{subscription}{?includeGrabs}] + Parameters @@ -71,13 +72,13 @@ + includeGrabs: `1` (optional) - Whether or not to include all the scheduled grabs for each subcription. + Response 200 (application/xml) - +```xml - +``` ### Delete a subscription [DELETE /media/subscriptions/{subscription}] + Parameters @@ -91,17 +92,17 @@ + prefs: `prefs[minVideoQuality]=720` (array) - Subscription preferences. + Response 200 (application/xml) - +```xml - +``` ### Get all scheduled recordings [GET /media/subscriptions/scheduled] + Response 200 (application/xml) - +```xml - +``` ### Process all subscriptions [POST /media/subscriptions/process] + Response 200 diff --git a/docs/legacy/plex/Media Providers/Remote Media Grabbers.md b/docs/legacy/plex/Media Providers/Remote Media Grabbers.md index 835edee..7ec64ea 100644 --- a/docs/legacy/plex/Media Providers/Remote Media Grabbers.md +++ b/docs/legacy/plex/Media Providers/Remote Media Grabbers.md @@ -47,7 +47,7 @@ The response consists of a list of devices, with the following attributes: - `enumValues`: A pipe-separated list of options for the preference. Each option is a colon-separated entry with the form of `value:display-string`. + Response 200 (application/xml) - +```xml - +``` ### Device Probe [POST /devices/probe{?uri}] Probes a specific URI for a network device, and returns a device, if it exists at the given URI. @@ -67,11 +67,11 @@ Probes a specific URI for a network device, and returns a device, if it exists a + uri: http://10.0.0.100:10000 (string) - URI for the device. Can be either HTTP or HTTPS. + Response 200 (application/xml) - +```xml - +``` ### Get identity and capabilities [GET /devices/{devicekey}] Returns the identity, capabilities, and current status of the devices and each of its tuners. @@ -98,7 +98,7 @@ Returns the identity, capabilities, and current status of the devices and each o + devicekey: 12323213 (string, required) - key referring to tuner device, as originally reported in the `/devices/discover` endpoint. + Response 200 (application/xml) - +```xml - +``` ### Get a device's channels [GET /devices/{devicekey}/channels] Returns the current channels. This list is updated after a complete channel scan, and should not be assumed to persist beyond that. @@ -132,12 +132,12 @@ The response contains zero or more channels, with the following attributes: + devicekey: 12323213 (string, required) - key referring to tuner device, as originally reported in the `/devices/discover` endpoint. + Response 200 (application/xml) - +```xml - +``` ### Get channel scan providers [GET /devices/{devicekey}/scanners{?type}] Before scanning a device for channels, it must be queried to ascertain which type of scanners are supported. Each scanner may have custom configuration which is passed back in the form of preferences. These preferences must be shown the user, and the values round-tripped back when the scan is kicked off. The response includes one or more scanners, defined below. @@ -149,7 +149,7 @@ If the response's media container has `simultaneousScanners="1"`, this implies t + type: 5 (string, optional) - The filter on broadcast standard type, which can be: `0` (atsc), `1` (cqam), `2` (dvb-s), `3` (iptv), `4` (virtual), `5` (dvb-t), `6` (dvb-c), `7` (isdbt) + Response 200 (application/xml) - +```xml @@ -163,7 +163,7 @@ If the response's media container has `simultaneousScanners="1"`, this implies t - +``` #### Scanners Defines a scanner that can be used to search for channels. They will have the following attributes: @@ -185,12 +185,12 @@ In some cases, channel scanning is a two-step process, where the first stage con + devicekey: 12323213 (string, required) - key referring to tuner device, as originally reported in the `/devices/discover` endpoint. + Response 200 (application/xml) - +```xml - +``` ### Start a channel scan for network [POST /devices/{devicekey}/scan{?network,source,provider}] Starts a background channel scan. Updates are received via querying the device details endpoint (`/devices/x`). The response will have the following attributes: @@ -204,9 +204,9 @@ Starts a background channel scan. Updates are received via querying the device d + provider: 1 (integer) - the key of the scanner to use when scanning. + Response 200 (application/xml) - +```xml - +``` ### Cancel channel scan [DELETE /devices/{devicekey}/scan] Cancels an ongoing background channel scan. @@ -215,9 +215,9 @@ Cancels an ongoing background channel scan. + devicekey: 12323213 (string, required) - key referring to tuner device, as originally reported in the `/devices/discover` endpoint. + Response 200 (application/xml) - +```xml - +``` ### Stream media from a tuner [GET /devices/{devicekey}/media/{channel}{?param}] + Parameters @@ -244,7 +244,7 @@ These preferences are originally provided by the device in the `/devices/discove 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 - +```xml 1 @@ -269,7 +269,7 @@ Network tuners can present themselves on the network using the Simple Service Di - +``` + Parameters + 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. diff --git a/docs/legacy/plex/Security.md b/docs/legacy/plex/Security.md index 204ff99..14456cc 100644 --- a/docs/legacy/plex/Security.md +++ b/docs/legacy/plex/Security.md @@ -9,9 +9,9 @@ This endpoint provides the caller with a temporary token with the same access le + scope: `all` - This is the only supported `scope` parameter. + Response 200 (application/xml) - +```xml - +``` ### Get Source Connection Information [GET /security/resources{?source}] If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. @@ -22,7 +22,7 @@ Note: requires Plex Media Server >= 1.15.4. + source: `server://client-identifier` or `provider://provider-identifier` - The source identifier with an included prefix. + Response 200 (application/xml) - +```xml @@ -30,3 +30,4 @@ Note: requires Plex Media Server >= 1.15.4. +``` \ No newline at end of file diff --git a/docs/legacy/plex/Transcoder/Image Processing.md b/docs/legacy/plex/Transcoder/Image Processing.md deleted file mode 100644 index e69de29..0000000