X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2FLibCecSharp%2FCecSharpTypes.h;h=fb14a54dba9cc00c6ac50d1b695fcacb29656507;hb=496897540ebcc6fc13b346aa5e08f2148a2770c7;hp=adef54d314768e550e0084e5970018d7a79d9582;hpb=8438c41fc8c7ee216ccc774005f862f42cf7f0df;p=deb_libcec.git diff --git a/src/LibCecSharp/CecSharpTypes.h b/src/LibCecSharp/CecSharpTypes.h index adef54d..fb14a54 100644 --- a/src/LibCecSharp/CecSharpTypes.h +++ b/src/LibCecSharp/CecSharpTypes.h @@ -39,6 +39,10 @@ #using +/// +/// LibCecSharp namespace +/// +/// namespace CecSharp { /// @@ -425,7 +429,7 @@ namespace CecSharp /// /// User control code, the key code when the user presses or releases a button on the remote. - /// Used by SendKeypress() and the CecKeyPress() callback. + /// Used by SendKeypress() and the CecKey callback. /// public enum class CecUserControlCode { @@ -913,6 +917,7 @@ namespace CecSharp GivePhysicalAddress = 0x83, /// /// Request language code of the menu language of a device + /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ /// GetMenuLanguage = 0x91, /// @@ -921,6 +926,7 @@ namespace CecSharp ReportPhysicalAddress = 0x84, /// /// Report the language code of the menu language + /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ /// SetMenuLanguage = 0x32, /// @@ -1149,7 +1155,15 @@ namespace CecSharp /// /// v1.9.0 /// - Version1_9_0 = 0x1900 + Version1_9_0 = 0x1900, + /// + /// v2.0.0-pre + /// + Version1_99_0 = 0x1990, + /// + /// v2.0.0 + /// + Version2_0_0 = 0x2000 }; /// @@ -1220,7 +1234,15 @@ namespace CecSharp /// /// v1.9.0 /// - Version1_9_0 = 0x1900 + Version1_9_0 = 0x1900, + /// + /// v2.0.0-pre + /// + Version1_99_0 = 0x1990, + /// + /// v2.0.0 + /// + Version2_0_0 = 0x2000 }; /// @@ -1729,22 +1751,22 @@ namespace CecSharp property CecDeviceTypeList ^ DeviceTypes; /// - /// True to try to autodetect the physical address, false otherwise + /// (read only) set to true by libCEC when the physical address was autodetected /// property bool AutodetectAddress; /// - /// The physical address that libCEC uses on the CEC bus + /// The physical address of the CEC adapter /// property uint16_t PhysicalAddress; /// - /// The logical address of the device to which the CEC adapter is connected, only used when PhysicalAddress isn't set + /// The logical address of the device to which the adapter is connected. Only used when PhysicalAddress = 0 or when the adapter doesn't support autodetection /// property CecLogicalAddress BaseDevice; /// - /// The hdmi port number on the device to which the CEC adapter is connected, only used when PhysicalAddress isn't set + /// The HDMI port to which the adapter is connected. Only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection /// property uint8_t HDMIPort; @@ -1759,7 +1781,7 @@ namespace CecSharp property CecServerVersion ServerVersion; /// - /// Override the vendor ID of the TV when set (for quirks mode) + /// Override the vendor ID of the TV. Leave this untouched to autodetect /// property CecVendorId TvVendor; @@ -1770,6 +1792,7 @@ namespace CecSharp /// /// Use the language setting of the TV in the client application. Must be implemented by the client application. + /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ /// property bool UseTVMenuLanguage; @@ -1779,12 +1802,12 @@ namespace CecSharp property bool ActivateSource; /// - /// List of devices to send a power on command to when starting the client application + /// List of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter. /// property CecLogicalAddresses ^WakeDevices; /// - /// List of devices to send a standby command to when exiting the client application + /// List of devices to power off when calling StandbyDevices() without any parameter. /// property CecLogicalAddresses ^PowerOffDevices; @@ -1817,6 +1840,10 @@ namespace CecSharp /// Send standby commands when the client application activates standby mode (S3). Must be implemented by the client application. /// property bool PowerOffDevicesOnStandby; + + /// + /// Shutdown this PC when the TV is switched off. only used when PowerOffOnStandby = false + /// property bool ShutdownOnStandby; /// @@ -1826,6 +1853,7 @@ namespace CecSharp /// /// The language code of the menu language that libCEC reports to other devices. + /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ /// property System::String ^ DeviceLanguage; @@ -1906,7 +1934,7 @@ namespace CecSharp /// Pointer to the callback struct /// The log message /// 1 when handled, 0 otherwise - int CecLogMessageCB(void *cbParam, const CEC::cec_log_message &message) + int CecLogMessageCB(void *cbParam, const CEC::cec_log_message message) { if (cbParam) { @@ -1924,7 +1952,7 @@ namespace CecSharp /// Pointer to the callback struct /// The key press command that libCEC received /// 1 when handled, 0 otherwise - int CecKeyPressCB(void *cbParam, const CEC::cec_keypress &key) + int CecKeyPressCB(void *cbParam, const CEC::cec_keypress key) { if (cbParam) { @@ -1942,7 +1970,7 @@ namespace CecSharp /// Pointer to the callback struct /// The raw CEC data /// 1 when handled, 0 otherwise - int CecCommandCB(void *cbParam, const CEC::cec_command &command) + int CecCommandCB(void *cbParam, const CEC::cec_command command) { if (cbParam) { @@ -1960,7 +1988,7 @@ namespace CecSharp /// Pointer to the callback struct /// The new configuration /// 1 when handled, 0 otherwise - int CecConfigCB(void *cbParam, const CEC::libcec_configuration &config) + int CecConfigCB(void *cbParam, const CEC::libcec_configuration config) { if (cbParam) { @@ -1978,7 +2006,7 @@ namespace CecSharp /// Pointer to the callback struct /// The alert message /// 1 when handled, 0 otherwise - int CecAlertCB(void *cbParam, const CEC::libcec_alert alert, const CEC::libcec_parameter &data) + int CecAlertCB(void *cbParam, const CEC::libcec_alert alert, const CEC::libcec_parameter data) { if (cbParam) { @@ -2026,14 +2054,34 @@ namespace CecSharp } #pragma managed - // delegates for the unmanaged callback methods + /// + /// Delegate method for the CecLogMessageCB callback in CecCallbackMethods + /// public delegate int CecLogMessageManagedDelegate(const CEC::cec_log_message &); + /// + /// Delegate method for the CecKeyPressCB callback in CecCallbackMethods + /// public delegate int CecKeyPressManagedDelegate(const CEC::cec_keypress &); + /// + /// Delegate method for the CecCommandCB callback in CecCallbackMethods + /// public delegate int CecCommandManagedDelegate(const CEC::cec_command &); + /// + /// Delegate method for the CecConfigCB callback in CecCallbackMethods + /// public delegate int CecConfigManagedDelegate(const CEC::libcec_configuration &); + /// + /// Delegate method for the CecAlertCB callback in CecCallbackMethods + /// public delegate int CecAlertManagedDelegate(const CEC::libcec_alert, const CEC::libcec_parameter &); - public delegate int CecMenuManagedDelegate(const CEC::cec_menu_state newVal); - public delegate void CecSourceActivatedManagedDelegate(const CEC::cec_logical_address logicalAddress, const uint8_t bActivated); + /// + /// Delegate method for the CecMenuCB callback in CecCallbackMethods + /// + public delegate int CecMenuManagedDelegate(const CEC::cec_menu_state); + /// + /// Delegate method for the CecSourceActivatedCB callback in CecCallbackMethods + /// + public delegate void CecSourceActivatedManagedDelegate(const CEC::cec_logical_address, const uint8_t); /// /// Assign the callback methods in the g_cecCallbacks struct