os/mm/mmplugins/mmfwplugins/src/Plugin/Controller/Video/AviPlayController/subtitlesource.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     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 #ifndef SUBTITLESOURCE_H
    17 #define SUBTITLESOURCE_H
    18 
    19 /**
    20 @file
    21 @internalTechnology 
    22 */
    23 
    24 /** The generic interface for the subtitle source */ 
    25 class MSubtitleSource
    26     {
    27 public:
    28     /** Write subtitle source data to a buffer 
    29     
    30     @param aBuffer the buffer to be populated by srt subtitle source data
    31     @return A system-wide error code
    32     */
    33     virtual TInt GetBuffer(TDes8& aBuffer) = 0;
    34     
    35     /** Sets the the current subtitle source position
    36     
    37     @param aPosition Offset from the start location
    38     @return A system-wide error code
    39     */
    40     virtual TInt SetPosition(TInt aPosition) = 0;
    41 
    42     /** Get the current subtitle language. 
    43     
    44     @return The current subtitle stream language 
    45     @leave If an error occurs, the method will leave with a system-wide error code.
    46     */
    47     virtual TLanguage SubtitleLanguageL() = 0;
    48         
    49     /** Return all languages supported in the current video stream
    50     
    51     @return All currently supported languages
    52     @leave If an error occurs, the method will leave with a system-wide error code.
    53     */
    54     virtual void GetSupportedSubtitleLanguagesL(RArray<TLanguage>& aLanguages) = 0;
    55     
    56     /** Set the subtitle language
    57     
    58     @param aLanguage the language to be used by the decoder
    59     @leave If an error occurs, the method will leave with a system-wide error code.
    60     */
    61     virtual void SetSubtitleLanguageL(TLanguage aLanguage) = 0;
    62     };
    63 
    64 #endif //SUBTITLESOURCE_H
    65