bluetoothappprofiles/avrcp/playerinformation/resource/settings.rh
changeset 70 f5508c13dfe0
parent 67 16e4b9007960
child 71 083fd884d7dd
equal deleted inserted replaced
67:16e4b9007960 70:f5508c13dfe0
     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Resource header for AVRCP resource files.
       
    15 // 
       
    16 //
       
    17 
       
    18 /**
       
    19  @file settings.rh
       
    20  @publishedPartner
       
    21  @released
       
    22 */
       
    23 
       
    24 #ifndef SETTINGS_RH
       
    25 #define SETTINGS_RH
       
    26 
       
    27 /** 
       
    28 This resource header file defines the structures and constants required
       
    29 for the AVRCP Player Application Settings and Values, as defined in
       
    30 Appendix F of the Bluetooth Specification (AVRCP), page 80.
       
    31 
       
    32 A setting file consists of an arbitrary number of settings. This file
       
    33 will be parsed and used to set values for a media application at
       
    34 startup time, to be queried through the AVRCP profile.
       
    35 
       
    36 A setting file has the following structure
       
    37 
       
    38 UID2 KUidAVRCPResourceFile    // Identifies this as an AVRCP settings file
       
    39 
       
    40 RESOURCE SETTINGS mysettings
       
    41     {
       
    42     settings =
       
    43         {
       
    44         SETTING
       
    45             {
       
    46             // definition of setting 1
       
    47             },
       
    48         SETTING
       
    49             {
       
    50             // definition of setting 2
       
    51             },
       
    52         // etc
       
    53         };
       
    54     }
       
    55 */
       
    56 
       
    57 #define KUidAVRCPResourceFile       0x10285ACD
       
    58 
       
    59 #define KIllegal        0x00
       
    60 #define KEqualizerMode  0x01
       
    61 #define KRepeatMode     0x02
       
    62 #define KShuffleMode    0x03
       
    63 #define KScanMode       0x04
       
    64 
       
    65 #define KOff            0x01
       
    66 #define KOn             0x02
       
    67 
       
    68 // Off                      0x01
       
    69 #define KSingleTrackRepeat  0x02
       
    70 #define KAllTracksRepeat    0x03
       
    71 #define KGroupRepeat        0x04
       
    72 
       
    73 // Off                      0x01
       
    74 #define KAllTracksShuffle   0x02
       
    75 #define KGroupShuffle       0x03
       
    76 
       
    77 // Off                      0x01
       
    78 #define KAllTracksScan      0x02
       
    79 #define KGroupScan          0x03
       
    80 
       
    81 #define KUserDefined        0x80
       
    82 
       
    83 // Defines a single setting
       
    84 STRUCT SETTING
       
    85     {
       
    86     // The player application setting attribute
       
    87     // e.g. 0x00 illegal, not to be used
       
    88     //      0x01 equalizer status
       
    89     //      0x02 repeat mode status
       
    90     //      0x03 shuffle mode status
       
    91     //      0x04 scan mode status
       
    92     //      0x05 - 0x7f reserved for future use
       
    93     //      0x80 - 0xff provided for TG driver static media player menu extension by CT
       
    94     BYTE    attribute = 0;
       
    95 
       
    96     // The defined settings for this attribute
       
    97     BYTE    initialValue = 0;
       
    98 
       
    99     // An string which describes this setting
       
   100     // This can be localised into the target language
       
   101     LTEXT8   description = "";
       
   102 
       
   103     // The values and descriptions that this attribute can take
       
   104     STRUCT  definedValues[];
       
   105     }
       
   106 
       
   107 // Defines a single setting
       
   108 STRUCT VALUE
       
   109     {
       
   110     // The setting value id in hex
       
   111     BYTE    valueId = 0;
       
   112 
       
   113     // An string which describes this value
       
   114     // This can be localised into the target language
       
   115     LTEXT8   description = "";
       
   116     }
       
   117 
       
   118 // Defines a set of settings and the implementations UIDs of the default
       
   119 // setting evaluator and dialog creator plug-ins.
       
   120 STRUCT SETTINGS
       
   121     {
       
   122     // Version of the AVRCP resource file.
       
   123     // Settings files MUST NOT change this value.
       
   124     // This must match with the number defined in settingsresource.cpp
       
   125     WORD version = 1;
       
   126 
       
   127     // An array of SETTING structures
       
   128     STRUCT settings[];
       
   129     }
       
   130 
       
   131 #endif