nc::NcAudio Struct Reference

Audio module interface. More...

#include <NcAudio.h>

Inheritance diagram for nc::NcAudio:

Public Member Functions
virtual void	RegisterListener (Entity entity) noexcept=0
	Register an object to be the reference point audio. More...
virtual auto	GetStreamTime () const noexcept -> double=0
	Get the current stream time. More...
virtual void	SetStreamTime (double time) noexcept=0
	Set the stream time. More...
virtual auto	EnumerateOutputDevices () noexcept -> std::vector< AudioDevice >=0
	Get a list of available output devices. More...
virtual auto	GetOutputDevice () const noexcept -> const AudioDevice &=0
	Get the active output device. More...
virtual auto	SetOutputDevice (uint32_t deviceId=DefaultAudioDeviceId) noexcept -> bool=0
	Set the active output device. More...
virtual auto	OnChangeOutputDevice () noexcept -> Signal< const AudioDevice & > &=0
	Get the signal for device change events. More...
Public Member Functions inherited from nc::Module
	Module (size_t id=0) noexcept
	Constructor for the Module interface. More...
auto	Id () const noexcept
	Get the module's unique id.
virtual void	OnBuildTaskGraph (task::UpdateTasks &, task::RenderTasks &)
	Called on registered modules when the task graphs are constructed.
virtual void	OnBeforeSceneLoad ()
	Called on registered modules prior to loading a new scene.
virtual void	OnBeforeSceneFragmentLoad ()
	Called on registered modules immediately before loading a SceneFragment file.
virtual void	OnAfterSceneFragmentLoad ()
	Called on registered modules immediately after loading a SceneFragment file.
virtual void	Clear () noexcept
	Called on registered modules prior to clearing the Registry. This includes Scene::Unload() and NcEngine::Shutdown().

Detailed Description

Audio module interface.

Tasks: AudioSourceUpdate Depends On: None Component Access: Write: AudioSource Read: Transform

Member Function Documentation

EnumerateOutputDevices()

virtual auto nc::NcAudio::EnumerateOutputDevices ( ) -> std::vector< AudioDevice >

pure virtualnoexcept

Get a list of available output devices.

Returns

A vector of AudioDevice objects.

This returned list is not static, and is subject to change upon device connection or disconnection. Devices that do not meet internal usage requirements are excluded from the list.

GetOutputDevice()

virtual auto nc::NcAudio::GetOutputDevice ( ) const -> const AudioDevice &

pure virtualnoexcept

Get the active output device.

Returns

A const reference to the active AudioDevice.

If no device is in use, the returned value will have an id of InvalidDeviceId.

GetStreamTime()

virtual auto nc::NcAudio::GetStreamTime ( ) const -> double

pure virtualnoexcept

Get the current stream time.

Returns

The time in seconds since the stream was started.

The stream time is an approximation of the number of seconds the stream has been playing based on the number of buffers processed.

OnChangeOutputDevice()

virtual auto nc::NcAudio::OnChangeOutputDevice ( ) -> Signal< const AudioDevice & > &

pure virtualnoexcept

Get the signal for device change events.

Returns

A reference to the signal managing device change events.

RegisterListener()

virtual void nc::NcAudio::RegisterListener ( Entity  entity )

pure virtualnoexcept

Register an object to be the reference point audio.

Parameters

entity

An Entity to use as the listener.

A listener must be registered for the audio module to operate. A listener should not be destroyed while it is registered, except on a scene change. A new Entity or Entity::Null() may be passed to unregister the current listener.

SetOutputDevice()

virtual auto nc::NcAudio::SetOutputDevice ( uint32_t  deviceId = DefaultAudioDeviceId ) -> bool

pure virtualnoexcept

Set the active output device.

Parameters

deviceId

The id of the preferred device.

Returns

true if any device was successfuly selected.

If the operation fails using the provided id, an attempt will be made to fallback to another suitable device, preferring the system default.

SetStreamTime()

virtual void nc::NcAudio::SetStreamTime ( double  time )

pure virtualnoexcept

Set the stream time.

Parameters

time	The time in seconds to overwrite the stream time with. Must be >= 0.

---

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

• include/ncengine/audio/NcAudio.h