Audio

Description

Audio clips, 3D sound and music reproduction.

Classes

struct  AudioDevice
 Identifier for a device that can be used for playing audio. More...
 
class  Audio
 Provides global functionality relating to sounds and music. More...
 
struct  AUDIO_CLIP_DESC
 Descriptor used for initializing an audio clip. More...
 
class  AudioClip
 Audio clip stores audio data in a compressed or uncompressed format. More...
 
class  AudioListener
 Represents a listener that hears audio sources. More...
 
class  AudioSource
 Represents a source for emitting audio. More...
 
class  AudioUtility
 Provides various utility functionality relating to audio. More...
 

Enumerations

enum  AudioFormat { PCM, VORBIS }
 Valid internal engine audio formats. More...
 
enum  AudioReadMode { LoadDecompressed, LoadCompressed, Stream }
 Modes that determine how and when is audio data read. More...
 
enum  AudioSourceState { Playing, Paused, Stopped }
 Valid states in which AudioSource can be in. More...
 

Functions

BS_CORE_EXPORT Audio & gAudio ()
 Provides easier access to Audio. More...
 

Enumeration Type Documentation

enum AudioFormat
strong

Valid internal engine audio formats.

Enumerator
PCM 

Pulse code modulation audio ("raw" uncompressed audio).

VORBIS 

Vorbis compressed audio.

enum AudioReadMode
strong

Modes that determine how and when is audio data read.

Enumerator
LoadDecompressed 

Entire audio clip will be loaded and decompressed.

Uses most memory but has lowest CPU impact.

LoadCompressed 

Entire audio clip will be loaded, but will be decompressed while playing.

Uses medium amount of memory and has the highest CPU impact.

Stream 

Audio will be slowly streamed from the disk, and decompressed if needed.

Uses very little memory, and has either low or high CPU impact depending if the audio is in a compressed format. Since data is streamed from the disk, read speeds could also be a bottleneck.

enum AudioSourceState
strong

Valid states in which AudioSource can be in.

Enumerator
Playing 

Source is currently playing.

Paused 

Source is currently paused (play will resume from paused point).

Stopped 

Source is currently stopped (play will resume from start).

Function Documentation

BS_CORE_EXPORT Audio& bs::gAudio ( )

Provides easier access to Audio.