plexjs/docs/sdks/timeline

Timeline

(timeline)

Overview

The actions feature within a media provider

Available Operations

• markPlayed - Mark an item as played
• report - Report media timeline
• unscrobble - Mark an item as unplayed

markPlayed

Mark an item as played. Note, this does not create any view history of this item but rather just sets the state as played. The client must provide either the key or uri query parameter This API does respond to the GET verb but applications should use PUT

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";

const plexAPI = new PlexAPI({
  accepts: 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",
});

async function run() {
  const result = await plexAPI.timeline.markPlayed({
    identifier: "<value>",
    key: "59398",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { timelineMarkPlayed } from "@lukehagar/plexjs/funcs/timelineMarkPlayed.js";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
  accepts: 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",
});

async function run() {
  const res = await timelineMarkPlayed(plexAPI, {
    identifier: "<value>",
    key: "59398",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("timelineMarkPlayed failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.MarkPlayedRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.MarkPlayedResponse>

Errors

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

report

This endpoint is hit during media playback for an item. It must be hit whenever the play state changes, or in the absence of a play state change, in a regular fashion (generally this means every 10 seconds on a LAN/WAN, and every 20 seconds over cellular).

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";
import { ReportState } from "@lukehagar/plexjs/sdk/models/operations";
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";

const plexAPI = new PlexAPI({
  accepts: 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",
});

async function run() {
  const result = await plexAPI.timeline.report({
    key: "/foo",
    ratingKey: "xyz",
    state: ReportState.Playing,
    playQueueItemID: "123",
    time: 0,
    duration: 10000,
    continuing: BoolInt.One,
    updated: 14200000,
    offline: BoolInt.One,
    timeToFirstFrame: 1000,
    timeStalled: 1000,
    bandwidth: 100,
    bufferedTime: 100,
    bufferedSize: 1024,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { timelineReport } from "@lukehagar/plexjs/funcs/timelineReport.js";
import { ReportState } from "@lukehagar/plexjs/sdk/models/operations";
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
  accepts: 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",
});

async function run() {
  const res = await timelineReport(plexAPI, {
    key: "/foo",
    ratingKey: "xyz",
    state: ReportState.Playing,
    playQueueItemID: "123",
    time: 0,
    duration: 10000,
    continuing: BoolInt.One,
    updated: 14200000,
    offline: BoolInt.One,
    timeToFirstFrame: 1000,
    timeStalled: 1000,
    bandwidth: 100,
    bufferedTime: 100,
    bufferedSize: 1024,
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("timelineReport failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.ReportRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ReportResponse>

Errors

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

unscrobble

Mark an item as unplayed. The client must provide either the key or uri query parameter This API does respond to the GET verb but applications should use PUT

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";

const plexAPI = new PlexAPI({
  accepts: 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",
});

async function run() {
  const result = await plexAPI.timeline.unscrobble({
    identifier: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { timelineUnscrobble } from "@lukehagar/plexjs/funcs/timelineUnscrobble.js";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
  accepts: 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",
});

async function run() {
  const res = await timelineUnscrobble(plexAPI, {
    identifier: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("timelineUnscrobble failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.UnscrobbleRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.UnscrobbleResponse>

Errors

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