Class Channel

Class Documentation

class ear::Channel

Representation of a channel, with a name, real and nominal positions, allowed azimuth and elevation ranges, and an lfe flag.

Public Functions

Channel() = default
Channel(const std::string &name, PolarPosition polarPosition, boost::optional<PolarPosition> polarPositionNominal = boost::none, boost::optional<std::pair<double, double>> azimuthRange = boost::none, boost::optional<std::pair<double, double>> elevationRange = boost::none, bool isLfe = false)
Parameters
  • nameChannel name.

  • polarPosition – real speaker location

  • polarPositionNominal – nominal speaker location, defaults to polar_position

  • azimuthRange – azimuth range in degrees; allowed range is interpreted as starting at azimuthRange[0], moving anticlockwise to azimuthRange[1]; defaults to the azimuth of polar_nominal_position.

  • elevationRange – elevation range in degrees; allowed range is interpreted as starting at elevationRange.first, moving up to elevationRange.second defaults to the elevation of polar_nominal_position.

  • isLfe – flag to indicate an LFE channel

std::string name() const
PolarPosition polarPosition() const
PolarPosition polarPositionNominal() const
std::pair<double, double> azimuthRange() const
std::pair<double, double> elevationRange() const
bool isLfe() const
void name(const std::string &name)
void polarPosition(PolarPosition polarPosition)
void polarPositionNominal(const boost::optional<PolarPosition> &polarPositionNominal)
void azimuthRange(const boost::optional<std::pair<double, double>> &azimuthRange)
void elevationRange(const boost::optional<std::pair<double, double>> &elevationRange)
void isLfe(bool isLfe)
void checkPosition(std::function<void(const std::string&)> callback) const