DzAudioClip Class Reference

Class that encapsulates audio playback. More...

Inheritance diagram for DzAudioClip:

DzBase DzRefCountedItem QObject Object DzMacAudioClip DzWinAudioClip List of all members.

Properties

DzTime currentPosition
String filename
DzTime length
Number rate

Methods

DzError openFile (String filename)
void pause ()
void play ()
void reset ()

Detailed Description

Class that encapsulates audio playback.

This class is implemented by platform specific audioclip classes, DzWinAudioClip and DzMacAudioClip.

See also:
DzScene::getAudio(), DzScene::setAudio(), DzAudioImporter, DzMultiMediaMgr::importAudioClip()


Member Function Documentation

DzError DzAudioClip::openFile ( String  filename  ) 

Opens the file specified by filename and sets up the audio clip.

Parameters:
filename The name of the audio file to load.
Returns:
true if the file was successfully opened, false otherwise;

void DzAudioClip::pause (  ) 

Pauses the audio clip without resetting current position.

void DzAudioClip::play (  ) 

Plays the audio clip from current position.

void DzAudioClip::reset (  ) 

Resets the current position of the audio clip to the beginning.


Member Data Documentation

DzTime DzAudioClip::currentPosition

The current position of the audio clip from the start.

String DzAudioClip::filename

The name of the file the audio clip was loaded from (Read Only)

DzTime DzAudioClip::length

The length of the audio clip (Read Only)

Number DzAudioClip::rate

The current rate multiplier for the audio clip


Generated on Thu Sep 24 12:21:10 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.