RDK Documentation (Open Sourced RDK Components)
hdmiIn.hpp
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 /*
21  * If not stated otherwise in this file or this component's Licenses.txt file the
22  * following copyright and licenses apply:
23  *
24  * Copyright ARRIS Enterprises, Inc. 2015.
25  *
26  * Licensed under the Apache License, Version 2.0 (the "License");
27  * you may not use this file except in compliance with the License.
28  * You may obtain a copy of the License at
29  *
30  * http://www.apache.org/licenses/LICENSE-2.0
31  *
32  * Unless required by applicable law or agreed to in writing, software
33  * distributed under the License is distributed on an "AS IS" BASIS,
34  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35  * See the License for the specific language governing permissions and
36  * limitations under
37 */
38 
39 
40 /**
41 * @defgroup devicesettings
42 * @{
43 * @defgroup ds
44 * @{
45 **/
46 
47 
48 #ifndef _DS_HDMIIN_HPP_
49 #define _DS_HDMIIN_HPP_
50 
51 #include <stdint.h>
52 #include <vector>
53 
54 #include "dsTypes.h"
55 /**
56  * @file hdmiIn.hpp
57  * @brief Structures and classes for HDMI Input are defined here
58  * @ingroup hdmiIn
59  */
60 
61 static const int8_t HDMI_IN_PORT_NONE = -1;
62 
63 namespace device
64 {
65 
66 
67 /**
68  * @class HdmiInput
69  * @brief This class manages HDMI Input
70  */
71 class HdmiInput
72 {
73 
74 public:
75  static HdmiInput & getInstance();
76 
77  uint8_t getNumberOfInputs () const;
78  bool isPresented () const;
79  bool isActivePort (int8_t Port) const;
80  int8_t getActivePort () const;
81  bool isPortConnected (int8_t Port) const;
82  void selectPort (int8_t Port) const;
83  void scaleVideo (int32_t x, int32_t y, int32_t width, int32_t height) const;
84  void selectZoomMode (int8_t zoomMode) const;
85  void pauseAudio () const;
86  void resumeAudio () const;
87  std::string getCurrentVideoMode () const;
88  void getCurrentVideoModeObj (dsVideoPortResolution_t& resolution);
89  void getEDIDBytesInfo (int iHdmiPort, std::vector<uint8_t> &edid) const;
90  void getHDMISPDInfo (int iHdmiPort, std::vector<uint8_t> &data);
91  void setEdidVersion (int iHdmiPort, int iEdidVersion);
92  void getEdidVersion (int iHdmiPort, int *iEdidVersion);
93  void getHdmiALLMStatus (int iHdmiPort, bool *allmStatus);
94  void getSupportedGameFeatures (std::vector<std::string> &featureList);
95 
96 private:
97  HdmiInput (); /* default constructor */
98  virtual ~HdmiInput (); /* destructor */
99 };
100 
101 
102 } /* namespace device */
103 
104 
105 #endif /* _DS_HDMIIN_HPP_ */
106 
107 
108 /** @} */
109 /** @} */
device::HdmiInput::~HdmiInput
virtual ~HdmiInput()
destructor
Definition: hdmiIn.cpp:96
device::HdmiInput::getInstance
static HdmiInput & getInstance()
This API is used to get the instance of the HDMI Input.
Definition: hdmiIn.cpp:110
device::HdmiInput::selectZoomMode
void selectZoomMode(int8_t zoomMode) const
This API is used to select the HDMI In video zoom mode.
Definition: hdmiIn.cpp:291
device::HdmiInput::isPortConnected
bool isPortConnected(int8_t Port) const
This API is used to specify if the prvided HDMI Input port is connected (i.e. HDMI Input devie is plu...
Definition: hdmiIn.cpp:222
device::HdmiInput::isActivePort
bool isActivePort(int8_t Port) const
This API is used to specify if the provided HDMI Input port is active (i.e. communicating with the se...
Definition: hdmiIn.cpp:174
device::HdmiInput::resumeAudio
void resumeAudio() const
This API is used to select the HDMI In video zoom mode.
Definition: hdmiIn.cpp:331
dsTypes.h
Device Settings HAL types.
device::HdmiInput::HdmiInput
HdmiInput()
default constructor
Definition: hdmiIn.cpp:82
device::HdmiInput::pauseAudio
void pauseAudio() const
This API is used to select the HDMI In video zoom mode.
Definition: hdmiIn.cpp:311
device::HdmiInput::scaleVideo
void scaleVideo(int32_t x, int32_t y, int32_t width, int32_t height) const
This API is used to scale the HDMI In video.
Definition: hdmiIn.cpp:270
device::HdmiInput::selectPort
void selectPort(int8_t Port) const
This API is used to select the HDMI In port to be presented.
Definition: hdmiIn.cpp:246
device::HdmiInput
This class manages HDMI Input.
Definition: hdmiIn.hpp:71
_dsVideoPortResolution_t
Structure that defines video port resolution settings of output video device.
Definition: dsTypes.h:642
device::HdmiInput::getActivePort
int8_t getActivePort() const
This API is used to specify the active (i.e. communicating with the set-top) HDMI Input port.
Definition: hdmiIn.cpp:198
device::HdmiInput::isPresented
bool isPresented() const
This API is used to specify if HDMI Input is being presented via HDMI Out.
Definition: hdmiIn.cpp:150
device::HdmiInput::getNumberOfInputs
uint8_t getNumberOfInputs() const
This API is used to get the number of HDMI Input ports on the set-top.
Definition: hdmiIn.cpp:125
device::HdmiInput::getCurrentVideoMode
std::string getCurrentVideoMode() const
This API is used to get the current HDMI In video mode (resolution)
Definition: hdmiIn.cpp:459