2.5.17 IDeckLinkProfileAttributes Interface

The IDeckLinkProfileAttributes interface provides details about the capabilities of a profile for a DeckLink card. The detail types that are available for various capabilities are: flag, int, float, and string. The DeckLink Attribute ID section lists the hardware capabilities and associated attributes identifiers that can be queried using this interface.

Related Interfaces

Interface

Interface ID

Description

IDeckLink

IID_IDeckLink

An IDeckLinkProfileAttributes object interface may be obtained from IDeckLink using QueryInterface

IDeckLinkProfile

IID_IDeckLinkProfile

An IDeckLinkProfileAttributes object interface may be obtained from IDeckLinkProfile using QueryInterface

2.5.17.1 IDeckLinkProfileAttributes::GetFlag method

HRESULT IDeckLinkProfileAttributes::GetFlag(BMDDeckLinkAttributeID cfgID, Boolean *value);

The GetFlag method gets a boolean flag associated with a given BMDDeckLinkAttributeID. (See BMDDeckLinkAttributeID for a list of attribute IDs)

Parameters:
Return values:

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.17.2 IDeckLinkProfileAttributes::GetInt method

HRESULT IDeckLinkProfileAttributes::GetInt(BMDDeckLinkAttributeID cfgID, int64_t *value);

The GetInt method gets an integer value associated with a given BMDDeckLinkAttributeID.

Parameters:
Return values:

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.17.3 IDeckLinkProfileAttributes::GetFloat method

HRESULT IDeckLinkProfileAttributes::GetFloat(BMDDeckLinkAttributeID cfgID, double *value);

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

Parameters:
Return values:

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.17.4 IDeckLinkProfileAttributes::GetString method

HRESULT IDeckLinkProfileAttributes::GetString(BMDDeckLinkAttributeID cfgID, string *value);

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

Parameters:
Return values:

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.17.5 IDeckLinkProfileAttributes::GetStringWithParam method

HRESULT IDeckLinkProfileAttributes::GetStringWithParam(BMDDeckLinkAttributeID cfgID, uint64_t param, string *value);

The GetStringWithParam method gets a string value associated with the given BMDDeckLinkAttributeID and 64-bit unsigned integer parameter.

Parameters:

  • cfgID – BMDDeckLinkAttributeID to get the string value.

  • param – The parameter for the associated cfgID.

  • value – The string value corresponding to the cfgID. This allocated string must be freed by the caller when no longer required.

Return values:

  • E_INVALIDARG – There is no flag type status corresponding to the given BMDDeckLinkAttributeID and 64-bit unsigned integer parameter.

  • E_NOTIMPL – The request is correct however it is not supported by the DeckLink hardware.

  • E_FAIL – Failure

  • S_OK – Success