SinricPro Library
InputController< T >

InputController. More...

Inheritance diagram for InputController< T >:

Public Types

using SelectInputCallback = std::function< bool(const String &, String &)>
 Callback definition for onSelectInput function. More...
 

Public Member Functions

void onSelectInput (SelectInputCallback cb)
 Set callback function for selectInput request. More...
 
bool sendSelectInputEvent (String intput, String cause="PHYSICAL_INTERACTION")
 Send selectInput event to SinricPro Server to report selected input. More...
 

Detailed Description

template<typename T>
class InputController< T >

InputController.

Member Typedef Documentation

◆ SelectInputCallback

using SelectInputCallback = std::function<bool(const String &, String &)>

Callback definition for onSelectInput function.

Gets called when device receive a selectInput request

Parameters
[in]deviceIdString which contains the ID of device
[in]inputString with input name device is requested to switch to
AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX
[out]inputString with input name device has switchted to
AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX
Returns
the success of the request
Return values
truerequest handled properly
falserequest was not handled properly because of some error

Example-Code

bool onSelectInput(const String &deviceId, String &input) {
Serial.printf("Device %s input changed to %s\r\n", deviceId.c_str(), input.c_str());
return true;
}
void onSelectInput(SelectInputCallback cb)
Set callback function for selectInput request.
Definition: InputController.h:48

Member Function Documentation

◆ onSelectInput()

void onSelectInput ( SelectInputCallback  cb)

Set callback function for selectInput request.

Parameters
cbFunction pointer to a SelectInputCallback function
Returns
void
See also
SelectInputCallback

◆ sendSelectInputEvent()

bool sendSelectInputEvent ( String  input,
String  cause = "PHYSICAL_INTERACTION" 
)

Send selectInput event to SinricPro Server to report selected input.

Parameters
inputString with actual media control
AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX
cause(optional) String reason why event is sent (default = "PHYSICAL_INTERACTION")
Returns
the success of sending the even
Return values
trueevent has been sent successfully
falseevent has not been sent, maybe you sent to much events in a short distance of time