Surround Channel Arrangement

Detailed Description

Utility class dealing with the Companion-API-dependent surround channel arrangements.

Classes

class  ARA::ChannelArrangement
 Helper class to parse the opaque, Companion-API-dependent channel arrangement information. More...
 

Class Documentation

◆ ARA::ChannelArrangement

class ARA::ChannelArrangement

Helper class to parse the opaque, Companion-API-dependent channel arrangement information.

Public Member Functions

 ChannelArrangement ()
 Construct either as default, undefined format, or construct with explicit data.
 
bool operator== (const ChannelArrangement &other) const noexcept
 Equality tests.
 
ARAChannelArrangementDataType getChannelArrangementDataType () const noexcept
 Returns the channel arrangement data type.
 
const void * getChannelArrangement () const noexcept
 Returns the Companion-API-dependent channel arrangement data.
 
ARASize getDataSize () const noexcept
 Returns the size of the opaque channel arrangement data.
 
ARAChannelCount getImpliedChannelCount () const noexcept
 Returns the channel count encoded in the channel arrangement data. May return 0 if the arrangement data does not imply a certain channel count.
 
bool isValidForChannelCount (ARAChannelCount requiredChannelCount) const noexcept
 Validation helper for use at API boundary.