TautulliSession class
Model for a single activity session in Tautulli.
- Annotations
-
- @JsonSerializable(explicitToJson: true)
Constructors
-
TautulliSession({int? sessionKey, TautulliMediaType? mediaType, int? viewOffset, int? progressPercent, String? qualityProfile, String? syncedVersionProfile, String? optimizedVersionProfile, String? user, int? channelStream, int? sectionId, String? libraryName, int? ratingKey, int? parentRatingKey, int? grandparentRatingKey, String? title, String? parentTitle, String? grandparentTitle, String? originalTitle, String? sortTitle, int? mediaIndex, int? parentMediaIndex, String? studio, String? contentRating, String? summary, String? tagline, double? rating, String? ratingImage, double? audienceRating, String? audienceRatingImage, double? userRating, Duration? duration, int? year, String? thumb, String? parentThumb, String? grandparentThumb, String? art, String? banner, String? originallyAvailableAt, DateTime? addedAt, DateTime? updatedAt, DateTime? lastViewedAt, String? guid, String? parentGuid, String? grandparentGuid, List<
String?> ? directors, List<String?> ? actors, List<String?> ? writers, List<String?> ? genres, List<String?> ? labels, List<String?> ? collections, String? fullTitle, int? childrenCount, bool? live, int? id, String? container, int? bitrate, int? height, int? width, double? aspectRatio, String? videoCodec, String? videoResolution, String? videoFullResolution, String? videoFramerate, String? videoProfile, String? audioCodec, int? audioChannels, String? audioChannelLayout, String? audioProfile, bool? optimizedVersion, String? channelCallSign, String? channelIdentifier, String? channelThumb, String? file, int? fileSize, bool? indexes, bool? selected, int? type, String? videoCodecLevel, int? videoBitrate, int? videoBitDepth, String? videoChromaSubsampling, String? videoColorPrimaries, String? videoColorRange, String? videoColorSpace, String? videoColorTRC, double? videoFrameRate, int? videoRefFrames, int? videoHeight, int? videoWidth, String? videoLanguage, String? videoLanguageCode, String? videoDynamicRange, String? videoScanType, int? audioBitrate, String? audioBitrateMode, int? audioSampleRate, String? audioLanguage, String? audioLanguageCode, String? subtitleCodec, String? subtitleContainer, String? subtitleFormat, bool? subtitleForced, String? subtitleLanguage, String? subtitleLanguageCode, String? subtitleLocation, int? rowId, int? userId, String? username, String? friendlyName, String? userThumb, String? email, bool? isActive, bool? isAdmin, bool? isHomeUser, bool? isAllowSync, bool? isRestricted, bool? doNotify, bool? keepHistory, bool? deletedUser, bool? allowGuest, String? ipAddress, String? ipAddressPublic, String? device, String? platform, String? platformName, String? platformVersion, String? product, String? productVersion, String? profile, String? player, String? machineId, TautulliSessionState? state, bool? local, bool? relayed, bool? secure, String? sessionId, int? bandwidth, TautulliSessionLocation? location, String? transcodeKey, bool? transcodeThrottled, int? transcodeProgress, double? transcodeSpeed, int? transcodeAudioChannels, String? transcodeAudioCodec, String? transcodeVideoCodec, int? transcodeWidth, int? transcodeHeight, String? transcodeContainer, String? transcodeProtocol, bool? transcodeHardwareRequested, String? transcodeHardwareDecode, String? transcodeHardwareDecodeTitle, String? transcodeHardwarEencode, String? transcodeHardwarEencodeTitle, bool? transcodeHardwareFullPipeline, TautulliTranscodeDecision? audioDecision, TautulliTranscodeDecision? videoDecision, TautulliTranscodeDecision? subtitleDecision, bool? throttled, bool? transcodeHardwareDecoding, bool? transcodeHardwareEncoding, String? streamContainer, int? streamBitrate, double? streamAspectRatio, String? streamAudioCodec, int? streamAudioChannels, String? streamAudioChannelLayout, String? streamAudioChannelLayout_, String? streamVideoCodec, String? streamVideoFramerate, String? streamVideoResolution, int? streamVideoHeight, int? streamVideoWidth, Duration? streamDuration, TautulliTranscodeDecision? streamContainerDecision, String? optimizedVersionTitle, bool? syncedVersion, String? liveUuid, String? bifThumb, TautulliTranscodeDecision? transcodeDecision, bool? subtitles, String? streamVideoFullResolution, String? streamVideoDynamicRange, int? streamVideoBitDepth, int? streamVideoBitrate, String? streamVideoChromaSubsampling, String? streamVideoCodecLevel, String? streamVideoColorPrimaries, String? streamVideoColorRange, String? streamVideoColorSpace, String? streamVideoColorTRC, int? streamVideoRefFrames, TautulliTranscodeDecision? streamVideoDecision, String? streamVideoLanguage, String? streamVideoLanguageCode, String? streamVideoScanType, int? streamAudioBitrate, String? streamAudioBitrateMode, TautulliTranscodeDecision? streamAudioDecision, String? streamAudioLanguage, String? streamAudioLanguageCode, int? streamAudioSampleRate, String? streamSubtitleCodec, String? streamSubtitleContainer, TautulliTranscodeDecision? streamSubtitleDecision, bool? streamSubtitleForced, String? streamSubtitleFormat, String? streamSubtitleLanguage, String? streamSubtitleLanguageCode, String? streamSubtitleLocation, bool? streamSubtitleTransient}) -
TautulliSession.fromJson(Map<
String, dynamic> json) -
Deserialize a JSON map to a TautulliSession object.
factory
Properties
-
actors
→ List<
String?> ? -
List of actors's names who acted in the content.
final
- addedAt → DateTime?
-
The date on which the content was added to Plex.
This is typically read/stored as the file creation date within Plex.
final
- allowGuest → bool?
-
Does the user have guest access to Tautulli?
final
- art → String?
-
Artwork path for the content.
final
- aspectRatio → double?
-
Aspect ratio of the content.
final
- audienceRating → double?
-
The audience rating of the content.
final
- audienceRatingImage → String?
-
Link to an image for the audience rating.
final
- audioBitrate → int?
-
Bitrate of the audio stream.
final
- audioBitrateMode → String?
-
Bitrate mode of the audio stream.
final
- audioChannelLayout → String?
-
The layout of the channels in the audio stream.
final
- audioChannels → int?
-
Number of channels in the audio stream.
final
- audioCodec → String?
-
Codec of the audio stream.
final
- audioDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the audio stream.
final
- audioLanguage → String?
-
Language of the audio stream.
final
- audioLanguageCode → String?
-
Language code of the audio stream.
final
- audioProfile → String?
-
Profile of the audio stream.
final
- audioSampleRate → int?
-
Sample rate of the audio stream.
final
- bandwidth → int?
-
The total bandwidth usage of the session.
final
-
Banner path for the content.
final
- bifThumb → String?
-
Location of the content's BIF thumbnail
final
- bitrate → int?
-
Bitrate of the content.
final
- channelCallSign → String?
-
The channel's callsign for live content.
final
- channelIdentifier → String?
-
The channel's identifier for live content.
final
- channelStream → int?
-
Unknown: Likely related to live TV streams.
final
- channelThumb → String?
-
The channel's thumbnail for live content.
final
- childrenCount → int?
-
The amount of children this content has.
final
-
collections
→ List<
String?> ? -
List of collections the content is apart of on Plex.
final
- container → String?
-
The media container type of the content.
final
- contentRating → String?
-
The content rating for the content.
final
- deletedUser → bool?
-
Is the user deleted?
final
- device → String?
-
Streaming device name.
final
-
directors
→ List<
String?> ? -
List of director's names who directed the content.
final
- doNotify → bool?
-
Does the user get notified?
final
- duration → Duration?
-
Duration of the content.
final
- email → String?
-
Email of the streaming user.
final
- file → String?
-
The path to the file on your system.
final
- fileSize → int?
-
The size of the file, in bytes.
final
- friendlyName → String?
-
Friendly name of the streaming user.
final
- fullTitle → String?
-
The full title of the content.
final
-
genres
→ List<
String?> ? -
List of genres of the content.
final
- grandparentGuid → String?
-
The globally unique identifier for the content's grandparent.
final
- grandparentRatingKey → int?
-
The content's grandparent's unique ID from Plex.
final
- grandparentThumb → String?
-
Thumbnail path for the content's grandparent.
final
- grandparentTitle → String?
-
Title of the grandparent of the content.
final
- guid → String?
-
The globally unique identifier for the content.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → int?
-
Height in pixels.
final
- id → int?
-
The ID of the content.
final
- indexes → bool?
-
Does the file have generated index files?
final
- ipAddress → String?
-
IP address of the streaming device.
final
- ipAddressPublic → String?
-
Public IP address of the streaming device.
final
- isActive → bool?
-
Is the user active?
final
- isAdmin → bool?
-
Is the user an admin?
final
- isAllowSync → bool?
-
Is the user allowed to sync content?
final
- isHomeUser → bool?
-
Is the user a home user?
final
- isRestricted → bool?
-
Is the user restricted?
final
- keepHistory → bool?
-
Is history enabled for the user?
final
-
labels
→ List<
String?> ? -
List of labels that have been attached on Plex.
final
- lastViewedAt → DateTime?
-
The date on which the content was last viewed on Plex.
final
- libraryName → String?
-
Name of the Plex library that the content belongs to.
final
- live → bool?
-
Is this session live content?
final
- liveUuid → String?
-
UUID of the live stream session.
final
- local → bool?
-
Is it a local stream?
final
- location → TautulliSessionLocation?
-
Location of the stream session (LAN or WAN).
final
- machineId → String?
-
Unique machine identifier key.
final
- mediaIndex → int?
-
The index of the content with respect to its parent (for example, track number in an album).
final
- mediaType → TautulliMediaType?
-
Type of media in this session.
final
- optimizedVersion → bool?
-
Is this session using an optimized version?
final
- optimizedVersionProfile → String?
-
Quality of the optimized version of the content.
final
- optimizedVersionTitle → String?
-
Optimized version title.
final
- originallyAvailableAt → String?
-
The date on which the content was originally available on.
final
- originalTitle → String?
-
The original title of the content.
final
- parentGuid → String?
-
The globally unique identifier for the content's parent.
final
- parentMediaIndex → int?
-
The index of the parent of the content.
final
- parentRatingKey → int?
-
The content's parent's unique ID from Plex.
final
- parentThumb → String?
-
Thumbnail path for the content's parent.
final
- parentTitle → String?
-
Title of the parent of the content.
final
- platform → String?
-
Platform of the streaming device.
final
- platformName → String?
-
Name of the streaming device.
final
- platformVersion → String?
-
Version of the streaming device.
final
- player → String?
-
Name of the streaming device/player.
final
- product → String?
-
Plex product name on the streaming device.
final
- productVersion → String?
-
Plex product version on the streaming device.
final
- profile → String?
-
Plex profile on the streaming device.
final
- progressPercent → int?
-
How much of the content has been played.
final
- qualityProfile → String?
-
Quality profile of the stream.
final
- rating → double?
-
The critic rating of the content.
final
- ratingImage → String?
-
Link to an image for the critic rating.
final
- ratingKey → int?
-
The content's unique ID from Plex.
final
- relayed → bool?
-
Is it a relayed stream?
final
- rowId → int?
-
Row identifier of the streaming user.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sectionId → int?
-
Plex section ID the content belongs to.
final
- secure → bool?
-
Is it a secure stream?
final
- selected → bool?
-
Unknown
final
- sessionId → String?
-
Session ID of the stream.
final
- sessionKey → int?
-
Session's key/identifier.
final
-
List of libraries that are shared with this user.
final
- sortTitle → String?
-
The sort title of the content (if different from the title).
final
- state → TautulliSessionState?
-
Current state of the session.
final
- streamAspectRatio → double?
-
Aspect ratio of the final video stream.
final
- streamAudioBitrate → int?
-
Bitrate of the final audio stream.
final
- streamAudioBitrateMode → String?
-
Bitrate mode of the final audio stream.
final
- streamAudioChannelLayout → String?
-
The layout of the channels in the final audio stream.
final
- streamAudioChannelLayout_ → String?
-
The layout of the channels in the final audio stream. Unsure how this is different from streamAudioChannelLayout.
final
- streamAudioChannels → int?
-
Number of channels in the final audio stream.
final
- streamAudioCodec → String?
-
Codec of the final audio stream.
final
- streamAudioDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the final video stream.
final
- streamAudioLanguage → String?
-
Language of the final audio stream.
final
- streamAudioLanguageCode → String?
-
Language code of the final audio stream.
final
- streamAudioSampleRate → int?
-
Sample rate of the final audio stream.
final
- streamBitrate → int?
-
Bitrate of the final stream.
final
- streamContainer → String?
-
Container used for the final stream.
final
- streamContainerDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the final container of the stream.
final
- streamDuration → Duration?
-
Duration of the final stream.
final
- streamSubtitleCodec → String?
-
Codec of the final subtitle stream.
final
- streamSubtitleContainer → String?
-
Container of the final subtitle stream.
final
- streamSubtitleDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the final subtitle stream.
final
- streamSubtitleForced → bool?
-
Is the final subtitle stream forced?
final
- streamSubtitleFormat → String?
-
Format of the final subtitle stream.
final
- streamSubtitleLanguage → String?
-
Language of the final subtitle stream.
final
- streamSubtitleLanguageCode → String?
-
Language code of the final subtitle stream.
final
- streamSubtitleLocation → String?
-
Location of the final subtitle stream.
final
- streamSubtitleTransient → bool?
-
Is the final subtitle stream transient?
final
- streamVideoBitDepth → int?
-
Bit depth of the final video stream.
final
- streamVideoBitrate → int?
-
Bitrate of the final video stream.
final
- streamVideoChromaSubsampling → String?
-
Chroma subsampling of the final video stream.
final
- streamVideoCodec → String?
-
Codec of the final video stream.
final
- streamVideoCodecLevel → String?
-
Codec level of the final video stream.
final
- streamVideoColorPrimaries → String?
-
Color primaries of the final video stream.
final
- streamVideoColorRange → String?
-
Color range of the final video stream.
final
- streamVideoColorSpace → String?
-
Color space of the final video stream.
final
- streamVideoColorTRC → String?
-
Color TRC of the final video stream.
final
- streamVideoDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the final video stream.
final
- streamVideoDynamicRange → String?
-
Dynamic range of the final video stream.
final
- streamVideoFramerate → String?
-
Framerate of the final video stream.
final
- streamVideoFullResolution → String?
-
Full resoltuion of the final video stream.
final
- streamVideoHeight → int?
-
Height in pixels of the final video stream.
final
- streamVideoLanguage → String?
-
Language of the final video stream.
final
- streamVideoLanguageCode → String?
-
Language code of the final video stream.
final
- streamVideoRefFrames → int?
-
Reference frames in the final video stream.
final
- streamVideoResolution → String?
-
Resolution of the final video stream.
final
- streamVideoScanType → String?
-
Scan type of the final video stream.
final
- streamVideoWidth → int?
-
Width in pixels of the final video stream.
final
- studio → String?
-
The studio that made the content.
final
- subtitleCodec → String?
-
Codec of the subtitle stream.
final
- subtitleContainer → String?
-
Container of the subtitle stream.
final
- subtitleDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the subtitle stream.
final
- subtitleForced → bool?
-
Is the subtitle stream forced?
final
- subtitleFormat → String?
-
Format of the subtitle stream.
final
- subtitleLanguage → String?
-
Language of the subtitle stream.
final
- subtitleLanguageCode → String?
-
Language code of the subtitle stream.
final
- subtitleLocation → String?
-
Location of the subtitle stream.
final
- subtitles → bool?
-
Are subtitles being used for this session?
final
- summary → String?
-
The summary of the content.
final
- syncedVersion → bool?
-
Is the stream a synced version of the content?
final
- syncedVersionProfile → String?
-
Quality of the synced version of the content.
final
- tagline → String?
-
The tagline of the content.
final
- throttled → bool?
-
Is the transcoder throttled?
final
- thumb → String?
-
Thumbnail path for the content.
final
- title → String?
-
Title of the content.
final
- transcodeAudioChannels → int?
-
Number of audio channels in the transcode stream.
final
- transcodeAudioCodec → String?
-
Audio codec of the transcode stream.
final
- transcodeContainer → String?
-
Container used for the transcode stream.
final
- transcodeDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the content.
final
- transcodeHardwareDecode → String?
-
Hardware decode of the transcode stream.
final
- transcodeHardwareDecodeTitle → String?
-
Hardware decode title of the transcode stream.
final
- transcodeHardwareDecoding → bool?
-
Is the transcoder using hardware acceleration for decoding?
final
- transcodeHardwarEencode → String?
-
Hardware encode of the transcode stream.
final
- transcodeHardwarEencodeTitle → String?
-
Hardware encode title of the transcode stream.
final
- transcodeHardwareEncoding → bool?
-
Is the transcoder using hardware acceleration for encoding?
final
- transcodeHardwareFullPipeline → bool?
-
Is the transcoder using hardware acceleration for the full pipeline?
final
- transcodeHardwareRequested → bool?
-
Did the transcoder request hardware acceleration?
final
- transcodeHeight → int?
-
Height in pixels of the video in the transcode stream.
final
- transcodeKey → String?
-
Transcoder key/identifier for the session.
final
- transcodeProgress → int?
-
Progress of the transcoder for the session.
final
- transcodeProtocol → String?
-
Protocol used to transmit the transcode stream.
final
- transcodeSpeed → double?
-
Transcoder speed for the session.
final
- transcodeThrottled → bool?
-
Is the transcoder throttled?
final
- transcodeVideoCodec → String?
-
Video codec of the transcode stream.
final
- transcodeWidth → int?
-
Width in pixels of the video in the transcode stream.
final
- type → int?
-
Unknown
final
- updatedAt → DateTime?
-
The date on which the content was last updated on Plex.
final
- user → String?
-
The user streaming the content.
final
- userId → int?
-
User identifier of the streaming user.
final
- username → String?
-
Username of the streaming user.
final
- userRating → double?
-
The user rating of the content.
final
- userThumb → String?
-
Thumbnail link of the streaming user.
final
- videoBitDepth → int?
-
Bit depth of the video stream.
final
- videoBitrate → int?
-
Bitrate of the video stream.
final
- videoChromaSubsampling → String?
-
Chroma subsampling of the video stream.
final
- videoCodec → String?
-
Codec of the video stream.
final
- videoCodecLevel → String?
-
Codec level of the video stream.
final
- videoColorPrimaries → String?
-
Color primaries of the video stream.
final
- videoColorRange → String?
-
Color range of the video stream.
final
- videoColorSpace → String?
-
Color space of the video stream.
final
- videoColorTRC → String?
-
Color TRC of the video stream.
final
- videoDecision → TautulliTranscodeDecision?
-
What decision was made on how to handle the video stream.
final
- videoDynamicRange → String?
-
Dynamic range of the video stream.
final
- videoFrameRate → double?
-
Frame rate of the video stream.
final
- videoFramerate → String?
-
Framerate of the video stream.
final
- videoFullResolution → String?
-
Full resoltuion of the video stream.
final
- videoHeight → int?
-
Height in pixels of the video stream.
final
- videoLanguage → String?
-
Language of the video stream.
final
- videoLanguageCode → String?
-
Language code of the video stream.
final
- videoProfile → String?
-
Profile of the video stream.
final
- videoRefFrames → int?
-
Reference frames in the video stream.
final
- videoResolution → String?
-
Resolution of the video stream.
final
- videoScanType → String?
-
Scan type of the video stream.
final
- videoWidth → int?
-
Width in pixels of the video stream.
final
- viewOffset → int?
-
Unknown: Somehow related to the progress percentage.
final
- width → int?
-
Width in pixels.
final
-
writers
→ List<
String?> ? -
List of writer's names who wrote the content.
final
- year → int?
-
Year the content was released.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Serialize a TautulliSession object to a JSON map.
-
toString(
) → String -
Returns a JSON-encoded string version of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited