ChannelController< T >

ChannelController. More...

#include <ChannelController.h>

Inheritance diagram for ChannelController< T >:

Public Member Functions
void	onChangeChannel (ChangeChannelCallback cb)
	Set callback function for changeChannel request.
void	onChangeChannelNumber (ChangeChannelNumberCallback cb)
	Set callback function for changeChannel request.
void	onSkipChannels (SkipChannelsCallback cb)
	Set callback function for skipChannels request.
bool	sendChangeChannelEvent (String channelName, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
	Send changeChannel event to SinricPro Server to report selected channel.

Detailed Description

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

ChannelController.

Member Function Documentation

onChangeChannel()

template<typename T >

void onChangeChannel

(

ChangeChannelCallback

cb

)

Set callback function for changeChannel request.

Parameters

cb	Function pointer to a ChangeChannelCallback function

Returns

void

See also

ChangeChannelCallback

onChangeChannelNumber()

template<typename T >

void onChangeChannelNumber

(

ChangeChannelNumberCallback

cb

)

Set callback function for changeChannel request.

Parameters

cb	Function pointer to a ChangeChannelNumberCallback function

Returns

void

See also

ChangeChannelNumberCallback

onSkipChannels()

template<typename T >

void onSkipChannels

(

SkipChannelsCallback

cb

)

Set callback function for skipChannels request.

Parameters

cb	Function pointer to a SkipChannelsCallback function

Returns

void

See also

SkipChannelsCallback

sendChangeChannelEvent()

template<typename T >

bool sendChangeChannelEvent	(	String	channelName,
		String	cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION
	)

Send changeChannel event to SinricPro Server to report selected channel.

Parameters

channelName	String with actual channel
cause	(optional) String reason why event is sent (default = "PHYSICAL_INTERACTION")

Returns

the success of sending the even

Return values

true	event has been sent successfully
false	event has not been sent, maybe you sent to much events in a short distance of time