epoc32/include/hwrmvibrasdkcrkeys.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  This file contains SDK central repository key definitions
williamr@2
    15
*                for the vibra
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef HWRMVIBRASDKCRKEYS_H
williamr@2
    21
#define HWRMVIBRASDKCRKEYS_H
williamr@2
    22
williamr@2
    23
#include <e32std.h>
williamr@2
    24
williamr@2
    25
/** 
williamr@2
    26
* @file hwrmvibrasdkcrkeys.h
williamr@2
    27
* 
williamr@2
    28
* The API provides the vibra related Centrl Repository keys. 
williamr@2
    29
* These keys provide information on the vibra setting controlled by
williamr@2
    30
* Profiles, maximum vibrating time supported by the device and 
williamr@2
    31
* minimum time vibra cannot be started after it was forcibly 
williamr@2
    32
* turned off when maximum time was reached. In addition keys
williamr@2
    33
* provide tactile feedback setting controlled by profiles and 
williamr@2
    34
* default intensity and duration for feedback vibration.
williamr@2
    35
*
williamr@2
    36
* This interface relies on the Central Repository (CenRep) interface provided
williamr@2
    37
* by Symbian. 
williamr@2
    38
*
williamr@2
    39
* The CenRep UID is #KCRUidVibraCtrl and following keys are provided:
williamr@2
    40
* - #KVibraCtrlProfileVibraEnabled
williamr@2
    41
* - #KVibraCtrlMaxTime
williamr@2
    42
* - #KVibraMinOffTime
williamr@2
    43
*/
williamr@2
    44
williamr@2
    45
/**
williamr@2
    46
* CenRep UID for all vibra related settings keys provided by this API.
williamr@2
    47
*/
williamr@2
    48
const TUid KCRUidVibraCtrl = {0x10200C8B};
williamr@2
    49
williamr@2
    50
/**
williamr@2
    51
* Vibra setting controlled by Profiles. 
williamr@2
    52
* 
williamr@2
    53
* Possible integer values:
williamr@2
    54
*
williamr@2
    55
* 0 = Vibra is off in profile (default value) <br>
williamr@2
    56
* 1 = Vibra is on in profile <br>
williamr@2
    57
*/
williamr@2
    58
const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
williamr@2
    59
williamr@2
    60
/**
williamr@2
    61
* Maximum vibrating time supported by device. 
williamr@2
    62
* 
williamr@2
    63
* Value is milliseconds as an integer. 
williamr@2
    64
* If value is zero, no maximum time is supported.
williamr@2
    65
* Maximum supported time is TMaxTInt microseconds in milliseconds.
williamr@2
    66
*
williamr@2
    67
* Value is read-only.
williamr@2
    68
*
williamr@2
    69
* Default value: 10000.
williamr@2
    70
*/
williamr@2
    71
const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
williamr@2
    72
williamr@2
    73
/**
williamr@2
    74
* Minimum time vibra cannot be started after it was
williamr@2
    75
* forcibly turned off when maximum time was reached.
williamr@2
    76
* This can be used to enforce vibra cooling after long 
williamr@2
    77
* use periods.
williamr@2
    78
*
williamr@2
    79
* Value is milliseconds as an integer.
williamr@2
    80
*
williamr@2
    81
* Value is read-only.
williamr@2
    82
*
williamr@2
    83
* Default value: 0
williamr@2
    84
*/
williamr@2
    85
const TUint32 KVibraMinOffTime                  = 0x00000003;
williamr@2
    86
williamr@2
    87
/**
williamr@2
    88
* Tactile feedback setting controlled by Profiles. 
williamr@2
    89
* 
williamr@2
    90
* Possible integer values:
williamr@2
    91
*
williamr@2
    92
* 0 = Tactile feedback is off in profile (default value) <br>
williamr@2
    93
* 1 = Tactile feedback is on in profile <br>
williamr@2
    94
*/
williamr@2
    95
const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
williamr@2
    96
williamr@2
    97
/**
williamr@2
    98
* Tactile feedback vibration default intensity. 
williamr@2
    99
* 
williamr@2
   100
* Possible default intensity values are from the range -100...100.
williamr@2
   101
*
williamr@2
   102
* Value is read-only.
williamr@2
   103
*
williamr@2
   104
* Default value: 100
williamr@2
   105
*/
williamr@2
   106
const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
williamr@2
   107
williamr@2
   108
/**
williamr@2
   109
* Tactile feedback vibration default duration. 
williamr@2
   110
* 
williamr@2
   111
* Value is milliseconds as an integer.
williamr@2
   112
*
williamr@2
   113
* Value is read-only.
williamr@2
   114
*
williamr@2
   115
* Default value: 20
williamr@2
   116
*/
williamr@2
   117
const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
williamr@2
   118
williamr@2
   119
williamr@2
   120
#endif  // HWRMVIBRASDKCRKEYS_H
williamr@2
   121
            
williamr@2
   122
// End of File