VBANConfig Class Reference

#include <VBANStream.h>

Inheritance diagram for VBANConfig:

Collaboration diagram for VBANConfig:

Public Member Functions
	VBANConfig ()
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.

Public Attributes
const char *	application_name = "VBAN Streamer"
uint32_t	bitfeature = 0x00000001
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.
uint32_t	device_color = 0x00FF00
uint32_t	device_flags = 0x00000001
const char *	device_name = nullptr
uint8_t	format = 0
const char *	host_name = nullptr
const char *	manufacturer_name = "ESP32 AudioTools"
int	max_write_size
RxTxMode	mode
const char *	password = nullptr
	password for wifi connection
int	rx_buffer_count = 30
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
const char *	ssid = nullptr
	ssid for wifi connection
const char *	stream_name = "Stream1"
	name of the stream
IPAddress	target_ip {0, 0, 0, 0}
	Use {0,0,0,0}; as broadcast address.
bool	throttle_active = false
int	throttle_correction_us = 0
uint16_t	udp_port = 6980
	default port is 6980
const char *	user_comment = "ESP32 VBAN Audio Device"
const char *	user_name = "User"

Constructor & Destructor Documentation

VBANConfig()

VBANConfig ( )

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.

Member Data Documentation

application_name

const char* application_name = "VBAN Streamer"

bitfeature

uint32_t bitfeature = 0x00000001

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.

device_color

uint32_t device_color = 0x00FF00

device_flags

uint32_t device_flags = 0x00000001

device_name

const char* device_name = nullptr

format

uint8_t format = 0

host_name

const char* host_name = nullptr

manufacturer_name

const char* manufacturer_name = "ESP32 AudioTools"

max_write_size

int max_write_size

Initial value:

=
      DEFAULT_BUFFER_SIZE * 2

mode

RxTxMode mode

password

const char* password = nullptr

password for wifi connection

rx_buffer_count

int rx_buffer_count = 30

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

ssid

const char* ssid = nullptr

ssid for wifi connection

stream_name

const char* stream_name = "Stream1"

name of the stream

target_ip

IPAddress target_ip {0, 0, 0, 0}

Use {0,0,0,0}; as broadcast address.

throttle_active

bool throttle_active = false

throttle_correction_us

int throttle_correction_us = 0

udp_port

uint16_t udp_port = 6980

default port is 6980

user_comment

const char* user_comment = "ESP32 VBAN Audio Device"

user_name

const char* user_name = "User"

---

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

• src/AudioTools/Communication/VBANStream.h