fbplayercontrol.h File Reference

Transport control and timing management interface. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcommand.h>

Go to the source code of this file.

Classes
class	FBEventPlayerControlChange
class	FBPlayerControl
	Player control. More...
class	FBReferenceTime
	Reference time class. More...

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...

Enumerations
enum	FBTransportMode {   kFBTransportPlay ,   kFBTransportPlayPrepare ,   kFBTransportPlayReady ,   kFBTransportStop ,   kFBTransportStopPost ,   kFBTransportStopReady ,   kFBTransportShuttle ,   kFBTransportShuttlePrepare ,   kFBTransportShuttleReady ,   kFBTransportPlayReverse ,   kFBTransportPlayReversePrepare ,   kFBTransportPlayReverseReady ,   kFBTransportJog ,   kFBTransportJogPrepare ,   kFBTransportJogReady ,   kFBTransportGoto ,   kFBTransportGotoPrepare ,   kFBTransportGotoReady ,   kFBTransportStepForward ,   kFBTransportStepForwardPrepare ,   kFBTransportStepForwardReady ,   kFBTransportStepBackward ,   kFBTransportStepBackwardPrepare ,   kFBTransportStepBackwardReady }
	Transport modes. More...
enum	FBTransportTimeFormat {   kFBTimeFormatTimecode ,   kFBTimeFormatFrame }
	Available transport control time display. More...
enum	FBTransportPlaySpeed {   kFBSpeed_1_10x ,   kFBSpeed_1_5x ,   kFBSpeed_1_4x ,   kFBSpeed_1_3x ,   kFBSpeed_1_2x ,   kFBSpeed_1x ,   kFBSpeed_ALL_FR ,   kFBSpeed_2x ,   kFBSpeed_3x ,   kFBSpeed_4x ,   kFBSpeed_5x ,   kFBSpeed_10x ,   kFBSpeed_Custom }
	Available transport control play speed. More...
enum	FBTransportSnapMode {   kFBTransportSnapModeNoSnap ,   kFBTransportSnapModeSnapOnFrames ,   kFBTransportSnapModePlayOnFrames ,   kFBTransportSnapModeSnapAndPlayOnFrames }
	Available snap methods for the transport control. More...
enum	FBTransportLoopMode {   kFBTransportNoLoop ,   kFBTransportLoopCurrentTake ,   kFBTransportLoopThroughAllTakes }
	Available loop modes for the transport control. More...
enum	FBPlayerControlChangeType {   kFBPlayerControlNone ,   kFBPlayerControlPlay ,   kFBPlayerControlPlayReverse ,   kFBPlayerControlStop ,   kFBPlayerControlStepForward ,   kFBPlayerControlStepBackward ,   kFBPlayerControlGoto ,   kFBPlayerControlRecordModeOn ,   kFBPlayerControlRecordModeOff }
	Types of player control change events. More...

Functions
	FB_DEFINE_ENUM (K_DLLIMPORT, TransportMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, TransportTimeFormat)
	FB_DEFINE_ENUM (K_DLLIMPORT, TransportPlaySpeed)
	FB_DEFINE_ENUM (K_DLLIMPORT, TransportSnapMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, TransportLoopMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, PlayerControlChangeType)
	__FB_FORWARD (FBEventPlayerControlChange)
	__FB_FORWARD (FBPlayerControl)
	__FB_FORWARD (FBReferenceTime)

Detailed Description

Transport control and timing management interface.

Definition in file fbplayercontrol.h.

Macro Definition Documentation

FBSDK_DLL

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbplayercontrol.h.

Enumeration Type Documentation

FBPlayerControlChangeType

enum FBPlayerControlChangeType

Types of player control change events.

Enumerator
kFBPlayerControlNone	None.
kFBPlayerControlPlay	Play.
kFBPlayerControlPlayReverse	Play reverse.
kFBPlayerControlStop	Stop.
kFBPlayerControlStepForward	Step forward.
kFBPlayerControlStepBackward	Step backward.
kFBPlayerControlGoto	Goto.
kFBPlayerControlRecordModeOn	Record mode on.
kFBPlayerControlRecordModeOff	Record mode off.

Definition at line 120 of file fbplayercontrol.h.

FBTransportLoopMode

enum FBTransportLoopMode

Available loop modes for the transport control.

Enumerator
kFBTransportNoLoop	Playback not looping.
kFBTransportLoopCurrentTake	Playback looping the current take.
kFBTransportLoopThroughAllTakes	Playback from the current take through all takes in order then stops.

Definition at line 112 of file fbplayercontrol.h.

FBTransportMode

enum FBTransportMode

Transport modes.

Enumerator
kFBTransportPlayPrepare	!< Play mode
kFBTransportStopPost	!< Stop mode
kFBTransportShuttlePrepare	!< Shuttle mode
kFBTransportPlayReversePrepare	!< Play reverse.
kFBTransportJogPrepare	!< Jog.
kFBTransportGotoPrepare	!< Goto.
kFBTransportStepForwardPrepare	!< Step forward
kFBTransportStepBackwardPrepare	!< Step backward.

Definition at line 60 of file fbplayercontrol.h.

FBTransportPlaySpeed

enum FBTransportPlaySpeed

Available transport control play speed.

Enumerator
kFBSpeed_1_10x	0.10x
kFBSpeed_1_5x	0.20x
kFBSpeed_1_4x	0.25x
kFBSpeed_1_3x	0.33x
kFBSpeed_1_2x	0.50x
kFBSpeed_1x	1x
kFBSpeed_ALL_FR	All frames.
kFBSpeed_2x	2x
kFBSpeed_3x	3x
kFBSpeed_4x	4x
kFBSpeed_5x	5x
kFBSpeed_10x	10x
kFBSpeed_Custom	Custom speed.

Definition at line 83 of file fbplayercontrol.h.

FBTransportSnapMode

enum FBTransportSnapMode

Available snap methods for the transport control.

Enumerator
kFBTransportSnapModeNoSnap	No snapping is applied.
kFBTransportSnapModeSnapOnFrames	Snaps to an exact frame when modifying the current time.
kFBTransportSnapModePlayOnFrames	When playing, plays to exact frames.
kFBTransportSnapModeSnapAndPlayOnFrames	Combines both Snap and Play on frames modes.

Definition at line 102 of file fbplayercontrol.h.

FBTransportTimeFormat

enum FBTransportTimeFormat

Available transport control time display.

Enumerator
kFBTimeFormatTimecode	Timecode time display mode.
kFBTimeFormatFrame	Frame time display mode.

Definition at line 73 of file fbplayercontrol.h.