A library of static functions providing access to different audio I/O systems and devices. More...

#include <ST_AudioProcessingFunctionLibrary.h>

Static Public Member Functions
static class UST_AudioIOBase *	GetST_AudioIO (EAudioIOType Type)
	Retrieves a specific audio I/O instance based on the provided I/O type.
static class UST_AudioIOBase *	GetST_AudioIOFromId (FIntPoint IOId)
	Retrieves a specific audio I/O instance based on the provided I/O identifier.
static bool	GetST_AudioIOsInMask (int32 IOMask, TArray< class UST_AudioIOBase * > &ValidIOs)
	Gets all valid audio I/O systems based on a provided I/O mask.
static class UST_AudioCaptureMicrophone *	GetST_AudioCaptureMicrophone ()
	Retrieves an audio capture microphone instance.
static class UST_AudioCaptureLoopback *	GetST_AudioCaptureLoopback ()
	Retrieves an audio capture loopback instance.
static class UST_AudioPlaybackEnginePlayer *	GetST_AudioPlaybackEnginePlayer ()
	Retrieves an audio playback engine player instance.
static class UST_AudioPlaybackPlayer *	GetST_AudioPlaybackPlayer ()
	Retrieves an audio playback player instance.
static class UST_AudioPlaybackWaveform *	GetST_AudioPlaybackWaveform ()
	Retrieves an audio playback waveform instance.
static bool	IsGlobalAudioIOFlagged (EAudioIOType Type)
	Checks if a global audio I/O system is flagged based on the I/O type.
static void	GetIOId (EAudioIOType Type, FIntPoint &Id)
	Retrieves the unique identifier for a given audio I/O type.
static int32	CountIOEnum ()
	Retrieves the total count of audio I/O types.
static int32	GetNumIOs ()
	Retrieves the total number of audio I/O systems.
static TArray< class UST_AudioIOBase * >	GetAudioIOs ()
	Retrieves all audio I/O systems.
static TArray< FName >	GetPlaybackDeviceNames ()
	Retrieves the names of all playback devices.
static TArray< FName >	GetCaptureDeviceNames ()
	Retrieves the names of all capture devices.
static FString	GetAudioFilePathFromLocation (EST_AudioFileLocation AudioFileLocation)
	Retrieves the path from the given audio file location.
static void	GetPeriodsData (const ma_device_config *pConfig, uint32 &periodsOut, uint32 &periodSizeInFramesOut, uint32 &periodDurationInMicrosecondsOut)
	Retrieves data related to audio periods for a given device configuration.

Detailed Description

A library of static functions providing access to different audio I/O systems and devices.

This class contains functions to get instances of various audio input and output systems, such as capture devices (microphone, loopback) and playback systems (engine player, waveform). It also provides utility functions to query audio I/O configurations and system flags.

Member Function Documentation

◆ CountIOEnum()

int32 UST_AudioProcessingFunctionLibrary::CountIOEnum ( )

static

Retrieves the total count of audio I/O types.

This function returns the number of distinct audio I/O types that are defined in the system.

Returns: The number of audio I/O types.

◆ GetAudioFilePathFromLocation()

FString UST_AudioProcessingFunctionLibrary::GetAudioFilePathFromLocation ( EST_AudioFileLocation AudioFileLocation )

static

Retrieves the path from the given audio file location.

This function returns the path from a given EST_AudioFileLocation enum using FPaths.

Returns: An FString containing the folder path.

◆ GetAudioIOs()

TArray< UST_AudioIOBase * > UST_AudioProcessingFunctionLibrary::GetAudioIOs ( )

static

Retrieves all audio I/O systems.

This function returns all available audio I/O systems that are currently active.

Returns: An array of all audio I/O systems.

◆ GetCaptureDeviceNames()

TArray< FName > UST_AudioProcessingFunctionLibrary::GetCaptureDeviceNames ( )

static

Retrieves the names of all capture devices.

This function returns a list of all available capture devices by name.

Returns: An array of capture device names.

◆ GetIOId()

void UST_AudioProcessingFunctionLibrary::GetIOId	(	EAudioIOType	Type,
		FIntPoint &	Id )

static

Retrieves the unique identifier for a given audio I/O type.

This function retrieves the I/O identifier for a given audio I/O type, which can be used for identifying the system and mapping it to other resources.

Parameters

Type	The audio I/O type for which the identifier is requested.
Id	The I/O identifier to be populated.

◆ GetNumIOs()

int32 UST_AudioProcessingFunctionLibrary::GetNumIOs ( )

static

Retrieves the total number of audio I/O systems.

This function returns the total number of audio I/O systems currently available.

Returns: The number of available audio I/O systems.

◆ GetPeriodsData()

void UST_AudioProcessingFunctionLibrary::GetPeriodsData	(	const ma_device_config *	pConfig,
		uint32 &	periodsOut,
		uint32 &	periodSizeInFramesOut,
		uint32 &	periodDurationInMicrosecondsOut )

static

Retrieves data related to audio periods for a given device configuration.

This function calculates the number of periods, the size of each period in frames, and the duration of each period in microseconds based on the provided device configuration.

