Top

Articles in this section

IMDeckControl

Avatar
Alexander Bashlykov
  • Updated

Operates Decklink devices via RS422

Methods

DeckAbort

Aborts the deck.

Syntax

void DeckAbort()

DeckClose

Optionally place the deck in standby mode before closing the connection

Syntax

void DeckClose( 
   int _bStandbyOn
)

Parameters

_bStandbyOn - place the deck into standby mode (1) before disconnection

DeckCrashRecordStart

Sets the deck to record.

Syntax

void DeckCrashRecordStart( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckCrashRecordStop

Stops the deck record operation.

Syntax

void DeckCrashRecordStop( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckEject

Sends an “eject tape” command to the deck.

Syntax

void DeckEject( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckFastForward

Sends a “fast forward” command to the deck.

Syntax

void DeckFastForward( 
   int _bViewTape,
   out eMBMDDeckControlError _pError
)

Parameters

_bViewTape - view the tape (1) or enable automatic selection of “tape view” or “end to end view” (0)
_pError - error code

DeckGetCaptureOffset

Returns the current setting of the field accurate capture timecode offset in fields.

Syntax

void DeckGetCaptureOffset( 
   out int _pCaptureOffsetFields
)

Parameters

_pCaptureOffsetFields - current timecode offset in fields

DeckGetCurrentState

Gets the current state of the deck

Syntax

void DeckGetCurrentState( 
   out eMBMDDeckControlMode _pMode,
   out eMBMDDeckControlVTRControlState _pVtrControlState,
   out int _pFlags
)

Parameters

_pMode - control mode
_pVtrControlState - control state
_pFlags - control status flags

DeckGetDeviceID

Gets the device ID returned by the deck.

Syntax

void DeckGetDeviceID( 
   out int _pDeviceId,
   out eMBMDDeckControlError _pError
)

Parameters

_pDeviceId - code for the device model
_pError - error code

DeckGetExportOffset

Returns the current setting of the export offset in fields.

Syntax

void DeckGetExportOffset( 
   out int _pExportOffsetFields
)

Parameters

_pExportOffsetFields - current timecode offset in fields

DeckGetManualExportOffset

Returns the manual export offset for the current deck. This is only applicable for manual exports and may be adjusted with the main export offset if required.

Syntax

void DeckGetManualExportOffset( 
   out int _pDeckManualExportOffsetFields
)

Parameters

_pDeckManualExportOffsetFields - current timecode offset

DeckGetPreroll

Gets the preroll time period.

Syntax

void DeckGetPreroll( 
   out int _pPrerollSeconds
)

Parameters

_pPrerollSeconds - preroll value in seconds

DeckGetTimecode

Returns the current timecode.

Syntax

void DeckGetTimecode( 
   out M_TIMECODE _pCurrentTimeCode,
   out eMBMDDeckControlError _pError
)

Parameters

_pCurrentTimeCode - current timecode
_pError - error code

DeckGetTimecodeString

Returns the current timecode in string format.

Syntax

void DeckGetTimecodeString( 
   out string _pCurrentTimeCode,
   out eMBMDDeckControlError _pError
)

Parameters

_pCurrentTimeCode - current timecode in string format
_pError - error code

DeckGoToTimecode

Sends a “go to timecode” command to the deck.

Syntax

void DeckGoToTimecode( 
   M_TIMECODE _timecode,
   out eMBMDDeckControlError _pError
)

Parameters

_timecode - timecode to go to
_pError - error code

DeckJog

Sends a “jog playback” command to the deck.

Syntax

void DeckJog( 
   double _dblRate,
   out eMBMDDeckControlError _pError
)

Parameters

_dblRate - The rate at which to jog playback. A value greater than 0 will enable forward playback, alue less than 0 will enable reverse playback. The rate range is from -50.0 to 50.0
_pError - error code

DeckOpen

Configures a deck control session and opens a connection to a deck.

Syntax

void DeckOpen( 
   int _bTimecodeIsDropFrame,
   out eMBMDDeckControlError _pError
)

Parameters

_bTimecodeIsDropFrame - Timecode is drop frame (1) or a non drop frame (0)
_pError - error code

DeckPlay

Sends a “play” command to the deck.

Syntax

void DeckPlay( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckRewind

Sends a “rewind” command to the deck.

Syntax

void DeckRewind( 
   int _bViewTape,
   out eMBMDDeckControlError _pError
)

Parameters

_bViewTape - view the tape (1) or enable automatic selection of “tape view” or “end to end view” (0)
_pError - error code

DeckSendCommand

Sends a custom command to the deck. A custom command operation cannot occur if there is an export-to-tape, capture or a custom command operation in progress. The supplied custom command must conform to the Sony 9 Pin protocol and must not include the checksum byte. It will be generated by this interface and added to the command.

Syntax

void DeckSendCommand( 
   int _lInBufferSize,
   long _pInBuffer,
   out int _pOutDataSize,
   long _ppOutBuffer,
   int outBufferSize,
   out eMBMDDeckControlError _pError
)

Parameters

_lInBufferSize - the size of the buffer containing the command packet to transmit
_pInBuffer - the buffer containing the command packet to transmit
_pOutDataSize - the size of the response data
_ppOutBuffer - the buffer to contain the response packet outBufferSize the size of the buffer that will contain the response packet
_pError - error code

DeckSendCommand_I

Sends a custom command to the deck. A custom command operation cannot occur if there is an export-to-tape, capture or a custom command operation in progress. The supplied custom command must conform to the Sony 9 Pin protocol and must not include the checksum byte. It will be generated by this interface and added to the command.

Syntax

void DeckSendCommand_I( 
   int _lInBufferSize,
   ref byte _pInBuffer,
   out int _pOutDataSize,
   out IntPtr _ppOutBuffer,
   int outBufferSize,
   out eMBMDDeckControlError _pError
)

Parameters

_lInBufferSize - the size of the buffer containing the command packet to transmit
_pInBuffer - the buffer containing the command packet to transmit
_pOutDataSize - the size of the response data
_ppOutBuffer - the buffer to contain the response packet outBufferSize the size of the buffer that will contain the response packet
_pError - error code

DeckSetCaptureOffset

The capture offset may be used to compensate for a deck specific offset between the inpoint and the time at which the capture starts.

Syntax

void DeckSetCaptureOffset( 
   int _lCaptureOffsetFields
)

Parameters

_lCaptureOffsetFields - timecode offset to set in fields

DeckSetExportOffset

Sets the current export timecode offset in fields. This method permits fine control of the timecode offset to tailor for the response of an individual deck by adjusting the number of fields prior to the in or out point where an export will begin or end.

Syntax

void DeckSetExportOffset( 
   int _lExportOffsetFields
)

Parameters

_lExportOffsetFields - timecode offset in fields

DeckSetPreroll

Sets the preroll time period.

Syntax

void DeckSetPreroll( 
   int _lPrerollSeconds
)

Parameters

_lPrerollSeconds - preroll value in seconds

DeckSetStandby

Sends a “set standby” command to the deck

Syntax

void DeckSetStandby( 
   int _bStandbyOn
)

Parameters

_bStandbyOn - set standby on (1) , or set standby off (0)

DeckShuttle

Sends a “shuttle” playback command to the deck.

Syntax

void DeckShuttle( 
   double _dblRate,
   out eMBMDDeckControlError _pError
)

Parameters

_dblRate - The rate at which to jog playback. A value greater than 0 will enable forward playback, value less than 0 will enable reverse playback. The rate range is from -50.0 to 50.0
_pError - error code

DeckStartCapture

Starts a capture operation using the given parameters.

Syntax

void DeckStartCapture( 
   int _bUseVITC,
   int _lInTimecode,
   int _lOutTimecode,
   out eMBMDDeckControlError _pError
)

Parameters

_bUseVITC - If 1 use VITC as the source of timecodes
_lInTimecode - timecode to start the capture sequence
_lOutTimecode - timecode to stop the capture sequence
_pError - error code

DeckStartExport

Starts an export to tape operation using the given parameters.

Syntax

void DeckStartExport( 
   int _lInTimecode,
   int _lOutTimecode,
   int _lExportModeOps,
   out eMBMDDeckControlError _pError
)

Parameters

_lInTimecode - timecode to start the export sequence.
_lOutTimecode - timecode to stop the export sequence.
_lExportModeOps - export mode operations
_pError - error code

DeckStepBack

Sends a “step back” command to the deck.

Syntax

void DeckStepBack( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckStepForward

Sends a “step forward” command to the deck.

Syntax

void DeckStepForward( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckStop

Sends a “stop” command to the deck

Syntax

void DeckStop( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

DeckTogglePlayStop

Sends a “play” command to the deck, if the deck is currently paused or stopped. If the deck is currently playing, a “pause” command will be sent to the deck.

Syntax

void DeckTogglePlayStop( 
   out eMBMDDeckControlError _pError
)

Parameters

_pError - error code

Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles