FBAudioClip Class Reference

#include <fbaudio.h>

FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip FBAudioClip

Inheritance diagram for FBAudioClip:

[legend]

List of all members.

---

Detailed Description

Audio Clip class.

This class permits you to access audio clip's properties to read or change them.

Definition at line 134 of file fbaudio.h.

Public Member Functions
	FBAudioClip (char *pFileName, bool pSetToDefaultDest=true, HIObject pObject=NULL)
	Constructor.
virtual void	FBDelete ()
	Virtual FBDelete function.
bool	Play (FBTriggerStyle pStyle=kFBTriggerStyleContinue, HFBAudioOut pDestination=NULL)
	Play audio clip now.
void	Stop (HFBAudioOut pDestination=NULL)
	Stop any playing triggered audio clip on a specified destination.
Public Attributes
FBPropertyString	Filename
	Read Only Property: Filename of media.
FBPropertyString	RelativePath
	Read Only Property: Relative path of media.
FBPropertyInt	Format
	Read Only Property: Data format of media, including rate, bits and channels count. You can typecast it to a FBAudioFmt.
FBPropertyAudioOut	Destination
	Read Write Property: The audio output destination where the clip will be played.
FBPropertyTime	Duration
	Read Only Property: Total duration of this audio clip.
FBPropertyTime	InPoint
	Read Write Property: When not used in the Story, this specify when the clips begin to play.
FBPropertyAccessMode	AccessMode
	Read Write Property: Specify the media data access mode between disk or memory.
FBPropertyUseChnMode	UseChannelMode
	Read Write Property: Enables you to control which track are used with stereo clips.
FBPropertyBool	Scrubbing
	Read Write Property: Control which clip (one at a time) can shuttle when playing a various speeds.

---

Constructor & Destructor Documentation

FBAudioClip	(	char *	pFileName,
		bool	pSetToDefaultDest = true,
		HIObject	pObject = NULL
	)

Constructor.

Parameters:

	pFileName	The complete file path of the media file to access.
	pSetToDefaultDest	If true and the media file open successfully, it will automatically be connected to an output device.
	pObject	For internal use only.

---

Member Function Documentation

virtual void FBDelete

(

)

[virtual]

Virtual FBDelete function.

Reimplemented from FBComponent.

bool Play	(	FBTriggerStyle	pStyle = kFBTriggerStyleContinue,
		HFBAudioOut	pDestination = NULL
	)

Play audio clip now.

Parameters:

	pStyle	How the audio clip should be triggered.
	pDestination	Where the audio clip should be played. If NULL, it will play on the default destination.

Returns:

Return true if the buffer for the audio clip was successfully allocated so that you can hear the sound.

void Stop

(

HFBAudioOut

pDestination = NULL

)

Stop any playing triggered audio clip on a specified destination.

Parameters:

pDestination

Where the audio clip is playing. If NULL, the default destination will be used.

---

Member Data Documentation

FBPropertyString Filename

Read Only Property: Filename of media.

Definition at line 163 of file fbaudio.h.

FBPropertyString RelativePath

Read Only Property: Relative path of media.

Definition at line 164 of file fbaudio.h.

FBPropertyInt Format

Read Only Property: Data format of media, including rate, bits and channels count. You can typecast it to a FBAudioFmt.

Definition at line 165 of file fbaudio.h.

FBPropertyAudioOut Destination

Read Write Property: The audio output destination where the clip will be played.

Definition at line 166 of file fbaudio.h.

FBPropertyTime Duration

Read Only Property: Total duration of this audio clip.

Definition at line 167 of file fbaudio.h.

FBPropertyTime InPoint

Read Write Property: When not used in the Story, this specify when the clips begin to play.

Definition at line 168 of file fbaudio.h.

FBPropertyAccessMode AccessMode

Read Write Property: Specify the media data access mode between disk or memory.

Definition at line 169 of file fbaudio.h.

FBPropertyUseChnMode UseChannelMode

Read Write Property: Enables you to control which track are used with stereo clips.

Definition at line 170 of file fbaudio.h.

FBPropertyBool Scrubbing

Read Write Property: Control which clip (one at a time) can shuttle when playing a various speeds.

Definition at line 171 of file fbaudio.h.

---

Please send us your comments about this page.