2.5.40 IDeckLinkEncoderConfiguration Interface

The IDeckLinkEncoderConfiguration interface allows querying and modification of DeckLink encoder configuration parameters.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkEncoderInput

IID_IDeckLinkEncoderInput

An IDeckLinkEncoderConfiguration object interface may be obtained from IDeckLinkEncoderInput using QueryInterface

2.5.40.1 IDeckLinkEncoderConfiguration::SetFlag method

HRESULT IDeckLinkEncoderConfiguration::SetFlag(BMDDeckLinkEncoderConfigurationID cfgID, Boolean value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.2 IDeckLinkEncoderConfiguration::GetFlag method

HRESULT IDeckLinkEncoderConfiguration::GetFlag(BMDDeckLinkEncoderConfigurationID cfgID, Boolean *value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.3 IDeckLinkEncoderConfiguration::SetInt method

HRESULT IDeckLinkEncoderConfiguration::SetInt(BMDDeckLinkEncoderConfigurationID cfgID, int64_t value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.4 IDeckLinkEncoderConfiguration::GetInt method

HRESULT IDeckLinkEncoderConfiguration::GetInt(BMDDeckLinkEncoderConfigurationID cfgID, int64_t *value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.5 IDeckLinkEncoderConfiguration::SetFloat method

HRESULT IDeckLinkEncoderConfiguration::SetFloat(BMDDeckLinkEncoderConfigurationID cfgID, double value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.6 IDeckLinkEncoderConfiguration::GetFloat method

HRESULT IDeckLinkEncoderConfiguration::GetFloat(BMDDeckLinkEncoderConfigurationID cfgID, double *value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.7 IDeckLinkEncoderConfiguration::SetString method

HRESULT IDeckLinkEncoderConfiguration::SetString(BMDDeckLinkEncoderConfigurationID cfgID, string value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.8 IDeckLinkEncoderConfiguration::GetString method

HRESULT IDeckLinkEncoderConfiguration::GetString(BMDDeckLinkEncoderConfigurationID cfgID, string *value);

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

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 BMDDeckLinkEncoderConfigurationID.

  • E_FAIL – Failure

  • S_OK – Success

2.5.40.9 IDeckLinkEncoderConfiguration::GetBytes method

HRESULT IDeckLinkEncoderConfiguration::GetBytes(BMDDeckLinkEncoderConfigurationID cfgID, void *buffer, uint32_t *bufferSize);

The GetBytes method gets the encoder configuration data in a format represented by the given BMDDeckLinkEncoderConfigurationID.To determine the size of the buffer required, call GetBytes by initially passing buffer as NULL. GetBytes will return S_OK and bufferSize will be updated to the required size.

Parameters:

  • cfgID – The ID of the configuration setting.

  • buffer – The buffer in which to return the configuration data, or NULL to determine the required buffer size.

  • bufferSize – The size of the provided buffer. Will be updated to the number of bytes returned.

Return values:

  • E_INVALIDARG – There is no encoder configuration data format corresponding to the given BMDDeckLinkEncoderConfigurationID.

  • E_OUTOFMEMORY – The provided buffer is too small.

  • E_FAIL – Failure

  • S_OK – Success