FBDeck Class Reference

Interface to a tape deck. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBDeck:

Public Member Functions
	FBDeck (str pName)
	Constructor.
	CueAt (FBTime pTime)
	Cue deck at a given time.
	DeckAutoCommandsNotify ()
	Deck auto commands notification.
	DeckStatusUpdateNotify ()
	Interface to IObject.
	Eject ()
	Eject tape.
	Forward ()
	Fast forward.
FBTime	GetTime ()
	Get the deck's time.
	Play (float pSpeed=1.0)
	Play forwards.
	ReversePlay (float pSpeed=1.0)
	Play backwards.
	Rewind ()
	Rewind.
	StepBack ()
	Step backwards.
	StepForward ()
	Step forwards.
	Stop ()
	Stop.
	ThreadSync ()
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
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.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
bool	CassetteInside
	Read Only Property: Is the cassette inside?
bool	EE
	Read Write Property: Is EE on?
str	IconFilename
	Read Write Property: Filename of icon for deck.
FBTime	Latency
	Read Write Property: Latency of response for the deck;
FBTime	Offset
	Read Write Property: Current offset for the TC.
bool	Online
	Read Write Property: Is deck online?
bool	PlayingBackward
	Read Only Property: Playing backwards?
bool	PlayingForward
	Read Only Property: Playing forward?
FBTime	PostRoll
	Read Write Property: Post-Roll.
FBTime	PreRoll
	Read Write Property: Pre-Roll.
bool	StandBy
	Read Write Property: In standby mode?
FBDeckTransportMode	TransportControl
	Read Write Property: Mode w/r to TC (None, Sync, Main );
str	UniqueName
	internal Unique name.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Interface to a tape deck.

Constructor & Destructor Documentation

FBDeck()

FBDeck

(

str

pName

)

Constructor.

Parameters

pName

Name of deck.

Member Function Documentation

CueAt()

CueAt

(

FBTime

pTime

)

Cue deck at a given time.

Parameters

pTime

Time to cue deck at.

DeckAutoCommandsNotify()

DeckAutoCommandsNotify

(

)

Deck auto commands notification.

DeckStatusUpdateNotify()

DeckStatusUpdateNotify

(

)

Interface to IObject.

Deck status update notification.

Eject()

Eject

(

)

Eject tape.

Forward()

Forward

(

)

Fast forward.

GetTime()

FBTime GetTime

(

)

Get the deck's time.

Returns

Time of deck.

Play()

Play

(

float

pSpeed = 1.0

)

Play forwards.

Parameters

pSpeed

Playback speed (default is 1.0).

ReversePlay()

ReversePlay

(

float

pSpeed = 1.0

)

Play backwards.

Parameters

pSpeed

Playback speed(default is 1.0).

Rewind()

Rewind

(

)

Rewind.

StepBack()

StepBack

(

)

Step backwards.

StepForward()

StepForward

(

)

Step forwards.

Stop()

Stop

(

)

Stop.

ThreadSync()

ThreadSync

(

)

Member Data Documentation

CassetteInside

bool CassetteInside

Read Only Property: Is the cassette inside?

EE

bool EE

Read Write Property: Is EE on?

IconFilename

str IconFilename

Read Write Property: Filename of icon for deck.

Latency

FBTime Latency

Read Write Property: Latency of response for the deck;

Offset

FBTime Offset

Read Write Property: Current offset for the TC.

Online

bool Online

Read Write Property: Is deck online?

PlayingBackward

bool PlayingBackward

Read Only Property: Playing backwards?

PlayingForward

bool PlayingForward

Read Only Property: Playing forward?

PostRoll

FBTime PostRoll

Read Write Property: Post-Roll.

PreRoll

FBTime PreRoll

Read Write Property: Pre-Roll.

StandBy

bool StandBy

Read Write Property: In standby mode?

TransportControl

FBDeckTransportMode TransportControl

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

UniqueName

str UniqueName

internal Unique name.