Configuration specifying what movie file to open and how. More...

#include <movie_open_config.h>

Public Types
using	ConstPtr = std::shared_ptr< const MovieOpenConfig >

using	Ptr = std::shared_ptr< MovieOpenConfig >

Public Member Functions
bool	allowYUVFallback () const

std::string	defaultEncoding () const

bool	extractMetadata () const

std::string	filenameOrURL () const

cras::optional< std::string >	forceEncoding () const

cras::optional< int >	forceStreamIndex () const

std::string	frameId () const

std::vector< std::shared_ptr< MovieMetadataProcessor > > &	metadataProcessors ()

const std::vector< std::shared_ptr< MovieMetadataProcessor > > &	metadataProcessors () const

std::unordered_set< MetadataType >	metadataTypes () const

	MovieOpenConfig (const cras::BoundParamHelperPtr &rosParams)

	MovieOpenConfig (const MovieOpenConfig &other)

	MovieOpenConfig (MovieOpenConfig &&other) noexcept

size_t	numThreads () const

MovieOpenConfig &	operator= (const MovieOpenConfig &other)

MovieOpenConfig &	operator= (MovieOpenConfig &&other) noexcept

std::string	opticalFrameId () const

cras::BoundParamHelperPtr	rosParams () const

cras::expected< void, std::string >	setAllowYUVFallback (bool data)

cras::expected< void, std::string >	setDefaultEncoding (const std::string &data)

cras::expected< void, std::string >	setExtractMetadata (bool data)

cras::expected< void, std::string >	setFilenameOrURL (const std::string &data)

cras::expected< void, std::string >	setForceEncoding (const cras::optional< std::string > &data)

cras::expected< void, std::string >	setForceStreamIndex (const cras::optional< int > &data)

cras::expected< void, std::string >	setFrameId (const std::string &data)

cras::expected< void, std::string >	setMetadataProcessors (const std::vector< std::shared_ptr< MovieMetadataProcessor >> &data)

cras::expected< void, std::string >	setMetadataTypes (const std::unordered_set< MetadataType > &types)

cras::expected< void, std::string >	setNumThreads (size_t data)

cras::expected< void, std::string >	setOpticalFrameId (const std::string &data)

cras::expected< void, std::string >	setRosParams (const cras::BoundParamHelperPtr &data)

cras::expected< void, std::string >	setTimestampOffset (const ros::Duration &data)

cras::expected< void, std::string >	setTimestampSource (TimestampSource data)

ros::Duration	timestampOffset () const

TimestampSource	timestampSource () const

	~MovieOpenConfig ()

Private Attributes
std::unique_ptr< Impl >	data
	PIMPL data. More...

Detailed Description

Configuration specifying what movie file to open and how.

Definition at line 28 of file movie_open_config.h.

Member Typedef Documentation

◆ ConstPtr

using movie_publisher::MovieOpenConfig::ConstPtr = std::shared_ptr<const MovieOpenConfig>

Definition at line 176 of file movie_open_config.h.

◆ Ptr

using movie_publisher::MovieOpenConfig::Ptr = std::shared_ptr<MovieOpenConfig>

Definition at line 175 of file movie_open_config.h.

Constructor & Destructor Documentation

◆ MovieOpenConfig() [1/3]

movie_publisher::MovieOpenConfig::MovieOpenConfig ( const cras::BoundParamHelperPtr & rosParams )

explicit

◆ ~MovieOpenConfig()

movie_publisher::MovieOpenConfig::~MovieOpenConfig ( )

◆ MovieOpenConfig() [2/3]

movie_publisher::MovieOpenConfig::MovieOpenConfig ( const MovieOpenConfig & other )

◆ MovieOpenConfig() [3/3]

movie_publisher::MovieOpenConfig::MovieOpenConfig ( MovieOpenConfig && other )

noexcept

Member Function Documentation

◆ allowYUVFallback()

bool movie_publisher::MovieOpenConfig::allowYUVFallback ( ) const

Returns: Allow falling back to YUV encodings if the pixel format has no ROS encoding.

◆ defaultEncoding()

std::string movie_publisher::MovieOpenConfig::defaultEncoding ( ) const

Returns: Default encoding to use if the pixel format has no corresponding ROS color encoding.

◆ extractMetadata()

bool movie_publisher::MovieOpenConfig::extractMetadata ( ) const

Returns: Whether non-essential metadata should be extracted.

◆ filenameOrURL()

std::string movie_publisher::MovieOpenConfig::filenameOrURL ( ) const

Returns: The name of the file with the movie, or its URL.

◆ forceEncoding()

cras::optional<std::string> movie_publisher::MovieOpenConfig::forceEncoding ( ) const

Returns: If set, this encoding will be forced.

◆ forceStreamIndex()

cras::optional<int> movie_publisher::MovieOpenConfig::forceStreamIndex ( ) const

Returns: If set, forces to read the given stream index instead of the automatically selected one.

◆ frameId()

std::string movie_publisher::MovieOpenConfig::frameId ( ) const

Returns: ID of the geometrical camera frame (used for position/orientation metadata).

◆ metadataProcessors() [1/2]

std::vector<std::shared_ptr<MovieMetadataProcessor> >& movie_publisher::MovieOpenConfig::metadataProcessors ( )

Returns: Metadata processors.

◆ metadataProcessors() [2/2]

const std::vector<std::shared_ptr<MovieMetadataProcessor> >& movie_publisher::MovieOpenConfig::metadataProcessors ( ) const

Returns: Metadata processors.

◆ metadataTypes()

std::unordered_set<MetadataType> movie_publisher::MovieOpenConfig::metadataTypes ( ) const

Returns: Types of metadata to be extracted (defaults to all metadata).

◆ numThreads()

size_t movie_publisher::MovieOpenConfig::numThreads ( ) const

Returns: Number of video decoding threads.

◆ operator=() [1/2]

MovieOpenConfig& movie_publisher::MovieOpenConfig::operator= ( const MovieOpenConfig & other )

◆ operator=() [2/2]

MovieOpenConfig& movie_publisher::MovieOpenConfig::operator= ( MovieOpenConfig && other )

noexcept

◆ opticalFrameId()

std::string movie_publisher::MovieOpenConfig::opticalFrameId ( ) const

Returns: ID of the optical camera frame (used for images). If empty, frameId() is returned.

◆ rosParams()

cras::BoundParamHelperPtr movie_publisher::MovieOpenConfig::rosParams ( ) const

Returns: ROS/YAML parameters that configure the reader and metadata extractors.

◆ setAllowYUVFallback()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setAllowYUVFallback ( bool data )

Parameters

[in] data Allow falling back to YUV encodings if the pixel format has no ROS encoding.

Returns: Nothing or error string.

◆ setDefaultEncoding()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setDefaultEncoding ( const std::string & data )

Parameters

[in] data Default encoding to use if the pixel format has no corresponding ROS color encoding.

Returns: Nothing or error string.

◆ setExtractMetadata()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setExtractMetadata ( bool data )

Parameters

[in] data Whether non-essential metadata should be extracted.

Returns: Nothing or error string.

◆ setFilenameOrURL()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setFilenameOrURL ( const std::string & data )

Parameters

[in] data The name of the file with the movie, or its URL.

Returns: Nothing or error string.

◆ setForceEncoding()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setForceEncoding ( const cras::optional< std::string > & data )

Parameters

[in] data If set, this encoding will be forced.

Returns: Nothing or error string.

◆ setForceStreamIndex()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setForceStreamIndex ( const cras::optional< int > & data )

Parameters

[in] data If set, forces to read the given stream index instead of the automatically selected one.

Returns: Nothing or error string.

◆ setFrameId()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setFrameId ( const std::string & data )

Parameters

[in] data ID of the geometrical camera frame (used for position/orientation metadata).

Returns: Nothing or error string.

◆ setMetadataProcessors()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setMetadataProcessors ( const std::vector< std::shared_ptr< MovieMetadataProcessor >> & data )

Parameters

[in] data Metadata processors.

Returns: Nothing or error string.

◆ setMetadataTypes()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setMetadataTypes ( const std::unordered_set< MetadataType > & types )

Parameters

[in] types Types of metadata to be extracted.

Returns: Nothing or error string.

◆ setNumThreads()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setNumThreads ( size_t data )

Parameters

[in] data Number of video decoding threads.

Returns: Nothing or error string.

◆ setOpticalFrameId()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setOpticalFrameId ( const std::string & data )

Parameters

[in] data ID of the optical camera frame (used for images).

Returns: Nothing or error string.

◆ setRosParams()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setRosParams ( const cras::BoundParamHelperPtr & data )

Parameters

[in] data ROS/YAML parameters that configure the reader and metadata extractors.

Returns: Nothing or error string.

◆ setTimestampOffset()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setTimestampOffset ( const ros::Duration & data )

Parameters

[in] data Optional offset to add to the extracted timestamps.

Returns: Nothing or error string.

◆ setTimestampSource()

cras::expected<void, std::string> movie_publisher::MovieOpenConfig::setTimestampSource ( TimestampSource data )

Parameters

[in] data How to extract timestamps.

Returns: Nothing or error string.

◆ timestampOffset()

ros::Duration movie_publisher::MovieOpenConfig::timestampOffset ( ) const

Returns: Optional offset to add to the extracted timestamps.

◆ timestampSource()

TimestampSource movie_publisher::MovieOpenConfig::timestampSource ( ) const

Returns: How to extract timestamps.

Member Data Documentation

◆ data

std::unique_ptr<Impl> movie_publisher::MovieOpenConfig::data

private

PIMPL data.

Definition at line 179 of file movie_open_config.h.

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

movie_open_config.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ MovieOpenConfig() [1/3]

◆ ~MovieOpenConfig()

◆ MovieOpenConfig() [2/3]

◆ MovieOpenConfig() [3/3]

Member Function Documentation

◆ allowYUVFallback()

◆ defaultEncoding()

◆ extractMetadata()

◆ filenameOrURL()

◆ forceEncoding()

◆ forceStreamIndex()

◆ frameId()

◆ metadataProcessors() [1/2]

◆ metadataProcessors() [2/2]

◆ metadataTypes()

◆ numThreads()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ opticalFrameId()

◆ rosParams()

◆ setAllowYUVFallback()

◆ setDefaultEncoding()

◆ setExtractMetadata()

◆ setFilenameOrURL()

◆ setForceEncoding()

◆ setForceStreamIndex()

◆ setFrameId()

◆ setMetadataProcessors()

◆ setMetadataTypes()

◆ setNumThreads()

◆ setOpticalFrameId()

◆ setRosParams()

◆ setTimestampOffset()

◆ setTimestampSource()

◆ timestampOffset()

◆ timestampSource()

Member Data Documentation

◆ data