OpusMultiStreamSettings Struct Reference

Settings for Opus MultiStream Decoder. More...

#include <CodecOpusMultiStream.h>

Inheritance diagram for OpusMultiStreamSettings:

Public Member Functions
	OpusMultiStreamSettings ()
virtual void	clear ()
void	copyFrom (AudioInfo info)
	Same as set.
bool	equals (AudioInfo alt)
	Returns true if alt values are the same like the current values.
bool	equalsExSampleRate (AudioInfo alt)
	Checks if only the sample rate is different.
virtual void	logInfo (const char *source="")
	operator bool ()
	Returns true if all components are defined (no component is 0)
bool	operator!= (AudioInfo alt)
	Returns true if alt values are the different from the current values.
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like the current values.
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.
void	setupChannelMapping ()
void	setupDefaultMapping ()
void	setupSeparateChannelsMapping ()

Public Attributes
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
int	coupled_streams = 1
opus_channel_mapping_enum_t	default_channel_mapping = OPUS_CHANNEL_MAPPING_COMBINED
unsigned char	mapping [255] = {}
int	max_buffer_size = 4 * 1024
int	max_buffer_write_size = 512
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
int	streams = 1

Detailed Description

Settings for Opus MultiStream Decoder.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

OpusMultiStreamSettings()

OpusMultiStreamSettings ( )

inline

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo()

virtual void logInfo ( const char *  source = "" )

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the different from the current values.

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

setupChannelMapping()

void setupChannelMapping ( )

inline

setupDefaultMapping()

void setupDefaultMapping ( )

inline

setupSeparateChannelsMapping()

void setupSeparateChannelsMapping ( )

inline

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

coupled_streams

int coupled_streams = 1

default_channel_mapping

opus_channel_mapping_enum_t default_channel_mapping = OPUS_CHANNEL_MAPPING_COMBINED

mapping

unsigned char mapping[255] = {}

max_buffer_size

int max_buffer_size = 4 * 1024

max_buffer_write_size

int max_buffer_write_size = 512

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

streams

int streams = 1

---

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

• src/AudioTools/AudioCodecs/CodecOpusMultiStream.h