|
sl@0
|
1 |
|
|
sl@0
|
2 |
// MmfDevSoundCustomInterfaceSupport.h
|
|
sl@0
|
3 |
|
|
sl@0
|
4 |
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
5 |
// All rights reserved.
|
|
sl@0
|
6 |
// This component and the accompanying materials are made available
|
|
sl@0
|
7 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
8 |
// which accompanies this distribution, and is available
|
|
sl@0
|
9 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Initial Contributors:
|
|
sl@0
|
12 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
13 |
//
|
|
sl@0
|
14 |
// Contributors:
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
// Description:
|
|
sl@0
|
17 |
//
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
/**
|
|
sl@0
|
20 |
@publishedAll
|
|
sl@0
|
21 |
@released
|
|
sl@0
|
22 |
@file
|
|
sl@0
|
23 |
*/
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#ifndef MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
|
|
sl@0
|
26 |
#define MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
|
|
sl@0
|
29 |
#include <mmf/server/mmfdevsoundcustominterfaceobserver.h>
|
|
sl@0
|
30 |
#include <mmf/server/mmfdevsoundcustominterfacesupportclasses.h>
|
|
sl@0
|
31 |
#endif
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
/**
|
|
sl@0
|
34 |
@publishedAll
|
|
sl@0
|
35 |
@released
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
Custom Interface providing support for AutoPauseResume Register, Cancel, GetResourceNotificationData and WillResumePlay.
|
|
sl@0
|
38 |
*/
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
class MAutoPauseResumeSupport
|
|
sl@0
|
41 |
{
|
|
sl@0
|
42 |
public:
|
|
sl@0
|
43 |
/**
|
|
sl@0
|
44 |
Registers the event for notification when resource is avaliable.
|
|
sl@0
|
45 |
|
|
sl@0
|
46 |
@param aEventType
|
|
sl@0
|
47 |
The event which the client is notified of.
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
@param aNotificationRegistrationData
|
|
sl@0
|
50 |
Notification registration specific data, which has been reserved for future use.
|
|
sl@0
|
51 |
|
|
sl@0
|
52 |
@return An error code indicating if the function call was successful. KErrNone on success, otherwise
|
|
sl@0
|
53 |
another of the system-wide error codes.
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
virtual TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData = KNullDesC8)=0;
|
|
sl@0
|
56 |
|
|
sl@0
|
57 |
/**
|
|
sl@0
|
58 |
Cancels the registered notification event.
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
@param aEventType
|
|
sl@0
|
61 |
The event to notify the client.
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
@return An error code indicating if the function call was successful. KErrNone on success, otherwise
|
|
sl@0
|
64 |
another of the system-wide error codes.
|
|
sl@0
|
65 |
*/
|
|
sl@0
|
66 |
virtual TInt CancelRegisterAsClient(TUid aEventType)=0;
|
|
sl@0
|
67 |
/**
|
|
sl@0
|
68 |
Gets the notification data for the event.
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
@param aEventType
|
|
sl@0
|
71 |
The event which the client is notified of.
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
@param aNotificationData
|
|
sl@0
|
74 |
The notification data for the client to resume playing. The actual data depends on the event type.
|
|
sl@0
|
75 |
Note that for the event type 'KMMFEventCategoryAudioResourceAvailable' the package buffer returned
|
|
sl@0
|
76 |
is TMMFTimeIntervalMicroSecondsPckg, but the contents should be converted to an integer and
|
|
sl@0
|
77 |
interpreted as the data returned is samples played, but not as a microsecond value.
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
@return An error code indicating if the function call was successful. KErrNone on success, otherwise
|
|
sl@0
|
80 |
another of the system-wide error codes.
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
virtual TInt GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData)=0;
|
|
sl@0
|
83 |
/**
|
|
sl@0
|
84 |
Waits for the client to resume the play even after the default timer expires.
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
@return An error code indicating if the function call was successful. KErrNone on success, otherwise
|
|
sl@0
|
87 |
another of the system-wide error codes.
|
|
sl@0
|
88 |
*/
|
|
sl@0
|
89 |
virtual TInt WillResumePlay()=0;
|
|
sl@0
|
90 |
};
|
|
sl@0
|
91 |
|
|
sl@0
|
92 |
#endif // MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
|