williamr@2: // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // 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
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: #ifndef __ASCLISOUNDPLAY_H__
williamr@2: #define __ASCLISOUNDPLAY_H__
williamr@2: 
williamr@2: // System includes
williamr@2: #include <e32base.h>
williamr@2: 
williamr@2: // User includes
williamr@2: #include <asshddefs.h>
williamr@2: 
williamr@2: // Type definitions
williamr@2: 
williamr@2: // Constants
williamr@2: 
williamr@2: // Enumerations
williamr@2: 
williamr@2: 
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: // ----> TASCliSoundPlayDefinition (header)
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: class TASCliSoundPlayDefinition
williamr@2: /** Defines when alarm sounds are to be played, and for how long. 
williamr@2: 
williamr@2: Alarm sounds are played according to intervals that consist of a duration 
williamr@2: and an offset. 
williamr@2: 
williamr@2: The duration is the number of seconds that the alarm sound plays. 
williamr@2: 
williamr@2: The offset is the number of minutes after the alarm expires that the alarm 
williamr@2: sound plays. 
williamr@2: 
williamr@2: The sound play definition is set using class RASCliSession. 
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: 	{
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: public:										// CONSTRUCT
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: 
williamr@2: 	inline TASCliSoundPlayDefinition();
williamr@2: 
williamr@2: 	inline TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration);
williamr@2: 
williamr@2: ////////////////////////////////////////////////////////////////////////////////////////
williamr@2: public:										// ACCESS
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: 
williamr@2: 	inline TTimeIntervalMinutes	Offset() const 
williamr@2: 	/** Retrieves the offset.
williamr@2: 	
williamr@2: 	@return The offset in minutes. */
williamr@2: 		{ return iOffset; }
williamr@2: 
williamr@2: 	inline TTimeIntervalSeconds	Duration() const 
williamr@2: 	/** Retrieves the duration.
williamr@2: 	
williamr@2: 	@return The duration in seconds. */
williamr@2: 		{ return iDuration; }
williamr@2: 
williamr@2: //////////////////////////////////////////////////////////////////////////////////////
williamr@2: private:									// MEMBER DATA
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: 
williamr@2: 	/*
williamr@2: 	 * From the time an alarm is first displayed
williamr@2: 	 */
williamr@2: 	TTimeIntervalMinutes					iOffset;
williamr@2: 
williamr@2: 	/*
williamr@2: 	 * How long the alarm playing lasts
williamr@2: 	 */
williamr@2: 	TTimeIntervalSeconds					iDuration;
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: // ----> TASCliSoundPlayDefinition (inlines)
williamr@2: ///////////////////////////////////////////////////////////////////////////////////////
williamr@2: inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition()
williamr@2: :	iOffset(KDefaultSoundPlayOffsetInSeconds), iDuration(KDefaultSoundPlayDurationInSeconds)
williamr@2: /** Default constructor. 
williamr@2: 
williamr@2: The default offset is zero, and the default duration is 30 seconds. */
williamr@2: 	{}
williamr@2: inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration)
williamr@2: :	iOffset(aOffset), iDuration(aDuration)
williamr@2: /** Constructor that initializes the offset and duration to specified values.
williamr@2: 	
williamr@2: @param aOffset Time in minutes for the offset. 
williamr@2: @param aDuration Time in seconds for the duration. */
williamr@2: 	{}
williamr@2: 
williamr@2: #endif