- Reviewed by Lionbridge.
Change-Id: I70b8cd18ebeea8182912a268514ba03c3754372d
Signed-off-by: Haesu Gwon <haesu.gwon@samsung.com>
}
/// <summary>
- /// The camera class provides methods to capture photos and support setting up notifications
- /// for state changes of capturing, previewing, focusing, information about resolution and binary format
- /// and functions for picture manipulations like sepia negative and many more.
- /// It also notifies you when a significant picture parameter changes e.g. focus.
+ /// This camera class provides methods to capture photos and supports setting up notifications
+ /// for state changes of capturing, previewing, focusing, and informing about the resolution and the binary format,
+ /// and functions for picture manipulations like sepia, negative, and many more.
+ /// It also notifies you when a significant picture parameter changes, (For example, focus).
/// </summary>
public class Camera : IDisposable, IDisplayable<CameraError>
{
private CameraState _state = CameraState.None;
/// <summary>
- /// Initializes a new instance of the <see cref="Camera"/> Class.
+ /// Initializes a new instance of the <see cref="Camera"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="device">The camera device to access</param>
+ /// <param name="device">The camera device to access.</param>
public Camera(CameraDevice device)
{
CameraErrorFactory.ThrowIfError(Native.Create(device, out _handle),
#region Dispose support
/// <summary>
- /// Releases the unmanaged resources used by the Camera.
+ /// Releases the unmanaged resources used by the camera.
/// </summary>
/// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Releases all resources used by the Camera.
+ /// Releases all resources used by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
#region EventHandlers
/// <summary>
- /// Event that occurs when the camera interrupt is started by policy.
+ /// An event that occurs when the camera interrupt is started by the policy.
/// </summary>
public event EventHandler<CameraInterruptStartedEventArgs> InterruptStarted;
private Native.InterruptStartedCallback _interruptStartedCallback;
/// <summary>
- /// Event that occurs when an camera is interrupted by policy.
+ /// An event that occurs when an camera is interrupted by the policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraInterruptedEventArgs> Interrupted;
private Native.InterruptedCallback _interruptedCallback;
/// <summary>
- /// Event that occurs when there is an asynchronous error.
+ /// An event that occurs when there is an asynchronous error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraErrorOccurredEventArgs> ErrorOccurred;
private Native.ErrorCallback _errorCallback;
/// <summary>
- /// Event that occurs when the auto focus state is changed.
+ /// An event that occurs when the auto focus state is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraFocusStateChangedEventArgs> FocusStateChanged;
private Native.FocusStateChangedCallback _focusStateChangedCallback;
/// <summary>
- /// Event that occurs when a face is detected in preview frame.
+ /// An event that occurs when a face is detected in the preview frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<FaceDetectedEventArgs> FaceDetected;
private Native.FaceDetectedCallback _faceDetectedCallback;
/// <summary>
- /// Event that occurs during capture of image.
+ /// An event that occurs during capture of an image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraCapturingEventArgs> Capturing;
private Native.CapturingCallback _capturingCallback;
/// <summary>
- /// Event that occurs after the capture of the image.
+ /// An event that occurs after the capture of the image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<EventArgs> CaptureCompleted;
private object _hdrCaptureProgressEventLock = new object();
/// <summary>
- /// Event that occurs when there is change in HDR capture progress.
- /// Check whether <see cref="CameraCapabilities.IsHdrCaptureSupported"/> is supported or not before add this EventHandler.
+ /// An event that occurs when there is a change in the HDR capture progress.
+ /// Checks whether the <see cref="CameraCapabilities.IsHdrCaptureSupported"/> is supported or not before adding this EventHandler.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="NotSupportedException">In case of HDR feature is not supported.</exception>
}
/// <summary>
- /// Event that occurs when camera state is changed.
+ /// An event that occurs when the camera state is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraStateChangedEventArgs> StateChanged;
private static int _deviceStateCallbackId;
/// <summary>
- /// Event that occurs after the <see cref="CameraDeviceState"/> is changed.
+ /// An event that occurs after the <see cref="CameraDeviceState"/> is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
private event EventHandler<PreviewEventArgs> _preview;
private object _previewEventLock = new object();
/// <summary>
- /// Event that occurs once per frame when previewing.
- /// Preview callback is registered when user add callback explicitly to avoid useless P/Invoke.
+ /// An event that occurs once per frame when previewing.
+ /// Preview callback is registered when an user adds a callback explicitly to avoid useless P/Invoke.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<PreviewEventArgs> Preview
private object _mediaPacketPreviewEventLock = new object();
/// <summary>
- /// Event that occurs once per frame when previewing.
- /// Preview callback is registered when user add callback explicitly to avoid useless P/Invoke.
+ /// An event that occurs once per frame when previewing.
+ /// Preview callback is registered when an user adds a callback explicitly to avoid useless P/Invoke.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<MediaPacketPreviewEventArgs> MediaPacketPreview
#region Properties
/// <summary>
- /// Get/Set the various camera settings.
+ /// Gets or sets the various camera settings.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraSettings Settings { get; }
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// This must be set before StartPreview() method.
- /// In Custom ROI display mode, DisplayRoiArea property must be set before calling this method.
+ /// This must be set before the StartPreview() method.
+ /// In custom ROI display mode, DisplayRoiArea property must be set before calling this method.
/// </remarks>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public Display Display
{
/// Gets the state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> None, Created, Preview, Capturing, Captured </value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value> None, Created, Preview, Capturing, Captured.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraState State
{
get
}
/// <summary>
- /// The hint for display reuse.
+ /// The hint for the display reuse.
/// If the hint is set to true, the display will be reused when the camera device is changed with
- /// ChangeDevice method.
+ /// the ChangeDevice method.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="InvalidOperationException">Invalid state.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="InvalidOperationException">An invalid state.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool DisplayReuseHint
{
get
}
/// <summary>
- /// Gets the facing direction of camera module.
+ /// Gets the facing direction of the camera module.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraFacingDirection"/> that specifies the facing direction of camera device.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraFacingDirection"/> that specifies the facing direction of the camera device.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraFacingDirection Direction
{
get
/// <since_tizen> 3 </since_tizen>
/// <value>This returns 2, if the device supports primary and secondary cameras.
/// Otherwise 1, if the device only supports primary camera.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int CameraCount
{
get
/// </remarks>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
- /// <exception cref="NotSupportedException">In case of ChangeDevice feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="NotSupportedException">In case of the ChangeDevice feature is not supported.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void ChangeDevice(CameraDevice device)
{
ValidateState(CameraState.Created);
/// Gets the device state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="device">The device to get state.</param>
- /// <returns>Returns the state of camera device</returns>
+ /// <param name="device">The device to get the state.</param>
+ /// <returns>Returns the state of the camera device.</returns>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
/// Gets the flash state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="device">The device to get state.</param>
- /// <returns>Returns the flash state of camera device</returns>
+ /// <param name="device">The device to get the state.</param>
+ /// <returns>Returns the flash state of the camera device.</returns>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
/// If needed set fps <see cref="CameraSettings.PreviewFps"/>, preview resolution
/// <see cref="CameraSettings.PreviewResolution"/>, or preview format <see cref="CameraSettings.PreviewPixelFormat"/>
/// before using this method.
- /// The camera must be in the <see cref="CameraState.Created"/> or <see cref="CameraState.Captured"/> state.
+ /// The camera must be in the <see cref="CameraState.Created"/> or the <see cref="CameraState.Captured"/> state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartPreview()
{
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StopPreview()
{
/// http://tizen.org/privilege/camera
/// </privilege>
/// <remarks>
- /// This function causes the transition of the camera state from Capturing to Captured
+ /// This function causes the transition of the camera state from capturing to captured
/// automatically and the corresponding EventHandlers will be invoked.
- /// The preview should be restarted by calling <see cref="StartPreview"/> method after capture is completed.
+ /// The preview should be restarted by calling the <see cref="StartPreview"/> method after capture is completed.
/// </remarks>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartCapture()
{
/// <param name="cancellationToken">The cancellation token to cancel capturing.</param>
/// <seealso cref="CancellationToken"/>
/// <remarks>
- /// If this is not supported zero shutter lag occurs. The capture resolution could be
+ /// If this is not supported, zero shutter lag occurs. The capture resolution could be
/// changed to the preview resolution. This function causes the transition of the camera state
- /// from Capturing to Captured automatically and the corresponding Eventhandlers will be invoked.
- /// Each captured image will be delivered through Eventhandler set using <see cref="Capturing"/> event.
- /// The preview should be restarted by calling <see cref="StartPreview"/> method after capture is completed.
+ /// from capturing to captured automatically and the corresponding Eventhandlers will be invoked.
+ /// Each captured image will be delivered through Eventhandler set using the <see cref="Capturing"/> event.
+ /// The preview should be restarted by calling the <see cref="StartPreview"/> method after capture is completed.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartCapture(int count, int interval, CancellationToken cancellationToken)
{
/// <summary>
/// Starts camera auto-focusing, asynchronously.
- /// The camera must be in the <see cref="CameraState.Preview"/> or <see cref="CameraState.Captured"/> state.
+ /// The camera must be in the <see cref="CameraState.Preview"/> or the <see cref="CameraState.Captured"/> state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="continuous">Continuous auto focus</param>
+ /// <param name="continuous">Continuous auto focus.</param>
/// <privilege>
/// http://tizen.org/privilege/camera
/// </privilege>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartFocusing(bool continuous)
{
/// <summary>
/// Stops camera auto focusing.
- /// The camera must be in the <see cref="CameraState.Preview"/> or <see cref="CameraState.Captured"/> state.
+ /// The camera must be in the <see cref="CameraState.Preview"/> or the <see cref="CameraState.Captured"/> state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StopFocusing()
{
/// </privilege>
/// <remarks>
/// This should be called after <see cref="StartPreview"/> is started.
- /// The Eventhandler set using <see cref="FaceDetected"/> invoked when the face is detected in preview frame.
- /// Internally it starts continuous focus and focusing on the detected face.
+ /// The Eventhandler set using <see cref="FaceDetected"/> is invoked when the face is detected in the preview frame.
+ /// Internally, it starts continuously focus and focusing on the detected face.
/// </remarks>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartFaceDetection()
{
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StopFaceDetection()
{
/// <summary>
/// Gets the face detection feature's supported state.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsFaceDetectionSupported { get; }
/// <summary>
/// Gets the media packet preview callback feature's supported state.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsMediaPacketPreviewCallbackSupported { get; }
/// <summary>
/// Gets the zero shutter lag feature's supported state.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsZeroShutterLagSupported { get; }
/// <summary>
- /// Gets continuous capture feature's supported state.
- /// true if supported, otherwise false.
+ /// Gets the continuous capture feature's supported state.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsContinuousCaptureSupported { get; }
/// <summary>
- /// Gets the support state of HDR capture.
- /// true if supported, otherwise false.
+ /// Gets the support state of the HDR capture.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsHdrCaptureSupported { get; }
/// <summary>
/// Gets the support state of the anti-shake feature.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsAntiShakeSupported { get; }
/// <summary>
/// Gets the support state of the video stabilization feature.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsVideoStabilizationSupported { get; }
/// <summary>
/// Gets the support state of auto contrast feature.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsAutoContrastSupported { get; }
/// <summary>
- /// Gets the support state of brightness feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the brightness feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsBrigtnessSupported { get; }
/// <summary>
- /// Gets the support state of exposure feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the exposure feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsExposureSupported { get; }
/// <summary>
- /// Gets the support state of zoom feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the zoom feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsZoomSupported { get; }
/// <summary>
- /// Gets the support state of pan feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the pan feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsPanSupported { get; }
/// <summary>
- /// Gets the support state of tilt feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the tilt feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsTiltSupported { get; }
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported preview resolutions.
- /// by recorder.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Size> SupportedPreviewResolutions
{
get
/// <returns>
/// It returns a list containing all the supported capture resolutions.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Size> SupportedCaptureResolutions
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraPixelFormat"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraPixelFormat> SupportedCapturePixelFormats
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraPixelFormat"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraPixelFormat> SupportedPreviewPixelFormats
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFps"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFps> SupportedPreviewFps
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFps"/> by resolution.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFps> GetSupportedPreviewFpsByResolution(int width, int height)
{
return GetSupportedPreviewFpsByResolutions(width, height);
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFps"/> by resolution.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFps> GetSupportedPreviewFpsByResolution(Size size)
{
return GetSupportedPreviewFpsByResolutions(size.Width, size.Height);
/// <returns>
/// It returns a list containing all the supported <see cref="CameraAutoFocusMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraAutoFocusMode> SupportedAutoFocusModes
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraExposureMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraExposureMode> SupportedExposureModes
{
get
}
/// <summary>
- /// Retrieves all the Iso level supported by the camera.
+ /// Retrieves all the ISO levels supported by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported <see cref="CameraIsoLevel"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraIsoLevel> SupportedIsoLevels
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraTheaterMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraTheaterMode> SupportedTheaterModes
{
get
}
/// <summary>
- /// Retrieves all the whitebalance modes supported by the camera.
+ /// Retrieves all the white balance modes supported by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported <see cref="CameraWhiteBalance"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraWhiteBalance> SupportedWhiteBalances
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFlashMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFlashMode> SupportedFlashModes
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraSceneMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraSceneMode> SupportedSceneModes
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraEffectMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraEffectMode> SupportedEffects
{
get
}
/// <summary>
- /// Retrieves all the stream rotation supported by the camera.
+ /// Retrieves all the stream rotations supported by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// An IEnumerable containing all the supported <see cref="Rotation"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Rotation> SupportedStreamRotations
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="Flips"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Flips> SupportedStreamFlips
{
get
}
/// <summary>
- /// Retrieves all the ptz types by the camera.
+ /// Retrieves all the PTZ types by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported <see cref="CameraPtzType"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraPtzType> SupportedPtzTypes
{
get
public StillImage MainImage { get; }
/// <summary>
- /// The image data of the postview.
+ /// The image data of the post view.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public StillImage PostView { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about previous and current state
+ /// An extended EventArgs class which contains details about the previous and the current state
/// of the camera when its state is changed.
/// </summary>
public class CameraDeviceStateChangedEventArgs : EventArgs
}
/// <summary>
- /// Camera device type.
+ /// The camera device type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraDevice Device { get; }
/// <summary>
- /// Current state of the camera device.
+ /// The current state of the camera device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraDeviceState State { get; }
{
/// <summary>
/// The CameraDisplay class allows you to manage display for the camera.
- /// It allows to set and get various display properties such as
- /// rotation, display visibility and display mode.
+ /// It allows to set and get various display properties, such as
+ /// rotation, display visibility, and display mode.
/// </summary>
public class CameraDisplaySettings
{
/// </remarks>
/// <value>A <see cref="CameraDisplayMode"/> that specifies the display mode.</value>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public CameraDisplayMode Mode
{
get
/// <summary>
/// The display visibility.
- /// True if camera display visible, otherwise false.
/// </summary>
+ /// <value>true if camera display is visible, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public bool Visible
{
get
/// <remarks>
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
- /// <value>A <see cref="Rotation"/> that specifies the rotation of camera device.</value>
+ /// <value>A <see cref="Rotation"/> that specifies the rotation of the camera device.</value>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public Rotation Rotation
{
get
/// <remarks>
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
- /// <value>A <see cref="Flips"/> that specifies camera flip type.</value>
+ /// <value>A <see cref="Flips"/> that specifies the camera flip type.</value>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public Flips Flip
{
get
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public Rectangle RoiArea
{
get
namespace Tizen.Multimedia
{
/// <summary>
- /// Enumeration for Camera device.
+ /// Enumeration for the camera device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraDevice
{
/// <summary>
- /// Rear Camera device.
+ /// The rear camera device.
/// </summary>
Rear,
/// <summary>
- /// Front Camera device.
+ /// The front camera device.
/// </summary>
Front
}
/// <summary>
- /// Enumeration for Camera device state.
+ /// Enumeration for the camera device state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraDeviceState
/// </summary>
Opened,
/// <summary>
- /// Now previewing or capturing or is being used for video recording.
+ /// Now previewing or capturing or is being used for the video recording.
/// </summary>
Working
}
/// <summary>
- /// Enumeration for the facing direction of camera module .
+ /// Enumeration for the facing direction of camera module.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraFacingDirection
/// </summary>
Rear,
/// <summary>
- /// Front direction
+ /// Front direction.
/// </summary>
Front
}
public enum CameraFlashState
{
/// <summary>
- /// Flash is not used now through camera API.
+ /// Flash is not used now through the camera API.
/// </summary>
NotUsed,
/// <summary>
- /// Flash is used now through camera API.
+ /// Flash is used now through the camera API.
/// </summary>
Used
}
/// </summary>
Released,
/// <summary>
- /// Focus in progress
+ /// Focus in progress.
/// </summary>
Ongoing,
/// <summary>
- /// Focus succeeded
+ /// Focus succeeded.
/// </summary>
Focused,
/// <summary>
/// </summary>
Nv12,
/// <summary>
- /// NV12 Tiled pixel format.
+ /// NV12 tiled pixel format.
/// </summary>
Nv12t,
/// <summary>
/// </summary>
None,
/// <summary>
- /// Security policy
+ /// Security policy.
/// </summary>
Security = 4,
/// <summary>
- /// Resource conflict
+ /// Resource conflict.
/// </summary>
ResourceConflict
}
}
/// <summary>
- /// Enumeration for the auto focus mode.
+ /// Enumeration for the auto-focus mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraAutoFocusMode
{
/// <summary>
- /// auto-focus is not set.
+ /// Auto-focus is not set.
/// </summary>
None,
/// <summary>
- /// auto-focus in the normal mode.
+ /// Auto-focus is in the normal mode.
/// </summary>
Normal,
/// <summary>
- /// auto-focus in the macro mode(close distance).
+ /// Auto-focus is in the macro mode (close distance).
/// </summary>
Macro,
/// <summary>
- /// auto-focus in the full mode(all range scan, limited by device spec).
+ /// Auto-focus is in the full mode (all range scan, limited by device spec).
/// </summary>
Full
}
/// </summary>
VintageWarm,
/// <summary>
- /// Vintage cold .
+ /// Vintage cold.
/// </summary>
VintageCold,
/// <summary>
/// </summary>
Cartoon,
/// <summary>
- /// Selective color - Red.
+ /// Selective color - red.
/// </summary>
SelectiveRed,
/// <summary>
- /// Selective color - Green.
+ /// Selective color - green.
/// </summary>
SelectiveGreen,
/// <summary>
- /// Selective color - Blue.
+ /// Selective color - blue.
/// </summary>
SelectiveBlue,
/// <summary>
- /// Selective color - Yellow.
+ /// Selective color - yellow.
/// </summary>
SelectiveYellow,
/// <summary>
- /// Selective color - Red and Yellow.
+ /// Selective color - red and yellow.
/// </summary>
SelectiveRedYellow,
/// <summary>
- /// Other Graphic effects.
+ /// Other graphic effects.
/// </summary>
OtherGraphics
}
}
/// <summary>
- /// Enumeration for preview FPS.
+ /// Enumeration for the preview fps.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraFps
{
/// <summary>
- /// Auto FPS.
+ /// Auto fps.
/// </summary>
Auto = 0,
/// <summary>
- /// 7 FPS.
+ /// 7 fps.
/// </summary>
Fps7 = 7,
/// <summary>
- /// 8 FPS.
+ /// 8 fps.
/// </summary>
Fps8 = 8,
/// <summary>
- /// 15 FPS.
+ /// 15 fps.
/// </summary>
Fps15 = 15,
/// <summary>
- /// 20 FPS.
+ /// 20 fps.
/// </summary>
Fps20 = 20,
/// <summary>
- /// 24 FPS.
+ /// 24 fps.
/// </summary>
Fps24 = 24,
/// <summary>
- /// 25 FPS.
+ /// 25 fps.
/// </summary>
Fps25 = 25,
/// <summary>
- /// 30 FPS.
+ /// 30 fps.
/// </summary>
Fps30 = 30,
/// <summary>
- /// 60 FPS.
+ /// 60 fps.
/// </summary>
Fps60 = 60,
/// <summary>
- /// 90 FPS.
+ /// 90 fps.
/// </summary>
Fps90 = 90,
/// <summary>
- /// 120 FPS.
+ /// 120 fps.
/// </summary>
Fps120 = 120
}
/// <summary>
- /// Enumeration for HDR capture mode.
+ /// Enumeration for the HDR capture mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraHdrMode
{
/// <summary>
- /// Disable HDR capture.
+ /// Disable the HDR capture.
/// </summary>
Disable,
/// <summary>
- /// Enable HDR capture.
+ /// Enable the HDR capture.
/// </summary>
Enable,
/// <summary>
- /// Enable HDR capture and keep original image data.
+ /// Enable the HDR capture mode and keep original image data.
/// </summary>
KeepOriginal
}
}
/// <summary>
- /// Enumeration for PTZ(Pan Tilt Zoom) movement type.
+ /// Enumeration for the PTZ(Pan Tilt Zoom) movement type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraPtzMoveType
/// </summary>
Absoulute,
/// <summary>
- /// Move a specific distance from the current position.
+ /// Move to a specific distance from the current position.
/// </summary>
Relative
}
/// <summary>
- /// Enumeration for PTZ(Pan Tilt Zoom) type.
+ /// Enumeration for the PTZ(Pan Tilt Zoom) type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraPtzType
/// </summary>
Sports,
/// <summary>
- /// Party & Indoor.
+ /// Party and indoor.
/// </summary>
PartyAndIndoor,
/// <summary>
- /// Beach & Indoor.
+ /// Beach and indoor.
/// </summary>
BeachAndIndoor,
/// <summary>
/// </summary>
Sunset,
/// <summary>
- /// Dusk & Dawn.
+ /// Dusk and dawn.
/// </summary>
DuskAndDawn,
/// <summary>
public enum CameraTagOrientation
{
/// <summary>
- /// Row #0 is at the top, Column #0 is to the left.
+ /// Row #0 is at the top, column #0 is to the left.
/// </summary>
TopLeft = 1,
/// <summary>
- /// Row #0 is at the top, Column #0 is to the right.
+ /// Row #0 is at the top, column #0 is to the right.
/// </summary>
TopRight = 2,
/// <summary>
- /// Row #0 is at the bottom, Column #0 is to the right.
+ /// Row #0 is at the bottom, column #0 is to the right.
/// </summary>
BottomRight = 3,
/// <summary>
- /// Row #0 is at the bottom, Column #0 is to the left.
+ /// Row #0 is at the bottom, column #0 is to the left.
/// </summary>
BottomLeft = 4,
/// <summary>
- /// Row #0 is at the left, Column #0 is to the top.
+ /// Row #0 is at the left, column #0 is to the top.
/// </summary>
LeftTop = 5,
/// <summary>
- /// Row #0 is at the right, Column #0 is to the top.
+ /// Row #0 is at the right, column #0 is to the top.
/// </summary>
RightTop = 6,
/// <summary>
- /// Row #0 is at the right, Column #0 is to the bottom.
+ /// Row #0 is at the right, column #0 is to the bottom.
/// </summary>
RightBottom = 7,
/// <summary>
- /// Row #0 is at the left, Column #0 is to the bottom.
+ /// Row #0 is at the left, column #0 is to the bottom.
/// </summary>
LeftBottom = 8
}
public enum CameraTheaterMode
{
/// <summary>
- /// Disable theater mode - External display shows same image as device display.
+ /// Disable the theater mode - the external display shows same image as the device display.
/// </summary>
Disable,
/// <summary>
- /// Clone mode - Preview image is displayed on external display with full screen mode. Also preview image is shown by the UI on device display.
+ /// Clone the mode - the preview image is displayed on an external display with full screen mode. Also, the preview image is shown by the UI on the device display.
/// </summary>
Clone,
/// <summary>
- /// Enable theater mode - Preview image is displayed on external display with full screen mode, but preview image is not shown on device display.
+ /// Enable the theater mode - the preview image is displayed on an external display with full screen mode, but the preview image is not shown on the device display.
/// </summary>
Enable
}
/// <summary>
- ///Enumeration for the white balance levels of the camera.
+ /// Enumeration for the white balance levels of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraWhiteBalance
/// </summary>
LetterBox,
/// <summary>
- /// Origin size.
+ /// Original size.
/// </summary>
OriginSize,
/// <summary>
}
/// <summary>
- /// Enumeration for camera failure error.
+ /// Enumeration for the camera failure error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraErrorCode
}
/// <summary>
- /// Enumeration for Image datatype.
+ /// Enumeration for the image datatype.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum PlaneType
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about error status and
- /// state of the camera when it failed.
+ /// An extended EventArgs class which contains details about the error status and the
+ /// state of the camera when it fails.
/// </summary>
public class CameraErrorOccurredEventArgs : EventArgs
{
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about focus state of the
- /// camera.
+ /// An extended EventArgs class which contains details about the focus state of the camera.
/// </summary>
public class CameraFocusStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Focus state of the camera.
+ /// The focus state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraFocusState State { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about previous and current state
- /// of the camera when its interrupted.
+ /// An extended EventArgs class which contains details about the previous and the current state
+ /// of the camera when it is interrupted.
/// </summary>
public class CameraInterruptedEventArgs : EventArgs
{
}
/// <summary>
- /// Previous state of the camera.
+ /// The previous state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Previous { get; }
/// <summary>
- /// Current state of the camera.
+ /// The current state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Current { get; }
#region Auto Focus
/// <summary>
- /// Sets auto focus area.
+ /// Sets the auto focus area.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// <see cref="CameraAutoFocusMode"/> should not be the <see cref="CameraAutoFocusMode.None"/>.
/// </remarks>
- /// <param name="x">X position</param>
- /// <param name="y">Y position</param>
+ /// <param name="x">X position.</param>
+ /// <param name="y">Y position.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetAutoFocusArea(int x, int y)
{
CameraErrorFactory.ThrowIfError(Native.SetAutoFocusArea(_camera.GetHandle(), x, y),
}
/// <summary>
- /// Sets auto focus area.
+ /// Sets the auto focus area.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// <see cref="CameraAutoFocusMode"/> should not be the <see cref="CameraAutoFocusMode.None"/>.
/// </remarks>
- /// <param name="pos"><see cref="Point"/> structure including X, Y position</param>
+ /// <param name="pos"><see cref="Point"/> structure including X, Y position.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetAutoFocusArea(Point pos)
{
CameraErrorFactory.ThrowIfError(Native.SetAutoFocusArea(_camera.GetHandle(), pos.X, pos.Y),
/// Clears the auto focus area.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void ClearFocusArea()
{
CameraErrorFactory.ThrowIfError(Native.ClearAutoFocusArea(_camera.GetHandle()),
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraAutoFocusMode"/> that specifies the auto focus mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraAutoFocusMode AutoFocusMode
{
get
/// The contrast level of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int Contrast
{
get
/// If true auto contrast is enabled, otherwise false.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool AutoContrast
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the mininum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range ContrastRange
/// The brightness level of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int Brightness
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range BrightnessRange
/// The exposure value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int Exposure
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraExposureMode"/> that specifies the exposure mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraExposureMode ExposureMode
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range ExposureRange
#region Zoom
/// <summary>
/// The zoom level.
- /// The range for zoom level is received from ZoomRange property.
+ /// The range for the zoom level is received from the ZoomRange property.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int ZoomLevel
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range ZoomRange
#endregion Zoom
/// <summary>
- /// The whitebalance mode.
+ /// The white balance mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraWhiteBalance"/> that specifies the white balance mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraWhiteBalance WhiteBalance
{
get
/// The ISO level.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraIsoLevel"/> that specifies ISO level.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraIsoLevel"/> that specifies the ISO level.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraIsoLevel IsoLevel
{
get
/// <summary>
/// The quality of the image.
- /// The range for image quality is 1 to 100.
+ /// The range for the image quality is 1 to 100.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int ImageQuality
{
get
/// The preview frame rate.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraFps"/> that specifies preview frame rate.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraFps"/> that specifies the preview frame rate.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraFps PreviewFps
{
get
}
/// <summary>
- /// Gets or sets the resolution of preview
+ /// Gets or sets the resolution of the preview.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Size PreviewResolution
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Depending on the capture resolution aspect ratio and display resolution,
+ /// Depending on the capture resolution aspect ratio and the display resolution,
/// the recommended preview resolution is determined.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Size RecommendedPreviewResolution
{
get
/// The preview data format.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraPixelFormat"/> that specifies the pixel format of preview data.</value>
+ /// <value>A <see cref="CameraPixelFormat"/> that specifies the pixel format of the preview data.</value>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraPixelFormat PreviewPixelFormat
{
get
/// Resolution of the captured image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ArgumentException">In case of invalid parameters</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ArgumentException">In case of invalid parameters.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Size CaptureResolution
{
get
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraPixelFormat"/> that specifies the pixel format of captured image.</value>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraPixelFormat CapturePixelFormat
{
get
#region Encoded preview
/// <summary>
- /// The bit rate of encoded preview.
+ /// The bit rate of the encoded preview.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int EncodedPreviewBitrate
{
get
}
/// <summary>
- /// GOP(Group Of Pictures) interval of encoded preview.
+ /// The GOP(Group Of Pictures) interval of the encoded preview.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int EncodedPreviewGopInterval
{
get
/// The theater mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraTheaterMode"/> that specifies theater mode.</value>
+ /// <value>A <see cref="CameraTheaterMode"/> that specifies the theater mode.</value>
/// <remarks>
/// If you want to display the preview image on the external display with the full screen mode,
/// use this property.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraTheaterMode TheaterMode
{
get
/// The camera effect mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraEffectMode"/> that specifies effect mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraEffectMode"/> that specifies the effect mode.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraEffectMode Effect
{
get
/// The scene mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraSceneMode"/> that specifies scene mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraSceneMode"/> that specifies the scene mode.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraSceneMode SceneMode
{
get
/// The camera's flash mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraFlashMode"/> that specifies flash mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraFlashMode"/> that specifies the flash mode.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraFlashMode FlashMode
{
get
/// Gets the camera lens orientation angle.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int LensOrientation
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="Rotation"/> that specifies the rotation of camera device.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Rotation StreamRotation
{
get
/// The stream flip.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="Flips"/> that specifies camera flip type.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="Flips"/> that specifies the camera flip type.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Flips StreamFlip
{
get
}
/// <summary>
- /// The mode of HDR(High dynamic range) capture.
+ /// The mode of the HDR(High dynamic range) capture.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraHdrMode"/> that specifies the HDR mode.</value>
/// <remarks>
- /// Taking multiple pictures at different exposure levels and intelligently stitching them together
+ /// Taking multiple pictures at different exposure levels and intelligently stitching them together,
/// so that we eventually arrive at a picture that is representative in both dark and bright areas.
- /// If this attribute is set, then eventhandler set for HdrCaptureProgress event is invoked.
+ /// If this attribute is set, then event handler set for the HdrCaptureProgress event is invoked.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraHdrMode HdrMode
{
get
/// <summary>
/// The anti shake feature.
- /// If true the antishake feature is enabled, otherwise false.
+ /// If true, the antishake feature is enabled, otherwise false.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool AntiShake
{
get
}
/// <summary>
- /// Enables/Disables the video stabilization feature.
- /// If true video stabilization is enabled, otherwise false.
+ /// Enables or disables the video stabilization feature.
+ /// If true, video stabilization is enabled, otherwise false.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// If video stabilization is enabled, zero shutter lag is disabled.
/// This feature is used to record a video.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool VideoStabilization
{
get
/// In some countries, this operation is not permitted.
/// </remarks>
/// <exception cref="InvalidOperationException">Disabling shutter sound is not permitted.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void DisableShutterSound(bool shutterSound)
{
CameraErrorFactory.ThrowIfError(Native.DisableShutterSound(_camera.GetHandle(), shutterSound),
#region PTZ(Pan Tilt Zoom), Pan, Tilt
/// <summary>
- /// Sets the type of PTZ(Pan Tilt Zoom). Mechanical or Electronic.
+ /// Sets the type of the PTZ(Pan Tilt Zoom). Mechanical or electronic.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraPtzType"/> that specifies the type of PTZ.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraPtzType"/> that specifies the type of the PTZ.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraPtzType PtzType
{
set
/// Sets the position to move horizontally.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">ptz move type. <seealso cref="CameraPtzMoveType"/></param>
- /// <param name="panStep">pan step</param>
+ /// <param name="type">The PTZ move type. <seealso cref="CameraPtzMoveType"/>.</param>
+ /// <param name="panStep">The pan step.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetPan(CameraPtzMoveType type, int panStep)
{
ValidationUtil.ValidateEnum(typeof(CameraPtzMoveType), type, nameof(type));
/// Gets the current position of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Returns the camera's horizontal position</returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <returns>Returns the camera's horizontal position.</returns>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int GetPan()
{
CameraErrorFactory.ThrowIfError(Native.GetPan(_camera.GetHandle(), out int val),
/// Sets the position to move vertically.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">ptz move type</param>
- /// <param name="tiltStep">tilt step</param>
+ /// <param name="type">the PTZ move type.</param>
+ /// <param name="tiltStep">The tilt step.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetTilt(CameraPtzMoveType type, int tiltStep)
{
ValidationUtil.ValidateEnum(typeof(CameraPtzMoveType), type, nameof(type));
/// Gets the current position of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Returns the current vertical position</returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <returns>Returns the current vertical position.</returns>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int GetTilt()
{
CameraErrorFactory.ThrowIfError(Native.GetTilt(_camera.GetHandle(), out int val),
}
/// <summary>
- /// Gets lower limit and upper limit for pan position.
+ /// Gets the lower limit and the upper limit for the pan position.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range PanRange
}
/// <summary>
- /// Gets lower limit and upper limit for tilt position.
+ /// Gets the lower limit and the upper limit for the tilt position.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range TiltRange
#region EXIF tag
/// <summary>
/// The scene mode.
- /// true if EXIF tags are enabled in JPEG file, otherwise false.
/// </summary>
+ /// <value>true if EXIF tags are enabled in the JPEG file, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool EnableTag
{
get
/// The camera image description in the EXIF tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public string ImageDescriptionTag
{
get
/// The software information in the EXIF tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public string SoftwareTag
{
get
}
/// <summary>
- /// The geotag(GPS data) in the EXIF tag.
+ /// The geo tag(GPS data) in the EXIF tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Location GeoTag
{
get
}
/// <summary>
- /// Removes the geotag(GPS data) in the EXIF(Exchangeable image file format) tag.
+ /// Removes the geo tag(GPS data) in the EXIF(EXchangeable Image File format) tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void RemoveGeoTag()
{
CameraErrorFactory.ThrowIfError(Native.RemoveGeotag(_camera.GetHandle()),
/// The camera orientation in the tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraTagOrientation OrientationTag
{
get
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about previous and current state
+ /// An extended EventArgs class which contains details about the previous and the current state
/// of the camera when its state is changed.
/// </summary>
public class CameraStateChangedEventArgs : EventArgs
}
/// <summary>
- /// Previous state of the camera.
+ /// Gets the previous state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Previous { get; }
/// <summary>
- /// Current state of the camera.
+ /// Gets the current state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Current { get; }
/// <summary>
- /// true if the state changed by policy such as Resource Conflict or Security, otherwise false
- /// in normal state change.
+ /// Gets the value indicating whether the state is changed by policy.
/// </summary>
+ /// <value>
+ /// true if the state changed by policy such as resource conflict or security, otherwise false.
+ /// </value>
/// <since_tizen> 3 </since_tizen>
public bool ByPolicy { get; }
}
namespace Tizen.Multimedia
{
/// <summary>
- /// The class containing Encoded image data.
+ /// The class containing the encoded image data.
/// </summary>
public class EncodedPlane : IPreviewPlane
{
}
/// <summary>
- /// The buffer containing encoded image data.
+ /// The buffer containing the encoded image data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Data { get; }
{
/// <summary>
/// An extended EventArgs class which contains details about all the faces detected.
- /// If user need to remain faces data, user have to copy the data.
+ /// If the user needs to keep the faces data, the user has to copy the data.
/// </summary>
public class FaceDetectedEventArgs : EventArgs
{
}
/// <summary>
- /// List containing faces of type <see cref="Tizen.Multimedia.FaceDetectionData"/>.
+ /// The list containing faces of type <see cref="Tizen.Multimedia.FaceDetectionData"/>.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IEnumerable<FaceDetectionData> Faces { get; }
}
/// <summary>
- /// The Id of each face.
+ /// The ID of each face.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int Id { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about the hdr capture progress.
+ /// An extended EventArgs class which contains details about the HDR capture progress.
/// </summary>
public class HdrCaptureProgressEventArgs : EventArgs
{
}
/// <summary>
- /// Hdr Capture progress in percent.
+ /// The HDR capture progress in percent.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int Percent { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// Location class containing GPS data details.
+ /// The location class containing GPS data details.
/// </summary>
public class Location
{
/// <summary>
- /// Public constructor.
+ /// The public constructor.
/// </summary>
- /// <param name="latitude">Latitude data</param>
- /// <param name="longitude">Longitude data</param>
- /// <param name="altitude">Altitude data</param>
+ /// <param name="latitude">The latitude data.</param>
+ /// <param name="longitude">The longitude data.</param>
+ /// <param name="altitude">The altitude data.</param>
public Location(double latitude, double longitude, double altitude)
{
Latitude = latitude;
}
/// <summary>
- /// The Latitude data.
+ /// The latitude data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public double Latitude { get; }
/// <summary>
- /// The Longitude data.
+ /// The longitude data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public double Longitude { get; }
/// <summary>
- /// The Altitude data.
+ /// The altitude data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public double Altitude { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about the Media packet preview frame.
+ /// An extended EventArgs class which contains details about the media packet preview frame.
/// </summary>
public class MediaPacketPreviewEventArgs : EventArgs
{
}
/// <summary>
- /// Media Packet data.
+ /// The media packet data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public MediaPacket Packet { get; }
}
/// <summary>
- /// PreviewData frame.
+ /// The PreviewData frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public PreviewFrame Preview { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// The class containing preview image data.
+ /// The class containing the preview image data.
/// </summary>
public class PreviewFrame
{
public Size Resolution { get; }
/// <summary>
- /// The timestamp of preview frame.
+ /// The time stamp of the preview frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint TimeStamp { get; }
/// <summary>
- /// The type of preview plane. <see cref="Tizen.Multimedia.PlaneType"/>
+ /// The type of the preview plane. <see cref="Tizen.Multimedia.PlaneType"/>
/// </summary>
/// <since_tizen> 3 </since_tizen>
public PlaneType PlaneType { get; }
/// <summary>
- /// The buffer including preview frame.
+ /// The buffer including the preview frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IPreviewPlane Plane { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// The class containing image data which has single plane.
+ /// The class containing the image data, which has a single plane.
/// </summary>
public class SinglePlane : IPreviewPlane
{
public Size Resolution { get; }
/// <summary>
- /// The buffer containing still image.
+ /// The buffer containing the still image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Data { get; }
projects / platform / core / csapi / tizenfx.git / commitdiff