1 /*

     2 * Copyright (c) 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:  Video session interface.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MVTENGSESSIONINFO_H

    21 #define MVTENGSESSIONINFO_H

    22 

    23 //  INCLUDES

    24 #include <e32std.h>

    25 

    26 // CONSTANTS

    27 

    28 // MACROS

    29 

    30 // DATA TYPES

    31 

    32 // FUNCTION PROTOTYPES

    33 

    34 // FORWARD DECLARATIONS

    35 

    36 // CLASS DECLARATION

    37 

    38 /**

    39 *  Abstraction for video telephony session with remote end.

    40 *

    41 *  @lib videoteleng

    42 *  @since 2.6

    43 */

    44 class MVtEngSessionInfo

    45     {

    46     public: // 

    47 

    48         /**

    49         * Session state

    50         * EIdle           Session not established.

    51         * EInitializing   Initializing MO session

    52         * ERemoteAlerting Remote end is alerting

    53         * EReceiving      Incoming session request from network

    54         * EConnected      Connection to peer is established.

    55         * ENegotiating    Handshaking with peer.

    56         * EOpen           Session active and media channels are open.

    57         * EClearing       Clearing connection.

    58         */

    59         enum TSessionState 

    60             {

    61             EUnknown = -1,

    62             EIdle,

    63             EInitializing,

    64             ERemoteAlerting,

    65             EReceiving,

    66             EConnected,

    67             ENegotiating,

    68             EOpen,

    69             EClearing

    70             };

    71         

    72         typedef TTimeIntervalSeconds TDuration;

    73 

    74         /**

    75         * Session direction

    76         * EDirectionNone In idle there's no direction .

    77         * EDirectionMO   Mobile originated sesison

    78         * EDirectionMT   Mobile terminated session

    79         */

    80         enum TDirection 

    81             {

    82             EDirectionNone,

    83             EDirectionMO,

    84             EDirectionMT

    85             };

    86         

    87         enum { KCallNameLength = 50 };

    88         

    89         typedef TBuf<KCallNameLength> TCallName;

    90         /**

    91         * CLI data related to a call

    92         */

    93         struct TCLI {

    94             // call id of the call

    95             TInt iCallId;

    96             

    97             // caller name

    98             TCallName iName;

    99             

   100             // indicates if voice call can be made to peer

   101             TBool iVoiceCallPossible;

   102             };

   103         

   104         /**

   105         * Returns session state

   106         * @aForcedRefresh if ETrue current state is forced to update.

   107         * Should be EFalse when called in frequently because forced

   108         * refresh is more time consuming (requires context switch)

   109         * @return

   110         */

   111         virtual TSessionState State( TBool aForcedRefresh ) const = 0;

   112 

   113         /**

   114         *

   115         * @return direction

   116         */

   117         virtual TInt GetDirection( TDirection& aDirection ) const = 0;

   118 

   119         /**

   120         *

   121         * @param 

   122         * @param aEnabled

   123         */

   124         virtual TInt GetDuration( 

   125             TDuration& aDuration,

   126             TBool& aEnabled ) const = 0;

   127         

   128         

   129         virtual TInt GetCLI( TCLI& aCLI ) const = 0;

   130     };

   131 

   132 

   133 #endif      // TVTENGSESSIONINFO_H

   134             

   135 // End of File