phoneapp/phoneringingtoneplayer/inc/mphonevideoplayer.h
changeset 78 baacf668fe89
parent 76 cfea66083b62
equal deleted inserted replaced
76:cfea66083b62 78:baacf668fe89
     1 /*
       
     2 * Copyright (c) 2009 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:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef M_PHONEVIDEOPLAYER_H
       
    19 #define M_PHONEVIDEOPLAYER_H
       
    20 
       
    21 // Forward declarations
       
    22 class MPhoneVideoPlayerObserver;
       
    23 
       
    24 /**
       
    25  *  Abstract video playing interface.
       
    26  *
       
    27  *
       
    28  *  @lib Phone.exe
       
    29  *  @since S60 v3.2
       
    30  */
       
    31 class MPhoneVideoPlayer
       
    32     {
       
    33 public:
       
    34     /**  Play modes */
       
    35     enum TPlayMode
       
    36         {
       
    37         EPlayInLoop,
       
    38         EPlayOnce,
       
    39         EPlayAscending    
       
    40         }; 
       
    41 
       
    42 public:
       
    43     /**
       
    44     * Plays given video ringing tone.
       
    45     *
       
    46     * @since S60 S60 v3.2
       
    47     * @param aFileName File name.
       
    48     * @param aPlayMode Playing mode.
       
    49     * @param aVolumeLevel Playing volume, range: 0-10.
       
    50     * @param aArbitraryScaling Set ETrue if arbitrary scaling supported.
       
    51     * @param aObserver Observer for playback events.
       
    52     */
       
    53     virtual void PlayVideoRingTone( const TDesC& aFileName,
       
    54                                     TPlayMode aPlayMode,
       
    55                                     TInt aVolumeLevel,
       
    56                                     TBool aArbitraryScaling,
       
    57                                     MPhoneVideoPlayerObserver* aObserver ) = 0;
       
    58     
       
    59     /**
       
    60     * Stops ringing.
       
    61     *
       
    62     * @since S60 S60 v3.2
       
    63     */
       
    64     virtual void StopVideoRingTone() = 0;
       
    65     
       
    66     /**
       
    67     * Mutes ringing tone playing.
       
    68     *
       
    69     * @since S60 S60 v3.2
       
    70     */    
       
    71     virtual void MuteVideoRingTone() = 0;
       
    72         
       
    73     /**
       
    74     * Cancels ringing tone playing.
       
    75     *
       
    76     * @since S60 S60 v3.2
       
    77     */
       
    78     virtual void CancelVideoRingTone() = 0;
       
    79     };
       
    80 
       
    81 
       
    82 #endif // M_PHONEVIDEOPLAYER_H