2.5.60 IDeckLinkIPFlowAttributes Interface

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

Related Interfaces

Interface

Interface ID

Description

IDeckLinkIPFlow

IID_IDeckLinkIPFlow

An IDeckLinkIPFlowAttributes object interface may be obtained from IDeckLinkIPFlow using QueryInterface

2.5.60.1 IDeckLinkIPFlowAttributes::GetInt method

HRESULT IDeckLinkIPFlowAttributes::GetInt(BMDDeckLinkIPFlowAttributeID attrID, int64_t *value);

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

Parameters:
Return values:

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

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

  • E_POINTER – The value output pointer is invalid.

  • S_OK – Success

2.5.60.2 IDeckLinkIPFlowAttributes::GetFlag method

HRESULT IDeckLinkIPFlowAttributes::GetFlag(BMDDeckLinkIPFlowAttributeID attrID, Boolean *value);

The GetFlag method gets a flag value associated with a given BMDDeckLinkIPFlowAttributeID.

Parameters:
Return values:

  • E_INVALIDARG – There is no flag type flow setting for this operation corresponding to the given BMDDeckLinkIPFlowAttributeID.

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

  • E_POINTER – The value output pointer is invalid.

  • S_OK – Success

2.5.60.3 IDeckLinkIPFlowAttributes::GetFloat method

HRESULT IDeckLinkIPFlowAttributes::GetFloat(BMDDeckLinkIPFlowAttributeID attrID, double *value);

The GetFloat method gets a double value associated with a given BMDDeckLinkIPFlowAttributeID.

Parameters:
Return values:

  • E_INVALIDARG – There is no double type flow setting for this operation corresponding to the given BMDDeckLinkIPFlowAttributeID.

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

  • E_POINTER – The value output pointer is invalid.

  • S_OK – Success

2.5.60.4 IDeckLinkIPFlowAttributes::GetString method

HRESULT IDeckLinkIPFlowAttributes::GetString(BMDDeckLinkIPFlowAttributeID attrID, string *value);

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

Parameters:
Return values:

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

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

  • E_POINTER – The value output pointer is invalid.

  • S_OK – Success