Class TSoundParameters

Unit

Declaration

type TSoundParameters = class(TObject)

Description

Parameters to use when playing sound, see TSoundEngine.PlaySound.

Hierarchy

  • TObject
  • TSoundParameters

Overview

Fields

Public Buffer: TSoundBuffer;
Public Spatial: boolean;
Public Looping: boolean;
Public Importance: Cardinal;
Public Gain: Single;
Public MinGain: Single;
Public MaxGain: Single;
Public Position: TVector3;
Public Pitch: Single;
Public RolloffFactor: Single;
Public ReferenceDistance: Single;
Public MaxDistance: Single;
Public Offset: Single;

Methods

Public constructor Create;

Description

Fields

Public Buffer: TSoundBuffer;
 
Public Spatial: boolean;
 
Public Looping: boolean;
 
Public Importance: Cardinal;
 
Public Gain: Single;

Gain is the volume of sound. MinGain and MaxGain determine how it can change because of spatialization (where the sound may get quieter / louder as you get further / closer to it). By default, Gain and MaxGain are 1.0, and MinGain is 0.0.

Public MinGain: Single;

Gain is the volume of sound. MinGain and MaxGain determine how it can change because of spatialization (where the sound may get quieter / louder as you get further / closer to it). By default, Gain and MaxGain are 1.0, and MinGain is 0.0.

Public MaxGain: Single;

Gain is the volume of sound. MinGain and MaxGain determine how it can change because of spatialization (where the sound may get quieter / louder as you get further / closer to it). By default, Gain and MaxGain are 1.0, and MinGain is 0.0.

Public Position: TVector3;

The position of sound in 3D space. Used only if Spatial = True.

Public Pitch: Single;

Pitch allows to play the sound faster. By default it is 1.0.

Public RolloffFactor: Single;

See TSoundEngine.DefaultRolloffFactor for description. The TSoundEngine.DefaultRolloffFactor is also the default value of this field.

Public ReferenceDistance: Single;

See TSoundEngine.DefaultReferenceDistance for description. The TSoundEngine.DefaultReferenceDistance is also the default value of this field.

Public MaxDistance: Single;

See TSoundEngine.DefaultMaxDistance for description. The TSoundEngine.DefaultMaxDistance is also the default value of this field.

Public Offset: Single;

Offset is a position in time of the sound.

Methods

Public constructor Create;
 

Generated by PasDoc 0.15.0.