Gazebo Gazebo

API Reference

3.15.1
SourcePlayInfo Struct Reference

A source's playing information. Useful for keeping track of when to start/stop playing a source. More...

#include <LogicalAudio.hh>

Public Member Functions

 SourcePlayInfo ()
 Constructor. More...
 
bool operator!= (const SourcePlayInfo &_sourcePlayInfo) const
 
bool operator== (const SourcePlayInfo &_sourcePlayInfo) const
 

Public Attributes

std::chrono::seconds playDuration
 How long the source should play for, in seconds. Setting this to 0 means the source has a play duration of infinity. More...
 
bool playing {false}
 Whether the source is currently playing or not. More...
 
std::chrono::steady_clock::duration startTime
 The time at which the source most recently started playing. More...
 

Detailed Description

A source's playing information. Useful for keeping track of when to start/stop playing a source.

Constructor & Destructor Documentation

◆ SourcePlayInfo()

SourcePlayInfo ( )
inline

Constructor.

Member Function Documentation

◆ operator!=()

bool operator!= ( const SourcePlayInfo _sourcePlayInfo) const
inline

◆ operator==()

bool operator== ( const SourcePlayInfo _sourcePlayInfo) const
inline

Member Data Documentation

◆ playDuration

std::chrono::seconds playDuration

How long the source should play for, in seconds. Setting this to 0 means the source has a play duration of infinity.

Referenced by LogicalAudioSourcePlayInfoSerializer::Deserialize(), SourcePlayInfo::operator==(), and LogicalAudioSourcePlayInfoSerializer::Serialize().

◆ playing

bool playing {false}

◆ startTime

std::chrono::steady_clock::duration startTime

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