mmappfw_plat/mpx_playback_common_definition_api/inc/mpxplaybackmessage.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     1 /*
       
     2 * Copyright (c) 2004 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:  Playback message
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef TMPXPLAYBACKMESSAGE_H
       
    21 #define TMPXPLAYBACKMESSAGE_H
       
    22 
       
    23 
       
    24 #include <e32base.h>
       
    25 #include <mpxmessage.h>
       
    26 /**
       
    27 * Playback message type.
       
    28 *
       
    29 * @lib mpxcommon.lib
       
    30 */
       
    31 class TMPXPlaybackMessage : public TMPXMessage
       
    32     {
       
    33 public:
       
    34     enum TEvent
       
    35         {
       
    36         ENoEvent,
       
    37         EError, // EError must be 1. iData is error originating from player, iType=event type
       
    38         ECommandReceived, // iType=TMPXPlaybackCommand
       
    39         ECommandComplete, // iType=TMPXPlaybackCommand
       
    40         EPropertyChanged, // iType=TMPXPlaybackProperty; iData=new value
       
    41         EStateChanged, // iType=TMPXPlaybackState
       
    42         ESongCorrupt,
       
    43         ESongContainerChanged, // Need to call MMPXMedia::CollectionPathL() to get new path
       
    44         EInitializeComplete, // iData = ETrue if init was to start playback, else EFalse.
       
    45         ESongChanged, // iData=new index; need to query to get new properties (e.g. duration, title etc.)
       
    46         EPlayerChanged, // Need to call MMPXPlaybackUtility::CurrentPlayer() to get new features
       
    47         EActivePlayerChanged, // iData=active/inactive (ETrue/EFalse); iType (ETrue,rebind to  ActivePlayerMode)
       
    48         ESubPlayersChanged, // Need to query to get new list of sub players
       
    49         EPlayerSelectionChanged, // Need to query MMPXPlayerManager::GetSelectionL()
       
    50         EDownloadStarted, // iData=total expected bytes
       
    51         EDownloadUpdated, // iData=total bytes so far
       
    52         EDownloadComplete, // iData=total bytes downloaded
       
    53         EDownloadPositionChanged, // iData=total bytes so far
       
    54         EDownloadStateChanged, // iData=TMPXPlaybackPdDownloadState
       
    55         EDownloadCmdPauseDownload, // iData=transaction ID
       
    56         EDownloadCmdResumeDownload, // iData=transaction ID
       
    57         EDownloadCmdCancelDownload, // iData=transaction ID
       
    58         EAccessoryChanged, // iType=TAccessoryMode
       
    59         EMediaChanged, // When the song/playlist hasn't, but data may become available
       
    60         ESkipping, //skipping event, iData=+1, skipping forward, -1, skipping backward
       
    61         ESkipEnd, //skipping end
       
    62         EPlayerUnavailable,
       
    63         EPlaylistUpdated, // playlist updated
       
    64         EReachedEndOfPlaylist, // playback or skipping forward has reached end of playlist
       
    65         EDownloadFileMoved
       
    66         };
       
    67 public:
       
    68     /**
       
    69     *  C++ constructor.
       
    70     *
       
    71     *  @since S60 3.2.3
       
    72     *  @param aEvent event
       
    73     *  @param aType event type
       
    74     *  @param aData optional data
       
    75     */
       
    76     inline TMPXPlaybackMessage(TEvent aEvent,TInt aType = 0,TInt aData = 0);
       
    77 
       
    78     /**
       
    79     *  C++ copy constructor.
       
    80     *
       
    81     *  @since S60 3.2.3
       
    82     *  @param aMsg source message
       
    83     */
       
    84     inline TMPXPlaybackMessage(const TMPXPlaybackMessage& aMsg);
       
    85 
       
    86     /**
       
    87     *  Overloaded assignment operator.
       
    88     *
       
    89     *  @since S60 3.2.3
       
    90     *  @param aMsg source message
       
    91     */
       
    92     inline TMPXPlaybackMessage& operator=(const TMPXPlaybackMessage& aMsg);
       
    93 
       
    94     /**
       
    95     *  C++ constructor.
       
    96     *
       
    97     *  @since S60 3.2.3
       
    98     */
       
    99     inline TMPXPlaybackMessage();
       
   100     };
       
   101 
       
   102 #include "mpxplaybackmessage.inl"
       
   103 
       
   104 #endif // TMPXPLAYBACKMESSAGE_H