epoc32/include/remcon/remconextapi1.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2004-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file
    20  @publishedPartner
    21  @released
    22 */
    23 
    24 #ifndef REMCONEXTAPI1_H
    25 #define REMCONEXTAPI1_H
    26 
    27 #include <e32base.h>
    28 
    29 // 'ExtApi1' constants apply to both interfaces within the ExtApi1 DLL, i.e. 
    30 // both the TrackInfo and AbsVol APIs.
    31 
    32 /** Offset in the operation-specific data of the 'result' (this field exists 
    33 in both commands and responses, but logically only applies to responses). */
    34 const TUint KRemConExtApi1ResultDataOffset = 0;
    35 
    36 /** Length of the results data/field in bytes. */
    37 const TUint KRemConExtApi1ResultDataLength = 4;
    38 
    39 /** Used for checking operation-specific data. The operation-specific data of 
    40 an ExtApi1 message must always contain at least a results field, so the length 
    41 of the results field is the minimum length of this 'packet'. */
    42 const TUint KRemConExtApi1MinimumDataLength = KRemConExtApi1ResultDataLength;
    43 
    44 /**
    45 The UID identifying the Track Info outer-layer RemCon interface.
    46 */
    47 const TInt KRemConTrackInfoApiUid = 0x10206863;
    48 
    49 /**
    50 Operation ids belonging to the Track Info interface.
    51 These are public so bearers/converters can access them.
    52 */
    53 enum TRemConTrackInfoOperationId
    54 	{
    55 	/** Get track name. */
    56 	ERemConGetTrackName			= 0x00,
    57 	/** Set track name. */
    58 	ERemConSetTrackName			= 0x01,
    59 	/** Get artist. */
    60 	ERemConGetArtist 			= 0x02,
    61 	/** Get track duration. */
    62 	ERemConGetTrackDuration		= 0x03,
    63 	};
    64 
    65 /**
    66 The UID identifying the Abs Vol outer-layer RemCon interface.
    67 */
    68 const TInt KRemConAbsVolApiUid = 0x1020831D;
    69 
    70 /**
    71 Operation ids belonging to the Abs Vol interface.
    72 These are public so bearers/converters can access them.
    73 */
    74 enum TRemConAbsVolOperationId
    75 	{
    76 	/** Get absolute volume. */
    77 	ERemConGetAbsoluteVolume 	= 0x00,
    78 	/** Set absolute volume. */
    79 	ERemConSetAbsoluteVolume 	= 0x01,
    80 	};
    81 
    82 #endif // REMCONEXTAPI1_H