User Tools

Site Tools


DzAudioClip

Class that encapsulates audio playback.

More...

Inherits :

Properties

Methods

DAZ Script
DzErroropenFile ( String filename )
voidpause ()
voidplay ()
voidreset ()

Detailed Description

This class is implemented by platform specific audioclip classes, winaudioclip_dz and macaudioclip_dz.

See Also:

Properties


DzTime : currentPosition

The current position of the audio clip from the start.


String : filename

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


DzTime : length

The length of the audio clip (Read Only)


Number : rate

The current rate multiplier for the audio clip

Methods


DzError : openFile( String filename )

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

Parameter(s):

  • filename - The name of the audio file to load.

Return Value:

  • true if the file was successfully opened, false otherwise;

void : pause()

Pauses the audio clip without resetting current position.


void : play()

Plays the audio clip from current position.


void : reset()

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