Basic information about an open movie. More...

#include <movie_info.h>

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

using	Ptr = std::shared_ptr< MovieInfo >

Public Member Functions
StreamDuration	duration () const

std::string	filenameOrURL () const

RationalNumber	frameRate () const

size_t	height () const

bool	isSeekable () const

bool	isStillImage () const

int	metadataRotation () const

ros::Time	metadataStartTime () const

	MovieInfo ()

	MovieInfo (const MovieInfo &other)

	MovieInfo (MovieInfo &&other) noexcept

int	movieStreamIndex () const

MovieInfo &	operator= (const MovieInfo &other)

MovieInfo &	operator= (MovieInfo &&other) noexcept

void	setDuration (const StreamDuration &data)

void	setFilenameOrURL (const std::string &data)

void	setFrameRate (const RationalNumber &data)

void	setHeight (size_t data)

void	setIsSeekable (bool data)

void	setIsStillImage (bool data)

void	setMetadataRotation (int data)

void	setMetadataStartTime (const ros::Time &data)

void	setMovieStreamIndex (int data)

void	setStreamDuration (const StreamDuration &data)

void	setStreamEnd (const StreamTime &data)

void	setStreamNumFrames (size_t data)

void	setStreamStart (const StreamTime &data)

void	setSubclipDuration (const StreamDuration &data)

void	setSubclipEnd (const StreamTime &data)

void	setSubclipNumFrames (size_t data)

void	setSubclipStart (const StreamTime &data)

void	setTimestampSource (TimestampSource data)

void	setWidth (size_t data)

StreamDuration	streamDuration () const

StreamTime	streamEnd () const

size_t	streamNumFrames () const

StreamTime	streamStart () const

StreamDuration	subclipDuration () const

StreamTime	subclipEnd () const

size_t	subclipNumFrames () const

StreamTime	subclipStart () const

TimestampSource	timestampSource () const

size_t	width () const

	~MovieInfo ()

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

Detailed Description

Basic information about an open movie.

Definition at line 24 of file movie_info.h.

Member Typedef Documentation

◆ ConstPtr

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

Definition at line 195 of file movie_info.h.

◆ Ptr

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

Definition at line 194 of file movie_info.h.

Constructor & Destructor Documentation

◆ MovieInfo() [1/3]

movie_publisher::MovieInfo::MovieInfo ( )

◆ ~MovieInfo()

movie_publisher::MovieInfo::~MovieInfo ( )

◆ MovieInfo() [2/3]

movie_publisher::MovieInfo::MovieInfo ( const MovieInfo & other )

◆ MovieInfo() [3/3]

movie_publisher::MovieInfo::MovieInfo ( MovieInfo && other )

noexcept

Member Function Documentation

◆ duration()

StreamDuration movie_publisher::MovieInfo::duration ( ) const

Returns: The duration of the stream (may be 0 for live streams) (either stream or container duration, whichever is non-zero).

◆ filenameOrURL()

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

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

◆ frameRate()

RationalNumber movie_publisher::MovieInfo::frameRate ( ) const

Returns: The framerate of the movie (can be 0 for still images).

◆ height()

size_t movie_publisher::MovieInfo::height ( ) const

Returns: Pixel height of the movie.

◆ isSeekable()

bool movie_publisher::MovieInfo::isSeekable ( ) const

Returns: Whether the movie can be efficiently seeked.

◆ isStillImage()

bool movie_publisher::MovieInfo::isStillImage ( ) const

Returns: Whether the movie is just a single still image.

◆ metadataRotation()

int movie_publisher::MovieInfo::metadataRotation ( ) const

Returns: Rotation of the image (0, 90, 180, 270).

◆ metadataStartTime()

ros::Time movie_publisher::MovieInfo::metadataStartTime ( ) const

Returns: The stream start time read from metadata (zero if not found).

◆ movieStreamIndex()

int movie_publisher::MovieInfo::movieStreamIndex ( ) const

Returns: Index of the selected stream from which the movie will be decoded.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

noexcept

◆ setDuration()

void movie_publisher::MovieInfo::setDuration ( const StreamDuration & data )

Parameters

[in] data The duration of the stream (may be 0 for live streams) (either stream or container duration, whichever is non-zero).

◆ setFilenameOrURL()

void movie_publisher::MovieInfo::setFilenameOrURL ( const std::string & data )

Parameters

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

◆ setFrameRate()

void movie_publisher::MovieInfo::setFrameRate ( const RationalNumber & data )

Parameters

[in] data The framerate of the movie (can be 0 for still images).

◆ setHeight()

void movie_publisher::MovieInfo::setHeight ( size_t data )

Parameters

[in] data Pixel height of the movie.

◆ setIsSeekable()

void movie_publisher::MovieInfo::setIsSeekable ( bool data )

Parameters

[in] data Whether the movie can be efficiently seeked.

◆ setIsStillImage()

void movie_publisher::MovieInfo::setIsStillImage ( bool data )

Parameters

[in] data Whether the movie is just a single still image.

◆ setMetadataRotation()

void movie_publisher::MovieInfo::setMetadataRotation ( int data )

Parameters

[in] data Rotation of the image (0, 90, 180, 270).

◆ setMetadataStartTime()

