Module fyrox::scene::sound

Everything related to sound in the engine.

Modules

• context
  Sound context.
• filter
  Contains various filter effects. For example, lowpass filter could be used to muffle sounds.
• listener
  Listener represents directional microphone-like device. It receives sound from surroundings and plays it through output device (headphones, speakers, etc.).
• reverb
  Reverberation module

Structs

• AllPass
  Allpass Filter - https://ccrma.stanford.edu/~jos/pasp/Allpass_Filters.html For details see - https://ccrma.stanford.edu/~jos/pasp/Allpass_Two_Combs.html
• Attenuate
  Attenuation effect.
• AudioBus
  Audio bus is a top-level audio processing unit. It takes data from multiple audio sources and passes their samples through a chain of effects. Output signal is then can be either sent to an audio playback device or to some other audio bus and be processed again, but with different sound effects (this can be done via AudioBusGraph.
• AudioBusGraph
  Audio bus graph is a complex audio data processing entity; it allows you to route samples from audio sources through a chain of audio buses or directly to an audio playback device. To get a better understanding of how the audio graph works take a look the data flow diagram below:
• Biquad
  Generic second order digital filter. More info here: https://ccrma.stanford.edu/~jos/filters/BiQuad_Section.html
• DelayLine
  See more info here https://ccrma.stanford.edu/~jos/pasp/Delay_Lines.html
• HrirSphere
  HRIR (Head-Related Impulse Response) spheres is a 3d mesh whose points contains impulse responses for left and right ears. It is used for interpolation of impulse responses.
• HrirSphereLoader
  Resource loader for HrirSphereResource.
• HrirSphereResourceData
  Wrapper for HrirSphere to be able to use it in the resource manager, that will handle async resource loading automatically.
• HrtfRenderer
  See module docs.
• LpfComb
  Lowpass-Feedback Comb Filter For details see - https://ccrma.stanford.edu/~jos/pasp/Lowpass_Feedback_Comb_Filter.html
• OnePole
  One-pole Filter. For details see - https://www.earlevel.com/main/2012/12/15/a-one-pole-filter/
• Sound
  Sound source.
• SoundBufferImportOptions
  Defines sound buffer resource import options.
• SoundBufferLoader
  Default implementation for sound buffer loading.
• SoundBuilder
  Sound builder, allows you to create a new Sound instance.
• SoundEngine
  Sound engine manages contexts, feeds output device with data. Sound engine instance can be cloned, however this is always a “shallow” clone, because actual sound engine data is wrapped in Arc.

Enums

• BiquadKind
  Exact kind of biquad filter - it defines coefficients of the filter. More info here: https://shepazu.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html
• DataSource
  Data source enumeration. Provides unified way of selecting data source for sound buffers. It can be either a file or memory block.
• DistanceModel
  Distance model defines how volume of sound will decay when distance to listener changes.
• Effect
  Effects is a digital signal processing (DSP) unit that transforms input signal in a specific way. For example, LowPassFilterEffect could be used to muffle audio sources; to create “underwater” effect.
• Renderer
  See module docs.
• SoundBuffer
  Sound buffer is a data source for sound sources. See module documentation for more info.
• SoundBufferResourceLoadError
  An error that can occur during loading of sound buffer.
• SoundError
  Generic error enumeration for each error in this engine.
• Status
  Status (state) of sound source.

Constants

• SAMPLE_RATE
  Sample rate for output device. TODO: Make this configurable, for now its set to most commonly used sample rate of 44100 Hz.

Traits

• HrirSphereResourceExt
  A set of extension methods for HrirSphereResource

Type Aliases

• HrirSphereResource
  An alias to Resource<HrirSphereResourceData>.
• SoundBufferResource
  Type alias for sound buffer resource.