ofBaseVideoGrabber

class methods

Extends

This class extends others, you can call their methods on an instance of ofBaseVideoGrabber too:

Documentation from code comments


A base class representing a video device such as a camera.

~ofBaseVideoGrabber()

ofBaseVideoGrabber::~ofBaseVideoGrabber()

Documentation from code comments


Destroy the ofBaseVideoGrabber

getHeight()

float ofBaseVideoGrabber::getHeight()

Documentation from code comments


Get the video grabber's height.

Returns: the video grabber's height.

getTexturePtr()

ofTexture * ofBaseVideoGrabber::getTexturePtr()

Documentation from code comments


Get the video grabber's internal ofTexture pointer if available.

\note Subclasses should implement this method only if internal API can upload video grabber pixels directly to an ofTexture.

Returns: the internal ofTexture pointer or nullptr if not available.

getWidth()

float ofBaseVideoGrabber::getWidth()

Documentation from code comments


Get the video grabber's width.

Returns: the video grabber's width.

listDevices()

vector< ofVideoDevice > ofBaseVideoGrabber::listDevices()

Documentation from code comments


Get a list of available video grabber devices.

Returns: a std::vector of ofVideoDevice objects.

setDesiredFrameRate(...)

void ofBaseVideoGrabber::setDesiredFrameRate(int framerate)

Documentation from code comments


Set the video grabber's desired frame rate.

Many video grabbers support user-specified frame rates. This frame rate should be considered a hint for the video grabber and is not guaranteed.

Parameters:

framerate the desired frame rate.

setDeviceID(...)

void ofBaseVideoGrabber::setDeviceID(int deviceID)

Documentation from code comments


Set the video grabber's device ID.

In most cases, a user can choose a specific grabber source by ID. This device ID information should be available to the user via the listDevices() method.

Parameters:

deviceID The device ID provided by listDevices().

setVerbose(...)

void ofBaseVideoGrabber::setVerbose(bool bTalkToMe)

Documentation from code comments


Set the video grabber's hardware verbosity level.

Parameters:

bTalkToMe true if verbose grabber logging feedback is required.

setup(...)

bool ofBaseVideoGrabber::setup(int w, int h)

Documentation from code comments


Set up the grabber with the requested width and height.

Some video grabbers may take the requested width and height as a hint and choose the closest dimensions to those requested. Users can check the actual width and height by calling getWidth() and getHeight() respectively after a successful setup.

Parameters:

w the requested width.

h the requested height.

Returns: true if the video grabber was set up successfully.

videoSettings()

void ofBaseVideoGrabber::videoSettings()

Documentation from code comments


Request a native GUI for video grabber settings. \note This feature may not be implemented by all video grabbers.

If you have any doubt about the usage of this module you can ask in the forum.

If you want to contribute better documentation or start documenting this section you can do so here

If you find anything wrong with this docs you can report any error by opening an issue