FBPlayerControl Class Reference

#include <mobu-python-api.h>

Class Description

Player control.

Interface to use the transport controls (play, stop, etc.) The following Python snippet shows its basic playback operation

lPlayer = FBPlayerControl()
lPlayer.GotoStart()
lPlayer.Play()

Keys can also be set and used with Key(), GotoNextKey(), and GotoPreviousKey().
All actions are performed by default on the current take. The is the MotionBuilder default take, unless you have multiple takes in your scene. To switch between takes, use FBTake.

See the C++ reference

Inheritance diagram for FBPlayerControl:

Public Member Functions
	__reduce__ ()
FBColor	GetGlobalTimeMarkColor (FBPlayerControl arg1, object arg2)
	Returns the color associated with a global time mark. More...
FBTime	GetGlobalTimeMarkTime (FBPlayerControl arg1, object arg2)
	Returns the time associated with a global time mark. More...
FBTime	GetEditZoomStop (FBPlayerControl arg1)
	Get Edit Zoom Stop. More...
FBTime	GetEditZoomStart (FBPlayerControl arg1)
	Get Edit Zoom Start. More...
FBTime	GetEditStop (FBPlayerControl arg1)
	Get Edit Stop. More...
FBTime	GetEditStart (FBPlayerControl arg1)
	Get Edit Start. More...
FBTime	GetEditCurrentTime (FBPlayerControl arg1)
	Get Edit Current Time. More...
FBTimeMode	GetTransportFps (FBPlayerControl arg1)
	Get the UI frame rate use for display configure in the system. More...
	__init__ (object arg1)
	Constructor. More...
float	GetTransportFpsValue (FBPlayerControl arg1, FBTimeMode arg2)
	Get the UI frame rate value. More...
FBTransportMode	GetTransportMode (FBPlayerControl arg1)
	Get Transport Mode. More...
bool	Goto (FBPlayerControl arg1, FBTime arg2, FBTimeReferential arg3)
bool	GotoEnd (FBPlayerControl arg1, FBTimeReferential arg2)
	GotoNextKey (FBPlayerControl arg1)
	Go to the next key. More...
	GotoPreviousKey (FBPlayerControl arg1)
	Go to the previous key. More...
bool	GotoStart (FBPlayerControl arg1, FBTimeReferential arg2)
	Key (FBPlayerControl arg1)
	Key default data. More...
bool	Play (FBPlayerControl arg1, object arg2)
	Play button. More...
bool	PlayReverse (FBPlayerControl arg1, object arg2)
	Play Reverse button. More...
bool	Record (FBPlayerControl arg1, object arg2, object arg3)
	Begin recording. More...
FBTransportPlaySpeed	GetPlaySpeedMode (FBPlayerControl arg1)
	Get Play Speed Mode. More...
float	GetPlaySpeed (FBPlayerControl arg1)
	Get Play Speed . More...
	SetPlaySpeedMode (FBPlayerControl arg1, FBTransportPlaySpeed arg2)
	Set Play Speed Mode. More...
	SetPlaySpeed (FBPlayerControl arg1, object arg2)
	SetTransportFps (FBPlayerControl arg1, FBTimeMode arg2, object arg3)
	Set the system frame rate use for display. More...
bool	StepBackward (FBPlayerControl arg1, FBTimeReferential arg2)
bool	StepForward (FBPlayerControl arg1, FBTimeReferential arg2)
bool	Stop (FBPlayerControl arg1)
	Stop button. More...
FBTimeReferential	GetTimeReferential (FBPlayerControl arg1)
	Get Time Referential. More...
	SetTimeReferential (FBPlayerControl arg1, FBTimeReferential arg2)
	Set Time Referential. More...
	SetEditStart (FBPlayerControl arg1, FBTime arg2)
	Set Edit Start. More...
	SetEditStop (FBPlayerControl arg1, FBTime arg2)
	Set Edit Stop. More...
	SetEditZoomStart (FBPlayerControl arg1, FBTime arg2)
	Set Edit Zoom Start. More...
	SetEditZoomStop (FBPlayerControl arg1, FBTime arg2)
	Set Edit Zoom Stop. More...
	LockTransport (FBPlayerControl arg1, object arg2)
	Lock the transport control. More...
