Interface to a tape deck. More...

#include <fbdeck.h>

Inheritance diagram for FBDeck:

[legend]

Public Member Functions
void	ThreadSync ()

	FBDeck (const char *pName, HIObject pObject=NULL)
	Constructor.

	IObject_Declare (override)

virtual void	DeckStatusUpdateNotify ()
	Interface to IObject.

virtual void	DeckAutoCommandsNotify ()
	Deck auto commands notification.

virtual void	Rewind ()
	Rewind.

virtual void	Stop ()
	Stop.

virtual void	Play (double pSpeed=1.0)
	Play forwards.

virtual void	Forward ()
	Fast forward.

virtual void	ReversePlay (double pSpeed=1.0)
	Play backwards.

virtual void	StepBack ()
	Step backwards.

virtual void	StepForward ()
	Step forwards.

virtual void	Eject ()
	Eject tape.

virtual void	CueAt (FBTime pTime)
	Cue deck at a given time.

virtual FBTime	GetTime ()
	Get the deck's time.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	FBX Store/Retrieval functions.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

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
const char *	UniqueName
	internal Unique name.

FBPropertyString	IconFilename
	Read Write Property: Filename of icon for deck.

FBPropertyBool	Online
	Read Write Property: Is deck online?

FBPropertyTime	Offset
	Read Write Property: Current offset for the TC.

FBPropertyTime	Latency
	Read Write Property: Latency of response for the deck;

FBPropertyTime	PreRoll
	Read Write Property: Pre-Roll.

FBPropertyTime	PostRoll
	Read Write Property: Post-Roll.

FBPropertyDeckTransportMode	TransportControl
	Read Write Property: Mode w/r to TC (None, Sync, Main );

FBPropertyBool	CassetteInside
	Read Only Property: Is the cassette inside?

FBPropertyBool	PlayingForward
	Read Only Property: Playing forward?

FBPropertyBool	PlayingBackward
	Read Only Property: Playing backwards?

FBPropertyBool	EE
	Read Write Property: Is EE on?

FBPropertyBool	StandBy
	Read Write Property: In standby mode?

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

Interface to a tape deck.

Definition at line 114 of file fbdeck.h.

Constructor & Destructor Documentation

◆ FBDeck()

FBDeck	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Name of deck.
pObject	Internal parent object (default is NULL).

Member Function Documentation

◆ CueAt()

virtual void CueAt ( FBTime pTime )

virtual

Cue deck at a given time.

Parameters

pTime Time to cue deck at.

◆ DeckAutoCommandsNotify()

virtual void DeckAutoCommandsNotify ( )

virtual

Deck auto commands notification.

◆ DeckStatusUpdateNotify()

virtual void DeckStatusUpdateNotify ( )

virtual

Interface to IObject.

Deck status update notification.

◆ Eject()

virtual void Eject ( )

virtual

Eject tape.

◆ FbxStore()

virtual bool FbxStore	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

virtual

FBX Store/Retrieval functions.

◆ Forward()

virtual void Forward ( )

virtual

Fast forward.

◆ GetTime()

virtual FBTime GetTime ( )

virtual

Get the deck's time.

Returns: Time of deck.

◆ Play()

virtual void Play ( double pSpeed = 1.0 )

virtual

Play forwards.

Parameters

pSpeed Playback speed (default is 1.0).

◆ ReversePlay()

virtual void ReversePlay ( double pSpeed = 1.0 )

virtual

Play backwards.

Parameters

pSpeed Playback speed(default is 1.0).

◆ Rewind()

virtual void Rewind ( )

virtual

Rewind.

◆ StepBack()

virtual void StepBack ( )

virtual

Step backwards.

◆ StepForward()

virtual void StepForward ( )

virtual

Step forwards.

◆ Stop()

virtual void Stop ( )

virtual

Stop.

Member Data Documentation

◆ CassetteInside

FBPropertyBool CassetteInside

Read Only Property: Is the cassette inside?

Definition at line 177 of file fbdeck.h.

◆ EE

FBPropertyBool EE

Read Write Property: Is EE on?

Definition at line 180 of file fbdeck.h.

◆ IconFilename

FBPropertyString IconFilename

Read Write Property: Filename of icon for deck.

Definition at line 166 of file fbdeck.h.

◆ Latency

FBPropertyTime Latency

Read Write Property: Latency of response for the deck;

Definition at line 171 of file fbdeck.h.

◆ Offset

FBPropertyTime Offset

Read Write Property: Current offset for the TC.

Definition at line 170 of file fbdeck.h.

◆ Online

FBPropertyBool Online

Read Write Property: Is deck online?

Definition at line 169 of file fbdeck.h.

◆ PlayingBackward

FBPropertyBool PlayingBackward

Read Only Property: Playing backwards?

Definition at line 179 of file fbdeck.h.

◆ PlayingForward

FBPropertyBool PlayingForward

Read Only Property: Playing forward?

Definition at line 178 of file fbdeck.h.

◆ PostRoll

FBPropertyTime PostRoll

Read Write Property: Post-Roll.

Definition at line 173 of file fbdeck.h.

◆ PreRoll

FBPropertyTime PreRoll

Read Write Property: Pre-Roll.

Definition at line 172 of file fbdeck.h.

◆ StandBy

FBPropertyBool StandBy

Read Write Property: In standby mode?

Definition at line 181 of file fbdeck.h.

◆ TransportControl

FBPropertyDeckTransportMode TransportControl

Read Write Property: Mode w/r to TC (None, Sync, Main );

Definition at line 174 of file fbdeck.h.

◆ UniqueName

const char* UniqueName

internal Unique name.

Definition at line 117 of file fbdeck.h.

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

fbdeck.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBDeck()

Member Function Documentation

◆ CueAt()

◆ DeckAutoCommandsNotify()

◆ DeckStatusUpdateNotify()

◆ Eject()

◆ FbxStore()

◆ Forward()

◆ GetTime()

◆ Play()

◆ ReversePlay()

◆ Rewind()

◆ StepBack()

◆ StepForward()

◆ Stop()

Member Data Documentation

◆ CassetteInside

◆ EE

◆ IconFilename

◆ Latency

◆ Offset

◆ Online

◆ PlayingBackward

◆ PlayingForward

◆ PostRoll

◆ PreRoll

◆ StandBy

◆ TransportControl

◆ UniqueName