SinricPro Library
Loading...
Searching...
No Matches
MuteController< T >

MuteController. More...

#include <MuteController.h>

Inheritance diagram for MuteController< T >:

Public Member Functions

void onMute (MuteCallback cb)
 Set callback function for setMute request.
 
bool sendMuteEvent (bool mute, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
 Send setMute event to SinricPro Server indicating actual mute state.
 

Detailed Description

template<typename T>
class SINRICPRO_3_0_0::MuteController< T >

MuteController.

Member Function Documentation

◆ onMute()

template<typename T >
void onMute ( MuteCallback  cb)

Set callback function for setMute request.

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

◆ sendMuteEvent()

template<typename T >
bool sendMuteEvent ( bool  mute,
String  cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION 
)

Send setMute event to SinricPro Server indicating actual mute state.

Parameters
mutetrue = device is muted on
false = device is unmuted
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