ICECCallbacks Struct Reference

#include <cectypes.h>

Public Member Functions
	ICECCallbacks (void)
	~ICECCallbacks (void)
void	Clear (void)

Public Attributes
void(*	logMessage )(void *cbparam, const cec_log_message *message)
	Transfer a log message from libCEC to the client.
void(*	keyPress )(void *cbparam, const cec_keypress *key)
	Transfer a keypress from libCEC to the client.
void(*	commandReceived )(void *cbparam, const cec_command *command)
	Transfer a CEC command from libCEC to the client.
void(*	configurationChanged )(void *cbparam, const libcec_configuration *configuration)
	Transfer a changed configuration from libCEC to the client.
void(*	alert )(void *cbparam, const libcec_alert alert, const libcec_parameter param)
	Transfer a libcec alert message from libCEC to the client.
int(*	menuStateChanged )(void *cbparam, const cec_menu_state state)
	Transfer a menu state change to the client.
void(*	sourceActivated )(void *cbParam, const cec_logical_address logicalAddress, const uint8_t bActivated)
	Called when a source that's handled by this client is activated.
int(*	commandHandler )(void *cbparam, const cec_command *command)
	Allow the client handle a CEC command instead of libcec.

Detailed Description

Definition at line 1469 of file cectypes.h.

Constructor & Destructor Documentation

ICECCallbacks()

ICECCallbacks::ICECCallbacks ( void  )

inline

Definition at line 1538 of file cectypes.h.

~ICECCallbacks()

ICECCallbacks::~ICECCallbacks ( void  )

inline

Definition at line 1539 of file cectypes.h.

Member Function Documentation

Clear()

void ICECCallbacks::Clear ( void  )

inline

Definition at line 1541 of file cectypes.h.

Member Data Documentation

logMessage

void( * ICECCallbacks::logMessage) (void *cbparam, const cec_log_message *message)

Transfer a log message from libCEC to the client.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
message	The message to transfer.

Definition at line 1476 of file cectypes.h.

keyPress

void( * ICECCallbacks::keyPress) (void *cbparam, const cec_keypress *key)

Transfer a keypress from libCEC to the client.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
key	The keypress to transfer.

Definition at line 1483 of file cectypes.h.

commandReceived

void( * ICECCallbacks::commandReceived) (void *cbparam, const cec_command *command)

Transfer a CEC command from libCEC to the client.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
command	The command to transfer.

Definition at line 1490 of file cectypes.h.

configurationChanged

void( * ICECCallbacks::configurationChanged) (void *cbparam, const libcec_configuration *configuration)

Transfer a changed configuration from libCEC to the client.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
configuration	The configuration to transfer

Definition at line 1497 of file cectypes.h.

alert

void( * ICECCallbacks::alert) (void *cbparam, const libcec_alert alert, const libcec_parameter param)

Transfer a libcec alert message from libCEC to the client.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
alert	The alert type transfer.
data	Misc. additional information.

Definition at line 1505 of file cectypes.h.

menuStateChanged

int( * ICECCallbacks::menuStateChanged) (void *cbparam, const cec_menu_state state)

Transfer a menu state change to the client.

Transfer a menu state change to the client. If the command returns 1, then the change will be processed by the busdevice. If 0, then the state of the busdevice won't be changed, and will always be kept 'activated',

Warning

CEC does not allow the player to suppress the menu state change on the TV, so the menu on the TV will always be displayed, whatever the return value of this method is. so keypresses are always routed.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
state	The new value.

Returns

1 if libCEC should use this new value, 0 otherwise.

Definition at line 1518 of file cectypes.h.

sourceActivated

void( * ICECCallbacks::sourceActivated) (void *cbParam, const cec_logical_address logicalAddress, const uint8_t bActivated)

Called when a source that's handled by this client is activated.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
logicalAddress	The address that was just activated.
bActivated	1 if activated, 0 when deactivated.

Definition at line 1526 of file cectypes.h.

commandHandler

int( * ICECCallbacks::commandHandler) (void *cbparam, const cec_command *command)

Allow the client handle a CEC command instead of libcec.

Parameters

cbparam	Callback parameter provided when the callbacks were set up
command	The command to handle.

Returns

1 if the command has been handled and if libCEC should not take any action

Definition at line 1535 of file cectypes.h.

---

The documentation for this struct was generated from the following file:

• cectypes.h