bool	IsLocked (FBPlayerControl arg1)
	Return the current locking state of the transport. More...
	EvaluationPause (FBPlayerControl arg1)
	Pause device evaluation thread. More...
	EvaluationResume (FBPlayerControl arg1)
	Resume device evaluation thread. More...
int	AddGlobalTimeMark (FBPlayerControl arg1, FBTime arg2)
	Add a global time mark. More...
bool	DeleteGlobalTimeMark (FBPlayerControl arg1, object arg2)
	Delete a global time mark. More...
	DeleteAllGlobalTimeMarks (FBPlayerControl arg1)
	Delete all global time marks. More...
int	GetGlobalTimeMarkCount (FBPlayerControl arg1)
	Returns the number of global time marks. More...
int	SetGlobalTimeMarkTime (FBPlayerControl arg1, object arg2, FBTime arg3)
	Sets a new time for an existing global time mark. More...
str	GetGlobalTimeMarkName (FBPlayerControl arg1, object arg2)
	Returns the name associated with a global time mark. More...
bool	SetGlobalTimeMarkName (FBPlayerControl arg1, object arg2, str arg3)
	Sets a new name for an existing global time mark. More...
FBTimeMarkAction	GetGlobalTimeMarkAction (FBPlayerControl arg1, object arg2)
	Returns the action associated with a global time mark. More...
bool	SetGlobalTimeMarkAction (FBPlayerControl arg1, object arg2, FBTimeMarkAction arg3)
	Sets a new action for an existing global time mark. More...
bool	SetGlobalTimeMarkColor (FBPlayerControl arg1, object arg2, FBColor arg3)
	Sets a new color for an existing global time mark. More...
int	GetNextGlobalTimeMarkIndex (FBPlayerControl arg1)
	Returns the next global time mark index, based on the current local time. More...
int	GetPreviousGlobalTimeMarkIndex (FBPlayerControl arg1)
	Returns the previous global time mark index, based on the current local time. 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	IsPlaying
	Read Only Property: Is the transport control playing? More...
FBPropertyBool	IsRecording
	Read Only Property: Is there a recording in progress? More...
FBPropertyBool	IsPlotting
	Read Only Property: Is there a plotting in progress? More...
FBPropertyBool	LoopActive
	Read Write Property: Is looping active? More...
FBPropertyTime	LoopStart
	Read Write Property: Loop begin time. More...
FBPropertyTime	LoopStop
	Read Write Property: Loop end time. More...
FBPropertyTime	NextMarker
	Read Only Property: Next marked time. More...
FBPropertyTime	PreviousMarker
	Read Only Property: Previous marked time. More...
FBPropertyTransportSnapMode	SnapMode
	Read Write Property: Set the transport control snap mode. More...
FBPropertyTransportTimeFormat	TransportTimeFormat
	Read Write Property: Current Time Mode of the transport controls. More...
FBPropertyTime	ZoomWindowStart
	Read Write Property: Starting time of the transport control zoom window. More...
FBPropertyTime	ZoomWindowStop
	Read Write Property: Stopping time of the transport control zoom window. More...
FBPropertyTime	RecordingSamplingPeriod
	Read Write Property: Sampling period for the model recording. More...
FBPropertyTime	PlotSamplingPeriod
	Read Write Property: Sampling period for the model plotting. More...
ORSDK2018::FBPropertyEvent	OnChange
	Event Property: Fired when something in the player control has changed. 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

)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBPlayerControl(HIObject pObject = ((void *) 0)) 

Parameters

pObject

Internal parent object(default=NULL).

See the C++ reference

__reduce__

(

)

int AddGlobalTimeMark	(	FBPlayerControl	arg1,
		FBTime	arg2
	)

Add a global time mark.

Python Docstring:

AddGlobalTimeMark( (FBPlayerControl)arg1, (FBTime)arg2) -> int 

C++ Signature:

int AddGlobalTimeMark(ORSDK2018::FBTime pTime, const char * pName = ((void *) 0)) 

