pulp::audio::ChannelSet Struct Reference

Named channel layout — maps channel indices to speaker positions. More...

#include <channel_set.hpp>

Public Member Functions
uint32_t	size () const
bool	operator== (const ChannelSet &other) const

Static Public Member Functions
static ChannelSet	mono ()
static ChannelSet	stereo ()
static ChannelSet	lrc ()
static ChannelSet	quad ()
static ChannelSet	surround_5_0 ()
static ChannelSet	surround_5_1 ()
static ChannelSet	surround_7_1 ()
static ChannelSet	surround_7_1_4 ()
static ChannelSet	discrete (uint32_t num_channels)
	Create a discrete (unnamed) channel set with N channels.
static ChannelSet	from_channel_count (uint32_t count)
	Get a standard layout by channel count (best guess).
static ChannelSet	from_name (std::string_view name)
	Get a standard layout by name.

Public Attributes
std::string	name
std::vector< Speaker >	speakers

Detailed Description

Named channel layout — maps channel indices to speaker positions.

Member Function Documentation

discrete()

ChannelSet pulp::audio::ChannelSet::discrete ( uint32_t num_channels )

inlinestatic

Create a discrete (unnamed) channel set with N channels.

from_channel_count()

ChannelSet pulp::audio::ChannelSet::from_channel_count ( uint32_t count )

inlinestatic

Get a standard layout by channel count (best guess).

from_name()

ChannelSet pulp::audio::ChannelSet::from_name ( std::string_view name )

static

Get a standard layout by name.

lrc()

ChannelSet pulp::audio::ChannelSet::lrc ( )

inlinestatic

mono()

ChannelSet pulp::audio::ChannelSet::mono ( )

inlinestatic

operator==()

bool pulp::audio::ChannelSet::operator== ( const ChannelSet & other ) const

inline

quad()

ChannelSet pulp::audio::ChannelSet::quad ( )

inlinestatic

size()

uint32_t pulp::audio::ChannelSet::size ( ) const

inline

stereo()

ChannelSet pulp::audio::ChannelSet::stereo ( )

inlinestatic

surround_5_0()

ChannelSet pulp::audio::ChannelSet::surround_5_0 ( )

inlinestatic

surround_5_1()

ChannelSet pulp::audio::ChannelSet::surround_5_1 ( )

inlinestatic

surround_7_1()

ChannelSet pulp::audio::ChannelSet::surround_7_1 ( )

inlinestatic

surround_7_1_4()

ChannelSet pulp::audio::ChannelSet::surround_7_1_4 ( )

inlinestatic

Member Data Documentation

name

std::string pulp::audio::ChannelSet::name

speakers

std::vector<Speaker> pulp::audio::ChannelSet::speakers

---

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

• /home/runner/work/pulp/pulp/core/audio/include/pulp/audio/channel_set.hpp