Class TPHXAudioStream

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TPHXAudioStream = class(TPHXAudioSource)

Description

A audio source that is streamed from disk when playing Use this for music

Hierarchy

Overview

Methods

Protected procedure LoadStream(const Name: String); virtual; abstract;
Protected function GetDuration: Double; virtual; abstract;
Protected function GetPosition: Double; virtual; abstract;
Protected procedure SetVolume(const Value: Single); virtual;
Protected procedure SetLooped(const Value: Boolean); virtual;
Public constructor Create;
Public procedure Play; virtual; abstract;
Public procedure Stop; virtual; abstract;
Public procedure Restart; virtual; abstract;

Properties

Public property Volume: Single read FVolume write SetVolume;
Public property Looped: Boolean read FLooped write SetLooped;
Public property Duration: Double read GetDuration;
Public property Position: Double read GetPosition;

Description

Methods

Protected procedure LoadStream(const Name: String); virtual; abstract;

Load the stream from a filename

Protected function GetDuration: Double; virtual; abstract;

Returns the length of the stream in seconds

Protected function GetPosition: Double; virtual; abstract;

Returns the current position of the stream in seconds

Protected procedure SetVolume(const Value: Single); virtual;

Set the volume level, from 0.0 (silent) to 1.0 (full)

Protected procedure SetLooped(const Value: Boolean); virtual;

Set if the stream should be looped

Public constructor Create;

Creates a new audio stream

Public procedure Play; virtual; abstract;

Play the stream

Public procedure Stop; virtual; abstract;

Stop the stream

Public procedure Restart; virtual; abstract;

Restarts the stream

Properties

Public property Volume: Single read FVolume write SetVolume;

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

Public property Looped: Boolean read FLooped write SetLooped;

If the stream should be looped

Public property Duration: Double read GetDuration;

Returns the length of the stream in seconds

Public property Position: Double read GetPosition;

Returns the current position of the stream in seconds


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