CEC::libcec_configuration Struct Reference

#include <cectypes.h>

Public Member Functions
	libcec_configuration (void)
	~libcec_configuration (void)
bool	operator== (const libcec_configuration &other) const
bool	operator!= (const libcec_configuration &other) const
void	Clear (void)
	Reset this configution struct to the default values.

Public Attributes
uint32_t	clientVersion
	the version of the client that is connecting
char	strDeviceName [(15)]
	the device name to use on the CEC bus, name + 0 terminator
cec_device_type_list	deviceTypes
	the device type(s) to use on the CEC bus for libCEC
uint8_t	bAutodetectAddress
	(read only) set to 1 by libCEC when the physical address was autodetected
uint16_t	iPhysicalAddress
	the physical address of the CEC adapter
cec_logical_address	baseDevice
	the logical address of the device to which the adapter is connected.
uint8_t	iHDMIPort
	the HDMI port to which the adapter is connected.
uint32_t	tvVendor
	override the vendor ID of the TV.
cec_logical_addresses	wakeDevices
	list of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter.
cec_logical_addresses	powerOffDevices
	list of devices to power off when calling StandbyDevices() without any parameter.
uint32_t	serverVersion
	the version number of the server.
uint8_t	bGetSettingsFromROM
	true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings.
uint8_t	bActivateSource
	make libCEC the active source on the bus when starting the player application
uint8_t	bPowerOffOnStandby
	put this PC in standby mode when the TV is switched off.
void *	callbackParam
	the object to pass along with a call of the callback methods.
ICECCallbacks *	callbacks
	the callback methods to use.
cec_logical_addresses	logicalAddresses
	(read-only) the current logical addresses.
uint16_t	iFirmwareVersion
	(read-only) the firmware version of the adapter.
char	strDeviceLanguage [3]
	the menu language used by the client.
uint32_t	iFirmwareBuildDate
	(read-only) the build date of the firmware, in seconds since epoch.
uint8_t	bMonitorOnly
	won't allocate a CCECClient when starting the connection when set (same as monitor mode).
cec_version	cecVersion
	CEC spec version to use by libCEC.
cec_adapter_type	adapterType
	type of the CEC adapter that we're connected to.
cec_user_control_code	comboKey
	key code that initiates combo keys.
uint32_t	iComboKeyTimeoutMs
	timeout until the combo key is sent as normal keypress
uint32_t	iButtonRepeatRateMs
	rate at which buttons autorepeat.
uint32_t	iButtonReleaseDelayMs
	duration after last update until a button is considered released
uint32_t	iDoubleTapTimeoutMs
	prevent double taps within this timeout.
uint8_t	bAutoWakeAVR
	set to 1 to automatically waking an AVR when the source is activated.
uint8_t	bAutoPowerOn
	set to 1 and save eeprom config to wake the tv when usb is powered.
uint8_t	bAutonomousMode
	set to 1 (default) to let the adapter stay active on the CEC bus when the host isn't running (ack polls and wake the host on a CEC request), or 0 to keep it silent when unattended so the TV/CEC bus can't wake the host.
uint32_t	iButtonRepeatDelayMs
	delay before a held button starts auto-repeating, when iButtonRepeatRateMs is set.
uint32_t	iDeviceVendorId
	the vendor ID to announce for this device.

Detailed Description

Definition at line 1561 of file cectypes.h.

Constructor & Destructor Documentation

libcec_configuration()

CEC::libcec_configuration::libcec_configuration ( void  )

inline

Definition at line 1607 of file cectypes.h.

~libcec_configuration()

CEC::libcec_configuration::~libcec_configuration ( void  )

inline

Definition at line 1608 of file cectypes.h.

Member Function Documentation

operator==()

bool CEC::libcec_configuration::operator== ( const libcec_configuration &  other ) const

inline

Definition at line 1610 of file cectypes.h.

operator!=()

bool CEC::libcec_configuration::operator!= ( const libcec_configuration &  other ) const

inline

Definition at line 1650 of file cectypes.h.

Clear()

void CEC::libcec_configuration::Clear ( void  )

inline

Reset this configution struct to the default values.

Definition at line 1658 of file cectypes.h.

Member Data Documentation

clientVersion

uint32_t CEC::libcec_configuration::clientVersion

the version of the client that is connecting

Definition at line 1563 of file cectypes.h.

strDeviceName

char CEC::libcec_configuration::strDeviceName[(15)]

the device name to use on the CEC bus, name + 0 terminator

Definition at line 1564 of file cectypes.h.

deviceTypes

cec_device_type_list CEC::libcec_configuration::deviceTypes

the device type(s) to use on the CEC bus for libCEC

Definition at line 1565 of file cectypes.h.

bAutodetectAddress

uint8_t CEC::libcec_configuration::bAutodetectAddress

(read only) set to 1 by libCEC when the physical address was autodetected

Definition at line 1566 of file cectypes.h.

iPhysicalAddress

uint16_t CEC::libcec_configuration::iPhysicalAddress

the physical address of the CEC adapter

Definition at line 1567 of file cectypes.h.

baseDevice

cec_logical_address CEC::libcec_configuration::baseDevice

the logical address of the device to which the adapter is connected.

only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection

Definition at line 1568 of file cectypes.h.

iHDMIPort

uint8_t CEC::libcec_configuration::iHDMIPort

the HDMI port to which the adapter is connected.

only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection

Definition at line 1569 of file cectypes.h.

tvVendor

uint32_t CEC::libcec_configuration::tvVendor

override the vendor ID of the TV.

leave this untouched to autodetect

