Camera Switcher Audio Manager class. More...

#include <fbcameraswitcheraudiomanager.h>

Inheritance diagram for FBCameraSwitcherAudioManager:

[legend]

Public Member Functions
bool	SetShowAudio (bool pShow)
	Set the 'Show Audio' state.

bool	GetShowAudio ()
	Get the 'Show Audio' state.

bool	SetAudioClip (FBAudioClip *pAudioClip)
	Set the Audio Clip to display on the Camera Switcher.

FBAudioClip *	GetAudioClip ()
	Get the Audio Clip displayed on the Camera Switcher.

bool	SetAudioTrack (FBStoryTrack *pAudioTrack)
	Set the Audio Track to display on the Camera Switcher.

FBStoryTrack *	GetAudioTrack ()
	Get the Audio Track displayed on the Camera Switcher.

bool	RemoveAudio ()
	Remove the audio clip or audio track currently displayed on the Camera Switcher.

bool	SetShowLeftChannel (bool pShow)
	Set the 'Show Left Channel' state.

bool	GetShowLeftChannel ()
	Get the 'Show Left Channel' state.

bool	SetShowRightChannel (bool pShow)
	Set the 'Show Right Channel' state.

bool	GetShowRightChannel ()
	Get the 'Show Right Channel' state.

bool	SetLockPitchToSpeed (bool pLock)
	Set the 'Lock Pitch to Speed' state.

bool	GetLockPitchToSpeed ()
	Get the 'Lock Pitch to Speed' state.

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 *)

Static Public Member Functions
static FBCameraSwitcherAudioManager &	TheOne ()
	Returns the only instance of FBCameraSwitcherAudioManager.

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)

Protected Member Functions
	FBCameraSwitcherAudioManager ()
	Constructor.

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.

Additional Inherited Members
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.

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

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

Camera Switcher Audio Manager class.

This class allows users to interact with the Audio Manager of the Camera Switcher.

Definition at line 67 of file fbcameraswitcheraudiomanager.h.

Constructor & Destructor Documentation

◆ FBCameraSwitcherAudioManager()

FBCameraSwitcherAudioManager ( )

protected

Constructor.

Protected constructor, use TheOne() access instead.

Member Function Documentation

◆ GetAudioClip()

FBAudioClip * GetAudioClip ( )

Get the Audio Clip displayed on the Camera Switcher.

Returns: The Audio Clip displayed, nullptr (C++) / None (Python) if any.

◆ GetAudioTrack()

FBStoryTrack * GetAudioTrack ( )

Get the Audio Track displayed on the Camera Switcher.

Returns: The Audio Track displayed, nullptr (C++) / None (Python) if any.

◆ GetLockPitchToSpeed()

bool GetLockPitchToSpeed ( )

Get the 'Lock Pitch to Speed' state.

Returns: True if the 'Lock Pitch to Speed' state is set, false otherwise.

◆ GetShowAudio()

bool GetShowAudio ( )

Get the 'Show Audio' state.

Returns: True if the 'Show Audio' state is set, false otherwise.

◆ GetShowLeftChannel()

bool GetShowLeftChannel ( )

Get the 'Show Left Channel' state.

Returns: True if the 'Show Left Channel' state is set, false otherwise.

◆ GetShowRightChannel()

bool GetShowRightChannel ( )

Get the 'Show Right Channel' state.

Returns: True if the 'Show Right Channel' state is set, false otherwise.

◆ RemoveAudio()

bool RemoveAudio ( )

Remove the audio clip or audio track currently displayed on the Camera Switcher.

Returns: True if the operation is successful, false otherwise.

◆ SetAudioClip()

bool SetAudioClip ( FBAudioClip * pAudioClip )

Set the Audio Clip to display on the Camera Switcher.

Parameters

pAudioClip The Audio Clip to display.

Returns: True if the operation is successful, false otherwise.

◆ SetAudioTrack()

bool SetAudioTrack ( FBStoryTrack * pAudioTrack )

Set the Audio Track to display on the Camera Switcher.

Parameters

pAudioTrack The Audio Track to display.

Returns: True if the operation is successful, false otherwise.

◆ SetLockPitchToSpeed()

bool SetLockPitchToSpeed ( bool pLock )

Set the 'Lock Pitch to Speed' state.

Parameters

pLock True to lock pitch to speed, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ SetShowAudio()

bool SetShowAudio ( bool pShow )

Set the 'Show Audio' state.

Parameters

pShow True to show the Audio waveform, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ SetShowLeftChannel()

bool SetShowLeftChannel ( bool pShow )

Set the 'Show Left Channel' state.

Parameters

pShow True to show the left channel, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ SetShowRightChannel()

bool SetShowRightChannel ( bool pShow )

Set the 'Show Right Channel' state.

Parameters

pShow True to show the right channel, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ TheOne()

static FBCameraSwitcherAudioManager & TheOne ( )

static

Returns the only instance of FBCameraSwitcherAudioManager.

Returns: The only instance of FBCameraSwitcherAudioManager.

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

fbcameraswitcheraudiomanager.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCameraSwitcherAudioManager()

Member Function Documentation

◆ GetAudioClip()

◆ GetAudioTrack()

◆ GetLockPitchToSpeed()

◆ GetShowAudio()

◆ GetShowLeftChannel()

◆ GetShowRightChannel()

◆ RemoveAudio()

◆ SetAudioClip()

◆ SetAudioTrack()

◆ SetLockPitchToSpeed()

◆ SetShowAudio()

◆ SetShowLeftChannel()

◆ SetShowRightChannel()

◆ TheOne()