Ignition Common

API Reference

3.5.0

Handle video encoding and decoding using libavcodec. More...

#include <Video.hh>

Public Member Functions

 Video ()
 Constructor. More...
 
virtual ~Video ()
 Destructor. More...
 
int Height () const
 Get the height of the video in pixels. More...
 
bool Load (const std::string &_filename)
 Load a video file. More...
 
bool NextFrame (unsigned char **_buffer)
 Get the next frame of the video. More...
 
int Width () const
 Get the width of the video in pixels. More...
 

Detailed Description

Handle video encoding and decoding using libavcodec.

Constructor & Destructor Documentation

◆ Video()

Video ( )

Constructor.

◆ ~Video()

virtual ~Video ( )
virtual

Destructor.

Member Function Documentation

◆ Height()

int Height ( ) const

Get the height of the video in pixels.

Returns
the height

◆ Load()

bool Load ( const std::string _filename)

Load a video file.

Parameters
[in]_filenameFull path of the video file
Returns
false if a video stream can't be found

◆ NextFrame()

bool NextFrame ( unsigned char **  _buffer)

Get the next frame of the video.

Parameters
[out]_imgImage in which the frame is stored
Returns
false on error

◆ Width()

int Width ( ) const

Get the width of the video in pixels.

Returns
the width

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