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.
sl@0
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#ifndef SUBTITLESOURCE_H
sl@0
    17
#define SUBTITLESOURCE_H
sl@0
    18
sl@0
    19
/**
sl@0
    20
@file
sl@0
    21
@internalTechnology 
sl@0
    22
*/
sl@0
    23
sl@0
    24
/** The generic interface for the subtitle source */ 
sl@0
    25
class MSubtitleSource
sl@0
    26
    {
sl@0
    27
public:
sl@0
    28
    /** Write subtitle source data to a buffer 
sl@0
    29
    
sl@0
    30
    @param aBuffer the buffer to be populated by srt subtitle source data
sl@0
    31
    @return A system-wide error code
sl@0
    32
    */
sl@0
    33
    virtual TInt GetBuffer(TDes8& aBuffer) = 0;
sl@0
    34
    
sl@0
    35
    /** Sets the the current subtitle source position
sl@0
    36
    
sl@0
    37
    @param aPosition Offset from the start location
sl@0
    38
    @return A system-wide error code
sl@0
    39
    */
sl@0
    40
    virtual TInt SetPosition(TInt aPosition) = 0;
sl@0
    41
sl@0
    42
    /** Get the current subtitle language. 
sl@0
    43
    
sl@0
    44
    @return The current subtitle stream language 
sl@0
    45
    @leave If an error occurs, the method will leave with a system-wide error code.
sl@0
    46
    */
sl@0
    47
    virtual TLanguage SubtitleLanguageL() = 0;
sl@0
    48
        
sl@0
    49
    /** Return all languages supported in the current video stream
sl@0
    50
    
sl@0
    51
    @return All currently supported languages
sl@0
    52
    @leave If an error occurs, the method will leave with a system-wide error code.
sl@0
    53
    */
sl@0
    54
    virtual void GetSupportedSubtitleLanguagesL(RArray<TLanguage>& aLanguages) = 0;
sl@0
    55
    
sl@0
    56
    /** Set the subtitle language
sl@0
    57
    
sl@0
    58
    @param aLanguage the language to be used by the decoder
sl@0
    59
    @leave If an error occurs, the method will leave with a system-wide error code.
sl@0
    60
    */
sl@0
    61
    virtual void SetSubtitleLanguageL(TLanguage aLanguage) = 0;
sl@0
    62
    };
sl@0
    63
sl@0
    64
#endif //SUBTITLESOURCE_H
sl@0
    65