CameraVideoRecorder Class Reference

Record video from a camera sensor. More...

#include <gz/sim/systems/CameraVideoRecorder.hh>

Public Member Functions
	CameraVideoRecorder ()
	Constructor.
	~CameraVideoRecorder () final=default
	Destructor.
void	Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
	Documentation inherited.
void	PostUpdate (const UpdateInfo &_info, const EntityComponentManager &_ecm) final
	Documentation inherited.
Public Member Functions inherited from System
	System ()=default
	Constructor.
virtual	~System ()=default
	Destructor.

Additional Inherited Members
Public Types inherited from System
using	PriorityType = int32_t
	Signed integer type used for specifying priority of the execution order of PreUpdate and Update phases.
Static Public Attributes inherited from System
static constexpr PriorityType	kDefaultPriority = {0}
	Default priority value for execution order of the PreUpdate and Update phases.
static constexpr std::string_view	kPriorityElementName
	Name of the XML element from which the priority value will be parsed.

Detailed Description

Record video from a camera sensor.

System Parameters

• <service>: Name of topic for the video recorder service. If this is not specified, the topic defaults to: /world/<world_name/model/<model_name>/link/<link_name>/ sensor/<sensor_name>/record_video
• <use_sim_time>: True/false value that specifies if the video should be recorded using simulation time or real time. The default is false, which indicates the use of real time.
• <fps>: Video recorder frames per second. The default value is 25, and the support type is unsigned int.
• <bitrate>: Video recorder bitrate (bps). The default value is 2070000 bps, and the supported type is unsigned int.

Constructor & Destructor Documentation

CameraVideoRecorder()

CameraVideoRecorder

(

)

Constructor.

~CameraVideoRecorder()

~CameraVideoRecorder ( )

finaldefault

Destructor.

Member Function Documentation

Configure()

void Configure ( const Entity &  _entity, const std::shared_ptr< const sdf::Element > &  _sdf, EntityComponentManager &  _ecm, EventManager &  _eventMgr  )

finalvirtual

Documentation inherited.

Implements ISystemConfigure.

PostUpdate()

void PostUpdate ( const UpdateInfo &  _info, const EntityComponentManager &  _ecm  )

finalvirtual

Documentation inherited.

Implements ISystemPostUpdate.

---

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

• CameraVideoRecorder.hh