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