Class TRepoSoundEngine

Unit

Declaration

type TRepoSoundEngine = class(TSoundEngine)

Description

Sound engine that keeps a repository of sounds, defined in a nice XML file. This allows to have simple Sound and Sound3D methods, that take a sound identifier (managing sound buffers will just happen automatically under the hood).

It extends TSoundEngine, so you can always still load new buffers and play them by TSoundEngine.LoadBuffer, TSoundEngine.PlaySound and all other methods. This only adds easy preloaded sounds, but you're not limited to them.

To initialize your sounds repository, you have to set the RepositoryURL property.

Hierarchy

Overview

Methods

Public constructor Create;
Public destructor Destroy; override;
Public procedure LoadFromConfig(const Config: TCastleConfig); override; deprecated 'load sound properties explicitly from UserConfig';
Public procedure SaveToConfig(const Config: TCastleConfig); override; deprecated 'save sound properties explicitly to UserConfig';
Public procedure ReloadSounds;
Public function SoundFromName(const SoundName: string; const Required: boolean = true): TCastleSound;
Public procedure AddSoundImportanceName(const Name: string; Importance: Integer); deprecated 'use Priority, with numeric values';
Public procedure PrepareResources;

Properties

Public property RepositoryURL: string read FRepositoryURL write SetRepositoryURL;
Public property SoundsFileName: string read FRepositoryURL write SetRepositoryURL; deprecated 'use RepositoryURL';
Public property SoundImportanceNames: TStringList read FSoundImportanceNames; deprecated 'use Priority, with numeric values';
Public property MusicPlayer: TLoopingChannel read GetMusicPlayer; deprecated 'use LoopingChannel[0]';
Public property LoopingChannel [const Index: Cardinal]: TLoopingChannel read GetLoopingChannel;

Description

Methods

Public constructor Create;
 
Public destructor Destroy; override;
 
Public procedure LoadFromConfig(const Config: TCastleConfig); override; deprecated 'load sound properties explicitly from UserConfig';

Warning: this symbol is deprecated: load sound properties explicitly from UserConfig

 
Public procedure SaveToConfig(const Config: TCastleConfig); override; deprecated 'save sound properties explicitly to UserConfig';

Warning: this symbol is deprecated: save sound properties explicitly to UserConfig

 
Public procedure ReloadSounds;

Reload the RepositoryURL and all referenced buffers. Useful as a tool for game designers, to reload the sounds XML file without restarting the game and sound engine.

Public function SoundFromName(const SoundName: string; const Required: boolean = true): TCastleSound;

Return sound with given name. Available names are given in SoundNames, defined in XML file pointed by RepositoryURL. Always for SoundName = '' it will return nil.

Parameters
Required

If Required = True, it will make a warning when the sound name is not found. This may mean that sound is missing in your sounds.xml file (so you should correct your sounds.xml), or that you didn't load the sounds.xml file yet (so you should correct your code to set TRepoSoundEngine.RepositoryURL early enough), or that you specified invalid sound name. When Required = False, missing sound is silently ignored, which is sensible if it was optional.

Regardless of the Required value, we return nil for missing sound. So the Required parameter only determines whether we make a warning, or not.

Public procedure AddSoundImportanceName(const Name: string; Importance: Integer); deprecated 'use Priority, with numeric values';

Warning: this symbol is deprecated: use Priority, with numeric values

 
Public procedure PrepareResources;

Opens sound context and loads sound files, but only if RepositoryURL was set and contains some sounds.

The idea is that you can call this during "loading" stage for any game that *possibly but not necessarily* uses sound. If a game doesn't use sound, this does nothing (doesn't waste time to even initialize sound context, which on some systems may cause some warnings). If a game uses sound (through RepositoryURL), this will initialize sound backend and load these sound files, to play them without any delay in game.

Note that, if this does nothing, but you later set RepositoryURL or do LoadBuffer or Play, then sound context will be created on-demand anyway. So calling this is always optional.

Properties

Public property RepositoryURL: string read FRepositoryURL write SetRepositoryURL;

The XML file that contains description of your sounds. This should be an URL (in simple cases, just a filename) pointing to an XML file describing your sounds. See https://castle-engine.io/creating_data_sound.php and engine examples for details (examples/audio/sample_sounds.xml contains an example file with lots of comments).

When you set RepositoryURL property, we read sound information from given XML file. You usually set RepositoryURL at the very beginning of the application. Right after setting RepositoryURL you usually call SoundFromName a couple of times to convert some names into TCastleSound values, to later use these TCastleSound values with Sound and Sound3D methods.

When the sound context is initialized (or when you set this property, if the sound context is initialized already) then sound buffers will actually be loaded.

If this is empty (the default), then no sounds are loaded, and TRepoSoundEngine doesn't really give you much above standard TSoundEngine.

If you want to actually use TRepoSoundEngine features (like the Sound and Sound3D methods) you have to set this property. For example like this:

SoundEngine.RepositoryURL := 'castle-data:/sounds.xml';
MySound1 := SoundEngine.SoundFromName('my_sound_1');
MySound2 := SoundEngine.SoundFromName('my_sound_2');
// ... and later in your game you can do stuff like this:
SoundEngine.Play(MySound1);

See https://castle-engine.io/manual_data_directory.php for information about the castle-data:/ protocol. In short, on desktop, this just indicates the "data" subdirectory of your project.

Public property SoundsFileName: string read FRepositoryURL write SetRepositoryURL; deprecated 'use RepositoryURL';

Warning: this symbol is deprecated: use RepositoryURL

Deprecated name for RepositoryURL.

Public property SoundImportanceNames: TStringList read FSoundImportanceNames; deprecated 'use Priority, with numeric values';

Warning: this symbol is deprecated: use Priority, with numeric values

Sound importance names and values. Each item is a name (as a string) and a value (that is stored in Objects property of the item as a pointer; add new importances by AddSoundImportanceName for comfort).

These can be used within sounds.xml file. Before using ContextOpen, you can fill this list with values.

Initially, it contains a couple of useful values (ordered here from most to least important):

Public property MusicPlayer: TLoopingChannel read GetMusicPlayer; deprecated 'use LoopingChannel[0]';

Warning: this symbol is deprecated: use LoopingChannel[0]

Comfortable way to play and control the music. Simply assign MusicPlayer.Sound to play music. Set it to Nil to stop playing music. This is just a shortcut for LoopingChannel[0].

Public property LoopingChannel [const Index: Cardinal]: TLoopingChannel read GetLoopingChannel;

Comfortable way to play and control looping non-spatial sounds, like music tracks, ambience.

The TLoopingChannel instance automatically remembers the sound it plays. You start playing just by setting TLoopingChannel.Sound to some sound. For example:

LoopingChannel[0].Sound := MyMusicTrack;

You stop by setting TLoopingChannel.Sound to something else, which can be Nil to just stop playing any looping sound on this channel. For example:

LoopingChannel[0].Sound := nil;

Each channel has it's own TLoopingChannel.Volume that can be changed at any point.

All the looping channels play simultaneously.

Note: Alternative way to play looping non-spatial sounds is to use Play with TCastlePlayingSound (setting TCastlePlayingSound.Loop to True).


Generated by PasDoc 0.16.0.