Merge pull request #438 from rdkcentral/feature/RDKEMW-6331

RDKEMW-6331 : Fix HdmiCecSink COM-RPC issues

Author: ramasat

apis/HdmiCecSink/IHdmiCecSink.h

@@ -27,29 +27,29 @@
  {
      namespace Exchange
      {
-         // @json @text:keep
+         /* @json 1.0.0 @text:keep */
          struct EXTERNAL IHdmiCecSink : virtual public Core::IUnknown {
              enum { ID = ID_HDMI_CEC_SINK };
 
-             struct HdmiCecSinkActivePath
+             struct EXTERNAL HdmiCecSinkActivePath
             {
-                uint8_t logicalAddress; /* @text logical address*/
-                string physicalAddress; /* @text physical address*/
-                string deviceType; /* @text device type*/
-                string vendorID;    /* @text vendor id*/
-                string osdName; /* @text osd name*/
+                uint8_t logicalAddress;
+                string physicalAddress;
+                string deviceType;
+                string vendorID;
+                string osdName;
             };
 
-            struct HdmiCecSinkDevices
+            struct EXTERNAL HdmiCecSinkDevices
             {
-                uint8_t logicalAddress; /* @text logical address*/
-                string physicalAddress; /* @text physical address*/
-                string deviceType; /* @text device type*/
-                string cecVersion; /* @text cec version*/
-                string osdName; /* @text osd name*/
-                string vendorID; /* @text vendor id*/
-                string powerStatus; /* @text power status*/
-                string portNumber; /* @text port number*/
+                uint8_t logicalAddress;
+                string physicalAddress;
+                string deviceType;
+                string cecVersion;
+                string osdName;
+                string vendorID;
+                string powerStatus;
+                string portNumber;
             };
 
             struct EXTERNAL HdmiCecSinkSuccess {
@@ -67,84 +67,84 @@
 
                 // @brief Triggered when routing though the HDMI ARC port is successfully established.
                 // @text arcInitiationEvent
-                // @param success: Is the operation successful or not
-                virtual void ArcInitiationEvent(const string success /* @in */) {};
+                // @param status: Is the operation successful or not
+                virtual void ArcInitiationEvent(const string status) {};
 
                 // @brief Triggered when routing though the HDMI ARC port terminates.
                 // @text arcTerminationEvent
-                // @param success: Is the operation successful or not
-                virtual void ArcTerminationEvent(const string success /* @in */) {};
+                // @param status: Is the operation successful or not
+                virtual void ArcTerminationEvent(const string status) {};
 
                 // @brief Triggered when the active source device changes.
                 // @text onActiveSourceChange
                 // @param logicalAddress: Logical address of the active source
                 // @param physicalAddress: Physical address of the active source
-                virtual void OnActiveSourceChange(const int logicalAddress /* @in */, const string physicalAddress /* @in */) {};
+                virtual void OnActiveSourceChange(const int logicalAddress, const string physicalAddress) {};
 
                 // @brief Triggered when a new device is added to the CEC network.
                 // @text onDeviceAdded
                 // @param logicalAddress: Logical address of the added device
-                virtual void OnDeviceAdded(const int logicalAddress /* @in */) {};
+                virtual void OnDeviceAdded(const int logicalAddress) {};
 
                 // @brief Triggered when device information changes.
                 // @text onDeviceInfoUpdated
                 // @param logicalAddress: Logical address of the device
-                virtual void OnDeviceInfoUpdated(const int logicalAddress /* @in */) {};
+                virtual void OnDeviceInfoUpdated(const int logicalAddress) {};
 
                 // @brief Triggered when a device is removed from the CEC network.
                 // @text onDeviceRemoved
                 // @param logicalAddress: Logical address of the removed device
-                virtual void OnDeviceRemoved(const int logicalAddress /* @in */) {};
+                virtual void OnDeviceRemoved(const int logicalAddress) {};
 
                 // @brief Triggered when an <Image View ON> CEC message is received from the source device.
                 // @text onImageViewOnMsg
                 // @param logicalAddress: Logical address of the device
-                virtual void OnImageViewOnMsg(const int logicalAddress /* @in */) {};
+                virtual void OnImageViewOnMsg(const int logicalAddress) {};
 
                 // @brief Triggered when the source is no longer active.
                 // @text onInActiveSource
                 // @param logicalAddress: Logical address of the source
                 // @param physicalAddress: Physical address of the source
-                virtual void OnInActiveSource(const int logicalAddress /* @in */, const string physicalAddress /* @in */) {};
+                virtual void OnInActiveSource(const int logicalAddress, const string physicalAddress) {};
 
                 // @brief Triggered when a <Text View ON> CEC message is received from the source device.
                 // @text onTextViewOnMsg
                 // @param logicalAddress: Logical address of the device
-                virtual void OnTextViewOnMsg(const int logicalAddress /* @in */) {};
+                virtual void OnTextViewOnMsg(const int logicalAddress) {};
 
                 // @brief Triggered when the TV is in standby mode and it receives <Image View ON>/ <Text View ON>/ <Active Source> CEC message from the connected source device.
                 // @text onWakeupFromStandby
                 // @param logicalAddress: Logical address of the device
-                virtual void OnWakeupFromStandby(const int logicalAddress /* @in */) {};
+                virtual void OnWakeupFromStandby(const int logicalAddress) {};
 
                 // @brief Triggered when an audio device is added or removed.
                 // @text reportAudioDeviceConnectedStatus
                 // @param status: Status of the audio device
                 // @param audioDeviceConnected: Audio device connected or not
-                virtual void ReportAudioDeviceConnectedStatus(const string status /* @in */, const string audioDeviceConnected /* @in */) {};
+                virtual void ReportAudioDeviceConnectedStatus(const string status, const string audioDeviceConnected) {};
 
                 // @brief Triggered when CEC <Report Audio Status> message of device is received.
                 // @text reportAudioStatusEvent
                 // @param muteStatus: Mute status of the device
                 // @param volumeLevel: Volume level of the device
-                virtual void ReportAudioStatusEvent(const int muteStatus /* @in */, const int volumeLevel /* @in */) {};
+                virtual void ReportAudioStatusEvent(const int muteStatus, const int volumeLevel) {};
 
                 // @brief Triggered when CEC <Feature Abort> message of device is received.
                 // @text reportFeatureAbortEvent
                 // @param logicalAddress: Logical address of the device
                 // @param opcode: Opcode of the message
                 // @param FeatureAbortReason: Reason for the feature abort
-                virtual void ReportFeatureAbortEvent(const int logicalAddress /* @in */, const int opcode /* @in */, const int FeatureAbortReason /* @in */) {};
+                virtual void ReportFeatureAbortEvent(const int logicalAddress, const int opcode, const int FeatureAbortReason) {};
 
                 // @brief Triggered when the HDMI-CEC is enabled.
                 // @text reportCecEnabledEvent
                 // @param cecEnable: HDMI-CEC enabled or not
-                virtual void ReportCecEnabledEvent(const string cecEnable /* @in */) {};
+                virtual void ReportCecEnabledEvent(const string cecEnable) {};
 
                 // @brief Triggered when CEC <Set System Audio Mode> message of device is received.
                 // @text setSystemAudioModeEvent
                 // @param audioMode: Audio mode of the device
-                virtual void SetSystemAudioModeEvent(const string audioMode /* @in */) {};
+                virtual void SetSystemAudioModeEvent(const string audioMode) {};
 
                 // @brief Triggered when SAD is received from the connected audio device. See requestShortAudioDescriptor.
                 // @text shortAudiodescriptorEvent
@@ -154,12 +154,12 @@
                 // @brief Triggered when the source device changes status to STANDBY.
                 // @text standbyMessageReceived
                 // @param logicalAddress: Logical address of the device
-                virtual void StandbyMessageReceived(const int logicalAddress /* @in */) {};
+                virtual void StandbyMessageReceived(const int logicalAddress) {};
 
                 // @brief Triggered when the source device changes.
                 // @text reportAudioDevicePowerStatus
                 // @param powerStatus: Power status of the device
-                virtual void ReportAudioDevicePowerStatus(const int powerStatus /* @in */) {};
+                virtual void ReportAudioDevicePowerStatus(const int powerStatus) {};
 
 
             };
@@ -233,95 +233,95 @@
             // @brief Request the active source in the network
             // @text requestActiveSource
             // @param success: Is the operation successful or not
-            virtual Core::hresult RequestActiveSource(HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult RequestActiveSource(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sends the CEC Request Short Audio Descriptor (SAD) message as an
             // @text requestShortAudioDescriptor
             // @param success: Is the operation successful or not
-            virtual Core::hresult RequestShortAudioDescriptor(HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult RequestShortAudioDescriptor(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief This message is used to power on the connected audio device. Usually sent by the TV when it comes out of standby and detects audio device connected in the network.
             // @text sendAudioDevicePowerOnMessage
             // @param success: Is the operation successful or not
-            virtual Core::hresult SendAudioDevicePowerOnMessage(HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SendAudioDevicePowerOnMessage(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sends the CEC <Give Audio Status> message to request the audio status.
             // @text sendGetAudioStatusMessage
             // @param success: Is the operation successful or not
-            virtual Core::hresult SendGetAudioStatusMessage(HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SendGetAudioStatusMessage(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sends the CEC <User Control Pressed> message when TV remote key is pressed.
             // @text sendKeyPressEvent
             // @param logicalAddress: Logical address of the device
             // @param keyCode: Key code of the key press event
             // @param success: Is the operation successful or not
-            virtual Core::hresult SendKeyPressEvent(const uint32_t &logicalAddress /* @in */, const uint32_t &keyCode /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SendKeyPressEvent(const uint32_t &logicalAddress /* @in */, const uint32_t &keyCode /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sends the CEC <User Control Pressed> message when TV remote key is pressed.
             // @text sendUserControlPressed
             // @param logicalAddress: Logical address of the device
             // @param keyCode: Key code of the key press event
             // @param success: Is the operation successful or not
-            virtual Core::hresult SendUserControlPressed(const uint32_t &logicalAddress /* @in */, const uint32_t &keyCode /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SendUserControlPressed(const uint32_t &logicalAddress /* @in */, const uint32_t &keyCode /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sends the CEC <User Control Released> message when TV remote key is released.
             // @text sendUserControlReleased
             // @param logicalAddress: Logical address of the device
             // @param success: Is the operation successful or not
-            virtual Core::hresult SendUserControlReleased(const uint32_t &logicalAddress /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SendUserControlReleased(const uint32_t &logicalAddress /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sends the CEC <Standby> message to another CEC device
             // @text sendStandbyMessage
             // @param success: Is the operation successful or not
-            virtual Core::hresult SendStandbyMessage(HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SendStandbyMessage(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sets the source device to active (setStreamPath). The source wakes from standby if it’s in the standby state.
             // @text setActivePath
             // @param activePath: Active path of the device
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetActivePath(const string &activePath /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetActivePath(const string &activePath /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sets the current active source as TV (physical address 0.0.0.0). This call needs to be made when the TV switches to internal tuner or any apps.
             // @text setActiveSource
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetActiveSource(HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetActiveSource(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sets the status of the HDMI CEC Sink
             // @text setEnabled
             // @param enabled: Is the HDMI CEC Sink enabled or not
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetEnabled(const bool &enabled /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetEnabled(const bool &enabled /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Updates the internal data structure with the new menu Language and also broadcasts the <Set Menu Language> CEC message.
             // @text setMenuLanguage
             // @param language: Menu language to be set
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetMenuLanguage(const string &language /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetMenuLanguage(const string &language /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sets the OSD name of the HDMI CEC Sink
             // @text setOSDName
             // @param osdName: OSD name of the HDMI CEC Sink
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetOSDName(const string &name /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetOSDName(const string &name /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Changes routing while switching between HDMI inputs and TV.
             // @text setRoutingChange
             // @param oldPort: Old port number
             // @param newPort: New port number
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetRoutingChange(const string &oldPort /* @in */, const string &newPort /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetRoutingChange(const string &oldPort /* @in */, const string &newPort /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Enable (or disable) HDMI-CEC Audio Return Channel (ARC) routing. Upon enabling, triggers arcInitiationEvent and upon disabling, triggers arcTerminationEvent.
             // @text setupARCRouting
             // @param enabled: Is the HDMI-CEC ARC routing enabled or not
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetupARCRouting(const bool &enabled /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetupARCRouting(const bool &enabled /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sets the vendor ID of the HDMI CEC Sink
             // @text setVendorId
             // @param vendorId: Vendor ID of the HDMI CEC Sink
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetVendorId(const string &vendorid /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetVendorId(const string &vendorid /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
             // @brief Sets the Current Latency Values such as Video Latency, Latency Flags,Audio Output Compensated value and Audio Output Delay by sending <Report Current Latency> message for Dynamic Auto LipSync Feature.
             // @text setLatencyInfo
@@ -330,10 +330,14 @@
             // @param audioOutputCompensated: Audio Output Compensated value
             // @param audioOutputDelay: Audio Output Delay value
             // @param success: Is the operation successful or not
-            virtual Core::hresult SetLatencyInfo(const string &videoLatency /* @in */, const string &lowLatencyMode /* @in */, const string &audioOutputCompensated /* @in */, const string &audioOutputDelay /* @in */, HdmiCecSinkSuccess &success /* @out */) = 0;
+            virtual Core::hresult SetLatencyInfo(const string &videoLatency /* @in */, const string &lowLatencyMode /* @in */, const string &audioOutputCompensated /* @in */, const string &audioOutputDelay /* @in */, HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
-         };
+            // @brief Requests the audio device power status.
+            // @text requestAudioDevicePowerStatus
+            // @param success: Is the operation successful or not
+            virtual Core::hresult RequestAudioDevicePowerStatus(HdmiCecSinkSuccess &successResult /* @out */) = 0;
 
+         };
  } // namespace Exchange
  } // namespace WPEFramework
- 
+