Class TLoopingChannel
Unit
CastleSoundEngine
Declaration
type TLoopingChannel = class(TObject)
Description
Looping sound management, to easily play music or other looping sounds.
Instance of this class should be created only internally by the TRepoSoundEngine, always use this through TRepoSoundEngine.MusicPlayer or TRepoSoundEngine.LoopingChannel.
Hierarchy
Overview
Fields
Methods
Properties
Description
Fields
 |
nested const DefaultVolume = 1.0; |
|
|
|
nested const DefaultMusicVolume = 1.0 deprecated 'use DefaultVolume'; |
|
Warning: this symbol is deprecated: use DefaultVolume |
Methods
|
destructor Destroy; override; |
|
|
Properties
|
property Sound: TSoundType read FSound write SetSound; |
|
Currently played sound. Set to stNone to stop playing. Set to anything else to play.
Changing value of this property (when both the old and new values are <> stNone and are different) restarts playing the sound.
By default none (stNone).
|
|
property Volume: Single read GetVolume write SetVolume default DefaultVolume; |
|
Volume. This must always be within 0..1 range. 0.0 means that there is no music (this case should be optimized).
|
|
property MusicVolume: Single read GetVolume write SetVolume default DefaultVolume; deprecated 'use Volume'; |
|
Warning: this symbol is deprecated: use Volume |
|
property Pitch: Single read GetPitch write SetPitch; |
|
|
Generated by PasDoc 0.16.0.