plexjs/docs/models/shared/mediacontainerwithdecisionstream.md

MediaContainerWithDecisionStream

Stream represents a particular stream from a media item, such as the video stream, audio stream, or subtitle stream. The stream may either be part of the file represented by the parent Part or, especially for subtitles, an external file. The stream contains more detailed information about the specific stream. For example, a video may include the aspectRatio at the Media level, but detailed information about the video stream like the color space will be included on the Stream for the video stream. Note that photos do not have streams (mostly as an optimization).

Example Usage

import { MediaContainerWithDecisionStream } from "@lukehagar/plexjs/models/shared";

let value: MediaContainerWithDecisionStream = {
  default: true,
  audioChannelLayout: "5.1(side)",
  channels: 6,
  bitDepth: 10,
  doviblCompatID: 1,
  doviblPresent: true,
  dovielPresent: false,
  doviLevel: 6,
  doviPresent: true,
  doviProfile: 8,
  dovirpuPresent: true,
  doviVersion: "1.0",
  bitrate: 24743,
  canAutoSync: false,
  chromaLocation: "topleft",
  chromaSubsampling: "4:2:0",
  codedHeight: 1608,
  codedWidth: 3840,
  closedCaptions: true,
  codec: "hevc",
  colorPrimaries: "bt2020",
  colorRange: "tv",
  colorSpace: "bt2020nc",
  colorTrc: "smpte2084",
  displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
  extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
  frameRate: 23.976,
  hasScalingMatrix: false,
  height: 1602,
  id: 1002625,
  index: 0,
  key: "/library/streams/216389",
  language: "English",
  languageCode: "eng",
  languageTag: "en",
  format: "srt",
  headerCompression: true,
  level: 150,
  original: true,
  profile: "main 10",
  refFrames: 1,
  samplingRate: 48000,
  scanType: "progressive",
  embeddedInVideo: "progressive",
  selected: true,
  forced: true,
  hearingImpaired: true,
  dub: true,
  title: "SDH",
  streamIdentifier: 1,
  width: 3840,
};

Fields

Field	Type	Required	Description	Example
default	boolean	➖	Indicates if this stream is default.	true
audioChannelLayout	string	➖	Audio channel layout.	5.1(side)
channels	number	➖	Number of audio channels (for audio streams).	6
bitDepth	number	➖	Bit depth of the video stream.	10
doviblCompatID	number	➖	Dolby Vision BL compatibility ID.	1
doviblPresent	boolean	➖	Indicates if Dolby Vision BL is present.	true
dovielPresent	boolean	➖	Indicates if Dolby Vision EL is present.	false
doviLevel	number	➖	Dolby Vision level.	6
doviPresent	boolean	➖	Indicates if Dolby Vision is present.	true
doviProfile	number	➖	Dolby Vision profile.	8
dovirpuPresent	boolean	➖	Indicates if Dolby Vision RPU is present.	true
doviVersion	string	➖	Dolby Vision version.	1.0
bitrate	number	➖	Bitrate of the stream.	24743
canAutoSync	boolean	➖	Indicates if the stream can auto-sync.	false
chromaLocation	string	➖	Chroma sample location.	topleft
chromaSubsampling	string	➖	Chroma subsampling format.	4:2:0
codedHeight	number	➖	Coded video height.	1608
codedWidth	number	➖	Coded video width.	3840
closedCaptions	boolean	➖	N/A	true
codec	string	✔️	Codec used by the stream.	hevc
colorPrimaries	string	➖	Color primaries used.	bt2020
colorRange	string	➖	Color range (e.g., tv).	tv
colorSpace	string	➖	Color space.	bt2020nc
colorTrc	string	➖	Color transfer characteristics.	smpte2084
displayTitle	string	✔️	Display title for the stream.	4K DoVi/HDR10 (HEVC Main 10)
extendedDisplayTitle	string	➖	Extended display title for the stream.	4K DoVi/HDR10 (HEVC Main 10)
frameRate	number	➖	Frame rate of the stream.	23.976
hasScalingMatrix	boolean	➖	N/A	false
height	number	➖	Height of the video stream.	1602
id	number	✔️	Unique stream identifier.	1002625
index	number	➖	Index of the stream.	0
key	string	✔️	Key to access this stream part.	/library/streams/216389
language	string	➖	Language of the stream.	English
languageCode	string	➖	ISO language code.	eng
languageTag	string	➖	Language tag (e.g., en).	en
format	string	➖	Format of the stream (e.g., srt).	srt
headerCompression	boolean	➖	Indicates whether header compression is enabled.	true
level	number	➖	Video level.	150
original	boolean	➖	Indicates if this is the original stream.	true
profile	string	➖	Video profile.	main 10
refFrames	number	➖	Number of reference frames.	1
samplingRate	number	➖	Sampling rate for the audio stream.	48000
scanType	string	➖	N/A	progressive
embeddedInVideo	string	➖	N/A	progressive
selected	boolean	➖	Indicates if this stream is selected (applicable for audio streams).	true
forced	boolean	➖	N/A	true
hearingImpaired	boolean	➖	Indicates if the stream is for the hearing impaired.	true
dub	boolean	➖	Indicates if the stream is a dub.	true
title	string	➖	Optional title for the stream (e.g., language variant).	SDH
streamIdentifier	number	➖	N/A	1
streamType	number	✔️	Stream type: - VIDEO = 1 - AUDIO = 2 - SUBTITLE = 3
width	number	➖	Width of the video stream.	3840
decision	shared.StreamDecision	➖	N/A
location	shared.MediaContainerWithDecisionLocation	➖	N/A
additionalProperties	Record<string, any>	➖	N/A