movie_publisher::MoviePlaybackState Struct Reference

State of movie playback. More...

#include <movie_playback_state.h>

Public Types
using	ConstPtr = std::shared_ptr< const MoviePlaybackState >
using	Ptr = std::shared_ptr< MoviePlaybackState >

Public Member Functions
size_t	frameNum () const
bool	hasMovieEnded () const
bool	hasMovieStarted () const
	MoviePlaybackState ()
	MoviePlaybackState (const MoviePlaybackState &other)
	MoviePlaybackState (MoviePlaybackState &&other) noexcept
MoviePlaybackState &	operator= (const MoviePlaybackState &other)
MoviePlaybackState &	operator= (MoviePlaybackState &&other) noexcept
void	reset ()
	Reset the playback state to uninitialized state. More...
ros::Time	rosTime () const
void	setFrameNum (size_t num)
void	setMovieEnded (bool ended)
void	setMovieStarted (bool started)
void	setRosTime (const ros::Time &time)
void	setStreamTime (const StreamTime &time)
void	setSubclipFrameNum (size_t num)
void	setSubclipTime (const StreamTime &time)
StreamTime	streamTime () const
size_t	subclipFrameNum () const
StreamTime	subclipTime () const
	~MoviePlaybackState ()

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

Detailed Description

State of movie playback.

Definition at line 23 of file movie_playback_state.h.

Member Typedef Documentation

ConstPtr

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

Definition at line 101 of file movie_playback_state.h.

Ptr

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

Definition at line 100 of file movie_playback_state.h.

Constructor & Destructor Documentation

MoviePlaybackState() [1/3]

movie_publisher::MoviePlaybackState::MoviePlaybackState

(

)

~MoviePlaybackState()

movie_publisher::MoviePlaybackState::~MoviePlaybackState

(

)

MoviePlaybackState() [2/3]

movie_publisher::MoviePlaybackState::MoviePlaybackState

(

const MoviePlaybackState &

other

)

MoviePlaybackState() [3/3]

movie_publisher::MoviePlaybackState::MoviePlaybackState ( MoviePlaybackState &&  other )

noexcept

Member Function Documentation

frameNum()

size_t movie_publisher::MoviePlaybackState::frameNum

(

)

const

Returns

The current frame number in the movie's stream.

hasMovieEnded()

bool movie_publisher::MoviePlaybackState::hasMovieEnded

(

)

const

Returns

Whether the movie has already ended (becomes true after the last nextFrame()).

hasMovieStarted()

bool movie_publisher::MoviePlaybackState::hasMovieStarted

(

)

const

Returns

Whether at least one frame of the movie has been read.

operator=() [1/2]

MoviePlaybackState& movie_publisher::MoviePlaybackState::operator=

(

const MoviePlaybackState &

other

)

operator=() [2/2]

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

noexcept

reset()

void movie_publisher::MoviePlaybackState::reset

(

)

Reset the playback state to uninitialized state.

rosTime()

ros::Time movie_publisher::MoviePlaybackState::rosTime

(

)

const

Returns

The ROS time of the last frame returned by MovieReader::nextFrame().

setFrameNum()

void movie_publisher::MoviePlaybackState::setFrameNum

(

size_t

num

)

Parameters

[in]

num

The current frame number in the movie's stream.

setMovieEnded()

void movie_publisher::MoviePlaybackState::setMovieEnded

(

bool

ended

)

Parameters

[in]

ended

Whether the movie has already ended (becomes true after the last nextFrame()).

setMovieStarted()

void movie_publisher::MoviePlaybackState::setMovieStarted

(

bool

started

)

Parameters

[in]

started

Whether at least one frame of the movie has been read.

setRosTime()

void movie_publisher::MoviePlaybackState::setRosTime

(

const ros::Time &

time

)

Parameters

[in]

time

The ROS time of the last frame returned by MovieReader::nextFrame().

setStreamTime()

void movie_publisher::MoviePlaybackState::setStreamTime

(

const StreamTime &

time

)

Parameters

[in]

time

The stream time of the last frame returned by MovieReader::nextFrame().

setSubclipFrameNum()

void movie_publisher::MoviePlaybackState::setSubclipFrameNum

(

size_t

num

)

Parameters

[in]

num

The current frame number in the selected subclip.

setSubclipTime()

void movie_publisher::MoviePlaybackState::setSubclipTime

(

const StreamTime &

time

)

Parameters

[in]

time

The subclip time of the last frame returned by MovieReader::nextFrame().

streamTime()

StreamTime movie_publisher::MoviePlaybackState::streamTime

(

)

const

Returns

The stream time of the last frame returned by MovieReader::nextFrame().

subclipFrameNum()

size_t movie_publisher::MoviePlaybackState::subclipFrameNum

(

)

const

Returns

The current frame number in the selected subclip.

subclipTime()

StreamTime movie_publisher::MoviePlaybackState::subclipTime

(

)

const

Returns

The subclip time of the last frame returned by MovieReader::nextFrame().

Member Data Documentation

data

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

private

PIMPL.

Definition at line 104 of file movie_playback_state.h.

---

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

• movie_playback_state.h