The IBMDSwitcherInput object interface represents a physical switcher device.
Related Interfaces
Interface Interface ID Description
IBMDSwitcherInputDiscovery IID_IBMDSwitcherInputDiscovery An IBMDSwitcherInput object will be returned after a successful call to the
IBMDSwitcherInputDiscovery::ConnectTo method Public Member Functions
Method Description
AddCallback Add a callback to receive input property changes.
RemoveCallback Remove a callback.
GetInputId Get the unique Id for this input.
GetFlag Get the current value of a boolean encoding mode setting.
GetInt Get the current value of a int64_t encoding mode setting
GetFloat Get the current value of a double encoding mode setting.
GetString Get the current value of a string encoding mode setting.
SetFlag Set the value for a boolean encoding mode setting.
SetInt ASet the value for an int64_t encoding mode setting.
SetFloat Set the value for a double encoding mode setting.
SetString Set the value for a string encoding mode setting.
2.3.5
Basic Switcher Control
2
SECTION
61
SDK Software Developers Kit
IBMDSwitcherInput::AddCallback method
The AddCallback method configures a callback to be called when a switcher input property changes.
Adding a new callback will not affect previously added callbacks. Callbacks will be called on a separate thread and in the order of their addition by AddCallback.
Syntax
HRESULT AddCallback (IBMDSwitcherInputCallback* callback);
Parameters
Value Description
S_OK Success
E_INVALIDARG The callback parameter is invalid.
Name Direction Description
callback in Callback object implementing the
IBMDSwitcherInputCallback object interface Return Values
2.3.5.1
Basic Switcher Control
2
SECTION
62
SDK Software Developers Kit
IBMDSwitcherInput::RemoveCallback method
The RemoveCallback method removes a previously installed callback.
Syntax
HRESULT RemoveCallback (IBMDSwitcherInputCallback* callback);
Parameters
Value Description
S_OK Success
E_INVALIDARG The callback parameter is invalid.
Name Direction Description
callback in Callback object to remove
Return Values
2.3.5.2
IBMDSwitcherInput::GetInputId method
The GetInputId method gets the unique Id for the switcher input.
Syntax
HRESULT GetInputId (BMDSwitcherInputId* inputId);
Parameters
Value Description
S_OK Success
E_POINTER The inputId parameter is invalid.
Name Direction Description
inputId out unique Id for switcher input
Return Values
2.3.5.3
Basic Switcher Control
2
SECTION
63
SDK Software Developers Kit
IBMDSwitcherInput::GetFlag method
The GetFlag method gets the current value of the boolean property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT GetFlag (BMDSwitcherInputPropertyId propertyId,
boolean* value);
Parameters
Value Description
S_OK Success
E_INVALIDARG The propertyId parameter is invalid.
E_POINTER The value parameter is invalid.
Name Direction Description
propertyId value Return Values
2.3.5.4
Basic Switcher Control
2
SECTION
64
SDK Software Developers Kit
IBMDSwitcherInput::GetInt method
The GetInt method gets the current value of the int64_t property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT GetInt (BMDSwitcherInputPropertyId propertyId,
int64_t* value);
Parameters
Value Description
S_OK Success
E_INVALIDARG The propertyId parameter is invalid.
E_POINTER The value parameter is invalid.
Name Direction Description
propertyId in BMDSwitcherInputPropertyId to get integer value.
value out The value corresponding to propertyId.
Return Values
2.3.5.5
Basic Switcher Control
2
SECTION
65
SDK Software Developers Kit
IBMDSwitcherInput::GetFloat method
The GetFloat gets the current value of the double property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT GetFloat (BMDSwitcherInputPropertyId propertyId,
double* value);
Parameters
Value Description
S_OK Success
E_INVALIDARG The propertyId parameter is invalid.
E_POINTER The value parameter is invalid.
Name Direction Description
propertyId value Return Values
2.3.5.6
Basic Switcher Control
2
SECTION
66
SDK Software Developers Kit
IBMDSwitcherInput::GetString method
The GetString current value of the string property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT GetString (BMDSwitcherInputPropertyId propertyId,
string value);
Parameters
Value Description
S_OK Success
E_INVALIDARG The propertyId parameter is invalid.
E_POINTER The value parameter is invalid.
E_OUTOFMEMORY Unable to allocate memory for string.
Name Direction Description
propertyId in BMDSwitcherInputPropertyId to get string value.
value out The value corresponding to propertyId. This allocated string must be released by the caller when no longer required.
Return Values
2.3.5.7
Basic Switcher Control
2
SECTION
67
SDK Software Developers Kit
IBMDSwitcherInput::SetFlag method
The SetFlag method sets a boolean value into the property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT SetFlag (BMDSwitcherInputPropertyId propertyId, boolean value);
Parameters
Value Description
E_FAIL Failure
S_OK Success
E_INVALIDARG One or more parameters are invalid.
Name Direction Description
propertyId in The ID of the property.
value in The boolean value to set into the selected property.
Return Values
2.3.5.8
Basic Switcher Control
2
SECTION
68
SDK Software Developers Kit
IBMDSwitcherInput::SetInt method
The SetInt method sets an int64_t value into the property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT SetInt (BMDSwitcherInputPropertyId propertyId, int64_t value);
Parameters
Value Description
E_FAIL Failure
S_OK Success
E_INVALIDARG One or more parameters are invalid.
Name Direction Description
propertyId in The ID of the property.
value in The integer value to set into the selected property.
Return Values
2.3.5.9
Basic Switcher Control
2
SECTION
69
SDK Software Developers Kit
IBMDSwitcherInput::SetFloat method
SetFloatBMDSwitcherInputPropertyIdSyntax
HRESULT SetFloat (BMDSwitcherInputPropertyId propertyId, double value);
Parameters
Value Description
E_FAIL Failure
S_OK Success
E_INVALIDARG One or more parameters are invalid.
Name Direction Description
propertyId in The ID of the property.
value in The double value to set into the selected property.
Return Values
2.3.5.10
Basic Switcher Control
2
SECTION
70
SDK Software Developers Kit
IBMDSwitcherInput::SetString method
The SetString method sets a string value into the property associated with the given BMDSwitcherInputPropertyId.
Syntax
HRESULT SetString (BMDSwitcherInputPropertyId propertyId, string value);
Parameters
Value Description
E_FAIL Failure
S_OK Success
E_INVALIDARG One or more parameters are invalid.
Name Direction Description
propertyId in The ID of the property.
value in The string value to set into the selected property.
Return Values
2.3.5.11
Basic Switcher Control
2
SECTION
71
SDK Software Developers Kit