SoundInput Class Reference

Gets audio data from a QAudioSource and passes frames to a sink. More...

#include <SoundInput.h>

Inheritance diagram for SoundInput:

Collaboration diagram for SoundInput:

Public Member Functions
	SoundInput (QObject *parent=nullptr)
	Construct a SoundInput helper.
	~SoundInput ()
	Destroy the SoundInput and release resources.
Q_SLOT void	start (QAudioDevice const &device, int framesPerBuffer, AudioDevice *sink, AudioDevice::Channel channel=AudioDevice::Mono)
	Start capturing audio and forward it to sink.
Q_SLOT void	suspend ()
	Temporarily suspend audio capture without dropping the stream.
Q_SLOT void	resume ()
	Resume a previously suspended capture session.
Q_SLOT void	stop ()
	Stop audio capture and release the configured sink.
Q_SIGNAL void	error (QString message) const
	Emitted when a non-fatal error occurs during capture.
Q_SIGNAL void	status (QString message) const
	Emitted to report status messages from the capture helper.

Detailed Description

Gets audio data from a QAudioSource and passes frames to a sink.

The sink must outlive the active capture session. Start/stop/suspend operations control the underlying QAudioSource stream.

Constructor & Destructor Documentation

SoundInput()

SoundInput::SoundInput ( QObject * parent = nullptr )

inline

Construct a SoundInput helper.

Parameters

parent

Optional parent QObject.

~SoundInput()

SoundInput::~SoundInput

(

)

Destroy the SoundInput and release resources.

Destructs the SoundInput object.

Here is the call graph for this function:

Member Function Documentation

error()

Q_SIGNAL void SoundInput::error

(

QString

message

)

const

Emitted when a non-fatal error occurs during capture.

Parameters

message

Human-readable error description.

Here is the caller graph for this function:

resume()

void SoundInput::resume

(

)

Resume a previously suspended capture session.

Resumes audio input.

Here is the caller graph for this function:

start()

void SoundInput::start	(	QAudioDevice const &	device,
		int	framesPerBuffer,
		AudioDevice *	sink,
		AudioDevice::Channel	channel = AudioDevice::Mono )

Start capturing audio and forward it to sink.

Starts audio input from the specified device.

Parameters

device	Input audio device to use.
framesPerBuffer	Number of frames to request per buffer.
sink	Destination AudioDevice to receive frames. Must outlive capture.
channel	Channel selection for the sink (default: Mono).
device	The QAudioDevice to use for input.
framesPerBuffer	The number of frames per buffer.
sink	The AudioDevice sink to write audio data to.
channel	The audio channel configuration (Mono or Stereo).

Here is the call graph for this function:

Here is the caller graph for this function:

status()

Q_SIGNAL void SoundInput::status

(

QString

message

)

const

Emitted to report status messages from the capture helper.

Parameters

message

Informational text.

stop()

void SoundInput::stop

(

)

Stop audio capture and release the configured sink.

Stops audio input.

Here is the caller graph for this function:

suspend()

void SoundInput::suspend

(

)

Temporarily suspend audio capture without dropping the stream.

Suspends audio input.

Here is the caller graph for this function:

---

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

• JS8_Audio/SoundInput.h
• JS8_Audio/SoundInput.cpp