Class TLoopingChannel

Unit

Declaration

type TLoopingChannel = class(TComponent)

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

  • TObject
  • TPersistent
  • TComponent
  • TLoopingChannel

Overview

Fields

Public nested const DefaultVolume = 1.0;
Public nested const DefaultMusicVolume = 1.0 deprecated 'use DefaultVolume';

Methods

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;
Public constructor Create(AnEngine: TRepoSoundEngine); reintroduce;
Public destructor Destroy; override;

Properties

Public property Sound: TCastleSound read FSound write SetSound;
Public property Volume: Single read GetVolume write SetVolume default DefaultVolume;
Public property MusicVolume: Single read GetVolume write SetVolume default DefaultVolume; deprecated 'use Volume';
Public property Pitch: Single read GetPitch write SetPitch;

Description

Fields

Public nested const DefaultVolume = 1.0;
 
Public nested const DefaultMusicVolume = 1.0 deprecated 'use DefaultVolume';

Warning: this symbol is deprecated: use DefaultVolume

 

Methods

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;
 
Public constructor Create(AnEngine: TRepoSoundEngine); reintroduce;
 
Public destructor Destroy; override;
 

Properties

Public property Sound: TCastleSound read FSound write SetSound;

Currently played looping sound. Set to Nil to just stop playing.

This only plays non-spatial sounds, as it doesn't give any control over the sound 3D position. Instead of this method, use TCastleSoundSource (attached to some TCastleTransform) for spatial sounds to control their 3D position.

Public 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).

Public property MusicVolume: Single read GetVolume write SetVolume default DefaultVolume; deprecated 'use Volume';

Warning: this symbol is deprecated: use Volume

 
Public property Pitch: Single read GetPitch write SetPitch;
 

Generated by PasDoc 0.16.0.