Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
VideoStreamDetail

Video stream details class used in combination with InfoTagVideo. More...

Classes

class  XBMCAddon::xbmc::VideoStreamDetail
 

Functions

 XBMCAddon::xbmc::VideoStreamDetail::VideoStreamDetail (...)
 

Function: xbmc.VideoStreamDetail([width, height, aspect, duration, codec, stereomode, language, hdrtype])


Creates a single video stream details class for a video item wrapped by InfoTagVideo.
 
 XBMCAddon::xbmc::VideoStreamDetail::getWidth ()
 

Function: getWidth()


Get the width of the video stream in pixel.
 
 XBMCAddon::xbmc::VideoStreamDetail::getHeight ()
 

Function: getHeight()


Get the height of the video stream in pixel.
 
 XBMCAddon::xbmc::VideoStreamDetail::getAspect ()
 

Function: getAspect()


Get the aspect ratio of the video stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::getDuration ()
 

Function: getDuration()


Get the duration of the video stream in seconds.
 
 XBMCAddon::xbmc::VideoStreamDetail::getCodec ()
 

Function: getCodec()


Get the codec of the stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::getStereoMode ()
 

Function: getStereoMode()


Get the stereo mode of the video stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::getLanguage ()
 

Function: getLanguage()


Get the language of the stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::getHDRType ()
 

Function: getHDRType()


Get the HDR type of the stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::setWidth (...)
 

Function: setWidth(width)


Set the width of the video stream in pixel.
 
 XBMCAddon::xbmc::VideoStreamDetail::setHeight (...)
 

Function: setHeight(height)


Set the height of the video stream in pixel.
 
 XBMCAddon::xbmc::VideoStreamDetail::setAspect (...)
 

Function: setAspect(aspect)


Set the aspect ratio of the video stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::setDuration (...)
 

Function: setDuration(duration)


Set the duration of the video stream in seconds.
 
 XBMCAddon::xbmc::VideoStreamDetail::setCodec (...)
 

Function: setCodec(codec)


Set the codec of the stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::setStereoMode (...)
 

Function: setStereoMode(stereomode)


Set the stereo mode of the video stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::setLanguage (...)
 

Function: setLanguage(language)


Set the language of the stream.
 
 XBMCAddon::xbmc::VideoStreamDetail::setHDRType (...)
 

Function: setHDRType(hdrtype)


Set the HDR type of the stream.
 

Detailed Description

Video stream details class used in combination with InfoTagVideo.

Class: xbmc.VideoStreamDetail([width, height, aspect, duration, codec, stereoMode, language, hdrType])

Represents a single selectable video stream for a video item wrapped by InfoTagVideo.


v20 Python API changes
New class added.

Example:

...
videostream = xbmc.VideoStreamDetail(1920, 1080, language='English')
...

Function Documentation

◆ getAspect()

XBMCAddon::xbmc::VideoStreamDetail::getAspect ( )

Function: getAspect()


Get the aspect ratio of the video stream.

Returns
[float] Aspect ratio of the video stream

v20 Python API changes
New function added.

◆ getCodec()

XBMCAddon::xbmc::VideoStreamDetail::getCodec ( )

Function: getCodec()


Get the codec of the stream.

Returns
[string] Codec of the stream

v20 Python API changes
New function added.

◆ getDuration()

XBMCAddon::xbmc::VideoStreamDetail::getDuration ( )

Function: getDuration()


Get the duration of the video stream in seconds.

Returns
[float] Duration of the video stream in seconds

v20 Python API changes
New function added.

◆ getHDRType()

XBMCAddon::xbmc::VideoStreamDetail::getHDRType ( )

Function: getHDRType()


Get the HDR type of the stream.

Returns
[string] HDR type of the stream

v20 Python API changes
New function added.

◆ getHeight()

XBMCAddon::xbmc::VideoStreamDetail::getHeight ( )

Function: getHeight()


Get the height of the video stream in pixel.

