|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description: Class handling restricted audio output
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
#ifndef RESTRICTEDAUDIOOUTPUT_H
|
|
sl@0
|
21 |
#define RESTRICTEDAUDIOOUTPUT_H
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#include <e32base.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
class CRestrictedAudioOutputImpl;
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
* CRestrictedAudioOutput class documentation.
|
|
sl@0
|
29 |
*
|
|
sl@0
|
30 |
* Use this class to control audio routing to enforce DRM restrictions.
|
|
sl@0
|
31 |
*
|
|
sl@0
|
32 |
* Instance of this class should be associated with an audio stream.
|
|
sl@0
|
33 |
* (Currently supported for DevSound API instance). Once associated, it is
|
|
sl@0
|
34 |
* valid and should be used only until the DevSound instance exist. Instance of
|
|
sl@0
|
35 |
* this class should be deleted before deleting the DevSound instance.
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* The output restrictions specified via Commit() will be applied to audio devices
|
|
sl@0
|
38 |
* when DevSound instance enters playing state.
|
|
sl@0
|
39 |
*
|
|
sl@0
|
40 |
* @lib RestrictedAudioOutput.lib
|
|
sl@0
|
41 |
*
|
|
sl@0
|
42 |
* @since S60 5.0
|
|
sl@0
|
43 |
*/
|
|
sl@0
|
44 |
class CRestrictedAudioOutput : public CBase
|
|
sl@0
|
45 |
{
|
|
sl@0
|
46 |
public:
|
|
sl@0
|
47 |
enum TAllowedOutputPreference
|
|
sl@0
|
48 |
{
|
|
sl@0
|
49 |
EAllowAllAudio,
|
|
sl@0
|
50 |
EAllowAudioAnalog,
|
|
sl@0
|
51 |
EAllowAudioFMTransmitter,
|
|
sl@0
|
52 |
EAllowAudioBtHFPHSP,
|
|
sl@0
|
53 |
EAllowAudioBtA2DP,
|
|
sl@0
|
54 |
EAllowAudioUplink,
|
|
sl@0
|
55 |
EAllowAudioUsb,
|
|
sl@0
|
56 |
EAllowAudioRecording,
|
|
sl@0
|
57 |
EAllowVisualization,
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* RIM CR 417-7642: HDMI with HDCP to Resctricted Audio Output API
|
|
sl@0
|
60 |
* Adding new ENUMs to CRestrictedAudioOutput::TAllowedOutputPreference for HDMI and HDCP
|
|
sl@0
|
61 |
* EAllowAudioHDMI and EAllowAudioHdmiHdcpRequired
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
EAllowAudioHDMI,
|
|
sl@0
|
64 |
EAllowAudioHdmiHdcpRequired
|
|
sl@0
|
65 |
};
|
|
sl@0
|
66 |
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
/**
|
|
sl@0
|
69 |
* Destructor
|
|
sl@0
|
70 |
*
|
|
sl@0
|
71 |
*/
|
|
sl@0
|
72 |
IMPORT_C virtual ~CRestrictedAudioOutput();
|
|
sl@0
|
73 |
|
|
sl@0
|
74 |
/**
|
|
sl@0
|
75 |
* Appends an allowed output to the existing list.
|
|
sl@0
|
76 |
*
|
|
sl@0
|
77 |
* @param aOutput to be appended.
|
|
sl@0
|
78 |
* @return KErrNone if successful. KErrAlreadyExists if aOutput is already
|
|
sl@0
|
79 |
* appended before. KErrIncompleteInitialization if ConstructL is not called
|
|
sl@0
|
80 |
* by the deriving class. Otherwise any systemwide error code.
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
IMPORT_C TInt AppendAllowedOutput( TAllowedOutputPreference aOutput );
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
/**
|
|
sl@0
|
85 |
* Removes an allowed output from the existing list.
|
|
sl@0
|
86 |
*
|
|
sl@0
|
87 |
* @param The position within the array from where the object is to be
|
|
sl@0
|
88 |
* removed. The position is relative to zero, i.e. zero implies that an
|
|
sl@0
|
89 |
* object at the beginning of the array is to be removed.
|
|
sl@0
|
90 |
*
|
|
sl@0
|
91 |
* @return KErrNone if successful. KErrNotFound if aOutput is not in the
|
|
sl@0
|
92 |
* the list. KErrIncompleteInitialization if ConstructL is not called
|
|
sl@0
|
93 |
* by the deriving class. Otherwise any systemwide error code.
|
|
sl@0
|
94 |
*/
|
|
sl@0
|
95 |
IMPORT_C TInt RemoveAllowedOutput( TAllowedOutputPreference aOutput );
|
|
sl@0
|
96 |
|
|
sl@0
|
97 |
/**
|
|
sl@0
|
98 |
* Gets a reference to an allowed output located at a specified position
|
|
sl@0
|
99 |
* within the list.
|
|
sl@0
|
100 |
*
|
|
sl@0
|
101 |
* @param The position within the array from where the object is to be
|
|
sl@0
|
102 |
* removed. The position is relative to zero, i.e. zero implies that an
|
|
sl@0
|
103 |
* object at the beginning of the array is to be removed.
|
|
sl@0
|
104 |
*
|
|
sl@0
|
105 |
* @param The position within the array from where the object is to be
|
|
sl@0
|
106 |
* removed. The position is relative to zero, i.e. zero implies that an
|
|
sl@0
|
107 |
* object at the beginning of the array is to be removed.
|
|
sl@0
|
108 |
*
|
|
sl@0
|
109 |
* @param A const reference to the object at position anIndex within the
|
|
sl@0
|
110 |
* list.
|
|
sl@0
|
111 |
*
|
|
sl@0
|
112 |
* @return KErrNone if successful. KErrNotFound if index is not in the
|
|
sl@0
|
113 |
* the list. KErrIncompleteInitialization if ConstructL is not called
|
|
sl@0
|
114 |
* by the deriving class. Otherwise any systemwide error code.
|
|
sl@0
|
115 |
*/
|
|
sl@0
|
116 |
IMPORT_C TInt GetAllowedOutput( TInt aIndex, TAllowedOutputPreference& aOutput );
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
/**
|
|
sl@0
|
119 |
* Gets the number of objects in the array.
|
|
sl@0
|
120 |
*
|
|
sl@0
|
121 |
* @param On successful return will contain the number of objects in
|
|
sl@0
|
122 |
* the list.
|
|
sl@0
|
123 |
*
|
|
sl@0
|
124 |
* @return KErrIncompleteInitialization if ConstructL is not called
|
|
sl@0
|
125 |
* by the deriving class. Otherwise a system wide error code.
|
|
sl@0
|
126 |
*/
|
|
sl@0
|
127 |
IMPORT_C TInt GetAllowedOutputCount( TInt& aSize );
|
|
sl@0
|
128 |
|
|
sl@0
|
129 |
/**
|
|
sl@0
|
130 |
* Empties the list, so that it is ready to be reused.
|
|
sl@0
|
131 |
*
|
|
sl@0
|
132 |
*
|
|
sl@0
|
133 |
* @return KErrNone if successful. KErrIncompleteInitialization if ConstructL
|
|
sl@0
|
134 |
* is not called by the deriving class.
|
|
sl@0
|
135 |
*/
|
|
sl@0
|
136 |
IMPORT_C TInt Reset();
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
/**
|
|
sl@0
|
139 |
* Applies settings cached locally and commits.
|
|
sl@0
|
140 |
*
|
|
sl@0
|
141 |
* This function can only be called when the DevSound instance is in Idle OR
|
|
sl@0
|
142 |
* Stopped state.
|
|
sl@0
|
143 |
*
|
|
sl@0
|
144 |
* Output preference will take into effect when DevSound instance goes to
|
|
sl@0
|
145 |
* Playing state.
|
|
sl@0
|
146 |
*
|
|
sl@0
|
147 |
* If the client commits an empty list, all other active audio output in
|
|
sl@0
|
148 |
* the system will be muted.
|
|
sl@0
|
149 |
*
|
|
sl@0
|
150 |
* @return KErrNone if successful. KErrInUse if DevSound instance is not in
|
|
sl@0
|
151 |
* idle/stopped state.
|
|
sl@0
|
152 |
*/
|
|
sl@0
|
153 |
virtual TInt Commit() = 0;
|
|
sl@0
|
154 |
|
|
sl@0
|
155 |
protected:
|
|
sl@0
|
156 |
|
|
sl@0
|
157 |
/**
|
|
sl@0
|
158 |
* Constructor
|
|
sl@0
|
159 |
*
|
|
sl@0
|
160 |
*/
|
|
sl@0
|
161 |
IMPORT_C CRestrictedAudioOutput();
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
/**
|
|
sl@0
|
164 |
* Second phase constructor. The derived class should call this during
|
|
sl@0
|
165 |
* construction.
|
|
sl@0
|
166 |
*
|
|
sl@0
|
167 |
*/
|
|
sl@0
|
168 |
IMPORT_C void ConstructL();
|
|
sl@0
|
169 |
|
|
sl@0
|
170 |
|
|
sl@0
|
171 |
|
|
sl@0
|
172 |
private:
|
|
sl@0
|
173 |
CRestrictedAudioOutputImpl* iImpl;
|
|
sl@0
|
174 |
|
|
sl@0
|
175 |
};
|
|
sl@0
|
176 |
|
|
sl@0
|
177 |
#endif // RESTRICTEDAUDIOOUTPUT_H
|
|
sl@0
|
178 |
|
|
sl@0
|
179 |
// End of file
|