ski_audio_settings_t

Structure with the connection settings of an audio stream.

#include <AudioSettings.h>

Public Functions

	Name
	ski_audio_settings_t()

Public Attributes

	Name
const char *	deviceName
const char *	audioAPI
unsigned int	sampleRate
unsigned int	bufferSize
int	nbStreamChannel
float	suggestedLatency

Public Functions Documentation

function ski_audio_settings_t

inline ski_audio_settings_t()

Constructor: Initialized using default audio settings.

Public Attributes Documentation

variable deviceName

const char * deviceName;

Name of the targeted audio device, default value "default_output" uses the OS default audio device. If using a specific audioPreset other than eCustomDevice, the parameter will be ignored.

variable audioAPI

const char * audioAPI;

Name of the targeted API. Default value "any_API" uses any available API which match the configuration, if any. If using a specific audioPreset other than eCustomDevice, the parameter will be ignored.

variable sampleRate

unsigned int sampleRate;

Sample rate of the audio stream. If using a specific audioPreset, the parameter will be ignored.

variable bufferSize

unsigned int bufferSize;

Size (strictly positive) of a chunk of data sent over the audio stream. This parameter MUST be set independently of the used audio preset.

variable nbStreamChannel

int nbStreamChannel;

Number of channels (strictly positive) to use while streaming to the haptic output. If using a specific audio preset, the parameter will be ignored. Setting -1 will use the number of actuator of the layout, or a portion of it.

variable suggestedLatency

float suggestedLatency;

Desired latency in seconds. The value is rounded to the closest available latency value from the audio API. If using a specific audioPreset other than eCustomDevice, the parameter will be ignored.

---

Updated on 2024-07-11 at 09:47:11 +0000