plexcsharp/docs/Models/Components/Stream.md

Stream

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).

Fields

Field	Type	Required	Description	Example
Default	bool	➖	Indicates if this stream is default.	true
AudioChannelLayout	string	➖	Audio channel layout.	5.1(side)
Channels	int	➖	Number of audio channels (for audio streams).	6
BitDepth	int	➖	Bit depth of the video stream.	10
DOVIBLCompatID	int	➖	Dolby Vision BL compatibility ID.	1
DOVIBLPresent	bool	➖	Indicates if Dolby Vision BL is present.	true
DOVIELPresent	bool	➖	Indicates if Dolby Vision EL is present.	false
DOVILevel	int	➖	Dolby Vision level.	6
DOVIPresent	bool	➖	Indicates if Dolby Vision is present.	true
DOVIProfile	int	➖	Dolby Vision profile.	8
DOVIRPUPresent	bool	➖	Indicates if Dolby Vision RPU is present.	true
DOVIVersion	string	➖	Dolby Vision version.	1.0
Bitrate	int	➖	Bitrate of the stream.	24743
CanAutoSync	bool	➖	Indicates if the stream can auto-sync.	false
ChromaLocation	string	➖	Chroma sample location.	topleft
ChromaSubsampling	string	➖	Chroma subsampling format.	4:2:0
CodedHeight	int	➖	Coded video height.	1608
CodedWidth	int	➖	Coded video width.	3840
ClosedCaptions	bool	➖	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	float	➖	Frame rate of the stream.	23.976
HasScalingMatrix	bool	➖	N/A	false
Height	int	➖	Height of the video stream.	1602
Id	int	✔️	Unique stream identifier.	1002625
Index	int	➖	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	bool	➖	Indicates whether header compression is enabled.	true
Level	int	➖	Video level.	150
Original	bool	➖	Indicates if this is the original stream.	true
Profile	string	➖	Video profile.	main 10
RefFrames	int	➖	Number of reference frames.	1
SamplingRate	int	➖	Sampling rate for the audio stream.	48000
ScanType	string	➖	N/A	progressive
EmbeddedInVideo	string	➖	N/A	progressive
Selected	bool	➖	Indicates if this stream is selected (applicable for audio streams).	true
Forced	bool	➖	N/A	true
HearingImpaired	bool	➖	Indicates if the stream is for the hearing impaired.	true
Dub	bool	➖	Indicates if the stream is a dub.	true
Title	string	➖	Optional title for the stream (e.g., language variant).	SDH
StreamIdentifier	int	➖	N/A	1
StreamType	long	✔️	Stream type: - VIDEO = 1 - AUDIO = 2 - SUBTITLE = 3
Width	int	➖	Width of the video stream.	3840
AdditionalProperties	Dictionary<String, object>	➖	N/A