#include <mobu-python-api.h>

Class 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.

Inheritance diagram for FBAudioClip:

Public Member Functions
	__reduce__ ()

	FBDelete (FBAudioClip arg1)
	Virtual FBDelete function. More...

	__init__ (object arg1, str arg2)
	Constructor. More...

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

bool	Play (FBAudioClip arg1, FBTriggerStyle arg2, FBAudioOut arg3)
	Play audio clip now. More...

	Stop (FBAudioClip arg1, FBAudioOut arg2)
	Stop any playing triggered audio clip on a specified destination. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
ORSDK2018::FBPropertyString	Path
	Read Only Property: Full Path of the media. More...

ORSDK2018::FBPropertyString	Filename
	[Deprecated]Read Only Property: Refer to Path More...

ORSDK2018::FBPropertyString	RelativePath
	Read Only Property: Relative path of media. More...

FBPropertyInt	Format
	Read Only Property: Data format of media, including rate, bits and channels count. More...

FBPropertyInt	Bits
	Read Only Property: the bits of media. More...

FBPropertyInt	Rate
	Read Only Property: the rate of media. More...

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

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

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

FBPropertyUseChnMode	UseChannelMode
	[Deprecated]Read Write Property: Enables you to control which track are used with stereo clips. More...

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

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

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

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

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

FBPropertyTime	InPoint
	[Deprecated]Read Write Property: Refer to DstIn. More...

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

FBPropertyTime	Duration
	[Deprecated]Read Write Property: Refer to DstDuration. More...

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

FBPropertyTime	EndPoint
	[Deprecated]Read Write Property: Refer to DstEnd. More...

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

FBPropertyBool	TakeSetsInPoint
	[Deprecated]Read Write Property: Indicates whether to lock the InPoint to the start of the take. More...

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

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

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

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

FBPropertyDouble	Pitch
	Read Write Property: The audio clip pitch value. More...

FBPropertyBool	LockPitchToSpeed
	Read Write Property: Time stretch enabled factor. More...

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None

C++ Signature:

 FBAudioClip(const char * pFileName, bool pSetToDefaultDest = true, HIObject pObject = ((void *) 0))

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.

See the C++ reference

__reduce__ ( )

FBDelete ( FBAudioClip arg1 )

Virtual FBDelete function.

Python Docstring:

FBDelete( (FBAudioClip)arg1) -> None

C++ Signature:

void FBDelete()

See the C++ reference

bool IsMediaReady ( FBAudioClip arg1 )

Check if the audio clip constructed properly.

Python Docstring:

IsMediaReady( (FBAudioClip)arg1) -> bool

C++ Signature:

bool IsMediaReady()

Returns: true if the audio clip was constructed properly.

See the C++ reference

bool Play	(	FBAudioClip	arg1,
		FBTriggerStyle	arg2,
		FBAudioOut	arg3
	)

Play audio clip now.

Python Docstring:

Play( (FBAudioClip)arg1 [, (FBTriggerStyle)arg2 [, (FBAudioOut)arg3]]) -> bool

C++ Signature:

bool Play(FBTriggerStyle pStyle = kFBTriggerStyleContinue, ORSDK2018::FBAudioOut * pDestination = ((void *) 0))

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.

See the C++ reference

Stop	(	FBAudioClip	arg1,
		FBAudioOut	arg2
	)

Stop any playing triggered audio clip on a specified destination.

Python Docstring:

Stop( (FBAudioClip)arg1 [, (FBAudioOut)arg2]) -> None

C++ Signature:

void Stop(ORSDK2018::FBAudioOut * pDestination = ((void *) 0))

Parameters

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

See the C++ reference

Member Data Documentation

FBPropertyAccessMode AccessMode

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

See the C++ reference

FBPropertyInt Bits

Read Only Property: the bits of media.

See the C++ reference

FBPropertyInt Channels

Read Only Property: the number of channels in use.

See the C++ reference

FBPropertyDouble ClipSpeed

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

See the C++ reference

FBPropertyBool ConstrainDstToTake

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

See the C++ reference

FBPropertyTake CurrentTake

Read Write Property: The take this media belongs to.

See the C++ reference

FBPropertyAudioOut Destination

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

See the C++ reference

FBPropertyTime DstDuration

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

See the C++ reference

FBPropertyTime DstEnd

Read Write Property: Total duration of this audio clip.

See the C++ reference

FBPropertyTime DstIn

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

See the C++ reference

FBPropertyTime Duration

[Deprecated]Read Write Property: Refer to DstDuration.

See the C++ reference

FBPropertyTime EndPoint

[Deprecated]Read Write Property: Refer to DstEnd.

See the C++ reference

ORSDK2018::FBPropertyString Filename

[Deprecated]Read Only Property: Refer to Path

See the C++ reference

FBPropertyInt Format

Read Only Property: Data format of media, including rate, bits and channels count.

You can typecast it to a FBAudioFmt.

See the C++ reference

FBPropertyTime InPoint

[Deprecated]Read Write Property: Refer to DstIn.

See the C++ reference

FBPropertyBool LockClipSpeed

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

See the C++ reference

FBPropertyBool LockPitchToSpeed

Read Write Property: Time stretch enabled factor.

See the C++ reference

ORSDK2018::FBPropertyString Path

Read Only Property: Full Path of the media.

See the C++ reference

FBPropertyDouble Pitch

Read Write Property: The audio clip pitch value.

To write to this property, you must first set LockPitchToSpeed property to false.

See the C++ reference

FBPropertyInt Rate

Read Only Property: the rate of media.

See the C++ reference

ORSDK2018::FBPropertyString RelativePath

Read Only Property: Relative path of media.

See the C++ reference

FBPropertyBool Scrubbing

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

See the C++ reference

FBPropertyTime SrcDuration

Read Only Property: The duration time of media.

See the C++ reference

FBPropertyTime SrcEnd

Read Only Property: The end time of media.

See the C++ reference

FBPropertyTime SrcIn

Read Only Property: The begin time of media.

See the C++ reference

FBPropertyBool TakeSetsInPoint

[Deprecated]Read Write Property: Indicates whether to lock the InPoint to the start of the take.

See the C++ reference

FBPropertyUseChnMode UseChannel

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

See the C++ reference

FBPropertyUseChnMode UseChannelMode

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

See the C++ reference

FBAudioClip Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation