Skip to content

Latest commit

 

History

History
151 lines (98 loc) · 12.6 KB

README.md

File metadata and controls

151 lines (98 loc) · 12.6 KB

Sessions

(Sessions)

Overview

API Calls that perform search operations with Plex Media Server Sessions

Available Operations

GetSessions

This will retrieve the "Now Playing" Information of the PMS.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Sessions.GetSessionsAsync();

// handle response

Response

GetSessionsResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionsBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionsUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*

GetSessionHistory

This will Retrieve a listing of all history views.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Sessions.GetSessionHistoryAsync(
    sort: "<value>",
    accountId: 1,
    filter: new QueryParamFilter() {},
    librarySectionID: 12
);

// handle response

Parameters

Parameter Type Required Description Example
Sort string ➖ Sorts the results by the specified field followed by the direction (asc, desc)
AccountId long ➖ Filter results by those that are related to a specific users id
 1
Filter QueryParamFilter ➖ Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
 {
"viewed-at-greater-than": {
"value": "viewedAt\u003e"
},
"viewed-at-greater-than-or-equal-to": {
"value": "viewedAt\u003e=\u003e"
},
"viewed-at-less-than": {
"value": "viewedAt\u003c"
}
}
LibrarySectionID long ➖ Filters the results based on the id of a valid library section
 12

Response

GetSessionHistoryResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionHistoryBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionHistoryUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*

GetTranscodeSessions

Get Transcode Sessions

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Sessions.GetTranscodeSessionsAsync();

// handle response

Response

GetTranscodeSessionsResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetTranscodeSessionsBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetTranscodeSessionsUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*

StopTranscodeSession

Stop a Transcode Session

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Sessions.StopTranscodeSessionAsync(sessionKey: "zz7llzqlx8w9vnrsbnwhbmep");

// handle response

Parameters

Parameter Type Required Description Example
SessionKey string ✔️ the Key of the transcode session to stop zz7llzqlx8w9vnrsbnwhbmep

Response

StopTranscodeSessionResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.StopTranscodeSessionBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.StopTranscodeSessionUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*