Usage.h revision 65c3781db3443531deacecfbda5c7e7e82868a34 
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 <RoutingStrategy.h>
21
22namespace android
23{
24namespace audio_policy
25{
26
27/**
28 * @tparam routing_strategy: Applicable strategy for this usage.
29 */
30template <>
31class Element<audio_usage_t>
32{
33public:
34    Element(const std::string &name)
35        : mName(name),
36          mApplicableStrategy(STRATEGY_MEDIA)
37    {}
38    ~Element() {}
39
40    /**
41     * Returns identifier of this policy element
42     *
43     * @returns string representing the name of this policy element
44     */
45    const std::string &getName() const { return mName; }
46
47    /**
48    * Set the unique identifier for this policy element.
49    *
50    * @tparam Key type of the unique identifier.
51    * @param[in] identifier to be set.
52    *
53    * @return NO_ERROR if the identifier is valid and set correctly, error code otherwise.
54    */
55    status_t setIdentifier(audio_usage_t identifier);
56
57    /**
58     * @return the unique identifier of this policy element.
59     */
60    audio_usage_t getIdentifier() const { return mIdentifier; }
61
62    /**
63     * A Policy element may implement getter/setter function for a given property.
64     * Property may be routing_strategy, audio_stream_type_t, audio_usage_t, audio_source_t
65     * or a string.
66     */
67    template <typename Property>
68    Property get() const;
69
70    template <typename Property>
71    status_t set(Property property);
72
73private:
74    /* Copy facilities are put private to disable copy. */
75    Element(const Element &object);
76    Element &operator=(const Element &object);
77
78    std::string mName; /**< Unique literal Identifier of a policy base element*/
79    audio_usage_t mIdentifier; /**< Unique numerical Identifier of a policy base element*/
80    routing_strategy mApplicableStrategy; /**< Applicable strategy for this usage. */
81};
82
83typedef Element<audio_usage_t> Usage;
84
85} // namespace audio_policy
86} // namespace android
87
88
89