2.5.63 IDeckLinkStatistics Interface

The IDeckLinkStatistics interface allows querying of statistics associated with a DeckLink device.

The DeckLink Statistic ID section enumerates the statistics that can be queried using this interface. An IDeckLinkStatistics interface can be obtained from an IDeckLink interface using QueryInterface.

For an example demonstrating the use of this interface, please see the DeviceStatus sample in the DeckLink SDK.

Related Interfaces

Interface

Interface ID

Description

IDeckLink

IID_IDeckLink

An IDeckLinkStatistics object interface may be obtained from IDeckLink using QueryInterface

2.5.63.1 IDeckLinkStatistics::GetInt method

HRESULT IDeckLinkStatistics::GetInt(BMDDeckLinkStatisticID statID, int64_t *value);

Gets the current integer value of a statistic associated with the given BMDDeckLinkStatisticID.

Parameters:

  • statID – The BMDDeckLinkStatisticID of the statistic.

  • value – The integer value corresponding to the statID.

Return values:

  • E_INVALIDARG – The BMDDeckLinkStatisticID is unknown or the value parameter was a nullptr.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.63.2 IDeckLinkStatistics::GetIntWithParam method

HRESULT IDeckLinkStatistics::GetIntWithParam(BMDDeckLinkStatisticID statID, uint64_t param, int64_t *value);

Gets the current integer value of a statistic associated with the given BMDDeckLinkStatisticID and 64-bit unsigned integer parameter.

Parameters:

  • statID – The BMDDeckLinkStatisticID of the parameterized statistic.

  • param – The parameter for the associated statID.

  • value – The integer value corresponding to the statID and parameter.

Return values:

  • E_INVALIDARG – The BMDDeckLinkStatisticID is unknown or the value parameter was a nullptr.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.63.3 IDeckLinkStatistics::GetStringWithParam method

HRESULT IDeckLinkStatistics::GetStringWithParam(BMDDeckLinkStatisticID statID, uint64_t param, string *value);

Gets the current string value of a statistic associated with the given BMDDeckLinkStatisticID and 64-bit unsigned integer parameter.

Parameters:

  • statID – The BMDDeckLinkStatisticID of the parameterized statistic.

  • param – The parameter for the associated statID.

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

Return values:

  • E_INVALIDARG – The BMDDeckLinkStatisticID is unknown or the value parameter was a nullptr.

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

  • E_FAIL – Failure

  • S_OK – Success