Class TPHXAudioSample

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TPHXAudioSample = class(TPHXAudioSource)

Description

A Audio source that is loaded into memory before playing

Hierarchy

Overview

Methods

Protected procedure LoadSample(Stream: TStream); virtual; abstract;
Protected procedure SetVolume(const Volume: Single); virtual;
Public constructor Create;
Public procedure LoadFromFile(const FileName: String);
Public procedure LoadFromStream(Stream: TStream);
Public procedure Play; overload; virtual; abstract;
Public procedure Play(const Volume: Single); overload; virtual; abstract;
Public procedure Stop; virtual; abstract;

Properties

Public property Volume: Single read FVolume write SetVolume;

Description

Methods

Protected procedure LoadSample(Stream: TStream); virtual; abstract;

Load the sample from a stream

Protected procedure SetVolume(const Volume: Single); virtual;
 
Public constructor Create;

Creates a new audio sample

Public procedure LoadFromFile(const FileName: String);

Load the audio sample from a file

Public procedure LoadFromStream(Stream: TStream);

Load the audio sample from a steam

Public procedure Play; overload; virtual; abstract;

Play this sample

Public procedure Play(const Volume: Single); overload; virtual; abstract;

Play this sample with a given volume

Public procedure Stop; virtual; abstract;

Stops all instances of this sample.

Properties

Public property Volume: Single read FVolume write SetVolume;

The volume level, from 0.0 (silent) to 1.0 (full)


Generated by PasDoc 0.13.0 on 2013-08-26 11:02:34