Unit CastleSoundEngine

Description

Cross-platform, spatial sound playback engine (SoundEngine singleton).

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class TInternalSoundSourceList  
Class TCastleSound Sound that can be loaded from Url (possibly reusing a cache, possibly using streaming) and played.
Class TCastlePlayingSound Controls a sound playback.
Class TSoundAllocator Manager of allocated sounds.
Class TSoundEngine Sound engine, responsible for loading and playing sounds.
Class TRepoSoundEngine Sound engine that keeps a repository of sounds, defined in a nice XML file.
Class TLoopingChannel Looping sound management, to easily play music or other looping sounds.
Class ESoundBufferNotLoaded  
Class EInvalidSoundBufferFree  
Class EInvalidSoundRepositoryXml  

Functions and Procedures

function SoundEngine: TRepoSoundEngine;

Types

TSoundDistanceModel = CastleSoundBase.TSoundDistanceModel;
TSoundDevice = CastleSoundBase.TSoundDevice;
TSoundBuffer = TInternalSoundBuffer deprecated 'use TInternalSoundBuffer';
TInternalSoundSourceEvent = procedure (Sender: TInternalSoundSource) of object;
TSound = TInternalSoundSource deprecated 'play sounds using TCastleSoundSource + TCastleSound';
TSoundParameters = TPlaySoundParameters deprecated 'use TPlaySoundParameters';
TSoundType = TCastleSound deprecated 'use TCastleSound';
TMusicPlayer = TLoopingChannel deprecated 'use TLoopingChannel';
ENoMoreSources = CastleSoundBase.ENoMoreSources;
ENoMoreOpenALSources = ENoMoreSources deprecated 'use ENoMoreSources';
ESoundFileError = CastleSoundBase.ESoundFileError;

Constants

dmInverse = CastleSoundBase.dmInverse;
dmLinear = CastleSoundBase.dmLinear;
LoadSound_FileFilters = 'All Files|*|' + '*All Sound Files|*.wav;*.ogg|' + 'WAV (*.wav)|*.wav|' + 'OggVorbis (*.ogg)|*.ogg';

Variables

stPlayerInteractFailed:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerPickItem:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerDropItem:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerSwimming:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerDrowning:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerFootstepsDefault:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerToxicPain:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerSuddenPain:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerDies:TCastleSound deprecated 'these predefined sounds should not be used';
stPlayerSwimmingChange:TCastleSound deprecated 'these predefined sounds should not be used';
stMenuCurrentItemChanged:TCastleSound deprecated 'these predefined sounds should not be used';
stMenuClick:TCastleSound deprecated 'these predefined sounds should not be used';

Description

Functions and Procedures

function SoundEngine: TRepoSoundEngine;

The sound engine. Singleton instance of TRepoSoundEngine, the most capable engine class. Created on first call to this function.

Types

TSoundDistanceModel = CastleSoundBase.TSoundDistanceModel;

This item has no description.

TSoundDevice = CastleSoundBase.TSoundDevice;

This item has no description.

TSoundBuffer = TInternalSoundBuffer deprecated 'use TInternalSoundBuffer';

Warning: this symbol is deprecated: use TInternalSoundBuffer

This item has no description.

TInternalSoundSourceEvent = procedure (Sender: TInternalSoundSource) of object;

type // allow type declaration to continue

TSound = TInternalSoundSource deprecated 'play sounds using TCastleSoundSource + TCastleSound';

Warning: this symbol is deprecated: play sounds using TCastleSoundSource + TCastleSound

This item has no description.

TSoundParameters = TPlaySoundParameters deprecated 'use TPlaySoundParameters';

Warning: this symbol is deprecated: use TPlaySoundParameters

This item has no description.

TSoundType = TCastleSound deprecated 'use TCastleSound';

Warning: this symbol is deprecated: use TCastleSound

Unique sound type identifier for sounds used within TRepoSoundEngine.

TMusicPlayer = TLoopingChannel deprecated 'use TLoopingChannel';

Warning: this symbol is deprecated: use TLoopingChannel

This item has no description.

ENoMoreSources = CastleSoundBase.ENoMoreSources;

Copyright 2010-2023 Michalis Kamburelis.

This file is part of "Castle Game Engine".

"Castle Game Engine" is free software; see the file COPYING.txt, included in this distribution, for details about the copyright.

"Castle Game Engine" is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

—————————————————————————-

ENoMoreOpenALSources = ENoMoreSources deprecated 'use ENoMoreSources';

Warning: this symbol is deprecated: use ENoMoreSources

This item has no description.

ESoundFileError = CastleSoundBase.ESoundFileError;

This item has no description.

Constants

dmInverse = CastleSoundBase.dmInverse;

This item has no description.

dmLinear = CastleSoundBase.dmLinear;

This item has no description.

LoadSound_FileFilters = 'All Files|*|' + '*All Sound Files|*.wav;*.ogg|' + 'WAV (*.wav)|*.wav|' + 'OggVorbis (*.ogg)|*.ogg';

Supported sound file formats. Use these filters with LCL file dialog (easily set by FileFiltersToDialog) or TCastleWindow.FileDialog.

Variables

stPlayerInteractFailed:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerPickItem:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerDropItem:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerSwimming:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerDrowning:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerFootstepsDefault:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerToxicPain:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerSuddenPain:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerDies:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stPlayerSwimmingChange:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Player sounds.

stMenuCurrentItemChanged:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Sounds used by TCastleOnScreenMenu.

stMenuClick:TCastleSound deprecated 'these predefined sounds should not be used';

Warning: this symbol is deprecated: these predefined sounds should not be used

Sounds used by TCastleOnScreenMenu.


Generated by PasDoc 0.16.0-snapshot.