It doesn't allow creating a time mark at the same time of another time mark. Note: Internally, the global time marks are stored in time order. Adding a time mark before other existing time marks will modify the index of these other time marks.

Parameters

pTime	Time where to add the time mark.
pName	Name of the time mark to add.

Returns

The index of the time mark added if the operation is successful, -1 otherwise.

See the C++ reference

DeleteAllGlobalTimeMarks

(

FBPlayerControl

arg1

)

Delete all global time marks.

Python Docstring:

DeleteAllGlobalTimeMarks( (FBPlayerControl)arg1) -> None 

C++ Signature:

void DeleteAllGlobalTimeMarks() 

See the C++ reference

bool DeleteGlobalTimeMark	(	FBPlayerControl	arg1,
		object	arg2
	)

Delete a global time mark.

Python Docstring:

DeleteGlobalTimeMark( (FBPlayerControl)arg1, (object)arg2) -> bool 

C++ Signature:

bool DeleteGlobalTimeMark(int pIndex) 

Note: Internally, the global time marks are stored in time order. Deleting a time mark will modify the index of time marks laying after the deleted time mark.

Parameters

pIndex

Index of the time mark to delete.

Returns

True if the operation is successful, false otherwise.

See the C++ reference

EvaluationPause

(

FBPlayerControl

arg1

)

Pause device evaluation thread.

Python Docstring:

EvaluationPause( (FBPlayerControl)arg1) -> None 

C++ Signature:

void EvaluationPause() 

See the C++ reference

EvaluationResume

(

FBPlayerControl

arg1

)

Resume device evaluation thread.

Python Docstring:

EvaluationResume( (FBPlayerControl)arg1) -> None 

C++ Signature:

void EvaluationResume() 

See the C++ reference

FBTime GetEditCurrentTime

(

FBPlayerControl

arg1

)

Get Edit Current Time.

Python Docstring:

GetEditCurrentTime( (FBPlayerControl)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetEditCurrentTime() 

Returns

The current time, in the edit time referential.

See the C++ reference

FBTime GetEditStart

(

FBPlayerControl

arg1

)

Get Edit Start.

Python Docstring:

GetEditStart( (FBPlayerControl)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetEditStart() 

Returns

Start value for the edit time range.

See the C++ reference

FBTime GetEditStop

(

FBPlayerControl

arg1

)

Get Edit Stop.

Python Docstring:

GetEditStop( (FBPlayerControl)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetEditStop() 

Returns

Stop value for the edit time range.

See the C++ reference

FBTime GetEditZoomStart

(

FBPlayerControl

arg1

)

Get Edit Zoom Start.

Python Docstring:

GetEditZoomStart( (FBPlayerControl)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetEditZoomStart() 

Returns

Start value for the edit zoom window.

See the C++ reference

FBTime GetEditZoomStop

(

FBPlayerControl

arg1

)

Get Edit Zoom Stop.

Python Docstring:

GetEditZoomStop( (FBPlayerControl)arg1) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetEditZoomStop() 

Returns

Stop value for the edit zoom window.

See the C++ reference

FBTimeMarkAction GetGlobalTimeMarkAction	(	FBPlayerControl	arg1,
		object	arg2
	)

Returns the action associated with a global time mark.

Python Docstring:

GetGlobalTimeMarkAction( (FBPlayerControl)arg1, (object)arg2) -> FBTimeMarkAction 

C++ Signature:

FBTimeMarkAction GetGlobalTimeMarkAction(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The action associated with the time mark.

See the C++ reference

FBColor GetGlobalTimeMarkColor	(	FBPlayerControl	arg1,
		object	arg2
	)

Returns the color associated with a global time mark.

Python Docstring:

GetGlobalTimeMarkColor( (FBPlayerControl)arg1, (object)arg2) -> FBColor 

C++ Signature:

ORSDK2018::FBColor GetGlobalTimeMarkColor(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The color associated with the time mark.

See the C++ reference

int GetGlobalTimeMarkCount

(

FBPlayerControl

arg1

)

Returns the number of global time marks.

Python Docstring:

GetGlobalTimeMarkCount( (FBPlayerControl)arg1) -> int 

C++ Signature:

int GetGlobalTimeMarkCount() 

Returns

The number of global time marks.

See the C++ reference

str GetGlobalTimeMarkName	(	FBPlayerControl	arg1,
		object	arg2
	)

Returns the name associated with a global time mark.

Python Docstring:

GetGlobalTimeMarkName( (FBPlayerControl)arg1, (object)arg2) -> str 

C++ Signature:

const char * GetGlobalTimeMarkName(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The name associated with the time mark.

See the C++ reference

FBTime GetGlobalTimeMarkTime	(	FBPlayerControl	arg1,
		object	arg2
	)

Returns the time associated with a global time mark.

Python Docstring:

GetGlobalTimeMarkTime( (FBPlayerControl)arg1, (object)arg2) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetGlobalTimeMarkTime(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The time associated with the time mark.

See the C++ reference

int GetNextGlobalTimeMarkIndex

(

FBPlayerControl

arg1

)

Returns the next global time mark index, based on the current local time.

Python Docstring:

GetNextGlobalTimeMarkIndex( (FBPlayerControl)arg1) -> int 

C++ Signature:

int GetNextGlobalTimeMarkIndex() 

Returns

The next global time mark index, -1 if any next time mark is available.

See the C++ reference

float GetPlaySpeed

(

FBPlayerControl

arg1

)

Get Play Speed .

Python Docstring:

GetPlaySpeed( (FBPlayerControl)arg1) -> float 

C++ Signature:

double GetPlaySpeed() 

Returns

transport current playback speed.

See the C++ reference

FBTransportPlaySpeed GetPlaySpeedMode

(

FBPlayerControl

arg1

)

Get Play Speed Mode.

Python Docstring:

GetPlaySpeedMode( (FBPlayerControl)arg1) -> FBTransportPlaySpeed 

C++ Signature:

FBTransportPlaySpeed GetPlaySpeedMode() 

Returns

transport current playback speed mode, including kFBSpeed_Custom mode.

See the C++ reference

int GetPreviousGlobalTimeMarkIndex

(

FBPlayerControl

arg1

)

Returns the previous global time mark index, based on the current local time.

Python Docstring:

GetPreviousGlobalTimeMarkIndex( (FBPlayerControl)arg1) -> int 

C++ Signature:

int GetPreviousGlobalTimeMarkIndex() 

Returns

The previous global time mark index, -1 if any previous time mark is available.

See the C++ reference

FBTimeReferential GetTimeReferential

(

FBPlayerControl

arg1

)

Get Time Referential.

Python Docstring:

GetTimeReferential( (FBPlayerControl)arg1) -> FBTimeReferential 

C++ Signature:

FBTimeReferential GetTimeReferential() 

Returns

Current time referential.

See the C++ reference

FBTimeMode GetTransportFps

(

FBPlayerControl

arg1

)

Get the UI frame rate use for display configure in the system.

Python Docstring:

GetTransportFps( (FBPlayerControl)arg1) -> FBTimeMode 

C++ Signature:

FBTimeMode GetTransportFps() 

Returns

current FrameRate selected for the system.

See the C++ reference

float GetTransportFpsValue	(	FBPlayerControl	arg1,
		FBTimeMode	arg2
	)

Get the UI frame rate value.

Python Docstring:

GetTransportFpsValue( (FBPlayerControl)arg1 [, (FBTimeMode)arg2]) -> float 

C++ Signature:

double GetTransportFpsValue(FBTimeMode pTimeMode = kFBTimeModeDefault) 

Parameters

pTimeMode

the time mode whose frame rate will be returned

Returns

Frame rate of the input time mode or system time mode when pTimeMode is not provided.

See the C++ reference

FBTransportMode GetTransportMode

(

FBPlayerControl

arg1

)

Get Transport Mode.

Python Docstring:

GetTransportMode( (FBPlayerControl)arg1) -> FBTransportMode 

C++ Signature:

FBTransportMode GetTransportMode() 

Returns

Current mode of the transport controls.

See the C++ reference

bool Goto	(	FBPlayerControl	arg1,
		FBTime	arg2,
		FBTimeReferential	arg3
	)

Python Docstring:

Goto( (FBPlayerControl)arg1, (FBTime)arg2 [, (FBTimeReferential)arg3]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool Goto(ORSDK2018::FBTime pTime)
bool Goto(ORSDK2018::FBTime , FBTimeReferential )

bool GotoEnd	(	FBPlayerControl	arg1,
		FBTimeReferential	arg2
	)

Python Docstring:

GotoEnd( (FBPlayerControl)arg1 [, (FBTimeReferential)arg2]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool GotoEnd()
bool GotoEnd(FBTimeReferential )

GotoNextKey

(

FBPlayerControl

arg1

)

Go to the next key.

Python Docstring:

GotoNextKey( (FBPlayerControl)arg1) -> None 

C++ Signature:

void GotoNextKey() 

See the C++ reference

GotoPreviousKey

(

FBPlayerControl

arg1

)

Go to the previous key.

Python Docstring:

GotoPreviousKey( (FBPlayerControl)arg1) -> None 

C++ Signature:

void GotoPreviousKey() 

See the C++ reference

bool GotoStart	(	FBPlayerControl	arg1,
		FBTimeReferential	arg2
	)

Python Docstring:

GotoStart( (FBPlayerControl)arg1 [, (FBTimeReferential)arg2]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool GotoStart()
bool GotoStart(FBTimeReferential )

bool IsLocked

(

FBPlayerControl

arg1

)

Return the current locking state of the transport.

Python Docstring:

IsLocked( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool IsLocked() 

See the C++ reference

Key

(

FBPlayerControl

arg1

)

Key default data.

Python Docstring:

Key( (FBPlayerControl)arg1) -> None 

C++ Signature:

void Key() 

Key all selected data.

See the C++ reference

LockTransport	(	FBPlayerControl	arg1,
		object	arg2
	)

Lock the transport control.

Python Docstring:

LockTransport( (FBPlayerControl)arg1, (object)arg2) -> None 

C++ Signature:

void LockTransport(bool pLock) 

Parameters

pLock

boolean value that indicates the new locked state of the transport.

See the C++ reference

bool Play	(	FBPlayerControl	arg1,
		object	arg2
	)

Play button.

Python Docstring:

Play( (FBPlayerControl)arg1 [, (object)arg2]) -> bool 

C++ Signature:

bool Play(bool pUseMarkers = false) 

Parameters

pUseMarkers

Play until next marker if true, ignore markers otherwise.

Returns

true if successful.

See the C++ reference

bool PlayReverse	(	FBPlayerControl	arg1,
		object	arg2
	)

Play Reverse button.

Python Docstring:

PlayReverse( (FBPlayerControl)arg1 [, (object)arg2]) -> bool 

C++ Signature:

bool PlayReverse(bool pUseMarkers = false) 

Parameters

pUseMarkers

Play until next marker if true, ignore markers otherwise.

Returns

true if successful.

See the C++ reference

bool Record	(	FBPlayerControl	arg1,
		object	arg2,
		object	arg3
	)

Begin recording.

Python Docstring:

Record( (FBPlayerControl)arg1 [, (object)arg2 [, (object)arg3]]) -> bool 

C++ Signature:

bool Record(bool pOverrideTake = false, bool pCopyData = true) 

Parameters

pOverrideTake	Write over current take?(default=false)
pCopyData	Unused. Necessary for compatibility(default=true).

Returns

true if successful.

See the C++ reference

SetEditStart	(	FBPlayerControl	arg1,
		FBTime	arg2
	)

Set Edit Start.

Python Docstring:

SetEditStart( (FBPlayerControl)arg1, (FBTime)arg2) -> None 

C++ Signature:

void SetEditStart(ORSDK2018::FBTime pTime) 

Parameters

pTime

The new start value for the edit time range.

See the C++ reference

SetEditStop	(	FBPlayerControl	arg1,
		FBTime	arg2
	)

Set Edit Stop.

Python Docstring:

SetEditStop( (FBPlayerControl)arg1, (FBTime)arg2) -> None 

C++ Signature:

void SetEditStop(ORSDK2018::FBTime pTime) 

Parameters

pTime

The new stop value for the edit time range.

See the C++ reference

SetEditZoomStart	(	FBPlayerControl	arg1,
		FBTime	arg2
	)

Set Edit Zoom Start.

Python Docstring:

SetEditZoomStart( (FBPlayerControl)arg1, (FBTime)arg2) -> None 

C++ Signature:

void SetEditZoomStart(ORSDK2018::FBTime pTime) 

Parameters

pTime

The new start value for the edit zoom window.

See the C++ reference

SetEditZoomStop	(	FBPlayerControl	arg1,
		FBTime	arg2
	)

Set Edit Zoom Stop.

Python Docstring:

SetEditZoomStop( (FBPlayerControl)arg1, (FBTime)arg2) -> None 

C++ Signature:

void SetEditZoomStop(ORSDK2018::FBTime pTime) 

Parameters

pTime

The new stop value for the edit zoom window.

See the C++ reference

bool SetGlobalTimeMarkAction	(	FBPlayerControl	arg1,
		object	arg2,
		FBTimeMarkAction	arg3
	)

Sets a new action for an existing global time mark.

Python Docstring:

SetGlobalTimeMarkAction( (FBPlayerControl)arg1, (object)arg2, (FBTimeMarkAction)arg3) -> bool 

C++ Signature:

bool SetGlobalTimeMarkAction(int pIndex, FBTimeMarkAction pAction) 

Parameters

pIndex	Index of the time mark.
pAction	The new action for the time mark.

Returns

True if the operation is successful, false otherwise.

See the C++ reference

bool SetGlobalTimeMarkColor	(	FBPlayerControl	arg1,
		object	arg2,
		FBColor	arg3
	)

Sets a new color for an existing global time mark.

Python Docstring:

SetGlobalTimeMarkColor( (FBPlayerControl)arg1, (object)arg2, (FBColor)arg3) -> bool 

C++ Signature:

bool SetGlobalTimeMarkColor(int pIndex, ORSDK2018::FBColor pColor) 

Parameters

pIndex	Index of the time mark.
pColor	The new color for the time mark.

Returns

True if the operation is successful, false otherwise.

See the C++ reference

bool SetGlobalTimeMarkName	(	FBPlayerControl	arg1,
		object	arg2,
		str	arg3
	)

Sets a new name for an existing global time mark.

Python Docstring:

SetGlobalTimeMarkName( (FBPlayerControl)arg1, (object)arg2, (str)arg3) -> bool 

C++ Signature:

bool SetGlobalTimeMarkName(int pIndex, const char * pName) 

Parameters

pIndex	Index of the time mark.
pName	The new name for the time mark.

Returns

True if the operation is successful, false otherwise.

See the C++ reference

int SetGlobalTimeMarkTime	(	FBPlayerControl	arg1,
		object	arg2,
		FBTime	arg3
	)

Sets a new time for an existing global time mark.

Python Docstring:

SetGlobalTimeMarkTime( (FBPlayerControl)arg1, (object)arg2, (FBTime)arg3) -> int 

C++ Signature:

int SetGlobalTimeMarkTime(int pIndex, ORSDK2018::FBTime pTime) 

Note: Internally, the global time marks are stored in time order. Modifying the time of a time mark may modify the index of all time marks.

Parameters

pIndex	Index of the time mark.
pTime	The new time for the time mark.

Returns

The new index of the modified time mark.

See the C++ reference

SetPlaySpeed	(	FBPlayerControl	arg1,
		object	arg2
	)

Python Docstring:

SetPlaySpeed( (FBPlayerControl)arg1, (object)arg2) -> None 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

void SetPlaySpeed(double pSpeed)
void SetPlaySpeed(FBTransportPlaySpeed pPlaySpeed)

SetPlaySpeedMode	(	FBPlayerControl	arg1,
		FBTransportPlaySpeed	arg2
	)

Set Play Speed Mode.

Python Docstring:

SetPlaySpeedMode( (FBPlayerControl)arg1, (FBTransportPlaySpeed)arg2) -> None 

C++ Signature:

void SetPlaySpeedMode(FBTransportPlaySpeed pPlaySpeedMode) 

Parameters

pPlaySpeedMode

a pre-defined play speed mode. Don't make sense to input kFBSpeed_Custom. To set the custom speed, use SetPlaySpeed() function directly.

See the C++ reference

SetTimeReferential	(	FBPlayerControl	arg1,
		FBTimeReferential	arg2
	)

Set Time Referential.

Python Docstring:

SetTimeReferential( (FBPlayerControl)arg1, (FBTimeReferential)arg2) -> None 

C++ Signature:

void SetTimeReferential(FBTimeReferential pTimeReferential) 

Parameters

pTimeReferential

The new time referential. Only kFBTimeReferentialAction and kFBTimeReferentialEdit are supported

See the C++ reference

SetTransportFps	(	FBPlayerControl	arg1,
		FBTimeMode	arg2,
		object	arg3
	)

Set the system frame rate use for display.

Python Docstring:

SetTransportFps( (FBPlayerControl)arg1, (FBTimeMode)arg2 [, (object)arg3]) -> None 

C++ Signature:

void SetTransportFps(FBTimeMode pTimeMode, double pCustom = 0.0) 

Parameters

pTimeMode	Indicate the frame rate value to use base on the FBTimeMode values enum.(kFBTimeModeDefault will be stored in fps)
pCustom	Should the time mode be kFBTimeModeCustom, this is used to specify the custom framerate.

See the C++ reference

bool StepBackward	(	FBPlayerControl	arg1,
		FBTimeReferential	arg2
	)

Python Docstring:

StepBackward( (FBPlayerControl)arg1 [, (FBTimeReferential)arg2]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool StepBackward()
bool StepBackward(FBTimeReferential )

bool StepForward	(	FBPlayerControl	arg1,
		FBTimeReferential	arg2
	)

Python Docstring:

StepForward( (FBPlayerControl)arg1 [, (FBTimeReferential)arg2]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool StepForward()
bool StepForward(FBTimeReferential )

bool Stop

(

FBPlayerControl

arg1

)

Stop button.

Python Docstring:

Stop( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool Stop() 

Returns

true if successful.

See the C++ reference

Member Data Documentation

FBPropertyBool IsPlaying

Read Only Property: Is the transport control playing?

See the C++ reference

FBPropertyBool IsPlotting

Read Only Property: Is there a plotting in progress?

See the C++ reference

FBPropertyBool IsRecording

Read Only Property: Is there a recording in progress?

See the C++ reference

FBPropertyBool LoopActive

Read Write Property: Is looping active?

See the C++ reference

FBPropertyTime LoopStart

Read Write Property: Loop begin time.

See the C++ reference

FBPropertyTime LoopStop

Read Write Property: Loop end time.

See the C++ reference

FBPropertyTime NextMarker

Read Only Property: Next marked time.

See the C++ reference

ORSDK2018::FBPropertyEvent OnChange

Event Property: Fired when something in the player control has changed.

(see FBEventPlayerControlChange)

See the C++ reference

FBPropertyTime PlotSamplingPeriod

Read Write Property: Sampling period for the model plotting.

See the C++ reference

FBPropertyTime PreviousMarker

Read Only Property: Previous marked time.

See the C++ reference

FBPropertyTime RecordingSamplingPeriod

Read Write Property: Sampling period for the model recording.

See the C++ reference

FBPropertyTransportSnapMode SnapMode

Read Write Property: Set the transport control snap mode.

See the C++ reference

FBPropertyTransportTimeFormat TransportTimeFormat

Read Write Property: Current Time Mode of the transport controls.

See the C++ reference

FBPropertyTime ZoomWindowStart

Read Write Property: Starting time of the transport control zoom window.

See the C++ reference

FBPropertyTime ZoomWindowStop

Read Write Property: Stopping time of the transport control zoom window.

See the C++ reference