2.5.62 IDeckLinkIPFlowSetting Interface

The IDeckLinkIPFlowSetting object interface allows querying and modification of DeckLink IP flow settings.

An IDeckLinkIPFlowSetting 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 bmdIPFlowSettingChanged topic using the IDeckLinkNotification interface. See BMDNotifications for more information

Related Interfaces

Interface

Interface ID

Description

IDeckLinkIPFlow

IID_IDeckLinkIPFlow

An IDeckLinkIPFlowSetting object interface may be obtained from IDeckLinkIPFlow using QueryInterface

2.5.62.1 IDeckLinkIPFlowSetting::GetInt method

HRESULT IDeckLinkIPFlowSetting::GetInt(BMDDeckLinkIPFlowSettingID settingID, int64_t *value);

The GetInt method gets the current integer value of a flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:
Return values:

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

  • 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.62.2 IDeckLinkIPFlowSetting::GetFlag method

HRESULT IDeckLinkIPFlowSetting::GetFlag(BMDDeckLinkIPFlowSettingID settingID, Boolean *value);

The GetFlag method gets the current boolean value of a flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:

  • settingID – BMDDeckLinkIPFlowSettingID to get flag value.

  • value – The boolean value that is set in the selected flow setting.

Return values:

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

  • 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.62.3 IDeckLinkIPFlowSetting::GetFloat method

HRESULT IDeckLinkIPFlowSetting::GetFloat(BMDDeckLinkIPFlowSettingID settingID, double *value);

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

Parameters:
Return values:

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

  • 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.62.4 IDeckLinkIPFlowSetting::GetString method

HRESULT IDeckLinkIPFlowSetting::GetString(BMDDeckLinkIPFlowSettingID settingID, string *value);

The GetString method gets the current string value of a flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:
Return values:

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

  • 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.62.5 IDeckLinkIPFlowSetting::SetInt method

HRESULT IDeckLinkIPFlowSetting::SetInt(BMDDeckLinkIPFlowSettingID settingID, int64_t value);

The SetInt method sets the integer value into the flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:

  • settingID – The ID of the flow setting.

  • value – The boolean value to set into the selected flow setting.

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.62.6 IDeckLinkIPFlowSetting::SetFlag method

HRESULT IDeckLinkIPFlowSetting::SetFlag(BMDDeckLinkIPFlowSettingID settingID, Boolean value);

The SetFlag method sets a boolean value into the flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:

  • settingID – The ID of the flow setting.

  • value – The boolean value to set into the selected flow setting.

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.62.7 IDeckLinkIPFlowSetting::SetFloat method

HRESULT IDeckLinkIPFlowSetting::SetFloat(BMDDeckLinkIPFlowSettingID settingID, double value);

The SetFloat method sets the current double value of a flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:

  • settingID – The ID of the flow setting.

  • value – The double value to set into the selected flow setting.

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.62.8 IDeckLinkIPFlowSetting::SetString method

HRESULT IDeckLinkIPFlowSetting::SetString(BMDDeckLinkIPFlowSettingID settingID, string value);

The SetString method sets the current string value of a flow setting associated with the given BMDDeckLinkIPFlowSettingID.

Parameters:

  • settingID – The ID of the flow setting.

  • value – The string to set into the selected flow setting. The value of the string is copied, so the string remains in the ownership of the caller.

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success