2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
14 * Description: Project specification for AddedDevSoundControl Custom Interface
19 #ifndef __ADDEDDEVSOUNDCONTROLCI_H__
20 #define __ADDEDDEVSOUNDCONTROLCI_H__
26 // Interface UID associated to the Custom Interface class.
27 const static TUid KUidAddedDevSoundControlInterface = {0x101FAF92};
33 // FUNCTION PROTOTYPES
35 // FORWARD DECLARATIONS
40 * Interface class for altering pause and resume behavior.
42 * Clients of DevSound API can use this interface alter the default pause
43 * and resume behavior. By default when CMMFDevSound::Pause() is called data
44 * already sent to it is flushed/discarded and audio resources are released.
45 * Upon next PlayInitL() audio resources are re-allocated.
47 * DevSound clients can obtain a handle to this interface by calling
48 * CMMFDevSound::CustomInterface() function with UID
49 * KUidAddedDevSoundControlInterface. Along with the handle, the ownership of
50 * the object is also transferred to the client.
52 * This interface is valid until the DevSound is re-initialized or deleted.
53 * Client shuold make sure that they delete the interface before DevSound is
54 * re-initialized or deleted.
59 class MAddedDevSoundControl
65 * Alters DevSound's behavior for handling Pause and Resume.
67 * Can be called after DevSound creation. Must be called prior to calling
68 * CMMFDevSound::Pause() to take effect.
70 * When value is ETrue, Calling CMMFDevSound::Pause() will halt the decoding
71 * and/or rendering temporarily. Data buffers sent to the DevSound instance
72 * are buffered up. Resources associated with the DevSound instance is kept
73 * intact. Upon resuming via CMMFDevSound::PlayInitL(), all buffered data
74 * will be decoded and/or rendered.
75 * When value is EFalse, CMMFDevSound::Pause() will stop decoding and/or
76 * rendering immediately. Data buffers sent to the DevSound instance that
77 * were not decoded/rendered are flushed. Resources associated with
78 * DevSound instance are also released.
80 * Not necessarily supported by all platforms.
82 * Will return a KErrNotSupported if the DevSound behavior cannot be altered.
85 * @param TBool - Toggles HW awarness
86 * @return TInt - Function call status
89 virtual TInt SetHwAwareness(TBool aHwAware) = 0;
93 * Flushes audio data that are not decoded/rendered yet.
95 * Not necessarily available in all platforms.
97 * DevSound instance must be in the playing PAUSED state.
101 * @return TInt - Function call status.
102 * KErrNone if audio data is flushed successfully.
103 * KErrInUse if DevSound is not in paused state.
104 * KErrNotSupported if the feature is not available and/or
105 * hardware awareness flag is not set.
108 virtual TInt PauseAndFlush() = 0;
112 * Provide virtual destructor to allow DevSound clients to delete
113 * instance through the pointer recieved via call to CustomInterface().
116 virtual ~MAddedDevSoundControl() {};
120 #endif // __ADDEDDEVSOUNDCONTROLCI_H__