2.5.16 IDeckLinkAPIInformation Interface

The IDeckLinkAPIInformation interface provides global API information.

A reference to an IDeckLinkAPIInformation interface may be obtained from CoCreateInstance() on platforms with native COM support or from CreateDeckLinkAPIInformationInstance() on other platforms.

2.5.16.1 IDeckLinkAPIInformation::GetFlag method

HRESULT IDeckLinkAPIInformation::GetFlag(BMDDeckLinkAPIInformationID cfgID, Boolean *value);

The GetFlag method gets a boolean flag associated with a given BMDDeckLinkAPIInformationID.

Parameters:
Return values:

  • E_INVALIDARG – There is no flag type attribute corresponding to cfgID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.16.2 IDeckLinkAPIInformation::GetInt method

HRESULT IDeckLinkAPIInformation::GetInt(BMDDeckLinkAPIInformationID cfgID, int64_t *value);

The GetInt method gets an 64-bit signed integer value associated with a given BMDDeckLinkAPIInformationID.

Parameters:
Return values:

  • E_INVALIDARG – There is no int type attribute corresponding to cfgID.

  • S_OK – Success

2.5.16.3 IDeckLinkAPIInformation::GetFloat method

HRESULT IDeckLinkAPIInformation::GetFloat(BMDDeckLinkAPIInformationID cfgID, double *value);

The GetFloat method gets a float value associated with a given BMDDeckLinkAPIInformationID.

Parameters:
Return values:

  • E_INVALIDARG – There is no float type attribute corresponding to cfgID.

  • S_OK – Success

2.5.16.4 IDeckLinkAPIInformation::GetString method

HRESULT IDeckLinkAPIInformation::GetString(BMDDeckLinkAPIInformationID cfgID, string *value);

The GetString method gets a string value associated with a given BMDDeckLinkAPIInformationID.

Parameters:
Return values:

  • E_INVALIDARG – There is no string type attribute corresponding to cfgID.

  • E_OUTOFMEMORY – Unable to allocate memory for string.

  • S_OK – Success