Used to play audio clips and access their properties. More...

#include <fbaudio.h>

Inheritance diagram for FBAudioClip:

[legend]

Public Member Functions
	FBAudioClip (const char *pFileName, bool pSetToDefaultDest=true, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Virtual FBDelete function.

bool	Play (FBTriggerStyle pStyle=kFBTriggerStyleContinue, FBAudioOut *pDestination=NULL)
	Play audio clip now.

void	Stop (FBAudioOut *pDestination=NULL)
	Stop any playing triggered audio clip on a specified destination.

bool	IsMediaReady ()
	Check if the audio clip constructed properly.

bool	FileOpen (char const *pPath)
	Load an audio clip file.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyString	Path
	Read Only Property: Full Path of the 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.

FBPropertyInt	Channels
	Read Only Property: the number of channels in use.

FBPropertyInt	Rate
	Read Only Property: the rate of media.

FBPropertyInt	Bits
	Read Only Property: the bits of media.

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

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

FBPropertyDouble	ClipSpeed
	Read Write Property: The speed of the media when being played.

FBPropertyTime	SrcIn
	Read Only Property: The begin time of media.

FBPropertyTime	SrcDuration
	Read Only Property: The duration time of media.

FBPropertyTime	SrcEnd
	Read Only Property: The end time of media.

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

FBPropertyTime	DstDuration
	Read Write Property: When not used in the Story, this specify when the clips stops playing.

FBPropertyTime	DstEnd
	Read Write Property: Total duration of this audio clip.

FBPropertyBool	ConstrainDstToTake
	Read Write Property: Indicates whether to constrain the EndPoint to the end of the take.

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

FBPropertyBool	LockClipSpeed
	Read Write Property: Indicates whether to lock the current playing speed.

FBPropertyTake	CurrentTake
	Read Write Property: The take this media belongs to.

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

FBPropertyDouble	Pitch
	Read Write Property: The audio clip pitch value. To write to this property, you must first set LockPitchToSpeed property to false.

FBPropertyBool	LockPitchToSpeed
	Read Write Property: Time stretch enabled factor.

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Used to play audio clips and access their properties.

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

Definition at line 304 of file fbaudio.h.

Constructor & Destructor Documentation

◆ FBAudioClip()

FBAudioClip	(	const 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

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBComponent.

◆ FileOpen()

bool FileOpen ( char const * pPath )

Load an audio clip file.

Parameters

pPath The filesystem path of the audio clip file to load.

Returns: true if the audio clip loaded successfully.

◆ IsMediaReady()

bool IsMediaReady ( )

Check if the audio clip constructed properly.

Returns: true if the audio clip was constructed properly.

◆ Play()

bool Play	(	FBTriggerStyle	pStyle = `kFBTriggerStyleContinue`,
		FBAudioOut *	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.

◆ Stop()

void Stop ( FBAudioOut * 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

◆ AccessMode

FBPropertyAccessMode AccessMode

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

Definition at line 352 of file fbaudio.h.

◆ Bits

FBPropertyInt Bits

Read Only Property: the bits of media.

Definition at line 351 of file fbaudio.h.

◆ Channels

FBPropertyInt Channels

Read Only Property: the number of channels in use.

Definition at line 349 of file fbaudio.h.

◆ ClipSpeed

FBPropertyDouble ClipSpeed

Read Write Property: The speed of the media when being played.

Definition at line 354 of file fbaudio.h.

◆ ConstrainDstToTake

FBPropertyBool ConstrainDstToTake

Read Write Property: Indicates whether to constrain the EndPoint to the end of the take.

Definition at line 364 of file fbaudio.h.

◆ CurrentTake

FBPropertyTake CurrentTake

Read Write Property: The take this media belongs to.

Definition at line 368 of file fbaudio.h.

◆ Destination

FBPropertyAudioOut Destination

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

Definition at line 369 of file fbaudio.h.

◆ DstDuration

FBPropertyTime DstDuration

Read Write Property: When not used in the Story, this specify when the clips stops playing.

Definition at line 361 of file fbaudio.h.

◆ DstEnd

FBPropertyTime DstEnd

Read Write Property: Total duration of this audio clip.

Definition at line 362 of file fbaudio.h.

◆ DstIn

FBPropertyTime DstIn

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

Definition at line 360 of file fbaudio.h.

◆ Format

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 348 of file fbaudio.h.

◆ LockClipSpeed

FBPropertyBool LockClipSpeed

Read Write Property: Indicates whether to lock the current playing speed.

Definition at line 366 of file fbaudio.h.

◆ LockPitchToSpeed

FBPropertyBool LockPitchToSpeed

Read Write Property: Time stretch enabled factor.

Definition at line 372 of file fbaudio.h.

◆ Path

FBPropertyString Path

Read Only Property: Full Path of the media.

Definition at line 345 of file fbaudio.h.

◆ Pitch

FBPropertyDouble Pitch

Read Write Property: The audio clip pitch value. To write to this property, you must first set LockPitchToSpeed property to false.

Definition at line 371 of file fbaudio.h.

◆ Rate

FBPropertyInt Rate

Read Only Property: the rate of media.

Definition at line 350 of file fbaudio.h.

◆ RelativePath

FBPropertyString RelativePath

Read Only Property: Relative path of media.

Definition at line 346 of file fbaudio.h.

◆ Scrubbing

FBPropertyBool Scrubbing

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

Definition at line 365 of file fbaudio.h.

◆ SrcDuration

FBPropertyTime SrcDuration

Read Only Property: The duration time of media.

Definition at line 357 of file fbaudio.h.

◆ SrcEnd

FBPropertyTime SrcEnd

Read Only Property: The end time of media.

Definition at line 358 of file fbaudio.h.

◆ SrcIn

FBPropertyTime SrcIn

Read Only Property: The begin time of media.

Definition at line 356 of file fbaudio.h.

◆ UseChannel

FBPropertyUseChnMode UseChannel

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

Definition at line 353 of file fbaudio.h.

The documentation for this class was generated from the following file:

fbaudio.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBAudioClip()

Member Function Documentation

◆ FBDelete()

◆ FileOpen()

◆ IsMediaReady()

◆ Play()

◆ Stop()

Member Data Documentation

◆ AccessMode

◆ Bits

◆ Channels

◆ ClipSpeed

◆ ConstrainDstToTake

◆ CurrentTake

◆ Destination

◆ DstDuration

◆ DstEnd

◆ DstIn

◆ Format

◆ LockClipSpeed

◆ LockPitchToSpeed

◆ Path

◆ Pitch

◆ Rate

◆ RelativePath

◆ Scrubbing

◆ SrcDuration

◆ SrcEnd

◆ SrcIn

◆ UseChannel