2.5.14 IDeckLinkDisplayMode Interface

class IDeckLinkDisplayMode

The IDeckLinkDisplayMode interface represents a supported display mode.

The IDeckLinkDisplayModeIterator interface enumerates supported display modes, returning IDeckLinkDisplayMode interfaces.

IDeckLinkDisplayMode interface objects can be also obtained from IDeckLinkOutput::GetDisplayMode(), IDeckLinkInput::GetDisplayMode() and IDeckLinkEncoderInput::GetDisplayMode() with the corresponding BMDDisplayMode enum

Related Interfaces

Interface	Interface ID	Description
IDeckLinkInputCallback	IID_IDeckLinkInputCallback	An IDeckLinkDisplayMode object interface is passed to IDeckLinkInputCallback::VideoInputFormatChanged()
IDeckLinkEncoderInputCallback	IID_IDeckLinkEncoderInputCallback	An IDeckLinkDisplayMode object interface is passed to IDeckLinkEncoderInputCallback::VideoInputSignalChanged()
IDeckLinkDisplayModeIterator	IID_IDeckLinkDisplayModeIterator	IDeckLinkDisplayModeIterator::Next() outputs an IDeckLinkDisplayMode object interface
IDeckLinkOutput	IID_IDeckLinkOutput	IDeckLinkOutput::GetDisplayMode() outputs an IDeckLinkDisplayMode object interface
IDeckLinkInput	IID_IDeckLinkInput	IDeckLinkInput::GetDisplayMode() outputs an IDeckLinkDisplayMode object interface
IDeckLinkEncoderInput	IID_IDeckLinkEncoderInput	IDeckLinkEncoderInput::GetDisplayMode() outputs an IDeckLinkDisplayMode object interface

2.5.14.1 IDeckLinkDisplayMode::GetName method

HRESULT IDeckLinkDisplayMode::GetName(string *name);

The GetName method returns a string describing the display mode.

Parameters:

name – Descriptive string. This allocated string must be freed by the caller when no longer required.

Return values:

• E_FAIL – Failure

• S_OK – Success

2.5.14.2 IDeckLinkDisplayMode::GetDisplayMode method

BMDDisplayMode IDeckLinkDisplayMode::GetDisplayMode();

The GetDisplayMode method returns the corresponding BMDDisplayMode for the selected display mode.

Returns:

BMDDisplayMode corresponding to the display mode

2.5.14.3 IDeckLinkDisplayMode::GetWidth method

long IDeckLinkDisplayMode::GetWidth();

The GetWidth method returns the width of a video frame in the display mode.

Returns:

Video frame width in pixels

2.5.14.4 IDeckLinkDisplayMode::GetHeight method

long IDeckLinkDisplayMode::GetHeight();

The GetHeight method returns the height of a video frame in the display mode.

Returns:

Video frame height in pixels

2.5.14.5 IDeckLinkDisplayMode::GetFrameRate method

HRESULT IDeckLinkDisplayMode::GetFrameRate(BMDTimeValue *frameDuration, BMDTimeScale *timeScale);

The GetFrameRate method returns the frame rate of the display mode. The frame rate is represented as the two integer components of a rational number for accuracy. The actual frame rate can be calculated by timeScale / frameDuration.

Parameters:

• frameDuration – Frame duration time value

• timeScale – Frame rate time scale

Return values:

S_OK – Success

2.5.14.6 IDeckLinkDisplayMode::GetFieldDominance method

BMDFieldDominance IDeckLinkDisplayMode::GetFieldDominance();

The GetFieldDominance method gets the field dominance of the frame.

Returns:

The field dominance see BMDFieldDominance for details.

2.5.14.7 IDeckLinkDisplayMode::GetFlags method

BMDDisplayModeFlags IDeckLinkDisplayMode::GetFlags();

The GetFlags method returns flags associated with display modes.

Returns:

The display mode flags see BMDDisplaymodeFlags for details.