systemswstubs/accessorypolicyreference/inc/AccPolProprietaryNameValuePairs.h
changeset 0 0ce1b5ce9557
equal deleted inserted replaced
-1:000000000000 0:0ce1b5ce9557
       
     1 /*
       
     2 * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  This header provides the proprietary Name/Value defintions of Name/Value pairs.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef ACCPOLPROPRIETARYNAMEVALUEPAIRS_H
       
    20 #define ACCPOLPROPRIETARYNAMEVALUEPAIRS_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <AccPolCommonNameValuePairs.h>
       
    24 
       
    25 // CONSTANTS
       
    26 
       
    27 // Accessory capabilities can be described as name/value pairs. To use accessorys
       
    28 // capabilities from generic identification, the user needs constants. These 
       
    29 // constants are referenced with name/value pairs.
       
    30 // Name constants are defined to a certain numerical space. 
       
    31 // In this numerical space each of these constats is presented with a term called
       
    32 // "name const literal". E.g. For name KAccAcousticEchoControl name const literal is
       
    33 // "1#1#1".
       
    34 // Accessory capabilities can be described the following values: name, value type,
       
    35 // dynamic type, I/O type, description and bitmask.
       
    36 // Name:           Acoustic Echo Control
       
    37 // --------------> Name of the capability 
       
    38 // Value Type:     TBool
       
    39 // --------------> Type of the value
       
    40 // Dynamic Type:   Dynamic/Static
       
    41 // --------------> Indicates if value can change while accessory is connected.
       
    42 //                 If value is dynamic type the client should registrate for 
       
    43 //                 listening indications for value changes.
       
    44 // I/O Type:       From accessory to terminal, input.
       
    45 // --------------> I/O type indicates the direction how the state update is done. 
       
    46 //                 E.g.output indicated that user can use setValueL method. If
       
    47 //                 accessory updates the value I/O type is input and if it done
       
    48 //                 by the terminal I/O type is output.
       
    49 // Description:    Accessory supports acoustic echo control. If value is true terminal
       
    50 //                 must disable its own echo control. To indicate if accessory has 
       
    51 //                 internal acoustic echo control.
       
    52 // --------------> Description of the capability.
       
    53 
       
    54 // Format of capability:
       
    55 // =====================
       
    56 //
       
    57 // 0b 000001 00000 00010
       
    58 //    ------ ----- -----
       
    59 //    |      |     |
       
    60 //    |      |     |_5 bits for capability. Tells which bit is one (*).
       
    61 //    |      |_5 bits for namespace,
       
    62 //    |_6 bits for capability group. Tells which bit is one (*).
       
    63 //
       
    64 // (*):
       
    65 // 0b00 -> bit number 1 is one -> value is 0b0001=1
       
    66 // 0b01 -> bit number 2 is one -> value is 0b0010=2
       
    67 // 0b10 -> bit number 3 is one -> value is 0b0100=4
       
    68 // 0b11 -> bit number 4 is one -> value is 0b1000=8
       
    69 //
       
    70 
       
    71 // Proprietary NAME-VALUE PAIRS:
       
    72 
       
    73 // Name:           Proprietary capability.
       
    74 // Value:          N/A
       
    75 // Dynamic Type:   N/A
       
    76 // I/O Type:       N/A
       
    77 // Description:    N/A
       
    78 //const TUint32 KAccProprietaryCapability = 0x8000;
       
    79 
       
    80 #endif      // ACCPOLPROPRIETARYNAMEVALUEPAIRS_H   
       
    81             
       
    82 // End of File