RDK Documentation (Open Sourced RDK Components)
compositeIn.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_COMPOSITEIN_HPP_
49 #define _DS_COMPOSITEIN_HPP_
50 
51 #include <stdint.h>
52 
53 /**
54  * @file compositeIn.hpp
55  * @brief Structures and classes for COMPOSITE Input are defined here
56  * @ingroup compositeIn
57  */
58 
59 static const int8_t COMPOSITE_IN_PORT_NONE = -1;
60 
61 namespace device
62 {
63 
64 
65 /**
66  * @class CompositeInput
67  * @brief This class manages COMPOSITE Input
68  */
70 {
71 
72 public:
73  static CompositeInput & getInstance();
74 
75  uint8_t getNumberOfInputs () const;
76  bool isPresented () const;
77  bool isActivePort (int8_t Port) const;
78  int8_t getActivePort () const;
79  bool isPortConnected (int8_t Port) const;
80  void selectPort (int8_t Port) const;
81  void scaleVideo (int32_t x, int32_t y, int32_t width, int32_t height) const;
82 
83 private:
84  CompositeInput (); /* default constructor */
85  virtual ~CompositeInput (); /* destructor */
86 };
87 
88 
89 } /* namespace device */
90 
91 
92 #endif /* _DS_COMPOSITEIN_HPP_ */
93 
94 
95 /** @} */
96 /** @} */
device::CompositeInput::~CompositeInput
virtual ~CompositeInput()
destructor
Definition: compositeIn.cpp:94
device::CompositeInput::isActivePort
bool isActivePort(int8_t Port) const
This API is used to specify if the provided COMPOSITE Input port is active (i.e. communicating with t...
Definition: compositeIn.cpp:170
device::CompositeInput::getNumberOfInputs
uint8_t getNumberOfInputs() const
This API is used to get the number of COMPOSITE Input ports on the set-top.
Definition: compositeIn.cpp:123
device::CompositeInput::isPortConnected
bool isPortConnected(int8_t Port) const
This API is used to specify if the prvided COMPOSITE Input port is connected (i.e....
Definition: compositeIn.cpp:216
device::CompositeInput::selectPort
void selectPort(int8_t Port) const
This API is used to select the COMPOSITE In port to be presented.
Definition: compositeIn.cpp:239
device::CompositeInput::CompositeInput
CompositeInput()
default constructor
Definition: compositeIn.cpp:80
device::CompositeInput
This class manages COMPOSITE Input.
Definition: compositeIn.hpp:69
device::CompositeInput::getInstance
static CompositeInput & getInstance()
This API is used to get the instance of the COMPOSITE Input.
Definition: compositeIn.cpp:108
device::CompositeInput::scaleVideo
void scaleVideo(int32_t x, int32_t y, int32_t width, int32_t height) const
This API is used to scale the COMPOSITE In video.
Definition: compositeIn.cpp:262
device::CompositeInput::getActivePort
int8_t getActivePort() const
This API is used to specify the active (i.e. communicating with the set-top) COMPOSITE Input port.
Definition: compositeIn.cpp:193
device::CompositeInput::isPresented
bool isPresented() const
This API is used to specify if COMPOSITE Input is being presented via COMPOSITE Out.
Definition: compositeIn.cpp:147