2 DeckLink API¶
- 2.1 Using the DeckLink API in a project
- 2.2 Sandboxing support on macOS
- 2.3 Accessing DeckLink devices
- 2.4 High level interface
- 2.4.1 Capture
- 2.4.2 Playback
- 2.4.3 3D Functionality
- 2.4.4 DeckLink Device Notification
- 2.4.5 Streaming Encoder
- 2.4.6 Automatic Mode Detection
- 2.4.7 Ancillary Data functionality
- 2.4.8 Keying
- 2.4.9 Timecode/Timecode user bits
- 2.4.10 H.265 Capture
- 2.4.11 Device Profiles
- 2.4.12 HDR Functionality
- 2.4.13 Synchronized Capture/Playback
- 2.4.14 Video Frame Conversion
- 2.4.15 SMPTE 2110 IP Flows
- 2.5 Interface Reference
- 2.5.1 IDeckLinkIterator Interface
- 2.5.2 IDeckLink Interface
- 2.5.3 IDeckLinkOutput Interface
- 2.5.3.1 IDeckLinkOutput::DoesSupportVideoMode method
- 2.5.3.2 IDeckLinkOutput::GetDisplayMode method
- 2.5.3.3 IDeckLinkOutput::GetDisplayModeIterator method
- 2.5.3.4 IDeckLinkOutput::SetScreenPreviewCallback method
- 2.5.3.5 IDeckLinkOutput::EnableVideoOutput method
- 2.5.3.6 IDeckLinkOutput::DisableVideoOutput method
- 2.5.3.7 IDeckLinkOutput::CreateVideoFrame method
- 2.5.3.8 IDeckLinkOutput::CreateVideoFrameWithBuffer method
- 2.5.3.9 IDeckLinkOutput::RowBytesForPixelFormat method
- 2.5.3.10 IDeckLinkOutput::CreateAncillaryData method
- 2.5.3.11 IDeckLinkOutput::DisplayVideoFrameSync method
- 2.5.3.12 IDeckLinkOutput::ScheduleVideoFrame method
- 2.5.3.13 IDeckLinkOutput::SetScheduledFrameCompletionCallback method
- 2.5.3.14 IDeckLinkOutput::GetBufferedVideoFrameCount method
- 2.5.3.15 IDeckLinkOutput::EnableAudioOutput method
- 2.5.3.16 IDeckLinkOutput::DisableAudioOutput method
- 2.5.3.17 IDeckLinkOutput::WriteAudioSamplesSync method
- 2.5.3.18 IDeckLinkOutput::BeginAudioPreroll method
- 2.5.3.19 IDeckLinkOutput::EndAudioPreroll method
- 2.5.3.20 IDeckLinkOutput::ScheduleAudioSamples method
- 2.5.3.21 IDeckLinkOutput::GetBufferedAudioSampleFrameCount method
- 2.5.3.22 IDeckLinkOutput::FlushBufferedAudioSamples method
- 2.5.3.23 IDeckLinkOutput::SetAudioCallback method
- 2.5.3.24 IDeckLinkOutput::StartScheduledPlayback method
- 2.5.3.25 IDeckLinkOutput::StopScheduledPlayback method
- 2.5.3.26 IDeckLinkOutput::IsScheduledPlaybackRunning method
- 2.5.3.27 IDeckLinkOutput::GetScheduledStreamTime method
- 2.5.3.28 IDeckLinkOutput::GetReferenceStatus method
- 2.5.3.29 IDeckLinkOutput::GetHardwareReferenceClock method
- 2.5.3.30 IDeckLinkOutput::GetFrameCompletionReferenceTimestamp method
- 2.5.4 IDeckLinkInput Interface
- 2.5.4.1 IDeckLinkInput::DoesSupportVideoMode method
- 2.5.4.2 IDeckLinkInput::GetDisplayMode method
- 2.5.4.3 IDeckLinkInput::GetDisplayModeIterator method
- 2.5.4.4 IDeckLinkInput::SetScreenPreviewCallback method
- 2.5.4.5 IDeckLinkInput::EnableVideoInput method
- 2.5.4.6 IDeckLinkInput::EnableVideoInputWithAllocatorProvider method
- 2.5.4.7 IDeckLinkInput::DisableVideoInput method
- 2.5.4.8 IDeckLinkInput::GetAvailableVideoFrameCount method
- 2.5.4.9 IDeckLinkInput::EnableAudioInput method
- 2.5.4.10 IDeckLinkInput::DisableAudioInput method
- 2.5.4.11 IDeckLinkInput::GetAvailableAudioSampleFrameCount method
- 2.5.4.12 IDeckLinkInput::StartStreams method
- 2.5.4.13 IDeckLinkInput::StopStreams method
- 2.5.4.14 IDeckLinkInput::PauseStreams method
- 2.5.4.15 IDeckLinkInput::FlushStreams method
- 2.5.4.16 IDeckLinkInput::SetCallback method
- 2.5.4.17 IDeckLinkInput::GetHardwareReferenceClock method
- 2.5.5 IDeckLinkVideoFrame Interface
- 2.5.5.1 IDeckLinkVideoFrame::GetWidth method
- 2.5.5.2 IDeckLinkVideoFrame::GetHeight method
- 2.5.5.3 IDeckLinkVideoFrame::GetRowBytes method
- 2.5.5.4 IDeckLinkVideoFrame::GetPixelFormat method
- 2.5.5.5 IDeckLinkVideoFrame::GetFlags method
- 2.5.5.6 IDeckLinkVideoFrame::GetTimecode method
- 2.5.5.7 IDeckLinkVideoFrame::GetAncillaryData method
- 2.5.6 IDeckLinkVideoOutputCallback Interface
- 2.5.7 IDeckLinkMutableVideoFrame Interface
- 2.5.7.1 IDeckLinkMutableVideoFrame::SetFlags method
- 2.5.7.2 IDeckLinkMutableVideoFrame::SetTimecode method
- 2.5.7.3 IDeckLinkMutableVideoFrame::SetTimecodeFromComponents method
- 2.5.7.4 IDeckLinkMutableVideoFrame::SetAncillaryData method
- 2.5.7.5 IDeckLinkMutableVideoFrame::SetTimecodeUserBits method
- 2.5.7.6 IDeckLinkMutableVideoFrame::SetInterfaceProvider method
- 2.5.8 IDeckLinkVideoFrame3DExtensions Interface
- 2.5.9 IDeckLinkAudioOutputCallback Interface
- 2.5.10 IDeckLinkInputCallback Interface
- 2.5.11 IDeckLinkVideoInputFrame Interface
- 2.5.12 IDeckLinkAudioInputPacket Interface
- 2.5.13 IDeckLinkDisplayModeIterator Interface
- 2.5.14 IDeckLinkDisplayMode Interface
- 2.5.14.1 IDeckLinkDisplayMode::GetName method
- 2.5.14.2 IDeckLinkDisplayMode::GetDisplayMode method
- 2.5.14.3 IDeckLinkDisplayMode::GetWidth method
- 2.5.14.4 IDeckLinkDisplayMode::GetHeight method
- 2.5.14.5 IDeckLinkDisplayMode::GetFrameRate method
- 2.5.14.6 IDeckLinkDisplayMode::GetFieldDominance method
- 2.5.14.7 IDeckLinkDisplayMode::GetFlags method
- 2.5.15 IDeckLinkConfiguration Interface
- 2.5.15.1 IDeckLinkConfiguration::SetFlag method
- 2.5.15.2 IDeckLinkConfiguration::GetFlag method
- 2.5.15.3 IDeckLinkConfiguration::SetInt method
- 2.5.15.4 IDeckLinkConfiguration::GetInt method
- 2.5.15.5 IDeckLinkConfiguration::SetFloat method
- 2.5.15.6 IDeckLinkConfiguration::GetFloat method
- 2.5.15.7 IDeckLinkConfiguration::SetString method
- 2.5.15.8 IDeckLinkConfiguration::GetString method
- 2.5.15.9 IDeckLinkConfiguration::WriteConfigurationToPreferences method
- 2.5.16 IDeckLinkAPIInformation Interface
- 2.5.17 IDeckLinkProfileAttributes Interface
- 2.5.18 IDeckLinkKeyer Interface
- 2.5.19 IDeckLinkVideoFrameAncillary Interface
- 2.5.20 IDeckLinkVideoFrameAncillaryPackets Interface
- 2.5.20.1 IDeckLinkVideoFrameAncillaryPackets::GetPacketIterator method
- 2.5.20.2 IDeckLinkVideoFrameAncillaryPackets::GetFirstPacketByID method
- 2.5.20.3 IDeckLinkVideoFrameAncillaryPackets::AttachPacket method
- 2.5.20.4 IDeckLinkVideoFrameAncillaryPackets::DetachPacket method
- 2.5.20.5 IDeckLinkVideoFrameAncillaryPackets::DetachAllPackets method
- 2.5.21 IDeckLinkAncillaryPacketIterator Interface
- 2.5.22 IDeckLinkAncillaryPacket Interface
- 2.5.23 IDeckLinkTimecode Interface
- 2.5.24 IDeckLinkScreenPreviewCallback Interface
- 2.5.25 IDeckLinkGLScreenPreviewHelper Interface
- 2.5.26 IDeckLinkCocoaScreenPreviewCallback Interface
- 2.5.27 IDeckLinkDX9ScreenPreviewHelper Interface
- 2.5.28 IDeckLinkDeckControl Interface
- 2.5.28.1 IDeckLinkDeckControl::Open method
- 2.5.28.2 IDeckLinkDeckControl::Close method
- 2.5.28.3 IDeckLinkDeckControl::GetCurrentState method
- 2.5.28.4 IDeckLinkDeckControl::SetStandby method
- 2.5.28.5 IDeckLinkDeckControl::SendCommand method
- 2.5.28.6 IDeckLinkDeckControl::Play method
- 2.5.28.7 IDeckLinkDeckControl::Stop method
- 2.5.28.8 IDeckLinkDeckControl::TogglePlayStop method
- 2.5.28.9 IDeckLinkDeckControl::Eject method
- 2.5.28.10 IDeckLinkDeckControl::GoToTimecode method
- 2.5.28.11 IDeckLinkDeckControl::FastForward method
- 2.5.28.12 IDeckLinkDeckControl::Rewind method
- 2.5.28.13 IDeckLinkDeckControl::StepForward method
- 2.5.28.14 IDeckLinkDeckControl::StepBack method
- 2.5.28.15 IDeckLinkDeckControl::Jog method
- 2.5.28.16 IDeckLinkDeckControl::Shuttle method
- 2.5.28.17 IDeckLinkDeckControl::GetTimecodeString method
- 2.5.28.18 IDeckLinkDeckControl::GetTimecode method
- 2.5.28.19 IDeckLinkDeckControl::GetTimecodeBCD method
- 2.5.28.20 IDeckLinkDeckControl::SetPreroll method
- 2.5.28.21 IDeckLinkDeckControl::GetPreroll method
- 2.5.28.22 IDeckLinkDeckControl::SetExportOffset method
- 2.5.28.23 IDeckLinkDeckControl::GetExportOffset method
- 2.5.28.24 IDeckLinkDeckControl::GetManualExportOffset method
- 2.5.28.25 IDeckLinkDeckControl::SetCaptureOffset method
- 2.5.28.26 IDeckLinkDeckControl::GetCaptureOffset method
- 2.5.28.27 IDeckLinkDeckControl::StartExport method
- 2.5.28.28 IDeckLinkDeckControl::StartCapture method
- 2.5.28.29 IDeckLinkDeckControl::GetDeviceID method
- 2.5.28.30 IDeckLinkDeckControl::Abort method
- 2.5.28.31 IDeckLinkDeckControl::CrashRecordStart method
- 2.5.28.32 IDeckLinkDeckControl::CrashRecordStop method
- 2.5.28.33 IDeckLinkDeckControl::SetCallback method
- 2.5.29 IDeckLinkDeckControlStatusCallback Interface
- 2.5.30 IDeckLinkDiscovery Interface
- 2.5.31 IDeckLinkDeviceNotificationCallback Interface
- 2.5.32 IDeckLinkNotification Interface
- 2.5.33 IDeckLinkNotificationCallback Interface
- 2.5.34 IDeckLinkEncoderInput Interface
- 2.5.34.1 IDeckLinkEncoderInput::DoesSupportVideoMode method
- 2.5.34.2 IDeckLinkEncoderInput::GetDisplayMode method
- 2.5.34.3 IDeckLinkEncoderInput::GetDisplayModeIterator method
- 2.5.34.4 IDeckLinkEncoderInput::EnableVideoInput method
- 2.5.34.5 IDeckLinkEncoderInput::DisableVideoInput method
- 2.5.34.6 IDeckLinkEncoderInput::GetAvailablePacketsCount method
- 2.5.34.7 IDeckLinkEncoderInput::EnableAudioInput method
- 2.5.34.8 IDeckLinkEncoderInput::DisableAudioInput method
- 2.5.34.9 IDeckLinkEncoderInput::GetAvailableAudioSampleFrameCount method
- 2.5.34.10 IDeckLinkEncoderInput::StartStreams method
- 2.5.34.11 IDeckLinkEncoderInput::StopStreams method
- 2.5.34.12 IDeckLinkEncoderInput::PauseStreams method
- 2.5.34.13 IDeckLinkEncoderInput::FlushStreams method
- 2.5.34.14 IDeckLinkEncoderInput::SetCallback method
- 2.5.34.15 IDeckLinkEncoderInput::GetHardwareReferenceClock method
- 2.5.35 IDeckLinkEncoderInputCallback Interface
- 2.5.36 IDeckLinkEncoderPacket Interface
- 2.5.37 IDeckLinkEncoderVideoPacket Interface
- 2.5.38 IDeckLinkEncoderAudioPacket Interface
- 2.5.39 IDeckLinkH265NALPacket Interface
- 2.5.40 IDeckLinkEncoderConfiguration Interface
- 2.5.40.1 IDeckLinkEncoderConfiguration::SetFlag method
- 2.5.40.2 IDeckLinkEncoderConfiguration::GetFlag method
- 2.5.40.3 IDeckLinkEncoderConfiguration::SetInt method
- 2.5.40.4 IDeckLinkEncoderConfiguration::GetInt method
- 2.5.40.5 IDeckLinkEncoderConfiguration::SetFloat method
- 2.5.40.6 IDeckLinkEncoderConfiguration::GetFloat method
- 2.5.40.7 IDeckLinkEncoderConfiguration::SetString method
- 2.5.40.8 IDeckLinkEncoderConfiguration::GetString method
- 2.5.40.9 IDeckLinkEncoderConfiguration::GetBytes method
- 2.5.41 IDeckLinkStatus Interface
- 2.5.42 IDeckLinkVideoFrameMetadataExtensions Interface
- 2.5.42.1 IDeckLinkVideoFrameMetadataExtensions::GetInt method
- 2.5.42.2 IDeckLinkVideoFrameMetadataExtensions::GetFloat method
- 2.5.42.3 IDeckLinkVideoFrameMetadataExtensions::GetFlag method
- 2.5.42.4 IDeckLinkVideoFrameMetadataExtensions::GetString method
- 2.5.42.5 IDeckLinkVideoFrameMetadataExtensions::GetBytes method
- 2.5.43 IDeckLinkVideoConversion Interface
- 2.5.44 IDeckLinkHDMIInputEDID Interface
- 2.5.45 IDeckLinkProfileManager Interface
- 2.5.46 IDeckLinkProfileIterator Interface
- 2.5.47 IDeckLinkProfile Interface
- 2.5.48 IDeckLinkProfileCallback Interface
- 2.5.49 IDeckLinkMetalScreenPreviewHelper Interface
- 2.5.50 IDeckLinkWPFDX9ScreenPreviewHelper Interface
- 2.5.50.1 IDeckLinkWPFDX9ScreenPreviewHelper::Initialize method
- 2.5.50.2 IDeckLinkWPFDX9ScreenPreviewHelper::Render method
- 2.5.50.3 IDeckLinkWPFDX9ScreenPreviewHelper::SetSurfaceSize method
- 2.5.50.4 IDeckLinkWPFDX9ScreenPreviewHelper::SetFrame method
- 2.5.50.5 IDeckLinkWPFDX9ScreenPreviewHelper::Set3DPreviewFormat method
- 2.5.50.6 IDeckLinkWPFDX9ScreenPreviewHelper::GetBackBuffer method
- 2.5.51 IDeckLinkMacOutput Interface
- 2.5.52 IDeckLinkMacVideoBuffer Interface
- 2.5.53 IDeckLinkVideoBuffer Interface
- 2.5.54 IDeckLinkVideoBufferAllocatorProvider Interface
- 2.5.55 IDeckLinkVideoBufferAllocator Interface
- 2.5.56 IDeckLinkVideoFrameMutableMetadataExtensions Interface
- 2.5.56.1 IDeckLinkVideoFrameMutableMetadataExtensions::SetInt method
- 2.5.56.2 IDeckLinkVideoFrameMutableMetadataExtensions::SetFloat method
- 2.5.56.3 IDeckLinkVideoFrameMutableMetadataExtensions::SetFlag method
- 2.5.56.4 IDeckLinkVideoFrameMutableMetadataExtensions::SetString method
- 2.5.56.5 IDeckLinkVideoFrameMutableMetadataExtensions::SetBytes method
- 2.5.57 IDeckLinkIPExtensions Interface
- 2.5.58 IDeckLinkIPFlowIterator Interface
- 2.5.59 IDeckLinkIPFlow Interface
- 2.5.60 IDeckLinkIPFlowAttributes Interface
- 2.5.61 IDeckLinkIPFlowStatus Interface
- 2.5.62 IDeckLinkIPFlowSetting Interface
- 2.5.62.1 IDeckLinkIPFlowSetting::GetInt method
- 2.5.62.2 IDeckLinkIPFlowSetting::GetFlag method
- 2.5.62.3 IDeckLinkIPFlowSetting::GetFloat method
- 2.5.62.4 IDeckLinkIPFlowSetting::GetString method
- 2.5.62.5 IDeckLinkIPFlowSetting::SetInt method
- 2.5.62.6 IDeckLinkIPFlowSetting::SetFlag method
- 2.5.62.7 IDeckLinkIPFlowSetting::SetFloat method
- 2.5.62.8 IDeckLinkIPFlowSetting::SetString method
- 2.6 Streaming Interface Reference
- 2.6.1 IBMDStreamingDiscovery Interface
- 2.6.2 IBMDStreamingDeviceNotificationCallback Interface
- 2.6.3 IBMDStreamingVideoEncodingMode Interface
- 2.6.3.1 IBMDStreamingVideoEncodingMode::GetName method
- 2.6.3.2 IBMDStreamingVideoEncodingMode::GetPresetID method
- 2.6.3.3 IBMDStreamingVideoEncodingMode::GetSourcePositionX method
- 2.6.3.4 IBMDStreamingVideoEncodingMode::GetSourcePositionY method
- 2.6.3.5 IBMDStreamingVideoEncodingMode::GetSourceWidth method
- 2.6.3.6 IBMDStreamingVideoEncodingMode::GetSourceHeight method
- 2.6.3.7 IBMDStreamingVideoEncodingMode::GetDestWidth method
- 2.6.3.8 IBMDStreamingVideoEncodingMode::GetDestHeight method
- 2.6.3.9 IBMDStreamingVideoEncodingMode::GetFlag method
- 2.6.3.10 IBMDStreamingVideoEncodingMode::GetInt method
- 2.6.3.11 IBMDStreamingVideoEncodingMode::GetFloat method
- 2.6.3.12 IBMDStreamingVideoEncodingMode::GetString method
- 2.6.3.13 IBMDStreamingVideoEncodingMode::CreateMutableVideoEncodingMode method
- 2.6.4 IBMDStreamingMutableVideoEncodingMode Interface
- 2.6.4.1 IBMDStreamingMutableVideoEncodingMode::SetSourceRect method
- 2.6.4.2 IBMDStreamingMutableVideoEncodingMode::SetDestSize method
- 2.6.4.3 IBMDStreamingMutableVideoEncodingMode::SetFlag method
- 2.6.4.4 IBMDStreamingMutableVideoEncodingMode::SetInt method
- 2.6.4.5 IBMDStreamingMutableVideoEncodingMode::SetFloat method
- 2.6.4.6 IBMDStreamingMutableVideoEncodingMode::SetString method
- 2.6.5 IBMDStreamingVideoEncodingModePresetIterator Interface
- 2.6.6 IBMDStreamingDeviceInput Interface
- 2.6.6.1 IBMDStreamingDeviceInput::DoesSupportVideoInputMode method
- 2.6.6.2 IBMDStreamingDeviceInput::GetVideoInputModeIterator method
- 2.6.6.3 IBMDStreamingDeviceInput::SetVideoInputMode method
- 2.6.6.4 IBMDStreamingDeviceInput::GetCurrentDetectedVideoInputMode method
- 2.6.6.5 IBMDStreamingDeviceInput::GetVideoEncodingMode method
- 2.6.6.6 IBMDStreamingDeviceInput::GetVideoEncodingModePresetIterator method
- 2.6.6.7 IBMDStreamingDeviceInput::DoesSupportVideoEncodingMode method
- 2.6.6.8 IBMDStreamingDeviceInput::SetVideoEncodingMode method
- 2.6.6.9 IBMDStreamingDeviceInput::StartCapture method
- 2.6.6.10 IBMDStreamingDeviceInput::StopCapture method
- 2.6.6.11 IBMDStreamingDeviceInput::SetCallback method
- 2.6.7 IBMDStreamingH264InputCallback Interface
- 2.6.7.1 IBMDStreamingH264InputCallback::H264NALPacketArrived method
- 2.6.7.2 IBMDStreamingH264InputCallback::H264AudioPacketArrived method
- 2.6.7.3 IBMDStreamingH264InputCallback::MPEG2TSPacketArrived method
- 2.6.7.4 IBMDStreamingH264InputCallback::H264VideoInputConnectorScanningChanged method
- 2.6.7.5 IBMDStreamingH264InputCallback::H264VideoInputConnectorChanged method
- 2.6.7.6 IBMDStreamingH264InputCallback::H264VideoInputModeChanged method
- 2.6.8 IBMDStreamingH264NALPacket Interface
- 2.6.9 IBMDStreamingAudioPacket Interface
- 2.6.10 IBMDStreamingMPEG2TSPacket Interface
- 2.6.11 IBMDStreamingH264NALParser Interface