void movie_publisher::MovieInfo::setMetadataStartTime ( const ros::Time & data )

Parameters

[in] data The stream start time read from metadata (zero if not found).

◆ setMovieStreamIndex()

void movie_publisher::MovieInfo::setMovieStreamIndex ( int data )

Parameters

[in] data Index of the selected stream from which the movie will be decoded.

◆ setStreamDuration()

void movie_publisher::MovieInfo::setStreamDuration ( const StreamDuration & data )

Parameters

[in] data The duration of the stream (may be 0 for live streams).

◆ setStreamEnd()

void movie_publisher::MovieInfo::setStreamEnd ( const StreamTime & data )

Parameters

[in] data End time of the selected movie stream (relative to movie start) (can be 0 e.g. for live streams).

◆ setStreamNumFrames()

void movie_publisher::MovieInfo::setStreamNumFrames ( size_t data )

Parameters

[in] data The number of frames in the movie (may be 0 for some formats or live streams).

◆ setStreamStart()

void movie_publisher::MovieInfo::setStreamStart ( const StreamTime & data )

Parameters

[in] data Start time of the selected movie stream (relative to movie start).

◆ setSubclipDuration()

void movie_publisher::MovieInfo::setSubclipDuration ( const StreamDuration & data )

Parameters

[in] data Duration of the subclip (can be 0 e.g. for live streams).

◆ setSubclipEnd()

void movie_publisher::MovieInfo::setSubclipEnd ( const StreamTime & data )

Parameters

[in] data End time of the subclip (relative to movie start) (can be 0 e.g. for live streams).

◆ setSubclipNumFrames()

void movie_publisher::MovieInfo::setSubclipNumFrames ( size_t data )

Parameters

[in] data The number of frames in the subclip (may be 0 for some formats or live streams).

◆ setSubclipStart()

void movie_publisher::MovieInfo::setSubclipStart ( const StreamTime & data )

Parameters

[in] data Start time of the subclip (relative to movie start).

◆ setTimestampSource()

void movie_publisher::MovieInfo::setTimestampSource ( TimestampSource data )

Parameters

[in] data The source of the timestamps.

◆ setWidth()

void movie_publisher::MovieInfo::setWidth ( size_t data )

Parameters

[in] data Pixel width of the movie.

◆ streamDuration()

StreamDuration movie_publisher::MovieInfo::streamDuration ( ) const

Returns: The duration of the stream (may be 0 for live streams).

◆ streamEnd()

StreamTime movie_publisher::MovieInfo::streamEnd ( ) const

Returns: End time of the selected movie stream (relative to movie start) (can be 0 e.g. for live streams).

◆ streamNumFrames()

size_t movie_publisher::MovieInfo::streamNumFrames ( ) const

Returns: The number of frames in the movie (may be 0 for some formats or live streams).

◆ streamStart()

StreamTime movie_publisher::MovieInfo::streamStart ( ) const

Returns: Start time of the selected movie stream (relative to movie start).

◆ subclipDuration()

StreamDuration movie_publisher::MovieInfo::subclipDuration ( ) const

Returns: Duration of the subclip (can be 0 e.g. for live streams).

◆ subclipEnd()

StreamTime movie_publisher::MovieInfo::subclipEnd ( ) const

Returns: End time of the subclip (relative to movie start) (can be 0 e.g. for live streams).

◆ subclipNumFrames()

size_t movie_publisher::MovieInfo::subclipNumFrames ( ) const

Returns: The number of frames in the subclip (may be 0 for some formats or live streams).

◆ subclipStart()

StreamTime movie_publisher::MovieInfo::subclipStart ( ) const

Returns: Start time of the subclip (relative to movie start).

◆ timestampSource()

TimestampSource movie_publisher::MovieInfo::timestampSource ( ) const

Returns: The source of the timestamps.

◆ width()

size_t movie_publisher::MovieInfo::width ( ) const

Returns: Pixel width of the movie.

Member Data Documentation

◆ data

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

private

PIMPL data.

Definition at line 198 of file movie_info.h.

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

movie_info.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ MovieInfo() [1/3]

◆ ~MovieInfo()

◆ MovieInfo() [2/3]

◆ MovieInfo() [3/3]

Member Function Documentation

◆ duration()

◆ filenameOrURL()

◆ frameRate()

◆ height()

◆ isSeekable()

◆ isStillImage()

◆ metadataRotation()

◆ metadataStartTime()

◆ movieStreamIndex()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setDuration()

◆ setFilenameOrURL()

◆ setFrameRate()

◆ setHeight()

◆ setIsSeekable()

◆ setIsStillImage()

◆ setMetadataRotation()

◆ setMetadataStartTime()

◆ setMovieStreamIndex()

◆ setStreamDuration()

◆ setStreamEnd()

◆ setStreamNumFrames()

◆ setStreamStart()

◆ setSubclipDuration()

◆ setSubclipEnd()

◆ setSubclipNumFrames()

◆ setSubclipStart()

◆ setTimestampSource()

◆ setWidth()

◆ streamDuration()

◆ streamEnd()

◆ streamNumFrames()

◆ streamStart()

◆ subclipDuration()

◆ subclipEnd()

◆ subclipNumFrames()

◆ subclipStart()

◆ timestampSource()

◆ width()

Member Data Documentation

◆ data