Ignition Gazebo

API Reference

6.1.0
VideoRecorder Class Reference

Provides video recording cababilities to the 3D scene. More...

#include <VideoRecorder.hh>

Public Slots

void OnCancel ()
 Callback when user cancels saving the recorded video. More...
 
void OnSave (const QString &_url)
 Callback when user selects a path to save the recorded video. More...
 
void OnStart (const QString &_format)
 Callback when video record start request is received. More...
 
void OnStop ()
 Callback when video record stop request is received. More...
 

Public Member Functions

 VideoRecorder ()
 Constructor. More...
 
 ~VideoRecorder () override
 Destructor. More...
 
bool eventFilter (QObject *_obj, QEvent *_event) override
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
void Update (const UpdateInfo &_info, EntityComponentManager &_ecm) override
 Update callback called every time the system is stepped. This is called at an Ignition transport thread, so any interaction with Qt should be done through signals and slots. More...
 

Detailed Description

Provides video recording cababilities to the 3D scene.

Constructor & Destructor Documentation

◆ VideoRecorder()

Constructor.

◆ ~VideoRecorder()

~VideoRecorder ( )
override

Destructor.

Member Function Documentation

◆ eventFilter()

bool eventFilter ( QObject *  _obj,
QEvent *  _event 
)
override

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem)
override

◆ OnCancel

void OnCancel ( )
slot

Callback when user cancels saving the recorded video.

◆ OnSave

void OnSave ( const QString &  _url)
slot

Callback when user selects a path to save the recorded video.

Parameters
[in]_urlPath of the file to save the recorded video

◆ OnStart

void OnStart ( const QString &  _format)
slot

Callback when video record start request is received.

Parameters
[in]_formatVideo encoding format

◆ OnStop

void OnStop ( )
slot

Callback when video record stop request is received.

◆ Update()

void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
overridevirtual

Update callback called every time the system is stepped. This is called at an Ignition transport thread, so any interaction with Qt should be done through signals and slots.

Parameters
[in]_infoCurrent simulation information, such as time.
[in]_ecmMutable reference to the ECM, so the system can read and write entities and their components.

Reimplemented from GuiSystem.


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