1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/asclisoundplay.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,110 @@
1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __ASCLISOUNDPLAY_H__
1.20 +#define __ASCLISOUNDPLAY_H__
1.21 +
1.22 +// System includes
1.23 +#include <e32base.h>
1.24 +
1.25 +// User includes
1.26 +#include <asshddefs.h>
1.27 +
1.28 +// Type definitions
1.29 +
1.30 +// Constants
1.31 +
1.32 +// Enumerations
1.33 +
1.34 +
1.35 +///////////////////////////////////////////////////////////////////////////////////////
1.36 +// ----> TASCliSoundPlayDefinition (header)
1.37 +///////////////////////////////////////////////////////////////////////////////////////
1.38 +class TASCliSoundPlayDefinition
1.39 +/** Defines when alarm sounds are to be played, and for how long.
1.40 +
1.41 +Alarm sounds are played according to intervals that consist of a duration
1.42 +and an offset.
1.43 +
1.44 +The duration is the number of seconds that the alarm sound plays.
1.45 +
1.46 +The offset is the number of minutes after the alarm expires that the alarm
1.47 +sound plays.
1.48 +
1.49 +The sound play definition is set using class RASCliSession.
1.50 +@publishedAll
1.51 +@released
1.52 +*/
1.53 + {
1.54 +///////////////////////////////////////////////////////////////////////////////////////
1.55 +public: // CONSTRUCT
1.56 +///////////////////////////////////////////////////////////////////////////////////////
1.57 +
1.58 + inline TASCliSoundPlayDefinition();
1.59 +
1.60 + inline TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration);
1.61 +
1.62 +////////////////////////////////////////////////////////////////////////////////////////
1.63 +public: // ACCESS
1.64 +///////////////////////////////////////////////////////////////////////////////////////
1.65 +
1.66 + inline TTimeIntervalMinutes Offset() const
1.67 + /** Retrieves the offset.
1.68 +
1.69 + @return The offset in minutes. */
1.70 + { return iOffset; }
1.71 +
1.72 + inline TTimeIntervalSeconds Duration() const
1.73 + /** Retrieves the duration.
1.74 +
1.75 + @return The duration in seconds. */
1.76 + { return iDuration; }
1.77 +
1.78 +//////////////////////////////////////////////////////////////////////////////////////
1.79 +private: // MEMBER DATA
1.80 +///////////////////////////////////////////////////////////////////////////////////////
1.81 +
1.82 + /*
1.83 + * From the time an alarm is first displayed
1.84 + */
1.85 + TTimeIntervalMinutes iOffset;
1.86 +
1.87 + /*
1.88 + * How long the alarm playing lasts
1.89 + */
1.90 + TTimeIntervalSeconds iDuration;
1.91 + };
1.92 +
1.93 +
1.94 +
1.95 +
1.96 +///////////////////////////////////////////////////////////////////////////////////////
1.97 +// ----> TASCliSoundPlayDefinition (inlines)
1.98 +///////////////////////////////////////////////////////////////////////////////////////
1.99 +inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition()
1.100 +: iOffset(KDefaultSoundPlayOffsetInSeconds), iDuration(KDefaultSoundPlayDurationInSeconds)
1.101 +/** Default constructor.
1.102 +
1.103 +The default offset is zero, and the default duration is 30 seconds. */
1.104 + {}
1.105 +inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration)
1.106 +: iOffset(aOffset), iDuration(aDuration)
1.107 +/** Constructor that initializes the offset and duration to specified values.
1.108 +
1.109 +@param aOffset Time in minutes for the offset.
1.110 +@param aDuration Time in seconds for the duration. */
1.111 + {}
1.112 +
1.113 +#endif