2.5.15 IDeckLinkConfiguration Interface

The IDeckLinkConfiguration interface allows querying and modification of DeckLink configuration parameters.The configuration settings are globally visible (not limited to the current process). Changes will persist until the IDeckLinkConfiguration object is released, unless WriteConfigurationToPreferences is called. In which case, the changes will be made permanent and will persist across restarts.

Related Interfaces

Interface

Interface ID

Description

IDeckLink

IID_IDeckLink

An IDeckLinkConfiguration object interface may be obtained from IDeckLink using QueryInterface

2.5.15.1 IDeckLinkConfiguration::SetFlag method

HRESULT IDeckLinkConfiguration::SetFlag(BMDDeckLinkConfigurationID cfgID, Boolean value);

The SetFlag method sets a boolean value into the configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

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

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.2 IDeckLinkConfiguration::GetFlag method

HRESULT IDeckLinkConfiguration::GetFlag(BMDDeckLinkConfigurationID cfgID, Boolean *value);

The GetFlag method gets the current boolean value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

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

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.3 IDeckLinkConfiguration::SetInt method

HRESULT IDeckLinkConfiguration::SetInt(BMDDeckLinkConfigurationID cfgID, int64_t value);

The SetInt method sets the current integer value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

  • value – The integer value to set into the selected configuration setting.

Return values:

  • E_INVALIDARG – There is no integer type configuration setting for this operation corresponding to the given BMDDeckLinkConfigurationID.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.4 IDeckLinkConfiguration::GetInt method

HRESULT IDeckLinkConfiguration::GetInt(BMDDeckLinkConfigurationID cfgID, int64_t *value);

The GetInt method gets the current integer value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

  • value – The integer value that is set in the selected configuration setting.

Return values:

  • E_INVALIDARG – There is no integer type configuration setting for this operation corresponding to the given BMDDeckLinkConfigurationID.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.5 IDeckLinkConfiguration::SetFloat method

HRESULT IDeckLinkConfiguration::SetFloat(BMDDeckLinkConfigurationID cfgID, double value);

The SetFloat method sets the current double value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

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

Return values:

  • E_INVALIDARG – There is no float type configuration setting for this operation corresponding to the given BMDDeckLinkConfigurationID.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.6 IDeckLinkConfiguration::GetFloat method

HRESULT IDeckLinkConfiguration::GetFloat(BMDDeckLinkConfigurationID cfgID, double *value);

The GetFloat method gets the current double value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

  • value – The double value that is set in the selected configuration setting.

Return values:

  • E_INVALIDARG – There is no float type configuration setting for this operation corresponding to the given BMDDeckLinkConfigurationID.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.7 IDeckLinkConfiguration::SetString method

HRESULT IDeckLinkConfiguration::SetString(BMDDeckLinkConfigurationID cfgID, string value);

The SetString method sets the current string value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

  • value – The string to set into the selected configuration 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 configuration setting for this operation corresponding to the given BMDDeckLinkConfigurationID.

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.8 IDeckLinkConfiguration::GetString method

HRESULT IDeckLinkConfiguration::GetString(BMDDeckLinkConfigurationID cfgID, string *value);

The GetString method gets the current string value of a configuration setting associated with the given BMDDeckLinkConfigurationID.

Parameters:

  • cfgID – The ID of the configuration setting.

  • value – The string set in the selected configuration setting. This allocated string must be freed by the caller when no longer required.

Return values:

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

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

  • E_FAIL – Failure

  • S_OK – Success

2.5.15.9 IDeckLinkConfiguration::WriteConfigurationToPreferences method

HRESULT IDeckLinkConfiguration::WriteConfigurationToPreferences();

The WriteConfigurationToPreferences method saves the current settings to system preferences so they will persist across system restarts.

Note

Configuration settings changed through this interface will be reverted when the interface is released unless this method is called.

Return values:

  • E_FAIL – Failure

  • S_OK – Success