Parameters

pConfig	The device configuration to use for calculation.
periodsOut	The number of periods (output).
periodSizeInFramesOut	The period size in frames (output).
periodDurationInMicrosecondsOut	The period duration in microseconds (output).

◆ GetPlaybackDeviceNames()

TArray< FName > UST_AudioProcessingFunctionLibrary::GetPlaybackDeviceNames ( )

static

Retrieves the names of all playback devices.

This function returns a list of all available playback devices by name.

Returns: An array of playback device names.

◆ GetST_AudioCaptureLoopback()

class UST_AudioCaptureLoopback * UST_AudioProcessingFunctionLibrary::GetST_AudioCaptureLoopback ( )

static

Retrieves an audio capture loopback instance.

This function returns the loopback capture device instance used for capturing audio from the output.

Returns: The audio capture loopback instance.

◆ GetST_AudioCaptureMicrophone()

class UST_AudioCaptureMicrophone * UST_AudioProcessingFunctionLibrary::GetST_AudioCaptureMicrophone ( )

static

Retrieves an audio capture microphone instance.

This function returns the microphone capture device instance used for audio input.

Returns: The audio capture microphone instance.

◆ GetST_AudioIO()

class UST_AudioIOBase * UST_AudioProcessingFunctionLibrary::GetST_AudioIO ( EAudioIOType Type )

static

Retrieves a specific audio I/O instance based on the provided I/O type.

This function allows retrieving an audio I/O instance of a specific type (e.g., playback, capture).

Parameters

Type	The type of audio I/O to retrieve.

Returns: The audio I/O instance corresponding to the given type.

◆ GetST_AudioIOFromId()

class UST_AudioIOBase * UST_AudioProcessingFunctionLibrary::GetST_AudioIOFromId ( FIntPoint IOId )

static

Retrieves a specific audio I/O instance based on the provided I/O identifier.

This function returns an audio I/O instance based on the I/O identifier, which is used for looking up audio systems uniquely.

Parameters

IOId	The unique identifier for the audio I/O system.

Returns: The audio I/O instance corresponding to the given I/O identifier.

◆ GetST_AudioIOsInMask()

bool UST_AudioProcessingFunctionLibrary::GetST_AudioIOsInMask	(	int32	IOMask,
		TArray< class UST_AudioIOBase * > &	ValidIOs )

static

Gets all valid audio I/O systems based on a provided I/O mask.

This function filters and returns audio I/O systems whose I/O types are included in the provided mask.

Parameters

IOMask	The mask indicating which I/O types to filter.
ValidIOs	An array to be filled with the valid I/O systems.

Returns: true if at least one valid I/O system is found; false otherwise.

◆ GetST_AudioPlaybackEnginePlayer()

class UST_AudioPlaybackEnginePlayer * UST_AudioProcessingFunctionLibrary::GetST_AudioPlaybackEnginePlayer ( )

static

Retrieves an audio playback engine player instance.

This function returns an engine player instance used for audio playback.

Returns: The audio playback engine player instance.

◆ GetST_AudioPlaybackPlayer()

class UST_AudioPlaybackPlayer * UST_AudioProcessingFunctionLibrary::GetST_AudioPlaybackPlayer ( )

static

Retrieves an audio playback player instance.

This function returns a playback player instance used for audio playback.

Returns: The audio playback player instance.

◆ GetST_AudioPlaybackWaveform()

class UST_AudioPlaybackWaveform * UST_AudioProcessingFunctionLibrary::GetST_AudioPlaybackWaveform ( )

static

Retrieves an audio playback waveform instance.

This function returns a playback waveform instance used for audio playback.

Returns: The audio playback waveform instance.

◆ IsGlobalAudioIOFlagged()

bool UST_AudioProcessingFunctionLibrary::IsGlobalAudioIOFlagged ( EAudioIOType Type )

static

Checks if a global audio I/O system is flagged based on the I/O type.

This function checks the system-wide flag state for a given audio I/O type, indicating whether the system is currently flagged for that type.

Parameters

Type	The audio I/O type to check the flag for.

Returns: true if the audio I/O system is flagged; false otherwise.

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

H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Public/Main/ST_AudioProcessingFunctionLibrary.h
H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Private/Main/ST_AudioProcessingFunctionLibrary.cpp

	VJ Master 1.0 Real-time audio analysis and visualisation.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CountIOEnum()

◆ GetAudioFilePathFromLocation()

◆ GetAudioIOs()

◆ GetCaptureDeviceNames()

◆ GetIOId()

◆ GetNumIOs()

◆ GetPeriodsData()

◆ GetPlaybackDeviceNames()

◆ GetST_AudioCaptureLoopback()

◆ GetST_AudioCaptureMicrophone()

◆ GetST_AudioIO()

◆ GetST_AudioIOFromId()

◆ GetST_AudioIOsInMask()

◆ GetST_AudioPlaybackEnginePlayer()

◆ GetST_AudioPlaybackPlayer()

◆ GetST_AudioPlaybackWaveform()

◆ IsGlobalAudioIOFlagged()