RDK Documentation (Open Sourced RDK Components)
AampRDKCCManager.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's license file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2018 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  * @file AampRDKCCManager.h
22  *
23  * @brief Integration layer of RDK ClosedCaption in AAMP
24  *
25  */
26 
27 #ifndef __AAMP_RDK_CC_MANAGER_H__
28 #define __AAMP_RDK_CC_MANAGER_H__
29 
31 
32 #include <string>
33 #include "vlCCConstants.h"
34 
35 /**
36  * @class AampRDKCCManager
37  * @brief Handling CC operations
38  */
40 {
41 public:
42 
43  /**
44  * @fn Release
45  */
46  void Release(int iID) override;
47 
48  /**
49  * @brief Constructor
50  */
51  AampRDKCCManager() = default;
52 
53  /**
54  * @brief Destructor
55  */
56  ~AampRDKCCManager() =default;
57 
58  AampRDKCCManager(const AampRDKCCManager&) = delete;
59  AampRDKCCManager& operator=(const AampRDKCCManager&) = delete;
60 
61 private:
62  /**
63  * @fn StartRendering
64  *
65  * @return void
66  */
67  void StartRendering() override;
68 
69  /**
70  * @fn StopRendering
71  *
72  * @return void
73  */
74  void StopRendering() override;
75 
76  /**
77  * @fn Initialize
78  *
79  * @return 0 - success, -1 - failure
80  */
81  int Initialize(void *handle) override;
82 
83  /**
84  * @fn SetDigitalChannel
85  *
86  * @return CC_VL_OS_API_RESULT
87  */
88  int SetDigitalChannel(unsigned int id) override;
89 
90  /**
91  * @fn SetAnalogChannel
92  *
93  * @return CC_VL_OS_API_RESULT
94  */
95  int SetAnalogChannel(unsigned int id) override;
96 
97  /**
98  * @brief validate mCCHandle
99  *
100  * @return bool
101  */
102  bool CheckCCHandle() const override{return mCCHandle!=NULL;}
103 
104 
105  void *mCCHandle{nullptr}; /**< Decoder handle for intializing CC resources */
106 
107 };
108 
109 #endif /* __AAMP_RDK_CC_MANAGER_H__ */
AampRDKCCManager::SetAnalogChannel
int SetAnalogChannel(unsigned int id) override
set analog channel with specified id
Definition: AampRDKCCManager.cpp:109
AampRDKCCManager::StopRendering
void StopRendering() override
To stop CC rendering.
Definition: AampRDKCCManager.cpp:63
AampRDKCCManager::Release
void Release(int iID) override
Release CC resources.
Definition: AampRDKCCManager.cpp:40
AampRDKCCManager::StartRendering
void StartRendering() override
To start CC rendering.
Definition: AampRDKCCManager.cpp:55
AampRDKCCManager::SetDigitalChannel
int SetDigitalChannel(unsigned int id) override
set digital channel with specified id
Definition: AampRDKCCManager.cpp:101
AampRDKCCManager::~AampRDKCCManager
~AampRDKCCManager()=default
Destructor.
AampCCManagerBase
Handles closed caption operations.
Definition: AampCCManager.h:51
AampRDKCCManager::CheckCCHandle
bool CheckCCHandle() const override
validate mCCHandle
Definition: AampRDKCCManager.h:102
AampRDKCCManager::mCCHandle
void * mCCHandle
Definition: AampRDKCCManager.h:105
AampRDKCCManager::Initialize
int Initialize(void *handle) override
Impl specific initialization code called once in Init() function.
Definition: AampRDKCCManager.cpp:71
AampRDKCCManager::AampRDKCCManager
AampRDKCCManager()=default
Constructor.
AampRDKCCManager
Handling CC operations.
Definition: AampRDKCCManager.h:39
AampCCManager.h
Integration layer of ClosedCaption in AAMP.