1 /*

     2 * Copyright (c) 2002-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:  MTag is an abstraction for a voice tag. MTag memebrs consist of 

    15 *               a context, speech item, and RRD. 

    16 *

    17 */

    18 

    19 

    20 #ifndef NSSVASMTAG_H

    21 #define NSSVASMTAG_H

    22 

    23 // include 

    24 

    25 #include <nssvasmcontext.h>

    26 #include <nssvasmrrd.h>

    27 #include <nssvasmspeechitem.h>

    28 

    29 /**

    30 * MTag is the interface class for tag processing.

    31 * A voice tag consists of a context, a RRD, and a speech item. A context can have

    32 * multiple voice tags. Context represents the category (application) to which the tag

    33 * belongs. RRD represents the result data for a tag. Speech item represents the speech

    34 * speech data and speech activities for a tag. A client will not create a tag diectly, 

    35 * but use the methods in tag manager to get a tag. After getting a tag, the client can

    36 * get the RRD and speech item objects using the following methods in MTag. A context needs

    37 * to be created before creating a tag. After a tag is used, it needs to be deleted. Deleting

    38 * a tag deletes its RRD and speech item, and thus they donot have to be deleted expicitly,

    39 * @lib NssVASApi.lib

    40 * @since 2.0

    41 */

    42 class MNssTag

    43     {

    44     public:

    45     

    46         /**

    47         * Get the context 

    48     	* @since 2.0

    49         * @return context object to which this tag belongs

    50         */	

    51         virtual MNssContext* Context() = 0;

    52 

    53         /**

    54         * Get the RRD

    55     	* @since 2.0

    56         * @return RRD object for this tag

    57         */

    58     	virtual MNssRRD* RRD() = 0;

    59 

    60         /**

    61         * Get the speech item

    62     	* @since 2.0

    63         * @return speech item for this tag

    64         */

    65     	virtual MNssSpeechItem* SpeechItem() = 0;

    66 

    67         /**

    68         * virtual destructor for proper clean up

    69         */

    70     	virtual ~MNssTag(){}

    71     	

    72     };

    73 

    74 #endif // NSSVASMTAG_H

    75             

    76 // End of File