third_party/decklink/mac/include/DeckLinkAPI_v7_9.h

   1 /* -LICENSE-START-
   2 ** Copyright (c) 2010 Blackmagic Design
   3 **
   4 ** Permission is hereby granted, free of charge, to any person or organization
   5 ** obtaining a copy of the software and accompanying documentation covered by
   6 ** this license (the "Software") to use, reproduce, display, distribute,
   7 ** execute, and transmit the Software, and to prepare derivative works of the
   8 ** Software, and to permit third-parties to whom the Software is furnished to
   9 ** do so, all subject to the following:
  10 **
  11 ** The copyright notices in the Software and this entire statement, including
  12 ** the above license grant, this restriction and the following disclaimer,
  13 ** must be included in all copies of the Software, in whole or in part, and
  14 ** all derivative works of the Software, unless such copies or derivative
  15 ** works are solely in the form of machine-executable object code generated by
  16 ** a source language processor.
  17 **
  18 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 ** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 ** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  21 ** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  22 ** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  23 ** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24 ** DEALINGS IN THE SOFTWARE.
  25 ** -LICENSE-END-
  26 */
  27
  28 /* DeckLinkAPI_v7_9.h */
  29
  30 #ifndef __DeckLink_API_v7_9_h__
  31 #define __DeckLink_API_v7_9_h__
  32
  33 #include "DeckLinkAPI.h"
  34
  35 // Interface ID Declarations
  36
  37 #define IID_IDeckLinkDeckControl_v7_9                    /* A4D81043-0619-42B7-8ED6-602D29041DF7 */ (REFIID){0xA4,0xD8,0x10,0x43,0x06,0x19,0x42,0xB7,0x8E,0xD6,0x60,0x2D,0x29,0x04,0x1D,0xF7}
  38
  39
  40 #if defined(__cplusplus)
  41
  42 // Forward Declarations
  43
  44 class IDeckLinkDeckControl_v7_9;
  45
  46
  47 /* Interface IDeckLinkDeckControl_v7_9 - Deck Control main interface */
  48
  49 class IDeckLinkDeckControl_v7_9 : public IUnknown
  50 {
  51 public:
  52     virtual HRESULT Open (/* in */ BMDTimeScale timeScale, /* in */ BMDTimeValue timeValue, /* in */ bool timecodeIsDropFrame, /* out */ BMDDeckControlError *error) = 0;
  53     virtual HRESULT Close (/* in */ bool standbyOn) = 0;
  54     virtual HRESULT GetCurrentState (/* out */ BMDDeckControlMode *mode, /* out */ BMDDeckControlVTRControlState *vtrControlState, /* out */ BMDDeckControlStatusFlags *flags) = 0;
  55     virtual HRESULT SetStandby (/* in */ bool standbyOn) = 0;
  56     virtual HRESULT Play (/* out */ BMDDeckControlError *error) = 0;
  57     virtual HRESULT Stop (/* out */ BMDDeckControlError *error) = 0;
  58     virtual HRESULT TogglePlayStop (/* out */ BMDDeckControlError *error) = 0;
  59     virtual HRESULT Eject (/* out */ BMDDeckControlError *error) = 0;
  60     virtual HRESULT GoToTimecode (/* in */ BMDTimecodeBCD timecode, /* out */ BMDDeckControlError *error) = 0;
  61     virtual HRESULT FastForward (/* in */ bool viewTape, /* out */ BMDDeckControlError *error) = 0;
  62     virtual HRESULT Rewind (/* in */ bool viewTape, /* out */ BMDDeckControlError *error) = 0;
  63     virtual HRESULT StepForward (/* out */ BMDDeckControlError *error) = 0;
  64     virtual HRESULT StepBack (/* out */ BMDDeckControlError *error) = 0;
  65     virtual HRESULT Jog (/* in */ double rate, /* out */ BMDDeckControlError *error) = 0;
  66     virtual HRESULT Shuttle (/* in */ double rate, /* out */ BMDDeckControlError *error) = 0;
  67     virtual HRESULT GetTimecodeString (/* out */ BMDstring *currentTimeCode, /* out */ BMDDeckControlError *error) = 0;
  68     virtual HRESULT GetTimecode (/* out */ IDeckLinkTimecode **currentTimecode, /* out */ BMDDeckControlError *error) = 0;
  69     virtual HRESULT GetTimecodeBCD (/* out */ BMDTimecodeBCD *currentTimecode, /* out */ BMDDeckControlError *error) = 0;
  70     virtual HRESULT SetPreroll (/* in */ uint32_t prerollSeconds) = 0;
  71     virtual HRESULT GetPreroll (/* out */ uint32_t *prerollSeconds) = 0;
  72     virtual HRESULT SetExportOffset (/* in */ int32_t exportOffsetFields) = 0;
  73     virtual HRESULT GetExportOffset (/* out */ int32_t *exportOffsetFields) = 0;
  74     virtual HRESULT GetManualExportOffset (/* out */ int32_t *deckManualExportOffsetFields) = 0;
  75     virtual HRESULT SetCaptureOffset (/* in */ int32_t captureOffsetFields) = 0;
  76     virtual HRESULT GetCaptureOffset (/* out */ int32_t *captureOffsetFields) = 0;
  77     virtual HRESULT StartExport (/* in */ BMDTimecodeBCD inTimecode, /* in */ BMDTimecodeBCD outTimecode, /* in */ BMDDeckControlExportModeOpsFlags exportModeOps, /* out */ BMDDeckControlError *error) = 0;
  78     virtual HRESULT StartCapture (/* in */ bool useVITC, /* in */ BMDTimecodeBCD inTimecode, /* in */ BMDTimecodeBCD outTimecode, /* out */ BMDDeckControlError *error) = 0;
  79     virtual HRESULT GetDeviceID (/* out */ uint16_t *deviceId, /* out */ BMDDeckControlError *error) = 0;
  80     virtual HRESULT Abort (void) = 0;
  81     virtual HRESULT CrashRecordStart (/* out */ BMDDeckControlError *error) = 0;
  82     virtual HRESULT CrashRecordStop (/* out */ BMDDeckControlError *error) = 0;
  83     virtual HRESULT SetCallback (/* in */ IDeckLinkDeckControlStatusCallback *callback) = 0;
  84
  85 protected:
  86     virtual ~IDeckLinkDeckControl_v7_9 () {}; // call Release method to drop reference count
  87 };
  88
  89
  90 #endif      // defined(__cplusplus)
  91 #endif      // __DeckLink_API_v7_9_h__