|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2006-2009 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:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
/**
|
|
sl@0
|
22 |
@publishedPartner
|
|
sl@0
|
23 |
@file
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#ifndef AUDIOCONTEXTFACTORY_H
|
|
sl@0
|
29 |
#define AUDIOCONTEXTFACTORY_H
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
#include <e32base.h>
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
class MAudioContext;
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
/**
|
|
sl@0
|
38 |
* An interface to an AudioContextFactory.
|
|
sl@0
|
39 |
*
|
|
sl@0
|
40 |
* Audio Context Factory is the entry point to the low level audio functionality of the device.
|
|
sl@0
|
41 |
* Audio Context Factory is used for creating new audio contexts.
|
|
sl@0
|
42 |
*
|
|
sl@0
|
43 |
* @lib AudioContextFactory.lib
|
|
sl@0
|
44 |
*/
|
|
sl@0
|
45 |
class CAudioContextFactory : public CBase
|
|
sl@0
|
46 |
{
|
|
sl@0
|
47 |
public:
|
|
sl@0
|
48 |
/**
|
|
sl@0
|
49 |
* Constructs and returns a pointer to a new CAudioContextFactory object.
|
|
sl@0
|
50 |
*
|
|
sl@0
|
51 |
* @return CAudioContextFactory* - on success, pointer to new class instance.
|
|
sl@0
|
52 |
* This call returns ownership, as in the standard NewL() pattern.
|
|
sl@0
|
53 |
*/
|
|
sl@0
|
54 |
IMPORT_C static CAudioContextFactory* NewL();
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
/**
|
|
sl@0
|
57 |
* Destructor.
|
|
sl@0
|
58 |
*
|
|
sl@0
|
59 |
* Deletes all objects and releases all resource owned by this instance.
|
|
sl@0
|
60 |
*/
|
|
sl@0
|
61 |
IMPORT_C virtual ~CAudioContextFactory();
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
/**
|
|
sl@0
|
64 |
* Creates a new audio context.
|
|
sl@0
|
65 |
*
|
|
sl@0
|
66 |
* The context must be removed using DeleteAudioContext() when it is no longer needed.
|
|
sl@0
|
67 |
* @param aContext on return contains a reference to the created context.
|
|
sl@0
|
68 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
IMPORT_C TInt CreateAudioContext(MAudioContext*& aContext);
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/**
|
|
sl@0
|
74 |
* Deletes the audio context.
|
|
sl@0
|
75 |
* All processing units have to be removed from the context by the client.
|
|
sl@0
|
76 |
* before the context is removed. This is a null-operation if aContext is NULL on DeleteAudioContext being called.
|
|
sl@0
|
77 |
* aContext is set to NULL on completion of the call.
|
|
sl@0
|
78 |
* @param aContext a pointer to the context to remove.
|
|
sl@0
|
79 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
80 |
*/
|
|
sl@0
|
81 |
IMPORT_C void DeleteAudioContext(MAudioContext*& aContext);
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
protected:
|
|
sl@0
|
84 |
/**
|
|
sl@0
|
85 |
* Constructor
|
|
sl@0
|
86 |
*/
|
|
sl@0
|
87 |
CAudioContextFactory();
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
* Second phase contructor.
|
|
sl@0
|
90 |
*/
|
|
sl@0
|
91 |
void ConstructL();
|
|
sl@0
|
92 |
};
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
#endif // AUDIOCONTEXTFACTORY_H
|