plexjs/docs/sdk/models/operations/reportrequest.md

ReportRequest

Example Usage

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

let value: ReportRequest = {
  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,
};

Fields

Field	Type	Required	Description	Example
xPlexClientIdentifier	string	➖	An opaque identifier unique to the client	abc123
xPlexProduct	string	➖	The name of the client product	Plex for Roku
xPlexVersion	string	➖	The version of the client application	2.4.1
xPlexPlatform	string	➖	The platform of the client	Roku
xPlexPlatformVersion	string	➖	The version of the platform	4.3 build 1057
xPlexDevice	string	➖	A relatively friendly name for the client device	Roku 3
xPlexModel	string	➖	A potentially less friendly identifier for the device model	4200X
xPlexDeviceVendor	string	➖	The device vendor	Roku
xPlexDeviceName	string	➖	A friendly name for the client	Living Room TV
xPlexMarketplace	string	➖	The marketplace on which the client application is distributed	googlePlay
key	string	➖	The details key for the item.	/foo
ratingKey	string	➖	The rating key attribute for the item.	xyz
state	operations.ReportState	➖	The current state of the media.	playing
playQueueItemID	string	➖	If playing media from a play queue, the play queue's ID.	123
time	number	➖	The current time offset of playback in ms.	0
duration	number	➖	The total duration of the item in ms.	10000
continuing	shared.BoolInt	➖	When state is stopped, a flag indicating whether or not the client is going to continue playing anothe item.	1
updated	number	➖	Used when a sync client comes online and is syncing media timelines, holds the time at which the playback state was last updated.	14200000
offline	shared.BoolInt	➖	Also used by sync clients, used to indicate that a timeline is being synced from being offline, as opposed to being "live".	1
timeToFirstFrame	number	➖	Time in seconds till first frame is displayed. Sent only on the first playing timeline request.	1000
timeStalled	number	➖	Time in seconds spent buffering since last request.	1000
bandwidth	number	➖	Bandwidth in kbps as estimated by the client.	100
bufferedTime	number	➖	Amount of time in seconds buffered by client. Omit if computed by bufferedSize below.	100
bufferedSize	number	➖	Size in kilobytes of data buffered by client. Omit if computed by bufferedTime above	1024
xPlexSessionIdentifier	string	➖	Unique per client playback session. Used if a client can playback multiple items at a time (such as a browser with multiple tabs)