williamr@2: /*
williamr@2: * Copyright (c) 2002-2007 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:  This file contains SDK central repository key definitions
williamr@2: *                for the vibra
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef HWRMVIBRASDKCRKEYS_H
williamr@2: #define HWRMVIBRASDKCRKEYS_H
williamr@2: 
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: /** 
williamr@2: * @file hwrmvibrasdkcrkeys.h
williamr@2: * 
williamr@2: * The API provides the vibra related Centrl Repository keys. 
williamr@2: * These keys provide information on the vibra setting controlled by
williamr@2: * Profiles, maximum vibrating time supported by the device and 
williamr@2: * minimum time vibra cannot be started after it was forcibly 
williamr@2: * turned off when maximum time was reached. In addition keys
williamr@2: * provide tactile feedback setting controlled by profiles and 
williamr@2: * default intensity and duration for feedback vibration.
williamr@2: *
williamr@2: * This interface relies on the Central Repository (CenRep) interface provided
williamr@2: * by Symbian. 
williamr@2: *
williamr@2: * The CenRep UID is #KCRUidVibraCtrl and following keys are provided:
williamr@2: * - #KVibraCtrlProfileVibraEnabled
williamr@2: * - #KVibraCtrlMaxTime
williamr@2: * - #KVibraMinOffTime
williamr@2: */
williamr@2: 
williamr@2: /**
williamr@2: * CenRep UID for all vibra related settings keys provided by this API.
williamr@2: */
williamr@2: const TUid KCRUidVibraCtrl = {0x10200C8B};
williamr@2: 
williamr@2: /**
williamr@2: * Vibra setting controlled by Profiles. 
williamr@2: * 
williamr@2: * Possible integer values:
williamr@2: *
williamr@2: * 0 = Vibra is off in profile (default value) <br>
williamr@2: * 1 = Vibra is on in profile <br>
williamr@2: */
williamr@2: const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
williamr@2: 
williamr@2: /**
williamr@2: * Maximum vibrating time supported by device. 
williamr@2: * 
williamr@2: * Value is milliseconds as an integer. 
williamr@2: * If value is zero, no maximum time is supported.
williamr@2: * Maximum supported time is TMaxTInt microseconds in milliseconds.
williamr@2: *
williamr@2: * Value is read-only.
williamr@2: *
williamr@2: * Default value: 10000.
williamr@2: */
williamr@2: const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
williamr@2: 
williamr@2: /**
williamr@2: * Minimum time vibra cannot be started after it was
williamr@2: * forcibly turned off when maximum time was reached.
williamr@2: * This can be used to enforce vibra cooling after long 
williamr@2: * use periods.
williamr@2: *
williamr@2: * Value is milliseconds as an integer.
williamr@2: *
williamr@2: * Value is read-only.
williamr@2: *
williamr@2: * Default value: 0
williamr@2: */
williamr@2: const TUint32 KVibraMinOffTime                  = 0x00000003;
williamr@2: 
williamr@2: /**
williamr@2: * Tactile feedback setting controlled by Profiles. 
williamr@2: * 
williamr@2: * Possible integer values:
williamr@2: *
williamr@2: * 0 = Tactile feedback is off in profile (default value) <br>
williamr@2: * 1 = Tactile feedback is on in profile <br>
williamr@2: */
williamr@2: const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
williamr@2: 
williamr@2: /**
williamr@2: * Tactile feedback vibration default intensity. 
williamr@2: * 
williamr@2: * Possible default intensity values are from the range -100...100.
williamr@2: *
williamr@2: * Value is read-only.
williamr@2: *
williamr@2: * Default value: 100
williamr@2: */
williamr@2: const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
williamr@2: 
williamr@2: /**
williamr@2: * Tactile feedback vibration default duration. 
williamr@2: * 
williamr@2: * Value is milliseconds as an integer.
williamr@2: *
williamr@2: * Value is read-only.
williamr@2: *
williamr@2: * Default value: 20
williamr@2: */
williamr@2: const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
williamr@2: 
williamr@2: 
williamr@2: #endif  // HWRMVIBRASDKCRKEYS_H
williamr@2:             
williamr@2: // End of File