mmappfw_plat/playlist_engine_api/inc/mpxplaylistpluginobserver.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     1 /*
       
     2 * Copyright (c) 2006 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:  Playlist plugin observer
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MMPXPLAYLISTPLUGINOBSERVER_H
       
    20 #define MMPXPLAYLISTPLUGINOBSERVER_H
       
    21 
       
    22 
       
    23 #include <mpxmedia.h>
       
    24 
       
    25 /**
       
    26 *  This interface is not visible to the playlist
       
    27 *  engine client. This observer interface is used internally by a plugin for request
       
    28 *  completion notification.
       
    29 *
       
    30 *  CMPXPlaylistEngine implements this interface. When a plugin completes a
       
    31 *  InternalizePlaylistL or ExternalizePlaylistL request, the appropriate
       
    32 *  HandlePlaylistL is called by the plugin to notify CMPXPlaylistEngine.
       
    33 *
       
    34 *  @lib mpxplaylistengine.lib
       
    35 */
       
    36 NONSHARABLE_CLASS(MMPXPlaylistPluginObserver) 
       
    37     {
       
    38     public:
       
    39 
       
    40         /**
       
    41         *  Callback for InternalizePlaylistL.
       
    42         *
       
    43         *  @since S60 3.2.3
       
    44         *  @param aPlaylist a list of media parsed from the playlist file. NULL
       
    45         *         if there is an error. client takes ownership of this object.
       
    46         *  @param aError error code    
       
    47         *  @param aCompleted a flag that indicates if internalize playlist command has
       
    48         *         been fully processed. EFalse if not. In this case, there will be
       
    49         *         subsequent calls to HandlePlaylistL for the same playlist with the
       
    50         *         segmented results.ETrue if there are no more results to be sent to
       
    51         *         the observer.        
       
    52         */
       
    53         virtual void HandlePlaylistL(CMPXMedia* aPlaylist,
       
    54                                      const TInt aError,
       
    55                                      const TBool aCompleted) = 0;
       
    56 
       
    57         /**
       
    58         *  Callback for ExternalizePlaylistL.
       
    59         *
       
    60         *  @since S60 3.2.3
       
    61         *  @param aPlaylistUri URI for the playlist which has been externalized
       
    62         *  @param aError error code    
       
    63         */
       
    64         virtual void HandlePlaylistL(const TDesC& aPlaylistUri,
       
    65                                      const TInt aError) = 0;        
       
    66     };
       
    67 
       
    68 #endif      // MMPXPLAYLISTPLUGINOBSERVER_H
       
    69 
       
    70