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