reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

ofBaseVideo Class Referenceabstract

A base class representing a video source. More...

#include <ofVideoBaseTypes.h>

Inheritance diagram for ofBaseVideo:
ofBaseHasPixels_< unsigned char > ofBaseUpdates ofAbstractHasPixels ofBaseVideoDraws ofBaseVideoGrabber ofBaseVideoPlayer ofGstVideoUtils ofVideoGrabber ofVideoPlayer ofDirectShowGrabber ofGstVideoGrabber ofVideoGrabber ofAVFoundationPlayer ofDirectShowPlayer ofGstVideoPlayer ofMediaFoundationPlayer

Public Member Functions

virtual ~ofBaseVideo ()
 Destroy the ofBaseVideo.
 
virtual bool isFrameNew () const =0
 
virtual void close ()=0
 Close the video source.
 
virtual bool isInitialized () const =0
 Determine if the video source is initialized.
 
virtual bool setPixelFormat (ofPixelFormat pixelFormat)=0
 Set the requested ofPixelFormat.
 
virtual ofPixelFormat getPixelFormat () const =0
 
- Public Member Functions inherited from ofBaseHasPixels_< unsigned char >
virtual ~ofBaseHasPixels_ ()
 Destroy the ofAbstractHasPixels.
 
virtual ofPixels_< unsigned char > & getPixels ()=0
 Get a reference to the underlying ofPixels.
 
virtual const ofPixels_< unsigned char > & getPixels () const=0
 Get a const reference to the underlying ofPixels.
 
- Public Member Functions inherited from ofAbstractHasPixels
virtual ~ofAbstractHasPixels ()
 Destroy the ofAbstractHasPixels.
 
- Public Member Functions inherited from ofBaseUpdates
virtual ~ofBaseUpdates ()
 Destroy the ofBaseUpdates.
 
virtual void update ()=0
 Update the object's state.
 

Detailed Description

A base class representing a video source.

Constructor & Destructor Documentation

◆ ~ofBaseVideo()

virtual ofBaseVideo::~ofBaseVideo ( )
inlinevirtual

Destroy the ofBaseVideo.

Member Function Documentation

◆ close()

virtual void ofBaseVideo::close ( )
pure virtual

◆ getPixelFormat()

virtual ofPixelFormat ofBaseVideo::getPixelFormat ( ) const
pure virtual

◆ isFrameNew()

virtual bool ofBaseVideo::isFrameNew ( ) const
pure virtual

◆ isInitialized()

virtual bool ofBaseVideo::isInitialized ( ) const
pure virtual

Determine if the video source is initialized.

Video sources such as cameras are often initialized with a setup() method. Video sources such as movie players are often initialized with a load() method.

Returns
true if the video source is initialized.

Implemented in ofDirectShowGrabber, ofGstVideoUtils, ofGstVideoGrabber, ofBaseVideoPlayer, ofVideoGrabber, ofVideoPlayer, and ofMediaFoundationPlayer.

◆ setPixelFormat()

virtual bool ofBaseVideo::setPixelFormat ( ofPixelFormat  pixelFormat)
pure virtual

Set the requested ofPixelFormat.

Parameters
pixelFormatthe requested ofPixelFormat.
Returns
true if the format was successfully changed.

Implemented in ofAVFoundationPlayer, ofDirectShowGrabber, ofDirectShowPlayer, ofGstVideoUtils, ofGstVideoGrabber, ofGstVideoPlayer, ofVideoGrabber, ofVideoPlayer, and ofMediaFoundationPlayer.


The documentation for this class was generated from the following file: