IST_AudioProcessingInterface Class Reference

Interface for handling audio processing events. More...

#include <ST_AudioProcessingInterface.h>

Public Member Functions
void	OnAudioIOStatusChanged (const bool bIsActive, const FIntPoint IOId)
	Event triggered when the status of an audio I/O device changes.
void	OnRawMagnitudesReady (const TArray< float > &RawMagnitudes, const FIntPoint IOId)
	Event triggered when raw magnitude data is ready for an audio I/O device.
void	OnFrequencyBandsReady (const TArray< float > &FrequencyBands, const int32 NumFrequencyBands, const FIntPoint IOId)
	Event triggered when frequency band data is ready for an audio I/O device.
void	OnAmplitudesReady (const TArray< float > &Amplitudes, const FIntPoint IOId)
	Event triggered when amplitude data is ready for an audio I/O device.
void	OnPitchesReady (const TArray< float > &Pitches, const FIntPoint IOId)
	Event triggered when pitch data is ready for an audio I/O device.
void	OnBeatDetected (const TArray< float > &Beats, const TArray< FChannelBeatDetection > &BeatDetectionForChannel, const FIntPoint IOId)
	Event triggered when a beat is detected in the audio data for an I/O device.

Detailed Description

Interface for handling audio processing events.

Implementing this interface allows a class to react to various audio processing events, including changes in I/O device status and the availability of processed audio data such as raw magnitudes, frequency bands, amplitudes, pitches, and beats.

Member Function Documentation

OnAmplitudesReady()

void IST_AudioProcessingInterface::OnAmplitudesReady	(	const TArray< float > &	Amplitudes,
		const FIntPoint	IOId )

Event triggered when amplitude data is ready for an audio I/O device.

This event is called when amplitude data for a specific audio I/O device is ready.

Parameters

Amplitudes	The array of amplitude values processed from the audio data.
IOId	The unique identifier for the audio I/O device that generated the amplitude data.

OnAudioIOStatusChanged()

void IST_AudioProcessingInterface::OnAudioIOStatusChanged	(	const bool	bIsActive,
		const FIntPoint	IOId )

Event triggered when the status of an audio I/O device changes.

This event is called when the audio I/O device becomes active or inactive.

Parameters

bIsActive	Indicates whether the I/O device is active (true) or inactive (false).
IOId	The unique identifier for the audio I/O device whose status has changed.

OnBeatDetected()

void IST_AudioProcessingInterface::OnBeatDetected	(	const TArray< float > &	Beats,
		const TArray< FChannelBeatDetection > &	BeatDetectionForChannel,
		const FIntPoint	IOId )

Event triggered when a beat is detected in the audio data for an I/O device.

This event is called when a beat is detected in the audio data, typically used for rhythm-based processing.

Parameters

Beats	The array of beat values detected in the audio data.
BeatDetectionForChannel	The array of channels and if a beat was detected in the audio data with BPM.
IOId	The unique identifier for the audio I/O device that detected the beats.

OnFrequencyBandsReady()

void IST_AudioProcessingInterface::OnFrequencyBandsReady	(	const TArray< float > &	FrequencyBands,
		const int32	NumFrequencyBands,
		const FIntPoint	IOId )

Event triggered when frequency band data is ready for an audio I/O device.

This event is called when frequency band data for a specific audio I/O device is ready.

Parameters

FrequencyBands	The array of frequency bands processed from the audio data.
NumFrequencyBands	The number of frequency bands available.
IOId	The unique identifier for the audio I/O device that generated the frequency band data.

OnPitchesReady()

void IST_AudioProcessingInterface::OnPitchesReady	(	const TArray< float > &	Pitches,
		const FIntPoint	IOId )

Event triggered when pitch data is ready for an audio I/O device.

This event is called when pitch data for a specific audio I/O device is ready.

Parameters

Pitches	The array of pitch values processed from the audio data.
IOId	The unique identifier for the audio I/O device that generated the pitch data.

OnRawMagnitudesReady()

void IST_AudioProcessingInterface::OnRawMagnitudesReady	(	const TArray< float > &	RawMagnitudes,
		const FIntPoint	IOId )

Event triggered when raw magnitude data is ready for an audio I/O device.

This event is called when raw magnitude data for a specific audio I/O device is ready.

Parameters

RawMagnitudes	The array of raw magnitudes for the audio data.
IOId	The unique identifier for the audio I/O device that generated the raw magnitudes.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Public/Main/ST_AudioProcessingInterface.h