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