RDK Documentation (Open Sourced RDK Components)
audioCompression.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 /**
22  * @file audioCompression.hpp
23  * @brief This file defines AudioCompression class for managing audio compression levels.
24  */
25 
26 
27 /**
28 * @defgroup devicesettings
29 * @{
30 * @defgroup ds
31 * @{
32 **/
33 
34 
35 #ifndef _DS_AUDIOCOMPRESSION_HPP_
36 #define _DS_AUDIOCOMPRESSION_HPP_
37 
38 #include "dsConstant.hpp"
39 #include <string>
40 
41 namespace device {
42 
43 /**
44  * @class AudioCompression
45  * @brief This class extends DSConstant for implementing AudioCompression.
46  * It helps to maintain different audio compressions.
47  * @ingroup devicesettingsclass
48  */
49 class AudioCompression : public DSConstant {
50 
51 public:
52  static const int kNone; //!< Indicates audio compression None.
53  static const int kLight; //!< Indicates light audio compression.
54  static const int kMedium; //!< Indicates medium audio compression.
55  static const int kHeavy; //!< Indicates heavy audio compression.
56  static const int kMax; //!< Indicates number of audio compression supported.
57 
58  static const AudioCompression & getInstance(int id);
59  static const AudioCompression & getInstance(const std::string &name);
60 
61  AudioCompression(int id);
62  virtual ~AudioCompression();
63 
64 };
65 
66 }
67 
68 #endif /* _DS_AUDIOCOMPRESSION_HPP_ */
69 
70 
71 /** @} */
72 /** @} */
device::AudioCompression
This class extends DSConstant for implementing AudioCompression. It helps to maintain different audio...
Definition: audioCompression.hpp:49
dsConstant.hpp
This file defines DSConstant class which is inherited by most of the device settings classes.
device::DSConstant
This class is used to store and manage the names and id's. It is derived by many classes like VideoRe...
Definition: dsConstant.hpp:52
device::AudioCompression::kMax
static const int kMax
Indicates number of audio compression supported.
Definition: audioCompression.hpp:56
device::AudioCompression::getInstance
static const AudioCompression & getInstance(int id)
This function gets an instance of AudioCompression against the specified id, only if the id passed is...
Definition: audioCompression.cpp:79
device::AudioCompression::kHeavy
static const int kHeavy
Indicates heavy audio compression.
Definition: audioCompression.hpp:55
device::AudioCompression::AudioCompression
AudioCompression(int id)
This function is a parameterised constructor. It initializes the AudioCompression instance with the p...
Definition: audioCompression.cpp:130
device::AudioCompression::~AudioCompression
virtual ~AudioCompression()
This function is the default destructor for AudioCompression.
Definition: audioCompression.cpp:148
device::AudioCompression::kNone
static const int kNone
Indicates audio compression None.
Definition: audioCompression.hpp:52
device::AudioCompression::kMedium
static const int kMedium
Indicates medium audio compression.
Definition: audioCompression.hpp:54
device::AudioCompression::kLight
static const int kLight
Indicates light audio compression.
Definition: audioCompression.hpp:53