internetradio2.0/inc/irpubsubkeys.h
changeset 14 896e9dbc5f19
child 15 065198191975
equal deleted inserted replaced
12:608f67c22514 14:896e9dbc5f19
       
     1 /*
       
     2 * Copyright (c) 2006-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:  ?Description
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef IRPUBSUBKEYS_H
       
    20 #define IRPUBSUBKEYS_H
       
    21 
       
    22 #include <e32def.h>
       
    23 #include <e32cmn.h>
       
    24 
       
    25 /** 
       
    26  * enum to indicate the state of iRAPP application
       
    27  */
       
    28 enum TIRPSApplicationRunningState
       
    29     {
       
    30     EIRPSApplicationUninitialized,
       
    31     EIRPSApplicationRunning,
       
    32     EIRPSApplicationClosing        
       
    33     };
       
    34 
       
    35 /**
       
    36  * enum to indicate the state of chanel playing
       
    37  */
       
    38 enum TIRStopPlayState
       
    39     {
       
    40     EIRStateUninitialized,
       
    41     EIRStatePlay,
       
    42     EIRStateStop
       
    43     };
       
    44     
       
    45     
       
    46 /**
       
    47  * enum to indicate the state of chanel playing
       
    48  */
       
    49 enum TIRBufferingState
       
    50     {
       
    51     EIRStateBufferingStart,
       
    52     EIRStateBufferingStop,
       
    53     EIRStateBufferingError
       
    54     };
       
    55 
       
    56 /** 
       
    57  * Internet Radio application Uid
       
    58  */
       
    59  
       
    60 //violates PC Lint Warning 569: Loss of information 
       
    61 //(initialization) (32 bits to 31 bits)
       
    62 
       
    63 const TUid KUidActiveInternetRadioApp = {0x2000B499};
       
    64 
       
    65 /** 
       
    66  * IR Publish and Subscribe keys base value
       
    67  */
       
    68 const TUint32 KIRPubSubBase = { 0x00000020 } ;
       
    69 
       
    70 /** 
       
    71  * IR Publish and Subscribe key to indicate prest index  change ( For XML Active Idle )
       
    72  */
       
    73 const TUint32 KIRPSPresetIndex = { KIRPubSubBase + 0x00000000 };
       
    74 
       
    75 /** 
       
    76  * IR Publish and Subscribe key to indicate if iRAPP is running ( For XML Active Idle )
       
    77  */
       
    78 const TUint32 KIRPSDataApplicationRunning = { KIRPubSubBase + 0x00000001 };
       
    79 
       
    80 /** 
       
    81  * This key is deprecated and the information is now available via KIRPSMetaData. 
       
    82  */
       
    83 const TUint32 KIRPSArtistTitleChanged = { KIRPubSubBase + 0x00000002 };
       
    84 
       
    85 /** 
       
    86  * This key is deprecated and the information is now available via KIRPSMetaData. 
       
    87  */
       
    88 const TUint32 KIRPSSongTitleChanged = { KIRPubSubBase + 0x00000003 };
       
    89 
       
    90 /** 
       
    91  * IR Publish and Subscribe key to indicate channel change ( For XML Active Idle )
       
    92  */
       
    93 const TUint32 KIRPSDataChannel = { KIRPubSubBase + 0x00000004 };
       
    94 
       
    95 /** 
       
    96  * IR Publish and Subscribe key to indicate volume change ( For XML Active Idle )
       
    97  */
       
    98 const TUint32 KIRPSVolume = { KIRPubSubBase + 0x00000005 };
       
    99 
       
   100 /** 
       
   101  * IR Publish and Subscribe key to indicate stop state ( For XML Active Idle )
       
   102  */
       
   103 const TUint32 KIRPSPlayStop = { KIRPubSubBase + 0x00000006 };
       
   104 
       
   105 /** 
       
   106  * IR Publish and Subscribe key to specify the channel server url
       
   107  */
       
   108 const TUint32 KIRPSChannelUrl = { KIRPubSubBase + 0x00000007 };
       
   109 
       
   110 /** 
       
   111  * IR Publish and Subscribe key to specify the Bitrate
       
   112  */
       
   113 const TUint32 KIRPSBitrate = { KIRPubSubBase + 0x00000008 };
       
   114 
       
   115 /** 
       
   116  * IR Publish and Subscribe key to Handle simultaneous play
       
   117  */
       
   118 const TUint32 KIRPSMultiplePlay = { KIRPubSubBase + 0x00000009 };
       
   119 
       
   120 /** 
       
   121  * IR Publish and Subscribe key to specify the channel server url
       
   122  */
       
   123 const TUint32 KIRPSStationName = { KIRPubSubBase + 0x0000000A };  
       
   124 
       
   125 /** 
       
   126  * IR Publish and Subscribe key to specify the number of application
       
   127  * instances running
       
   128  */
       
   129 const TUint32 KIRPSAppInstanceRunning = { KIRPubSubBase + 0x0000000B };  
       
   130 
       
   131 /**
       
   132  * Updated whenever meta data has been received for the channel that is currently streaming.
       
   133  *
       
   134  * As this data is packed in binary form, listeners of this key can use the following code snippet to support
       
   135  * unpacking it:
       
   136  *
       
   137  * #include <irmetadata.h>
       
   138  *
       
   139  * In your HandlePropertyChangeL( const TDesC8& aData ) method:
       
   140  *
       
   141  * if ( aKey == KIRPSMetaData )
       
   142  *     {
       
   143  *     CIRMetaData* metaData = CIRMetaData::NewL( aData ); 
       
   144  *     CleanupStack::PushL( metaData );
       
   145  *     // Meta data information is now available via the public access methods of CIRMetaData.
       
   146  *     // Do whatever needs to be done with the meta data information here.
       
   147  *     const TDesC& artist = metaData->Artist();
       
   148  *     ...
       
   149  *     CleanupStack::PopAndDestroy( metaData );
       
   150  *     }
       
   151  */
       
   152 const TUint32 KIRPSMetaData = { KIRPubSubBase + 0x0000000C };
       
   153 
       
   154 const TUint32 KIRPSChannelType = { KIRPubSubBase + 0x0000000D };
       
   155 
       
   156 const TUint32 KIRPSChannelId = { KIRPubSubBase + 0x000000E };
       
   157 
       
   158 const TUint32 KIRPSDataChannelDesc = { KIRPubSubBase + 0x0000000F };
       
   159 
       
   160 const TUint32 KIRPSChannelMusicFlag = { KIRPubSubBase + 0x00000010 };
       
   161 
       
   162 const TUint32 KIRPSControlSetPlayState = { KIRPubSubBase + 0x00000011 };
       
   163 
       
   164 
       
   165 const TUint32 KIRPSBufferingState = { KIRPubSubBase + 0x00000012 };
       
   166 
       
   167 /********************************************************************
       
   168 *  KIRPubSubBase + 0x00000015 should be reserved for startup key which is defined in \qtinternetradio\irqcommon\inc\irservicedef.h
       
   169 *const unsigned long int KInternetRadioStartupKey = 0x00000035; // = KIRPubSubBase + 0x00000015
       
   170 */
       
   171 
       
   172 #endif // IRPUBSUBKEYS_H
       
   173