XML Documentation for gmSound

This page lists elements defined in the gmSound module and parameters (P), containers (C), their types and their corresponding C++ methods.

Parameters are set either as attributes or with the param tag, e.g. <param name="fullscreen" value="true">. Containers are typically automatically associated with the child type, through the Object::getDefaultKey() method, however it can be explicitly controlled through the KEY="container" attribute. Observe also that futher documentation for how an attribute should be used is sometimes available adjacent to the C++ methods.

XML attributes are parsed by stream operators. For more information about how this is done, refer to the documentation of the respective stream operator in the gramods namespace.

CaptureFromWav

The instantiation of this class will attempt to open a capture device and allow for extraction of sample data from this. (more)

	Attribute	Type	Method	Documentation
P	exit	bool	setExit
P	file	filesystem::path	setFile
P	loop	bool	setLoop

Multilateration

Estimates the position of sound. (more)

	Attribute	Type	Method	Documentation
P	point	Vector3f	addPoint	Adds a microphone position for the multilateration.
C	soundDetector	SoundDetector	setSoundDetector	Sets the capture object to read audio sample data from.
P	speedOfSound	float	setSpeedOfSound	Sets the speed of sound (m/s) to use when estimating the distances from the sound.

OpenALCapture

The instantiation of this class will attempt to open a capture device and allow for extraction of sample data from this. (more)

	Attribute	Type	Method	Documentation
P	deviceName	string	setDeviceName	Sets the name of the capture device to open and capture from.

OpenALContext

The instantiation of this class will attempt to open a (specified) playback device and create a context for it. (more)

	Attribute	Type	Method	Documentation
P	deviceName	string	setDeviceName	Sets the name of the playback device to open a context for.

SoundBurstDetector (extends SoundDetector)

Sound detector search for samples over a specified threshold. (more)

	Attribute	Type	Method	Documentation
P	threshold	float	setThreshold	Sets the threshold used for detecting a sound event in the range 0-1.

SoundDetector

The interface for an algorithm detecting sound in an audio stream. (more)

	Attribute	Type	Method	Documentation
C	capture	Capture	setCapture	Sets the capture object to read audio sample data from.
P	window	float	setWindow	Sets the time window (in seconds) over which to search for matching events.