Core.hpp File Reference

Core engine lifecycle and configuration API. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	MayaFlux
	Main namespace for the Maya Flux audio engine.
namespace	MayaFlux::Core

Functions
void	MayaFlux::Await ()
	Blocks launcher until user input (optional convenience function)
void	MayaFlux::End ()
	Stops and cleans up the default engine.
Core::Engine &	MayaFlux::get_context ()
	Gets the default engine instance.
void	MayaFlux::Init ()
	Initializes the default engine with default settings.
void	MayaFlux::Init (Core::GlobalStreamInfo stream_info, Core::GlobalGraphicsConfig graphics_config, Core::GlobalInputConfig input_config, Core::GlobalNetworkConfig network_config)
	Initializes the default engine with specified stream and graphics info.
void	MayaFlux::Init (uint32_t sample_rate, uint32_t buffer_size=512, uint32_t num_out_channels=2, uint32_t num_in_channels=0)
	Initializes the default engine with specified parameters.
bool	MayaFlux::is_configured ()
	Checks if the default engine has currently accepted all configurations and initialized all managers.
bool	MayaFlux::is_initialized ()
	Checks if the default engine has been initialized.
void	MayaFlux::Pause ()
	Pauses audio processing on the default engine.
void	MayaFlux::Resume ()
	Resumes audio processing on the default engine.
void	MayaFlux::set_and_transfer_context (Core::Engine instance)
	Replaces the default engine with a new instance.
void	MayaFlux::Start ()
	Starts audio processing on the default engine.

Detailed Description

Core engine lifecycle and configuration API.

This header provides the fundamental engine control and configuration functions that form the foundation of the MayaFlux framework. All other subsystems depend on the engine being properly initialized and configured.

The Core API handles:

• Engine initialization with various stream configurations
• Engine lifecycle management (Start, Pause, Resume, End)
• Access to core engine context and configuration
• Global stream information queries

This is typically the first API users interact with when setting up a MayaFlux application, and other API modules depend on these functions for accessing engine subsystems.

Definition in file Core.hpp.