2.5.61 IDeckLinkIPFlowStatus Interface

class IDeckLinkIPFlowStatus

The IDeckLinkIPFlowStatus object interface allows querying of status information associated with a DeckLink IP flow.

An IDeckLinkIPFlowStatus object interface can be obtained from the IDeckLinkIPFlow interface using QueryInterface.

An application may be notified of changes to status information by subscribing to the bmdIPFlowStatusChanged topic using the IDeckLinkNotification interface. See BMDNotifications for more information

Related Interfaces

Interface	Interface ID	Description
IDeckLinkIPFlow	IID_IDeckLinkIPFlow	An IDeckLinkIPFlowStatus object interface may be obtained from IDeckLinkIPFlow using QueryInterface

2.5.61.1 IDeckLinkIPFlowStatus::GetInt method

HRESULT IDeckLinkIPFlowStatus::GetInt(BMDDeckLinkIPFlowStatusID statusID, int64_t *value);

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

Parameters:

• statusID – BMDDeckLinkIPFlowStatusID to get int value.

• value – The value corresponding to statusID.

Return values:

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

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

• E_POINTER – The value output pointer is invalid.

• E_FAIL – Failure

• S_OK – Success

2.5.61.2 IDeckLinkIPFlowStatus::GetFlag method

HRESULT IDeckLinkIPFlowStatus::GetFlag(BMDDeckLinkIPFlowStatusID statusID, Boolean *value);

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

Parameters:

• statusID – BMDDeckLinkIPFlowStatusID to get flag value.

• value – Value of flag corresponding to statusID.

Return values:

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

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

• E_POINTER – The value output pointer is invalid.

• E_FAIL – Failure

• S_OK – Success

2.5.61.3 IDeckLinkIPFlowStatus::GetFloat method

HRESULT IDeckLinkIPFlowStatus::GetFloat(BMDDeckLinkIPFlowStatusID statusID, double *value);

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

Parameters:

• statusID – BMDDeckLinkIPFlowStatusID to get double value.

• value – Value of double corresponding to statusID.

Return values:

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

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

• E_POINTER – The value output pointer is invalid.

• E_FAIL – Failure

• S_OK – Success

2.5.61.4 IDeckLinkIPFlowStatus::GetString method

HRESULT IDeckLinkIPFlowStatus::GetString(BMDDeckLinkIPFlowStatusID statusID, string *value);

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

Parameters:

• statusID – BMDDeckLinkIPFlowStatusID to get string value.

• value – Value of string corresponding to statusID.

Return values:

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

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

• E_POINTER – The value output pointer is invalid.

• E_FAIL – Failure

• S_OK – Success