Definition at line 1570 of file cectypes.h.

wakeDevices

cec_logical_addresses CEC::libcec_configuration::wakeDevices

list of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter.

Definition at line 1571 of file cectypes.h.

powerOffDevices

cec_logical_addresses CEC::libcec_configuration::powerOffDevices

list of devices to power off when calling StandbyDevices() without any parameter.

Definition at line 1572 of file cectypes.h.

serverVersion

uint32_t CEC::libcec_configuration::serverVersion

the version number of the server.

read-only

Definition at line 1574 of file cectypes.h.

bGetSettingsFromROM

uint8_t CEC::libcec_configuration::bGetSettingsFromROM

true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings.

Definition at line 1577 of file cectypes.h.

bActivateSource

uint8_t CEC::libcec_configuration::bActivateSource

make libCEC the active source on the bus when starting the player application

Definition at line 1578 of file cectypes.h.

bPowerOffOnStandby

uint8_t CEC::libcec_configuration::bPowerOffOnStandby

put this PC in standby mode when the TV is switched off.

only used when bShutdownOnStandby = 0

Definition at line 1579 of file cectypes.h.

callbackParam

void* CEC::libcec_configuration::callbackParam

the object to pass along with a call of the callback methods.

NULL to ignore

Definition at line 1581 of file cectypes.h.

callbacks

ICECCallbacks* CEC::libcec_configuration::callbacks

the callback methods to use.

set this to NULL when not using callbacks

Definition at line 1582 of file cectypes.h.

logicalAddresses

cec_logical_addresses CEC::libcec_configuration::logicalAddresses

(read-only) the current logical addresses.

added in 1.5.3

Definition at line 1584 of file cectypes.h.

iFirmwareVersion

uint16_t CEC::libcec_configuration::iFirmwareVersion

(read-only) the firmware version of the adapter.

added in 1.6.0

Definition at line 1585 of file cectypes.h.

strDeviceLanguage

char CEC::libcec_configuration::strDeviceLanguage[3]

the menu language used by the client.

3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ added in 1.6.2

Definition at line 1586 of file cectypes.h.

iFirmwareBuildDate

uint32_t CEC::libcec_configuration::iFirmwareBuildDate

(read-only) the build date of the firmware, in seconds since epoch.

if not available, this value will be set to 0. added in 1.6.2

Definition at line 1587 of file cectypes.h.

bMonitorOnly

uint8_t CEC::libcec_configuration::bMonitorOnly

won't allocate a CCECClient when starting the connection when set (same as monitor mode).

added in 1.6.3

Definition at line 1588 of file cectypes.h.

cecVersion

cec_version CEC::libcec_configuration::cecVersion

CEC spec version to use by libCEC.

defaults to v1.4. added in 1.8.0

Definition at line 1589 of file cectypes.h.

adapterType

cec_adapter_type CEC::libcec_configuration::adapterType

type of the CEC adapter that we're connected to.

added in 1.8.2

Definition at line 1590 of file cectypes.h.

comboKey

cec_user_control_code CEC::libcec_configuration::comboKey

key code that initiates combo keys.

defaults to CEC_USER_CONTROL_CODE_STOP. CEC_USER_CONTROL_CODE_UNKNOWN to disable. added in 2.0.5

Definition at line 1591 of file cectypes.h.

iComboKeyTimeoutMs

uint32_t CEC::libcec_configuration::iComboKeyTimeoutMs

timeout until the combo key is sent as normal keypress

Definition at line 1592 of file cectypes.h.

iButtonRepeatRateMs

uint32_t CEC::libcec_configuration::iButtonRepeatRateMs

rate at which buttons autorepeat.

0 means rely on CEC device

Definition at line 1593 of file cectypes.h.

iButtonReleaseDelayMs

uint32_t CEC::libcec_configuration::iButtonReleaseDelayMs

duration after last update until a button is considered released

Definition at line 1594 of file cectypes.h.

iDoubleTapTimeoutMs

uint32_t CEC::libcec_configuration::iDoubleTapTimeoutMs

prevent double taps within this timeout.

defaults to 200ms. added in 4.0.0

Definition at line 1595 of file cectypes.h.

bAutoWakeAVR

uint8_t CEC::libcec_configuration::bAutoWakeAVR

set to 1 to automatically waking an AVR when the source is activated.

added in 4.0.0

Definition at line 1596 of file cectypes.h.

bAutoPowerOn

uint8_t CEC::libcec_configuration::bAutoPowerOn

set to 1 and save eeprom config to wake the tv when usb is powered.

added in 5.0.0 / fw v9

Definition at line 1598 of file cectypes.h.

bAutonomousMode

uint8_t CEC::libcec_configuration::bAutonomousMode

set to 1 (default) to let the adapter stay active on the CEC bus when the host isn't running (ack polls and wake the host on a CEC request), or 0 to keep it silent when unattended so the TV/CEC bus can't wake the host.

save eeprom config to persist. added in 8.0.0

Definition at line 1601 of file cectypes.h.

iButtonRepeatDelayMs

uint32_t CEC::libcec_configuration::iButtonRepeatDelayMs

delay before a held button starts auto-repeating, when iButtonRepeatRateMs is set.

defaults to 200ms. added in 8.0.0

Definition at line 1602 of file cectypes.h.

iDeviceVendorId

uint32_t CEC::libcec_configuration::iDeviceVendorId

the vendor ID to announce for this device.

CEC_VENDOR_UNKNOWN (default) to keep libCEC's default identity. added in 8.0.0

Definition at line 1603 of file cectypes.h.

---

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

• cectypes.h