FBDeck Class Reference

#include <mobu-python-api.h>

Class Description

Interface to a tape deck.

+ Inheritance diagram for FBDeck:

Public Member Functions

 __reduce__ ()
 
 DeckAutoCommandsNotify (FBDeck arg1)
 Deck auto commands notification. More...
 
 CueAt (FBDeck arg1, FBTime arg2)
 Cue deck at a given time. More...
 
 DeckStatusUpdateNotify (FBDeck arg1)
 Interface to IObject. More...
 
 Eject (FBDeck arg1)
 Eject tape. More...
 
 Forward (FBDeck arg1)
 Fast forward. More...
 
FBTime GetTime (FBDeck arg1)
 Get the deck's time. More...
 
 Play (FBDeck arg1, object arg2)
 Play forwards. More...
 
 ReversePlay (FBDeck arg1, object arg2)
 Play backwards. More...
 
 Rewind (FBDeck arg1)
 Rewind. More...
 
 StepBack (FBDeck arg1)
 Step backwards. More...
 
 StepForward (FBDeck arg1)
 Step forwards. More...
 
 Stop (FBDeck arg1)
 Stop. More...
 
 ThreadSync (FBDeck arg1)
 
 __init__ (...)
 Constructor. 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

FBPropertyBool CassetteInside
 Read Only Property: Is the cassette inside? More...
 
FBPropertyBool EE
 Read Write Property: Is EE on? More...
 
ORSDK2018::FBPropertyString IconFilename
 Read Write Property: Filename of icon for deck. More...
 
FBPropertyTime Latency
 Read Write Property: Latency of response for the deck; More...
 
FBPropertyTime Offset
 Read Write Property: Current offset for the TC. More...
 
FBPropertyBool Online
 Read Write Property: Is deck online? More...
 
FBPropertyBool PlayingBackward
 Read Only Property: Playing backwards? More...
 
FBPropertyBool PlayingForward
 Read Only Property: Playing forward? More...
 
FBPropertyTime PostRoll
 Read Write Property: Post-Roll. More...
 
FBPropertyTime PreRoll
 Read Write Property: Pre-Roll. More...
 
FBPropertyBool StandBy
 Read Write Property: In standby mode? More...
 
FBPropertyDeckTransportMode TransportControl
 Read Write Property: Mode w/r to TC (None, Slave, Master ); More...
 
const char * UniqueName
 internal Unique name. 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__ (   ...)

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Signature:

 FBDeck(const char * pName, HIObject pObject = ((void *) 0)) 
Parameters
pNameName of deck.
pObjectInternal parent object (default is NULL).
__reduce__ ( )
CueAt ( FBDeck  arg1,
FBTime  arg2 
)

Cue deck at a given time.

Python Docstring:

CueAt( (FBDeck)arg1, (FBTime)arg2) -> None 

C++ Signature:

void CueAt(ORSDK2018::FBTime pTime) 
Parameters
pTimeTime to cue deck at.
DeckAutoCommandsNotify ( FBDeck  arg1)

Deck auto commands notification.

Python Docstring:

DeckAutoCommandsNotify( (FBDeck)arg1) -> None 

C++ Signature:

void DeckAutoCommandsNotify() 
DeckStatusUpdateNotify ( FBDeck  arg1)

Interface to IObject.

Python Docstring:

DeckStatusUpdateNotify( (FBDeck)arg1) -> None 

C++ Signature:

void DeckStatusUpdateNotify() 

Deck status update notification.

Eject ( FBDeck  arg1)

Eject tape.

Python Docstring:

Eject( (FBDeck)arg1) -> None 

C++ Signature:

void Eject() 
Forward ( FBDeck  arg1)

Fast forward.

Python Docstring:

Forward( (FBDeck)arg1) -> None 

C++ Signature:

void Forward() 
FBTime GetTime ( FBDeck  arg1)

Get the deck's time.

Python Docstring:

GetTime( (FBDeck)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetTime() 
Returns
Time of deck.
Play ( FBDeck  arg1,
object  arg2 
)

Play forwards.

Python Docstring:

Play( (FBDeck)arg1 [, (object)arg2]) -> None 

C++ Signature:

void Play(double pSpeed = 1.0) 
Parameters
pSpeedPlayback speed (default is 1.0).
ReversePlay ( FBDeck  arg1,
object  arg2 
)

Play backwards.

Python Docstring:

ReversePlay( (FBDeck)arg1 [, (object)arg2]) -> None 

C++ Signature:

void ReversePlay(double pSpeed = 1.0) 
Parameters
pSpeedPlayback speed(default is 1.0).
Rewind ( FBDeck  arg1)

Rewind.

Python Docstring:

Rewind( (FBDeck)arg1) -> None 

C++ Signature:

void Rewind() 
StepBack ( FBDeck  arg1)

Step backwards.

Python Docstring:

StepBack( (FBDeck)arg1) -> None 

C++ Signature:

void StepBack() 
StepForward ( FBDeck  arg1)

Step forwards.

Python Docstring:

StepForward( (FBDeck)arg1) -> None 

C++ Signature:

void StepForward() 
Stop ( FBDeck  arg1)

Stop.

Python Docstring:

Stop( (FBDeck)arg1) -> None 

C++ Signature:

void Stop() 
ThreadSync ( FBDeck  arg1)

Python Docstring:

ThreadSync( (FBDeck)arg1) -> None 

C++ Signature:

void ThreadSync() 

Member Data Documentation

FBPropertyBool CassetteInside

Read Only Property: Is the cassette inside?

Read Write Property: Is EE on?

ORSDK2018::FBPropertyString IconFilename

Read Write Property: Filename of icon for deck.

FBPropertyTime Latency

Read Write Property: Latency of response for the deck;

Read Write Property: Current offset for the TC.

Read Write Property: Is deck online?

FBPropertyBool PlayingBackward

Read Only Property: Playing backwards?

FBPropertyBool PlayingForward

Read Only Property: Playing forward?

FBPropertyTime PostRoll

Read Write Property: Post-Roll.

FBPropertyTime PreRoll

Read Write Property: Pre-Roll.

FBPropertyBool StandBy

Read Write Property: In standby mode?

FBPropertyDeckTransportMode TransportControl

Read Write Property: Mode w/r to TC (None, Slave, Master );

const char* UniqueName

internal Unique name.