epoc32/include/hwrmvibrasdkcrkeys.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100 (2010-03-31)
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@4
     2
* Copyright (c) 2006-2009 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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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@4
    14
* Description:
williamr@4
    15
* The API provides the vibra related Central Repository keys. 
williamr@4
    16
* These keys provide information on the vibra setting controlled by
williamr@4
    17
* profiles, maximum vibrating time supported by the device and 
williamr@4
    18
* minimum time vibra cannot be started after it was forcibly 
williamr@4
    19
* turned off when maximum time was reached. In addition keys
williamr@4
    20
* provide tactile feedback setting controlled by profiles and 
williamr@4
    21
* default intensity and duration for feedback vibration.
williamr@4
    22
* This interface relies on the Central Repository (CenRep) interface provided
williamr@4
    23
* by Symbian. 
williamr@4
    24
* The CenRep UID is KCRUidVibraCtrl and following keys are provided:
williamr@4
    25
* - KVibraCtrlProfileVibraEnabled
williamr@4
    26
* - KVibraCtrlMaxTime
williamr@4
    27
* - KVibraMinOffTime
williamr@2
    28
*
williamr@2
    29
*/
williamr@2
    30
williamr@2
    31
williamr@4
    32
williamr@4
    33
williamr@4
    34
/**
williamr@4
    35
 @file 
williamr@4
    36
 @publishedAll
williamr@4
    37
 @released
williamr@4
    38
*/
williamr@4
    39
williamr@2
    40
#ifndef HWRMVIBRASDKCRKEYS_H
williamr@2
    41
#define HWRMVIBRASDKCRKEYS_H
williamr@2
    42
williamr@2
    43
#include <e32std.h>
williamr@2
    44
williamr@2
    45
/**
williamr@2
    46
* CenRep UID for all vibra related settings keys provided by this API.
williamr@4
    47
*
williamr@4
    48
* @publishedAll
williamr@4
    49
* @released
williamr@2
    50
*/
williamr@2
    51
const TUid KCRUidVibraCtrl = {0x10200C8B};
williamr@2
    52
williamr@2
    53
/**
williamr@4
    54
* Vibra setting controlled by profiles. 
williamr@2
    55
* 
williamr@2
    56
* Possible integer values:
williamr@2
    57
*
williamr@2
    58
* 0 = Vibra is off in profile (default value) <br>
williamr@2
    59
* 1 = Vibra is on in profile <br>
williamr@4
    60
*
williamr@4
    61
* @publishedAll
williamr@4
    62
* @released
williamr@2
    63
*/
williamr@2
    64
const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
williamr@2
    65
williamr@2
    66
/**
williamr@2
    67
* Maximum vibrating time supported by device. 
williamr@2
    68
* 
williamr@2
    69
* Value is milliseconds as an integer. 
williamr@2
    70
* If value is zero, no maximum time is supported.
williamr@2
    71
* Maximum supported time is TMaxTInt microseconds in milliseconds.
williamr@2
    72
*
williamr@2
    73
* Value is read-only.
williamr@2
    74
*
williamr@2
    75
* Default value: 10000.
williamr@4
    76
*
williamr@4
    77
* @publishedAll
williamr@4
    78
* @released
williamr@2
    79
*/
williamr@2
    80
const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
williamr@2
    81
williamr@2
    82
/**
williamr@2
    83
* Minimum time vibra cannot be started after it was
williamr@2
    84
* forcibly turned off when maximum time was reached.
williamr@2
    85
* This can be used to enforce vibra cooling after long 
williamr@2
    86
* use periods.
williamr@2
    87
*
williamr@2
    88
* Value is milliseconds as an integer.
williamr@2
    89
*
williamr@2
    90
* Value is read-only.
williamr@2
    91
*
williamr@2
    92
* Default value: 0
williamr@4
    93
*
williamr@4
    94
* @publishedAll
williamr@4
    95
* @released
williamr@2
    96
*/
williamr@2
    97
const TUint32 KVibraMinOffTime                  = 0x00000003;
williamr@2
    98
williamr@2
    99
/**
williamr@2
   100
* Tactile feedback setting controlled by Profiles. 
williamr@2
   101
* 
williamr@2
   102
* Possible integer values:
williamr@2
   103
*
williamr@2
   104
* 0 = Tactile feedback is off in profile (default value) <br>
williamr@2
   105
* 1 = Tactile feedback is on in profile <br>
williamr@4
   106
*
williamr@4
   107
* @publishedAll
williamr@4
   108
* @released
williamr@2
   109
*/
williamr@2
   110
const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
williamr@2
   111
williamr@2
   112
/**
williamr@2
   113
* Tactile feedback vibration default intensity. 
williamr@2
   114
* 
williamr@2
   115
* Possible default intensity values are from the range -100...100.
williamr@2
   116
*
williamr@2
   117
* Value is read-only.
williamr@2
   118
*
williamr@2
   119
* Default value: 100
williamr@4
   120
*
williamr@4
   121
* @publishedAll
williamr@4
   122
* @released
williamr@2
   123
*/
williamr@2
   124
const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
williamr@2
   125
williamr@2
   126
/**
williamr@2
   127
* Tactile feedback vibration default duration. 
williamr@2
   128
* 
williamr@2
   129
* Value is milliseconds as an integer.
williamr@2
   130
*
williamr@2
   131
* Value is read-only.
williamr@2
   132
*
williamr@2
   133
* Default value: 20
williamr@4
   134
*
williamr@4
   135
* @publishedAll
williamr@4
   136
* @released
williamr@2
   137
*/
williamr@2
   138
const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
williamr@2
   139
williamr@2
   140
williamr@4
   141
williamr@2
   142
#endif  // HWRMVIBRASDKCRKEYS_H
williamr@2
   143
            
williamr@2
   144
// End of File