upnpsharing/upnpdlnaprofiler/inc/upnpprofiler.h
changeset 0 7f85d04be362
equal deleted inserted replaced
-1:000000000000 0:7f85d04be362
       
     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:      Definition of a MUpnpProfiler interface class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 #ifndef M_UPNPPROFILER_H
       
    24 #define M_UPNPPROFILER_H
       
    25 
       
    26 
       
    27 // system includes
       
    28 #include <e32base.h>
       
    29 
       
    30 // user includes
       
    31 // NONE
       
    32 
       
    33 // forward declarations
       
    34 class CDesC16ArrayFlat;
       
    35 
       
    36 // constants
       
    37 // NONE
       
    38 
       
    39 /**
       
    40  *  MUpnpProfiler interface class
       
    41  *
       
    42  *  MUpnpProfiler defines an interface for media solver plugins. It contains
       
    43  *  methods for querying the profiles supported by this solver plugin and
       
    44  *  for resolving a DLNA profile of a given file.
       
    45  *
       
    46  *  @lib dlnaprofiler.lib
       
    47  *  @since S60 v3.1
       
    48  */
       
    49 class MUpnpProfiler
       
    50     {
       
    51 
       
    52 public:
       
    53 
       
    54     virtual ~MUpnpProfiler() {};
       
    55     
       
    56     /**
       
    57      * SupportedProfilesL returns DLNA profiles that are currently supported.
       
    58      *
       
    59      * @since S60 v3.1
       
    60      * @param aProfiles Descriptor array where supported DLNA profiles are 
       
    61      *                  added.
       
    62      * @return TInt Error code, KErrNone if successfull.
       
    63      */
       
    64     virtual IMPORT_C TInt SupportedProfilesL( 
       
    65                                     CDesC16ArrayFlat* aProfiles ) const = 0;
       
    66 
       
    67     /**
       
    68      * ProfileForFileL is for resolving a DLNA profile of a given file.
       
    69      * Besides of file name, also mime type of the file is passed as a 
       
    70      * parameter in order to avoid re-opening of the file.
       
    71      *
       
    72      * @since S60 v3.1
       
    73      * @param aFileName Filename of the file which is to be resolved.
       
    74      * @param aMimeType Mime type of the file which is to be resolved.
       
    75      * @param aFile Handle to opened file specified by aFilename
       
    76      * @return DLNA profile of the file as a HBufC*, 
       
    77      *         NULL if could not be resolved
       
    78      */
       
    79     virtual IMPORT_C HBufC* ProfileForFileL( const TDesC& aFilename, 
       
    80                                              const TDesC8& aMimetype, 
       
    81                                              RFile& aFile 
       
    82                                            ) = 0;
       
    83 
       
    84     };
       
    85 
       
    86 
       
    87 #endif // M_UPNPPROFILER_H