RenderCapture

Kodi's render capture. More...

Classes
class	XBMCAddon::xbmc::RenderCapture

Functions
	XBMCAddon::xbmc::RenderCapture::RenderCapture ()
	XBMCAddon::xbmc::RenderCapture::~RenderCapture () override
	XBMCAddon::xbmc::RenderCapture::getWidth ()
	XBMCAddon::xbmc::RenderCapture::getHeight ()
	XBMCAddon::xbmc::RenderCapture::getAspectRatio ()
	XBMCAddon::xbmc::RenderCapture::getImageFormat ()
	XBMCAddon::xbmc::RenderCapture::getImage (...)
	XBMCAddon::xbmc::RenderCapture::capture (...)
bool	XBMCAddon::xbmc::RenderCapture::GetPixels (unsigned int msec)

Detailed Description

Kodi's render capture.

Class: RenderCapture()

---

Function Documentation

capture()

XBMCAddon::xbmc::RenderCapture::capture (   ... )

inline

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> capture(width, height) </big></font></span></code></h4> \endhtmlonly

Issue capture request.

Parameters

width	Width capture image should be rendered to
height	Height capture image should should be rendered to

---

v17 Python API changes:

Removed the option to pass flags

getAspectRatio()

XBMCAddon::xbmc::RenderCapture::getAspectRatio

(

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> getAspectRatio() </big></font></span></code></h4> \endhtmlonly

Get aspect ratio of currently displayed video.

Returns

Aspect ratio

Warning

This may be called prior to calling RenderCapture.capture().

getHeight()

XBMCAddon::xbmc::RenderCapture::getHeight

(

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> getHeight() </big></font></span></code></h4> \endhtmlonly

Get height

To get height of captured image as set during RenderCapture.capture(). Returns 0 prior to calling capture.

Returns

height or 0 prior to calling capture

getImage()

XBMCAddon::xbmc::RenderCapture::getImage (   ... )

inline

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> getImage([msecs]) </big></font></span></code></h4> \endhtmlonly

Returns captured image as a bytearray.

Parameters

msecs

[opt] Milliseconds to wait. Waits 1000ms if not specified

Returns

Captured image as a bytearray

Note

The size of the image is m_width * m_height * 4

---

v17 Python API changes:

Added the option to specify wait time in msec.

getImageFormat()

XBMCAddon::xbmc::RenderCapture::getImageFormat ( )

inline

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> getImageFormat() </big></font></span></code></h4> \endhtmlonly

Get image format

Returns

Format of captured image: 'BGRA'

---

v17 Python API changes:

Image will now always be returned in BGRA

GetPixels()

bool XBMCAddon::xbmc::RenderCapture::GetPixels ( unsigned int  msec )

inline

getWidth()

XBMCAddon::xbmc::RenderCapture::getWidth

(

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> getWidth() </big></font></span></code></h4> \endhtmlonly

Get width

To get width of captured image as set during RenderCapture.capture(). Returns 0 prior to calling capture.

Returns

Width or 0 prior to calling capture

RenderCapture()

XBMCAddon::xbmc::RenderCapture::RenderCapture ( )

inline

~RenderCapture()

XBMCAddon::xbmc::RenderCapture::~RenderCapture ( )

inlineoverride