epoc32/include/mw/remconmediabrowsetypes.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
williamr@4
    17
williamr@4
    18
/**
williamr@4
    19
 @file
williamr@4
    20
 @publishedAll
williamr@4
    21
 @released
williamr@4
    22
*/
williamr@4
    23
williamr@4
    24
#ifndef REMCONMEDIABROWSETYPES_H
williamr@4
    25
#define REMCONMEDIABROWSETYPES_H
williamr@4
    26
williamr@4
    27
#include <e32base.h>
williamr@4
    28
#include <remconmediaattributeid.h>
williamr@4
    29
williamr@4
    30
/**
williamr@4
    31
Defines a type representing a UID which is 8 octet and uniquely identifys 
williamr@4
    32
a folder or media element in the media library.
williamr@4
    33
*/
williamr@4
    34
typedef TUint64 TRemConItemUid;
williamr@4
    35
williamr@4
    36
/**
williamr@4
    37
Defines item types to indicate the item is a folder item or media item.
williamr@4
    38
*/
williamr@4
    39
enum TRemConItemType
williamr@4
    40
	{
williamr@4
    41
	ERemConFolderItem = 2,
williamr@4
    42
	ERemConMediaItem = 3,
williamr@4
    43
	};
williamr@4
    44
williamr@4
    45
class TRemConItem
williamr@4
    46
	{
williamr@4
    47
public:
williamr@4
    48
	TRemConItemUid iUid;
williamr@4
    49
	TRemConItemType iType;
williamr@4
    50
	};
williamr@4
    51
williamr@4
    52
/**
williamr@4
    53
Defines a type which indicates whether a folder item is playable.
williamr@4
    54
*/
williamr@4
    55
typedef TUint8 TFolderItemPlayable;
williamr@4
    56
williamr@4
    57
/**
williamr@4
    58
Defines a type to indicate a media item type.
williamr@4
    59
*/
williamr@4
    60
typedef TUint8 TMediaItemType;
williamr@4
    61
williamr@4
    62
const TFolderItemPlayable KFolderNotPlayable = 0;
williamr@4
    63
const TFolderItemPlayable KFolderPlayable = 1;
williamr@4
    64
williamr@4
    65
const TMediaItemType KMediaAudio = 0;
williamr@4
    66
const TMediaItemType KMediaVideo = 1;
williamr@4
    67
williamr@4
    68
enum TFolderItemType
williamr@4
    69
	{
williamr@4
    70
	EFolderMixed = 0,
williamr@4
    71
	EFolderTitles = 1,
williamr@4
    72
	EFolderAlbums = 2,
williamr@4
    73
	EFolderArtists = 3,
williamr@4
    74
	EFolderGenres = 4,
williamr@4
    75
	EFolderPlaylists = 5,
williamr@4
    76
	EFolderYears = 6,
williamr@4
    77
	};
williamr@4
    78
williamr@4
    79
/**
williamr@4
    80
Defines folder scopes in which media content navigaition  may take place.
williamr@4
    81
*/
williamr@4
    82
enum TRemConFolderScope
williamr@4
    83
	{
williamr@4
    84
	/**
williamr@4
    85
	Applicable in browsed player.
williamr@4
    86
	Valid browseable items are foler item and media element item.
williamr@4
    87
	*/
williamr@4
    88
	EBrowseFolder         = 0x1,
williamr@4
    89
	
williamr@4
    90
	/**
williamr@4
    91
	Applicable in browsed player.
williamr@4
    92
	Valid browseable items are media element items.
williamr@4
    93
	*/
williamr@4
    94
	ESearchResultFolder   = 0x2,
williamr@4
    95
	
williamr@4
    96
	/**
williamr@4
    97
	Applicable in addressed player.
williamr@4
    98
	Valid browseable items are media element items.
williamr@4
    99
	*/
williamr@4
   100
	ENowPlayingFolder     = 0x3
williamr@4
   101
	};
williamr@4
   102
williamr@4
   103
/**
williamr@4
   104
A data container of a media element attribute.
williamr@4
   105
williamr@4
   106
*/
williamr@4
   107
class TMediaElementAttribute
williamr@4
   108
	{
williamr@4
   109
public:
williamr@4
   110
	TMediaAttributeId     iAttributeId;
williamr@4
   111
	
williamr@4
   112
	/**
williamr@4
   113
	The value of the attribute in UTF-8.
williamr@4
   114
	*/
williamr@4
   115
	HBufC8*               iString;
williamr@4
   116
	};
williamr@4
   117
williamr@4
   118
#endif //REMCONMEDIABROWSETYPES_H