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. User code should use this only by accessing TRepoSoundEngine.LoopingChannel.

Source: audio/castlesoundengine_loopingchannel.inc (line 26).

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 Pitch: Single read GetPitch write SetPitch;

Description

Fields

Public nested const DefaultVolume = 1.0;

This item has no description.

Source: audio/castlesoundengine_loopingchannel.inc (line 54).

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

Warning: this symbol is deprecated: use DefaultVolume

This item has no description.

Source: audio/castlesoundengine_loopingchannel.inc (line 55).

Methods

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;

This item has no description.

Source: audio/castlesoundengine_loopingchannel.inc (line 51).

Public constructor Create(AnEngine: TRepoSoundEngine); reintroduce;

This item has no description.

Source: audio/castlesoundengine_loopingchannel.inc (line 57).

Public destructor Destroy; override;

This item has no description.

Source: audio/castlesoundengine_loopingchannel.inc (line 58).

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.

Source: audio/castlesoundengine_loopingchannel.inc (line 66).

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

Source: audio/castlesoundengine_loopingchannel.inc (line 70).

Public property Pitch: Single read GetPitch write SetPitch;

This item has no description.

Source: audio/castlesoundengine_loopingchannel.inc (line 72).


Generated by PasDoc 0.17.0.snapshot.