plexcsharp/docs/sdks/content/README.md

Content

(Content)

Overview

The actual content of the media provider

Available Operations

• GetCollectionItems - Get items in a collection
• GetMetadataItem - Get a metadata item
• GetAlbums - Set section albums
• ListContent - Get items in the section
• GetAllLeaves - Set section leaves
• GetArts - Set section artwork
• GetCategories - Set section categories
• GetCluster - Set section clusters
• GetSonicPath - Similar tracks to transition from one to another
• GetFolders - Get all folder locations
• ListMoments - Set section moments
• GetSonicallySimilar - The nearest audio tracks
• GetCollectionImage - Get a collection's image

GetCollectionItems

Get items in a collection. Note if this collection contains more than 100 items, paging must be used.

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetCollectionItemsRequest req = new GetCollectionItemsRequest() {
    CollectionId = 314585,
};

var res = await sdk.Content.GetCollectionItemsAsync(req);

// handle response

Parameters

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

Response

GetCollectionItemsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetMetadataItem

Get one or more metadata items.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using System.Collections.Generic;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetMetadataItemRequest req = new GetMetadataItemRequest() {
    Ids = new List<string>() {},
    AsyncCheckFiles = BoolInt.True,
    AsyncRefreshLocalMediaAgent = BoolInt.True,
    AsyncRefreshAnalysis = BoolInt.True,
    CheckFiles = BoolInt.True,
    SkipRefresh = BoolInt.True,
    CheckFileAvailability = BoolInt.True,
    AsyncAugmentMetadata = BoolInt.True,
    AugmentCount = BoolInt.True,
};

var res = await sdk.Content.GetMetadataItemAsync(req);

// handle response

Parameters

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

Response

GetMetadataItemResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetAlbums

Get all albums in a music section

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetAlbumsRequest req = new GetAlbumsRequest() {
    SectionId = 817133,
};

var res = await sdk.Content.GetAlbumsAsync(req);

// handle response

Parameters

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

Response

GetAlbumsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

ListContent

Get the items in a section, potentially filtering them

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

ListContentRequest req = new ListContentRequest() {
    MediaQuery = new MediaQuery() {
        Type = MediaType.Episode,
        SourceType = 2,
        Sort = "duration:desc,index",
    },
    IncludeMeta = BoolInt.True,
    IncludeGuids = BoolInt.True,
    SectionId = "<id>",
};

var res = await sdk.Content.ListContentAsync(req);

// handle response

Parameters

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

Response

ListContentResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetAllLeaves

Get all leaves in a section (such as episodes in a show section)

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetAllLeavesRequest req = new GetAllLeavesRequest() {
    SectionId = 633197,
};

var res = await sdk.Content.GetAllLeavesAsync(req);

// handle response

Parameters

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

Response

GetAllLeavesResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetArts

Get artwork for a library section

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetArtsRequest req = new GetArtsRequest() {
    SectionId = 859200,
};

var res = await sdk.Content.GetArtsAsync(req);

// handle response

Parameters

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

Response

GetArtsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetCategories

Get categories in a library section

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetCategoriesRequest req = new GetCategoriesRequest() {
    SectionId = 21841,
};

var res = await sdk.Content.GetCategoriesAsync(req);

// handle response

Parameters

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

Response

GetCategoriesResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetCluster

Get clusters in a library section (typically for photos)

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetClusterRequest req = new GetClusterRequest() {
    SectionId = 138560,
};

var res = await sdk.Content.GetClusterAsync(req);

// handle response

Parameters

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

Response

GetClusterResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetSonicPath

Get a list of audio tracks starting at one and ending at another which are similar across the path

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetSonicPathRequest req = new GetSonicPathRequest() {
    SectionId = 914549,
    StartID = 629990,
    EndID = 687740,
};

var res = await sdk.Content.GetSonicPathAsync(req);

// handle response

Parameters

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

Response

GetSonicPathResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetFolders

Get all folder locations of the media in a section

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetFoldersRequest req = new GetFoldersRequest() {
    SectionId = 892532,
};

var res = await sdk.Content.GetFoldersAsync(req);

// handle response

Parameters

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

Response

GetFoldersResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

ListMoments

Get moments in a library section (typically for photos)

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

ListMomentsRequest req = new ListMomentsRequest() {
    SectionId = 403239,
};

var res = await sdk.Content.ListMomentsAsync(req);

// handle response

Parameters

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

Response

ListMomentsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetSonicallySimilar

Get the nearest audio tracks to a particular analysis

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using System.Collections.Generic;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetSonicallySimilarRequest req = new GetSonicallySimilarRequest() {
    SectionId = 525956,
    Values = new List<long>() {},
};

var res = await sdk.Content.GetSonicallySimilarAsync(req);

// handle response

Parameters

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

Response

GetSonicallySimilarResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetCollectionImage

Get an image for the collection based on the items within

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetCollectionImageRequest req = new GetCollectionImageRequest() {
    CollectionId = 474227,
    UpdatedAt = 759379,
};

var res = await sdk.Content.GetCollectionImageAsync(req);

// handle response

Parameters

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

Response

GetCollectionImageResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*