imagingandcamerafws/camerafw/Include/ecamdef.h
changeset 0 40261b775718
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @internalTechnology
       
    19  @released
       
    20 */
       
    21 #ifndef ECAM_DEF_H
       
    22 #define ECAM_DEF_H
       
    23 
       
    24 #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    25 #include <ecamuidsconst.hrh>
       
    26 #include <ecamuidsdef.hrh>
       
    27 #endif
       
    28 /** 
       
    29 Viewfinder fading effect has been set.
       
    30 This event should be packed in TECAMEvent2 class.
       
    31 
       
    32 Note: TECAMEvent2::iParam represents viewfinder handle.
       
    33 
       
    34 @internalTechnology
       
    35 */
       
    36 static const TUid KUidECamEvent2ViewFinderFadingEffect = {KUidECamEvent2ViewFinderFadingEffectUidValue};
       
    37 				   
       
    38 /** 
       
    39 Event providing focussing feedback. The focussing feedback will be provided whenever the focussing state changes for the
       
    40 selected spot combination. 
       
    41 This event should be packed in TECAMEvent2 class.
       
    42 Note: TECAMEvent2::iParam represents bitfield of chosen spots which are in focus.
       
    43 Note: TECAMEvent2::iParam1 represents bitfield of chosen spots which are not in focus.
       
    44 
       
    45 @internalTechnology
       
    46 */
       
    47 static const TUid  KECamEvent2ImageCaptureControlFocussingInformation = {KECamEvent2ImageCaptureControlFocussingInformationUidValue};
       
    48 
       
    49 /** 
       
    50 Focussing spot combination. This event tells about completion of the setting operation for the spot combination.
       
    51 This event should be packed in TECAMEvent2 class.
       
    52 
       
    53 @note  static_cast<CCamera::CCameraAdvancedSettings::TFocusMode>(TECAMEvent2::iParam) represents the focus mode for 
       
    54 	   which the spot combination has to be set for receiving focussing feedback.
       
    55 
       
    56 @internalTechnology
       
    57 */
       
    58 static const TUid KUidECamEvent2ImageCaptureControlSpotCombination = {KUidECamEvent2ImageCaptureControlSpotCombinationUidValue};
       
    59 
       
    60 /** 
       
    61 Viewfinder magnification has been set.
       
    62 This event should be packed in TECAMEvent2 class.
       
    63 
       
    64 Note: TECAMEvent2::iParam represents viewfinder handle.
       
    65 
       
    66 @internalTechnology
       
    67 */
       
    68 static const TUid KUidECamEvent2ViewFinderMagnification = {KUidECamEvent2ViewFinderMagnificationUidValue};
       
    69 
       
    70 /**
       
    71 Notifies the current camera reserver that the camera control will be forcefully overtaken by another requesting client 
       
    72 after a specific time interval.
       
    73 
       
    74 This TUid is available from the following methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L():
       
    75 void CCamera::CCameraAdvancedSettings::GetSupportedSettingsL(RArray<TUid>& aSettings) const;
       
    76 void CCamera::CCameraAdvancedSettings::GetActiveSettingsL(RArray<TUid>& aActiveSettings) const;
       
    77 void CCamera::CCameraAdvancedSettings::GetDisabledSettingsL(RArray<TUid>& aDisabledSettings) const;
       
    78 
       
    79 @note   TTimeIntervalMicroSeconds32(TECAMEvent2::iParam) represents the maximum time to wait. 
       
    80 		TECAMEvent2::iParam needs to be passed as argument in order to construct the TTimeIntervalMicroSeconds32 object.
       
    81 
       
    82 Note: TECAMEvent2::iParam1 represents the priority of the requestor client to whom the camera control will be forcibly 
       
    83 passed after a specific time interval.
       
    84 
       
    85 @internalTechnology
       
    86 */
       
    87 static const TUid KUidECamEvent2CameraRequestForcedTimedTakeOver = {KUidECamEvent2CameraRequestForcedTimedTakeOverUidValue};
       
    88 
       
    89 /**
       
    90 Notifies the current camera reserver that another client is requesting for camera control in a specific time interval.
       
    91 
       
    92 This TUid is available from the following methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L():
       
    93 void CCamera::CCameraAdvancedSettings::GetSupportedSettingsL(RArray<TUid>& aSettings) const;
       
    94 void CCamera::CCameraAdvancedSettings::GetActiveSettingsL(RArray<TUid>& aActiveSettings) const;
       
    95 void CCamera::CCameraAdvancedSettings::GetDisabledSettingsL(RArray<TUid>& aDisabledSettings) const;
       
    96 
       
    97 @note   TTimeIntervalMicroSeconds32(TECAMEvent2::iParam) represents the maximum requested time within which the current 
       
    98 		reserver may release the camera if it wishes to do so.
       
    99 		TECAMEvent2::iParam needs to be passed as argument in order to construct the TTimeIntervalMicroSeconds32 object.
       
   100 
       
   101 Note: TECAMEvent2::iParam1 represents the priority of the requestor client to whom the camera control will be passed 
       
   102 should the current reserver wish to do so.
       
   103 
       
   104 @internalTechnology
       
   105 */
       
   106 static const TUid KUidECamEvent2CameraRequestTimedTakeOver = {KUidECamEvent2CameraRequestTimedTakeOverUidValue};
       
   107 
       
   108 /**
       
   109 Notifies the manual gain setting completion for the particular channel.
       
   110 
       
   111 This TUid is available from the following methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L():
       
   112 void CCamera::CCameraAdvancedSettings::GetSupportedSettingsL(RArray<TUid>& aSettings) const;
       
   113 void CCamera::CCameraAdvancedSettings::GetActiveSettingsL(RArray<TUid>& aActiveSettings) const;
       
   114 void CCamera::CCameraAdvancedSettings::GetDisabledSettingsL(RArray<TUid>& aDisabledSettings) const;
       
   115 
       
   116 Note: TECAMEvent2::iParam represents the specific channel for which the manual gain value has been set.
       
   117 
       
   118 @internalTechnology
       
   119 */
       
   120 static const TUid KUidECamEvent2CameraSettingManualGain = {KUidECamEvent2CameraSettingManualGainUidValue};
       
   121 
       
   122 /**
       
   123 Retrieves the optimal focussing feedback while using manual focus. This will be issued as a result of setting operation
       
   124 CCamera::CCameraAdvancedSettings::SetFocusDistance(TInt aDistance).
       
   125 
       
   126 This TUid is available from the following methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L():
       
   127 void CCamera::CCameraAdvancedSettings::GetSupportedSettingsL(RArray<TUid>& aSettings) const;
       
   128 void CCamera::CCameraAdvancedSettings::GetActiveSettingsL(RArray<TUid>& aActiveSettings) const;
       
   129 void CCamera::CCameraAdvancedSettings::GetDisabledSettingsL(RArray<TUid>& aDisabledSettings) const;
       
   130 
       
   131 @note   If TECAMEvent2::iParam > 1, information is unavailable; if TECAMEvent2::iParam < 0, error case. 
       
   132 		Otherwise, static_cast<TBool>(TECAMEvent2::iParam) retrieves whether optimal focussing has been achieved or not.
       
   133 
       
   134 @internalTechnology
       
   135 */
       
   136 static const TUid KUidECamEvent2CameraSettingFocusDistance = {KUidECamEvent2CameraSettingFocusDistanceUidValue};
       
   137 
       
   138 /**
       
   139 Instructs the client to change its priority in order to allow the legacy client to get hold of the camera. Client should
       
   140 restore their priority when they receive the notification 'KUidECamEventCameraSettingRestoreClientPriority'.
       
   141 
       
   142 This TUid is available from the following methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L():
       
   143 void CCamera::CCameraAdvancedSettings::GetSupportedSettingsL(RArray<TUid>& aSettings) const;
       
   144 void CCamera::CCameraAdvancedSettings::GetActiveSettingsL(RArray<TUid>& aActiveSettings) const;
       
   145 void CCamera::CCameraAdvancedSettings::GetDisabledSettingsL(RArray<TUid>& aDisabledSettings) const;
       
   146 
       
   147 Note: TECAMEvent2::iParam represents the target priority to which the client should set itself using the method SetClientPriorityL()
       
   148 
       
   149 @internalTechnology
       
   150 */
       
   151 static const TUid KUidECamEvent2CameraSettingChangeClientPriority  = {KUidECamEvent2CameraSettingChangeClientPriorityUidValue};
       
   152 
       
   153 /** 
       
   154 Event indicating image enhancement setting has been applied. 
       
   155 This event should be packed in TECAMEvent2 class.
       
   156 
       
   157 Note: TECAMEvent2::iParam represents viewfinder handle.
       
   158 
       
   159 @internalTechnology
       
   160 */
       
   161 static const TUid KUidECamEvent2ViewFinderImageEnhancement = {KUidECamEvent2ViewFinderImageEnhancementUidValue};
       
   162 	
       
   163 #endif // ECAM_DEF_H