MCameraVideoCaptureControl Class Reference
| class MCameraVideoCaptureControl |
Mixin class for implementation by providers of the Video Capture Control Camera Extension API. CCamera Video Capture Control class exposes an API for controlling advanced video capture related settings and control.
Member Functions Documentation
CreateHistogramImplFactoryL(MImplementationFactory *&)
Retrieves the concrete factory handle for the histogram implementation in order to use it specifically for the video capture.
-
leave
- May leave with any error code.
Parameters
| MImplementationFactory *& aImplFactoryPtr | The concrete factory handle for the histogram implementation specific to the video capture. |
GetDisabledSettingsL(RArray< TUid > &)
| void | GetDisabledSettingsL | ( | RArray< TUid > & | aDisabledSettings | ) | const [pure virtual] |
Retrieves the camera settings whose value got affected once the desired video settings (frame rate/frame size) are in place. This method may be called by the client after receiving the notification KUidECamEventVideoCaptureControlSettingsDisabled.
-
leave
- May leave with any error code.
PrepareVideoCapture(const TPrepareVideoParameters& aPrepareVideoParameters)
Parameters
| RArray< TUid > & aDisabledSettings | Retrieves the list of disabled settings |
GetEmbeddedStillCaptureSupportInfoL(TInt &)
| void | GetEmbeddedStillCaptureSupportInfoL | ( | TInt & | aSupportedEmbeddedStillCaptureTypes | ) | const [pure virtual] |
Informs whether or not the 'embedded still capture' feature is supported. Allowing still image capture in between on-going video capture is referred to as embedded still capture.
-
leave
- May leave with any error code.
Parameters
| TInt & aSupportedEmbeddedStillCaptureTypes | Retrieves the supported embedded still capture. The TInt is retrieved as a bit field of supported TEmbeddedStillCaptureTypes. |
GetFadingEffectStateL(CCamera::CCameraVideoCaptureControl::TFadingEffectState &)
Retrieves the fading effect state for video capture.
-
leave
- May leave with any error code.
GetImageProcessingImplFactoryL(MImplementationFactory *&)
Retrieves the concrete factory handle for the image processing implementation in order to use it specifically for the video capture.
-
leave
- May leave with any error code.
Parameters
| MImplementationFactory *& aImplFactoryPtr | The concrete factory handle for the image processing implementation specific to the video capture. |
GetPixelAspectsSupportedL(TUint &, CCamera::TFormat, const TSize &)
| void | GetPixelAspectsSupportedL | ( | TUint & | aPixelAspectsSupported, |
| | CCamera::TFormat | aVideoFormat, |
| | const TSize & | aSize |
| | ) | const [pure virtual] |
Retrieves the supported pixel aspect ratio for a given resolution in case of video.
-
leave
- May leave with any error code.
Parameters
| TUint & aPixelAspectsSupported | A bit field which retrieves the supported pixel aspect ratio for a given resolution. Pixel aspect ratio have been defined as CCamera::CCameraAdvancedSettings::TPixelAspectRatio |
| CCamera::TFormat aVideoFormat | The video format for which the supported pixel aspect ratio have to be retrieved. |
| const TSize & aSize | The resolution (or size) for which the supported pixel aspect ratio have to be retrieved. |
GetPrepareVideoParametersL(CCamera::CCameraVideoCaptureControl::TPrepareVideoParameters &)
Retrieves the current prepare video parameters.
-
leave
- May leave with any error code.
GetRangeAffectedSettingsL(RArray< TUid > &)
| void | GetRangeAffectedSettingsL | ( | RArray< TUid > & | aRangeAffectedSettings | ) | const [pure virtual] |
Retrieves the camera settings whose range got affected once the desired video settings (frame rate/frame size) are in place. This method may be called by the client after receiving the notification KUidECamEventVideoCaptureControlSettingsRangeChanged.
-
leave
- May leave with any error code.
PrepareVideoCapture(const TPrepareVideoParameters& aPrepareVideoParameters)
Parameters
| RArray< TUid > & aRangeAffectedSettings | Retrieves the list of range affected settings |
GetSnapshotImplFactoryL(MImplementationFactory *&)
Retrieves the concrete factory handle for the snapshot implementation in order to use it specifically for the video capture.
-
leave
- May leave with any error code.
Parameters
| MImplementationFactory *& aImplFactoryPtr | The concrete factory handle for the snapshot implementation specific to the video capture. |
GetValueAffectedSettingsL(RArray< TUid > &)
| void | GetValueAffectedSettingsL | ( | RArray< TUid > & | aValueAffectedSettings | ) | const [pure virtual] |
Retrieves the camera settings whose value got affected once the desired video settings (frame rate/frame size) are in place. This method may be called by the client after receiving the notification KUidECamEventVideoCaptureControlSettingsValueChanged.
-
leave
- May leave with any error code.
PrepareVideoCapture(const TPrepareVideoParameters& aPrepareVideoParameters)
Parameters
| RArray< TUid > & aValueAffectedSettings | Retrieves the list of value affected settings |
GetVideoCaptureStateL(CCamera::CCameraVideoCaptureControl::TVideoCaptureState &)
Retrieves the current video capture state.
-
leave
- May leave with any error code.
GetVideoCaptureSupportInfoL(TInt &)
| void | GetVideoCaptureSupportInfoL | ( | TInt & | aSupportedVideoCaptureTypes | ) | const [pure virtual] |
Retrieves the various types of video capture supported.
- leave
- May leave with any error code.
Parameters
| TInt & aSupportedVideoCaptureTypes | Retrieves the supported video capture type. The TInt is retrieved as a bit field of supported TVideoCaptureType. |
GetVideoFormatsSupportedL(TUint &, const TSize &)
| void | GetVideoFormatsSupportedL | ( | TUint & | aVideoFormatsSupported, |
| | const TSize & | aSize |
| | ) | const [pure virtual] |
Retrieves the supported video formats for a given resolution.
-
leave
- May leave with any error code.
Parameters
| TUint & aVideoFormatsSupported | A bit field which retrieves the supported video formats for a given resolution. Formats have been defined as CCamera::TFormat |
| const TSize & aSize | The resolution (or size) for which the total number of supported video formats have to be retrieved. |
PauseVideoCapture()
| void | PauseVideoCapture | ( | ) | [pure virtual] |
Pauses the on-going video capture. MCaptureVideoObserver::VideoBufferReady(MCameraBuffer2& aVideoBuffer, TInt aErrorCode) callback will not be received by the client until the video capture is resumed.
PrepareVideoCapture(const CCamera::CCameraVideoCaptureControl::TPrepareVideoParameters &)
Asynchronous method to prepare for video capture.
Performs setup and allocation of memory prior to calling StartVideoCapture() to keep the latency of that function to a minimum.
Release()
| void | Release | ( | ) | [pure virtual] |
ReleaseVideoResource()
| void | ReleaseVideoResource | ( | ) | [pure virtual] |
Frees the video resources which were set up as a result of CCameraVideoCaptureControl::PrepareVideoCapture call. If this methid is called while PrepareVideoCapture call is outstanding, then this will be equivalent to cancelling the PrepareVideoCapture call and release any allocated resources.
ResumeVideoCaptureL()
| void | ResumeVideoCaptureL | ( | ) | [pure virtual] |
Resumes the on-going video capture. MCaptureVideoObserver::VideoBufferReady(MCameraBuffer2& aVideoBuffer, TInt aErrorCode) callback will again be received by the client.
-
leave
- May leave with any error code.
SetCaptureVideoObserver(MCaptureVideoObserver &)
The observer for the video capture is passed to the implementation for passing callbacks on it.
SetFadingEffectState(CCamera::CCameraVideoCaptureControl::TFadingEffectState)
Sets the fading effect state for video capture.
Note:
Triggers a KUidECamEventVideoCaptureControlFadingEffect event notification.
StartVideoCaptureL()
| void | StartVideoCaptureL | ( | ) | [pure virtual] |
Starts the video capture. This operation gives priority to the low latency aspects.
Video frames are send to client via MCaptureVideoObserver::VideoBufferReady(MCameraBuffer2& aVideoBuffer, TInt aErrorCode).
-
leave
- May leave with any error code.
Note:
This method is recommended to be used rather than CCamera::StartVideoCaptureL().
StopVideoCapture()
| void | StopVideoCapture | ( | ) | [pure virtual] |
Stops the video capture. This operation gives priority to the low latency aspects.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.