1 /* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #pragma once 18 19 #include "Element.h" 20 #include "EngineDefinition.h" 21 #include <map> 22 23 namespace android { 24 namespace audio_policy { 25 26 /** 27 * @tparam product_strategy_t: Applicable strategy for this stream. 28 */ 29 template <> 30 class Element<audio_stream_type_t> 31 { 32 public: Element(const std::string & name)33 Element(const std::string &name) 34 : mName(name) 35 {} ~Element()36 ~Element() {} 37 38 /** 39 * Returns identifier of this policy element 40 * 41 * @returns string representing the name of this policy element 42 */ getName()43 const std::string &getName() const { return mName; } 44 45 /** 46 * Set the unique identifier for this policy element. 47 * 48 * @tparam Key type of the unique identifier. 49 * @param[in] identifier to be set. 50 * 51 * @return NO_ERROR if the identifier is valid and set correctly, error code otherwise. 52 */ 53 status_t setIdentifier(audio_stream_type_t identifier); 54 55 /** 56 * @return the unique identifier of this policy element. 57 */ getIdentifier()58 audio_stream_type_t getIdentifier() const { return mIdentifier; } 59 60 /** 61 * A Policy element may implement getter/setter function for a given property. 62 * Property may be audio_stream_type_t, audio_usage_t, audio_source_t 63 * or a string. 64 */ 65 template <typename Property> 66 Property get() const; 67 68 template <typename Property> 69 status_t set(Property property); 70 71 private: 72 /* Copy facilities are put private to disable copy. */ 73 Element(const Element &object); 74 Element &operator=(const Element &object); 75 76 std::string mName; /**< Unique literal Identifier of a policy base element*/ 77 audio_stream_type_t mIdentifier; /**< Unique numerical Identifier of a policy base element*/ 78 79 audio_stream_type_t mVolumeProfile; /**< Volume Profile followed by this stream. */ 80 }; 81 82 typedef Element<audio_stream_type_t> Stream; 83 84 } // namespace audio_policy 85 } // namespace android 86 87 88