PlexSessionsApi class

/status/sessions and /status/sessions/history/* — "what's playing on the server right now" and "what was played in the past".

Sessions include both the user's own playback and any other concurrent client. Useful for showing a "now playing on server" dashboard, or to detect when the user is already streaming elsewhere before starting a new transcode.

Constructors

PlexSessionsApi(PlexConnection _http)

Construct from a PlexConnection. Typically obtained via PlexClient.sessions.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

active() → Future<List<PlexSession>>

All active playback sessions on the server.

deleteHistoryEntry(String historyKey) → Future<void>

Delete a single history entry by its history key.

history({int? accountId, int? mindate, int? maxdate, int? librarySectionId, int start = 0, int size = 50, String? sort}) → Future<List<Map<String, dynamic>>>

Past sessions (scrobble history).

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

terminate({required String sessionId, String reason = 'Stopped'}) → Future<void>

Forcibly stop a session. sessionId is the Session.id field (NOT the playback session= UUID).

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited