AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
Public Types | Public Member Functions | Protected Attributes | List of all members
CBaseMachineControl Class Referenceabstract

A base class for deck control. More...

#include <basemachinecontrol.h>

Inheritance diagram for CBaseMachineControl:
[legend]

Public Types

enum  ControlType {
  CONTROLTYPE_DDR, CONTROLTYPE_XVID, CONTROLTYPE_NTV2, CONTROLTYPE_SERIAL,
  CONTROLTYPE_INVALID
}
 
enum  ControUnimplemented { CONTROL_UNIMPLEMENTED = 0xFFFFFFFF }
 

Public Member Functions

 CBaseMachineControl ()
 
virtual ~CBaseMachineControl ()
 
virtual bool Open (void)=0
 
virtual void Close (void)=0
 
virtual ULWord Play (void)
 
virtual ULWord ReversePlay (void)
 
virtual ULWord Stop (void)
 
virtual ULWord FastForward (void)
 
virtual ULWord Rewind (void)
 
virtual ULWord AdvanceFrame (void)
 
virtual ULWord BackFrame (void)
 
virtual ULWord GetTimecodeString (SByte *pOutTimecodeString)
 
virtual ULWord GotoFrameByString (SByte *pInFrameString)
 
virtual ULWord GotoFrame (ULWord inFrameNumber)
 
virtual ULWord GotoFrameByHMS (UByte inHrs, UByte inMins, UByte inSecs, UByte inFrames)
 
virtual ULWord RecordAtFrame (ULWord inFrameNumber)
 
virtual ULWord Loop (ULWord inStartFrameNumber, ULWord inEndFrameNumber)
 
virtual ControlType GetControlType (void) const
 

Protected Attributes

ControlType _controlType
 

Detailed Description

A base class for deck control.

Note
Not intended for use in production or mission-critical environments!

Definition at line 19 of file basemachinecontrol.h.

Member Enumeration Documentation

◆ ControlType

enum CBaseMachineControl::ControlType
Enumerator
CONTROLTYPE_DDR 
CONTROLTYPE_XVID 
CONTROLTYPE_NTV2 
CONTROLTYPE_SERIAL 
CONTROLTYPE_INVALID 

Definition at line 22 of file basemachinecontrol.h.

◆ ControUnimplemented

enum CBaseMachineControl::ControUnimplemented
Enumerator
CONTROL_UNIMPLEMENTED 

Definition at line 31 of file basemachinecontrol.h.

Constructor & Destructor Documentation

◆ CBaseMachineControl()

CBaseMachineControl::CBaseMachineControl ( )
inlineexplicit

Definition at line 37 of file basemachinecontrol.h.

◆ ~CBaseMachineControl()

virtual CBaseMachineControl::~CBaseMachineControl ( )
inlinevirtual

Definition at line 38 of file basemachinecontrol.h.

Member Function Documentation

◆ AdvanceFrame()

virtual ULWord CBaseMachineControl::AdvanceFrame ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 50 of file basemachinecontrol.h.

◆ BackFrame()

virtual ULWord CBaseMachineControl::BackFrame ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 51 of file basemachinecontrol.h.

◆ Close()

virtual void CBaseMachineControl::Close ( void  )
pure virtual

Implemented in CNTV2SerialControl.

◆ FastForward()

virtual ULWord CBaseMachineControl::FastForward ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 48 of file basemachinecontrol.h.

◆ GetControlType()

virtual ControlType CBaseMachineControl::GetControlType ( void  ) const
inlinevirtual

Definition at line 58 of file basemachinecontrol.h.

◆ GetTimecodeString()

virtual ULWord CBaseMachineControl::GetTimecodeString ( SByte *  pOutTimecodeString)
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 52 of file basemachinecontrol.h.

◆ GotoFrame()

virtual ULWord CBaseMachineControl::GotoFrame ( ULWord  inFrameNumber)
inlinevirtual

Definition at line 54 of file basemachinecontrol.h.

◆ GotoFrameByHMS()

virtual ULWord CBaseMachineControl::GotoFrameByHMS ( UByte  inHrs,
UByte  inMins,
UByte  inSecs,
UByte  inFrames 
)
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 55 of file basemachinecontrol.h.

◆ GotoFrameByString()

virtual ULWord CBaseMachineControl::GotoFrameByString ( SByte *  pInFrameString)
inlinevirtual

Definition at line 53 of file basemachinecontrol.h.

◆ Loop()

virtual ULWord CBaseMachineControl::Loop ( ULWord  inStartFrameNumber,
ULWord  inEndFrameNumber 
)
inlinevirtual

Definition at line 57 of file basemachinecontrol.h.

◆ Open()

virtual bool CBaseMachineControl::Open ( void  )
pure virtual

Implemented in CNTV2SerialControl.

◆ Play()

virtual ULWord CBaseMachineControl::Play ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 45 of file basemachinecontrol.h.

◆ RecordAtFrame()

virtual ULWord CBaseMachineControl::RecordAtFrame ( ULWord  inFrameNumber)
inlinevirtual

Definition at line 56 of file basemachinecontrol.h.

◆ ReversePlay()

virtual ULWord CBaseMachineControl::ReversePlay ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 46 of file basemachinecontrol.h.

◆ Rewind()

virtual ULWord CBaseMachineControl::Rewind ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 49 of file basemachinecontrol.h.

◆ Stop()

virtual ULWord CBaseMachineControl::Stop ( void  )
inlinevirtual

Reimplemented in CNTV2SerialControl.

Definition at line 47 of file basemachinecontrol.h.

Member Data Documentation

◆ _controlType

ControlType CBaseMachineControl::_controlType
protected

Definition at line 61 of file basemachinecontrol.h.

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