Returns
[integer] Height of the video stream

v20 Python API changes
New function added.

◆ getLanguage()

XBMCAddon::xbmc::VideoStreamDetail::getLanguage ( )

Function: getLanguage()


Get the language of the stream.

Returns
[string] Language of the stream

v20 Python API changes
New function added.

◆ getStereoMode()

XBMCAddon::xbmc::VideoStreamDetail::getStereoMode ( )

Function: getStereoMode()


Get the stereo mode of the video stream.

Returns
[string] Stereo mode of the video stream

v20 Python API changes
New function added.

◆ getWidth()

XBMCAddon::xbmc::VideoStreamDetail::getWidth ( )

Function: getWidth()


Get the width of the video stream in pixel.

Returns
[integer] Width of the video stream

v20 Python API changes
New function added.

◆ setAspect()

XBMCAddon::xbmc::VideoStreamDetail::setAspect ( ...)

Function: setAspect(aspect)


Set the aspect ratio of the video stream.

Parameters
aspectfloat - Aspect ratio of the video stream.

v20 Python API changes
New function added.

◆ setCodec()

XBMCAddon::xbmc::VideoStreamDetail::setCodec ( ...)

Function: setCodec(codec)


Set the codec of the stream.

Parameters
codecstring - Codec of the stream.

v20 Python API changes
New function added.

◆ setDuration()

XBMCAddon::xbmc::VideoStreamDetail::setDuration ( ...)

Function: setDuration(duration)


Set the duration of the video stream in seconds.

Parameters
durationinteger - Duration of the video stream in seconds.

v20 Python API changes
New function added.

◆ setHDRType()

XBMCAddon::xbmc::VideoStreamDetail::setHDRType ( ...)

Function: setHDRType(hdrtype)


Set the HDR type of the stream.

Parameters
hdrtypestring - HDR type of the stream. The following types are supported: dolbyvision, hdr10, hlg

v20 Python API changes
New function added.

◆ setHeight()

XBMCAddon::xbmc::VideoStreamDetail::setHeight ( ...)

Function: setHeight(height)


Set the height of the video stream in pixel.

Parameters
heightinteger - Height of the video stream in pixel.

v20 Python API changes
New function added.

◆ setLanguage()

XBMCAddon::xbmc::VideoStreamDetail::setLanguage ( ...)

Function: setLanguage(language)


Set the language of the stream.

Parameters
languagestring - Language of the stream.

v20 Python API changes
New function added.

◆ setStereoMode()

XBMCAddon::xbmc::VideoStreamDetail::setStereoMode ( ...)

Function: setStereoMode(stereomode)


Set the stereo mode of the video stream.

Parameters
stereomodestring - Stereo mode of the video stream.

v20 Python API changes
New function added.

◆ setWidth()

XBMCAddon::xbmc::VideoStreamDetail::setWidth ( ...)

Function: setWidth(width)


Set the width of the video stream in pixel.

Parameters
widthinteger - Width of the video stream in pixel.

v20 Python API changes
New function added.

◆ VideoStreamDetail()

XBMCAddon::xbmc::VideoStreamDetail::VideoStreamDetail ( ...)

Function: xbmc.VideoStreamDetail([width, height, aspect, duration, codec, stereomode, language, hdrtype])


Creates a single video stream details class for a video item wrapped by InfoTagVideo.

Parameters
width[opt] integer - Width of the video stream in pixel.
height[opt] integer - Height of the video stream in pixel.
aspect[opt] float - Aspect ratio of the video stream.
duration[opt] integer - Duration of the video stream in seconds.
codec[opt] string - Codec of the video stream.
stereomode[opt] string - Stereo mode of the video stream.
language[opt] string - Language of the video stream.
hdrtype[opt] string - HDR type of the video stream. The following types are supported: dolbyvision, hdr10, hlg

v20 Python API changes
New function added.

Example:

...
videostream = xbmc.VideoStreamDetail(1920, 1080, language='English')
...