audio Namespace Reference

Classes
struct	ListenerState
struct	SpatialParams
struct	AudioEventId
struct	AudioNodeId
struct	AudioClipId
struct	AudioBusId
struct	RtpcId
struct	SwitchGroupId
struct	SwitchValueId
struct	StateGroupId
struct	StateValueId
struct	AudioObjectId
struct	AudioBusDef
struct	AudioClipDef
struct	AudioNodeChild
struct	AudioNodeDef
struct	AudioAction
struct	AudioEventDef
struct	AudioCommand
struct	AudioObjectState
struct	AudioRuntimeStats
class	AudioManifest
class	AudioRuntime

Typedefs
using	StableId = std::uint32_t

Enumerations
enum class	AudioNodeType : std::uint8_t {   Sound , Random , Sequence , Switch ,   Blend }
enum class	AudioActionType : std::uint8_t {   Play , Stop , SetRtpc , SetSwitch ,   SetState , SetBusVolume }
enum class	AudioCommandType : std::uint8_t { Play , StopClip }

Functions
float	distanceAttenuation (float distance, float fullGainDistance, float silentDistance) noexcept
float	dopplerRatio (const glm::vec3 &sourceToListener, const glm::vec3 &sourceVelocity, const glm::vec3 &listenerVelocity) noexcept
SpatialParams	evaluateSpatial (const glm::vec3 &sourcePosition, const glm::vec3 &sourceVelocity, const ListenerState &listener, bool occluded, float fullGainDistance, float silentDistance) noexcept
constexpr StableId	stableHash (std::string_view text) noexcept
AudioEventId	eventId (std::string_view name) noexcept
AudioNodeId	nodeId (std::string_view name) noexcept
AudioClipId	clipId (std::string_view name) noexcept
AudioBusId	busId (std::string_view name) noexcept
RtpcId	rtpcId (std::string_view name) noexcept
SwitchGroupId	switchGroupId (std::string_view name) noexcept
SwitchValueId	switchValueId (std::string_view name) noexcept
StateGroupId	stateGroupId (std::string_view name) noexcept
StateValueId	stateValueId (std::string_view name) noexcept
AudioObjectId	objectId (std::string_view name) noexcept

Variables
constexpr int	k_mixerSampleRate = 48000
constexpr int	k_mixerChannels = 2
constexpr float	k_speedOfSoundUnitsPerSecond = 13500.0f
constexpr float	k_fullGainDistance = 450.0f
constexpr float	k_silentDistance = 3500.0f
constexpr AudioObjectId	kGlobalObject {0}
constexpr AudioBusId	kInvalidBus {0}

Typedef Documentation

StableId

using audio::StableId = std::uint32_t

Enumeration Type Documentation

AudioActionType

enum class audio::AudioActionType : std::uint8_t

strong

Enumerator
Play
Stop
SetRtpc
SetSwitch
SetState
SetBusVolume

AudioCommandType

enum class audio::AudioCommandType : std::uint8_t

strong

Enumerator
Play
StopClip

AudioNodeType

enum class audio::AudioNodeType : std::uint8_t

strong

Enumerator
Sound
Random
Sequence
Switch
Blend

Function Documentation

busId()

AudioBusId audio::busId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

clipId()

AudioClipId audio::clipId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

distanceAttenuation()

float audio::distanceAttenuation ( float distance, float fullGainDistance, float silentDistance )

nodiscardnoexcept

Here is the caller graph for this function:

dopplerRatio()

float audio::dopplerRatio ( const glm::vec3 & sourceToListener, const glm::vec3 & sourceVelocity, const glm::vec3 & listenerVelocity )

nodiscardnoexcept

Here is the caller graph for this function:

evaluateSpatial()

SpatialParams audio::evaluateSpatial ( const glm::vec3 & sourcePosition, const glm::vec3 & sourceVelocity, const ListenerState & listener, bool occluded, float fullGainDistance, float silentDistance )

nodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

eventId()

AudioEventId audio::eventId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

nodeId()

AudioNodeId audio::nodeId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

objectId()

AudioObjectId audio::objectId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

rtpcId()

RtpcId audio::rtpcId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

stableHash()

StableId audio::stableHash ( std::string_view text )

nodiscardconstexprnoexcept

Here is the caller graph for this function:

stateGroupId()

StateGroupId audio::stateGroupId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

stateValueId()

StateValueId audio::stateValueId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

switchGroupId()

SwitchGroupId audio::switchGroupId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

switchValueId()

SwitchValueId audio::switchValueId ( std::string_view name )

inlinenodiscardnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

k_fullGainDistance

float audio::k_fullGainDistance = 450.0f

inlineconstexpr

k_mixerChannels

int audio::k_mixerChannels = 2

inlineconstexpr

k_mixerSampleRate

int audio::k_mixerSampleRate = 48000

inlineconstexpr

k_silentDistance

float audio::k_silentDistance = 3500.0f

inlineconstexpr

k_speedOfSoundUnitsPerSecond

float audio::k_speedOfSoundUnitsPerSecond = 13500.0f

inlineconstexpr

kGlobalObject

AudioObjectId audio::kGlobalObject {0}

inlineconstexpr

kInvalidBus

AudioBusId audio::kInvalidBus {0}

inlineconstexpr