Ignition Gazebo

API Reference

4.6.0

Properties of a logical audio microphone. A microphone also has a pose, which can be stored as a component of a microphone entity via components::Pose. More...

#include <LogicalAudio.hh>

Public Member Functions

bool operator!= (const Microphone &_microphone) const
 
bool operator== (const Microphone &_microphone) const
 

Public Attributes

unsigned int id
 The microphone's id. More...
 
double volumeDetectionThreshold
 The minimum volume this microphone can detect. This should be a value between 0.0 (0% volume) and 1.0 (100% volume) More...
 

Detailed Description

Properties of a logical audio microphone. A microphone also has a pose, which can be stored as a component of a microphone entity via components::Pose.

Member Function Documentation

◆ operator!=()

bool operator!= ( const Microphone _microphone) const
inline

◆ operator==()

bool operator== ( const Microphone _microphone) const
inline

References Microphone::id.

Member Data Documentation

◆ id

◆ volumeDetectionThreshold

double volumeDetectionThreshold

The minimum volume this microphone can detect. This should be a value between 0.0 (0% volume) and 1.0 (100% volume)

Referenced by LogicalMicrophoneSerializer::Deserialize(), and LogicalMicrophoneSerializer::Serialize().


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