2.5.13 IDeckLinkDisplayModeIterator Interface

The IDeckLinkDisplayModeIterator interface is used to enumerate the available display modes for a DeckLink device.

An IDeckLinkDisplayModeIterator interface may be obtained from an IDeckLinkInput or IDeckLinkOutput interface using the GetDisplayModeIterator method.

Note

The IDeckLinkDisplayModeIterator will enumerate all display modes regardless of the current profile. An application should call the DoesSupportVideoMode method in the IDeckLinkInput, IDeckLinkOutput or IDeckLinkEncoderInput interfaces to ensure that a display mode is supported for a given profile.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkDisplayMode

IID_IDeckLinkDisplayMode

IDeckLinkDisplayModeIterator::Next() outputs an IDeckLinkDisplayMode object interface

IDeckLinkOutput

IID_IDeckLinkOutput

IDeckLinkOutput::GetDisplayModeIterator() outputs an IDeckLinkDisplayModeIterator object interface

IDeckLinkInput

IID_IDeckLinkInput

IDeckLinkInput::GetDisplayModeIterator() outputs an IDeckLinkDisplayModeIterator object interface

IDeckLinkEncoderInput

IID_IDeckLinkEncoderInput

IDeckLinkEncoderInput::GetDisplayModeIterator() outputs an IDeckLinkDisplayModeIterator object interface

IBMDStreamingDeviceInput

IID_IBMDStreamingDeviceInput

IBMDStreamingDeviceInput::GetVideoInputModeIterator() outputs an IDeckLinkDisplayModeIterator object interface

2.5.13.1 IDeckLinkDisplayModeIterator::Next method

HRESULT IDeckLinkDisplayModeIterator::Next(IDeckLinkDisplayMode **deckLinkDisplayMode);

The Next method returns the next available IDeckLinkDisplayMode interface.

Parameters:

deckLinkDisplayMode – IDeckLinkDisplayMode object interface or NULL when no more display modes are available.

Return values:

  • E_FAIL – Failure

  • S_FALSE – No (more) display modes found

  • S_OK – Success