devsoundextensions/telephonyaudiorouting/Session/inc/TelephonyAudioRoutingManagerSession.h
author hgs
Tue, 02 Nov 2010 12:28:51 +0000
changeset 6 fe9d1bf55678
parent 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk46_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
/*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
* All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
* Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
* Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
* Description:   This class is the main interface to the TelephonyAudioRoutingServer. 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
*				 It implements the client-side session.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
                                      
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
                                                                                 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
#ifndef TELEPHONYAUDIOROUTINGMANAGERSESSION_H                                                
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#define TELEPHONYAUDIOROUTINGMANAGERSESSION_H                                                  
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
                                                                                 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
#include <e32base.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
#include <e32std.h>     
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
#include "MTelephonyAudioRoutingPolicyObserver.h"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
#include "TelephonyAudioRoutingClientServer.h"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
  
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
class CTelephonyAudioRoutingPolicyRequest;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
class CTelephonyAudioRoutingManager;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
// CLASS DECLARATION
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
*  Main interface to the TelephonyAudioRoutingServer. 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
*  It implements the client-side session.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
*  @lib TelephonyAudioRoutingManagerSession.lib
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
*  @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
*/                                     
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
                                                                              
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
class RTelephonyAudioRoutingManagerSession : public RSessionBase                                   
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
    { 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
                                                                               
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
	public:                                                                          
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
                                                                        
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
    	IMPORT_C RTelephonyAudioRoutingManagerSession();    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
    public:                                                    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
         
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
    	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
        * Connects a policy client to the server.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
        * @param aAudioRoutingManager: Client, aPolicyObserver: client observer class
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
        * @return TInt: if connection was successful
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
    	IMPORT_C TInt Connect(CTelephonyAudioRoutingManager& aAudioRoutingManager, MTelephonyAudioRoutingPolicyObserver& aPolicyObserver);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
    	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
        /**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
        * Closes connection to the server.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
        * @param none
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
        IMPORT_C void Close();                                                      
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
                                      
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
	    /**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
        * Used by policy to notify server of audio output changes.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
        * @param aOutput: client obj
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
	    IMPORT_C void OutputChanged(CTelephonyAudioRouting::TAudioOutput aOutput); 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
	    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
	    /**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
        * Used by policy to notify server that requested output change completed
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
        * @param aOutput: client obj, aError: error code for operation
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
	    IMPORT_C void OutputChangeCompleted(CTelephonyAudioRouting::TAudioOutput aOutput, TInt aError); 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
	    	    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
	    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
    	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
        * Used by policy session to get notification whenever any of the clients sends
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
        * a SetOutput request.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
        * @param none
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
    	IMPORT_C void MonitorOutputChangeRequest();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
    	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
    	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
        * Sets policy session Id.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    97
        * @param none
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    98
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    99
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   100
    	IMPORT_C void SetPolicySessionIdL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
    	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
    	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
        * Cancel a previously send request.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
        * @param aRequest: request to cancel
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
    	IMPORT_C void CancelRequest(TTelAudRtngServRqst aRequest);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
    	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
    	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
        * Used by policy session to notify server if the available audio
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
        * output change.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
        * @param aOutputs: array of available outputs
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
    	IMPORT_C void AvailableOutputsChangedL(const TArray<CTelephonyAudioRouting::TAudioOutput>& aOutputs);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   118
    	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   119
     	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   120
        * Provide caller with iAudioOutputPkg
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   121
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   122
        * @param none
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   123
        * @return iAudioOutputPkg
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   124
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   125
    	IMPORT_C  TPckgBuf<CTelephonyAudioRouting::TAudioOutput>& AudioOutputPkg();    	 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   126
    	 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   127
	private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   128
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   129
   		/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   130
        * Start asynchronous request handlers.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   131
        * @since Series 60 3.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   132
        * @param aAudioRoutingManager: client obj, aPolicyObserver: observer obj for callbacks
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   133
        * @return void
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   134
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   135
   		void StartPolicyRequestHandlersL( CTelephonyAudioRoutingManager& aAudioRoutingManager, MTelephonyAudioRoutingPolicyObserver& aPolicyObserver );
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   136
     
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   137
	private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   138
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   139
  		TPckgBuf<CTelephonyAudioRouting::TAudioOutput> iAudioOutputPkg;      
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   140
		CTelephonyAudioRoutingPolicyRequest* iPolicyRequest;	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   141
		TBool iConnected;  
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   142
                                                                             
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   143
    };                                                                           
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   144
                                      
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   145
                                                                                 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   146
#endif         //TELEPHONYAUDIOROUTINGSESSION_H                                
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   147
                                                                                 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   148