vtengines/videoteleng/Inc/Commands/vtengcommands.h
changeset 0 ed9695c8bcbe
equal deleted inserted replaced
-1:000000000000 0:ed9695c8bcbe
       
     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 telephony engine command identifiers.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef CVTENGCOMMANDS_H
       
    21 #define CVTENGCOMMANDS_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32def.h>
       
    25 
       
    26 //  DATA TYPES
       
    27 typedef TInt TVtEngCommandId;
       
    28 
       
    29 // CONSTANTS
       
    30 
       
    31 
       
    32 const TInt KVtEngCommandNone = -1;
       
    33 
       
    34 const TInt KVtEngCommandBase = 0;
       
    35 
       
    36 /**
       
    37 * Configuration commands
       
    38 */
       
    39 const TInt KVtEngConfigureCommandBase = KVtEngCommandBase + 100;
       
    40 
       
    41 // Allocates essential resources when application starts up
       
    42 const TInt KVtEngInitializeEngine     = KVtEngConfigureCommandBase + 1;
       
    43 
       
    44 // Resets engine. Use when all video calls are ended.
       
    45 const TInt KVtEngResetEngine          = KVtEngConfigureCommandBase + 2;
       
    46 
       
    47 /**
       
    48 * Makes voice call to existing peer.
       
    49 */
       
    50 const TInt KVtEngSwitchToVoice        = KVtEngConfigureCommandBase + 4;
       
    51 
       
    52 // Allocates essential resources when application starts up - TEST MODE
       
    53 const TInt KVtEngInitializeEngineDiag     = KVtEngConfigureCommandBase + 50;
       
    54 
       
    55 // Allocates essential resources when application starts up - TEST MODE
       
    56 const TInt KVtEngInitializeEngineTest     = KVtEngConfigureCommandBase + 51;
       
    57 //
       
    58 
       
    59 /**
       
    60 * Media commands for controlling local display and sending
       
    61 * of media (audio/video) to the peer.
       
    62 */
       
    63 const TInt KVtEngMediaCommandBase   = KVtEngConfigureCommandBase + 100;      // 200
       
    64 
       
    65 // Actual commands
       
    66 
       
    67 /**
       
    68 * Selects source,
       
    69 * @see MVtEngMedia::TMediaSource for command parameters.
       
    70 */
       
    71 const TInt KVtEngSetSource            = KVtEngMediaCommandBase + 1;
       
    72 
       
    73 /**
       
    74 * Async
       
    75 * Initializes default or selected camera.
       
    76 * Does not take parameters. See KVtEngSetSource command parameters.
       
    77 */
       
    78 const TInt KVtEngPrepareCamera        = KVtEngMediaCommandBase + 2;
       
    79 
       
    80 /**
       
    81 * prepares engine to pass view finder frames to UI
       
    82 * @see MVtEngMedia::TVtEngViewFinderConfig for command parameters.
       
    83 */
       
    84 const TInt KVtEngPrepareViewFinder    = KVtEngMediaCommandBase + 3;
       
    85 
       
    86 /**
       
    87 * Sync
       
    88 * prepares engine to render view finder frames using DSA
       
    89 * @see MVtEngMedia::TRenderingOptionsDSA for command parameters.
       
    90 */
       
    91 const TInt KVtEngPrepareViewFinderDSA = KVtEngMediaCommandBase + 4;
       
    92 
       
    93 /**
       
    94 * Async
       
    95 * Starts view finder
       
    96 * @see MVtEngMedia::TRenderingOptionsDSA for command parameters.
       
    97 */
       
    98 const TInt KVtEngStartViewFinder      = KVtEngMediaCommandBase + 5;
       
    99 
       
   100 /**
       
   101 * Async
       
   102 * View finder control commands, do not take parameters.
       
   103 */
       
   104 const TInt KVtEngPauseViewFinder      = KVtEngMediaCommandBase + 6;
       
   105 const TInt KVtEngStopViewFinder       = KVtEngMediaCommandBase + 7;
       
   106 
       
   107 /**
       
   108 * Prepares engine for rendering video (with DSA) from peer
       
   109 * @see MVtEngMedia::TRenderingOptionsDSA for command parameters.
       
   110 */
       
   111 const TInt KVtEngPrepareRemoteRenderDSA  = KVtEngMediaCommandBase + 8;
       
   112 
       
   113 /**
       
   114 * Prepares engine for rendering video from peer
       
   115 * @see MVtEngMedia::TVtEngViewFinderConfig for command parameters.
       
   116 */
       
   117 const TInt KVtEngPrepareRemoteRender  = KVtEngMediaCommandBase + 9;
       
   118 
       
   119 /**
       
   120 * Remote video rendering commands, do not take parameters.
       
   121 */
       
   122 const TInt KVtEngStartRenderRemote    = KVtEngMediaCommandBase + 10;
       
   123 const TInt KVtEngPauseRenderRemote    = KVtEngMediaCommandBase + 11;
       
   124 const TInt KVtEngStopRenderRemote     = KVtEngMediaCommandBase + 12;
       
   125 
       
   126 /**
       
   127 * Media transport control commands, do not take parameters.
       
   128 */
       
   129 // Audio
       
   130 const TInt KVtEngMuteOutgoingAudio     = KVtEngMediaCommandBase + 13;
       
   131 const TInt KVtEngUnmuteOutgoingAudio    = KVtEngMediaCommandBase + 14;
       
   132 const TInt KVtEngPauseIncomigAudio      = KVtEngMediaCommandBase + 15;
       
   133 const TInt KVtEngResumeIncomigAudio     = KVtEngMediaCommandBase + 16;
       
   134 
       
   135 /**
       
   136 * Sync.
       
   137 * Sets video source provider zoom step.
       
   138 * Parameter is TInt from zero to maximum zoom step.
       
   139 * @see MVtEngMedia::GetMaxZoomStep.
       
   140 */
       
   141 const TInt KVtEngSetZoomStep            = KVtEngMediaCommandBase + 17;
       
   142 
       
   143 /**
       
   144 * Sync
       
   145 * Sets size of remote video, parameter is of type TSize
       
   146 */
       
   147 const TInt KVtEngSetRemoteVideoSize       = KVtEngMediaCommandBase + 18;
       
   148 
       
   149 /**
       
   150 * Sets UI foreground state (ETrue or EFalse)
       
   151 */
       
   152 const TInt KVtEngSetUIForeground            = KVtEngMediaCommandBase + 19;
       
   153 
       
   154 /**
       
   155 * Freeze provider video.
       
   156 */
       
   157 const TInt KVtEngFreeze                     = KVtEngMediaCommandBase + 20;
       
   158 
       
   159 /**
       
   160 * Unfreeze provider video.
       
   161 */
       
   162 const TInt KVtEngUnfreeze                   = KVtEngMediaCommandBase + 21;
       
   163 
       
   164 /**
       
   165 * Adjusts video quality.
       
   166 */
       
   167 const TInt KVtEngSetVideoQuality            = KVtEngMediaCommandBase + 22;
       
   168 
       
   169 /**
       
   170 * Initialize image sharing.
       
   171 */
       
   172 const TInt KVtEngInitializeShareImage       = KVtEngMediaCommandBase + 23;
       
   173 
       
   174 /**
       
   175 * Start image sharing (must be initialized first).
       
   176 */
       
   177 const TInt KVtEngStartShareImage            = KVtEngMediaCommandBase + 24;
       
   178 
       
   179 /**
       
   180 * Stop image sharing.
       
   181 */
       
   182 const TInt KVtEngStopShareImage             = KVtEngMediaCommandBase + 25;
       
   183 
       
   184 /**
       
   185 * Sync
       
   186 * prepares engine to render view finder frames using DP
       
   187 * @see MVtEngMedia::TRenderingOptionsDP for command parameters.
       
   188 */
       
   189 const TInt KVtEngPrepareViewFinderDP        = KVtEngMediaCommandBase + 26;
       
   190 
       
   191 /**
       
   192 * Prepares engine for rendering video (with DP) from peer
       
   193 * @see MVtEngMedia::TRenderingOptionsDP for command parameters.
       
   194 */
       
   195 const TInt KVtEngPrepareRemoteRenderDP      = KVtEngMediaCommandBase + 27;
       
   196 
       
   197 /**
       
   198 * Engine reintializes camera instance when layout change happens and active
       
   199 * provider is onboard camera. If anyother provider is selected, then nothing
       
   200 * will be done by the engine.
       
   201 */
       
   202 const TInt KVtEngHandleLayoutChange         = KVtEngMediaCommandBase + 28;
       
   203 
       
   204 /**
       
   205  * Sync
       
   206  * Request update last remote video frame through MVtEngFrameObserver::vtSetFrame 
       
   207  */
       
   208 const TInt KVtEngRequestLastRemoteFrame  = KVtEngMediaCommandBase + 29;
       
   209 
       
   210 
       
   211 const TInt KVtEngPrepareRemoteRenderNGA      = KVtEngMediaCommandBase + 30;
       
   212 
       
   213 /**
       
   214 * Audio control
       
   215 */
       
   216 const TInt KVtEngAudioCommandBase       = KVtEngMediaCommandBase + 100; // 300
       
   217 
       
   218 // Actual commands
       
   219 
       
   220 /**
       
   221 * Sets output volume level [1..10] for active audio device
       
   222 */
       
   223 const TInt KVtEngSetAudioVolume         = KVtEngAudioCommandBase + 1;
       
   224 
       
   225 /**
       
   226 * Audiorouting command
       
   227 */
       
   228 const TInt KVtEngSetAudioRouting        = KVtEngAudioCommandBase + 2;
       
   229 
       
   230 /**
       
   231 * Increase volume by one step.
       
   232 */
       
   233 const TInt KVtEngIncreaseAudioVolume    = KVtEngAudioCommandBase + 3;
       
   234 
       
   235 /**
       
   236 * Decrease volume by one step.
       
   237 */
       
   238 const TInt KVtEngDecreaseAudioVolume    = KVtEngAudioCommandBase + 4;
       
   239 
       
   240 /**
       
   241 * Session commands
       
   242 */
       
   243 const TInt KVtEngSessionCommandBase     = KVtEngAudioCommandBase + 100;
       
   244 
       
   245 // Actual commands
       
   246 
       
   247 /**
       
   248 * Terminates session and tears down connection
       
   249 */
       
   250 const TInt KVtEngTerminateSession       = KVtEngSessionCommandBase + 1;
       
   251 
       
   252 const TInt KVtEngSendDtmf               = KVtEngSessionCommandBase + 2;
       
   253 
       
   254 /**
       
   255 * Starts sending a DTMF tone. Takes TChar parameter. Sync
       
   256 */
       
   257 const TInt KVtEngStartDtmfTone          = KVtEngSessionCommandBase + 3;
       
   258 
       
   259 /**
       
   260 * Stops previously started tone. Does not take parametners. Sync
       
   261 */
       
   262 const TInt KVtEngStopDtmfTone           = KVtEngSessionCommandBase + 4;
       
   263 
       
   264 /**
       
   265 * Remote supports UII DTMF.
       
   266 */
       
   267 const TInt KVtEngSetUIIDtmfSupport           = KVtEngSessionCommandBase + 5;
       
   268 
       
   269 /**
       
   270 * Remote supports UII basic string.
       
   271 */
       
   272 const TInt KVtEngSetUIIBasicStringSupport = KVtEngSessionCommandBase + 6;
       
   273 
       
   274 /**
       
   275 * Remote supports UII IA5 string.
       
   276 */
       
   277 const TInt KVtEngSetUIIIA5StringSupport   = KVtEngSessionCommandBase + 7;
       
   278 
       
   279 /**
       
   280 * Remote supports UII general string.
       
   281 */
       
   282 const TInt KVtEngSetUIIGeneralStringSupport = KVtEngSessionCommandBase + 8;
       
   283 
       
   284 
       
   285 /**
       
   286 * Extension commands.
       
   287 */
       
   288 const TInt KVtEngExtensionCommandBase   = KVtEngSessionCommandBase + 100; //500
       
   289 const TInt KVtEngSetContrast            = KVtEngExtensionCommandBase + 1;
       
   290 const TInt KVtEngSetBrightness          = KVtEngExtensionCommandBase + 2;
       
   291 const TInt KVtEngSetWhiteBalance        = KVtEngExtensionCommandBase + 3;
       
   292 const TInt KVtEngSetColorTone           = KVtEngExtensionCommandBase + 4;
       
   293 #if defined ( RD_VT_RTF )
       
   294 const TInt KVtEngStartRecord			= KVtEngExtensionCommandBase + 5;
       
   295 const TInt KVtEngStopRecord				= KVtEngExtensionCommandBase + 6;
       
   296 #endif // RD_VT_RTF
       
   297 
       
   298 #endif      // CVTENGCOMMANDS_H
       
   299 
       
   300 // End of File