Class CameraSettings

Definition

Namespace:

Tizen.Multimedia

Assembly:

Tizen.Multimedia.Camera.dll

API Level:

3

The camera setting class provides methods/properties to get and set basic camera attributes.

public class CameraSettings

Inheritance

Object

CameraSettings

Properties

AntiShake

The anti shake feature. If true, the antishake feature is enabled, otherwise false.

Declaration

public bool AntiShake { get; set; }

Property Value

Type	Description
Boolean

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

AutoContrast

The auto contrast. If true auto contrast is enabled, otherwise false.

Declaration

public bool AutoContrast { get; set; }

Property Value

Type	Description
Boolean

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

AutoFocusMode

The auto focus mode.

Declaration

public CameraAutoFocusMode AutoFocusMode { get; set; }

Property Value

Type	Description
CameraAutoFocusMode	A CameraAutoFocusMode that specifies the auto focus mode.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Brightness

The brightness level of the camera.

Declaration

public int Brightness { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

BrightnessRange

Gets the available brightness level.

Declaration

public Range BrightnessRange { get; }

Property Value

Type	Description
Range

Remarks

If the minimum value is greater than the maximum value, it means this feature is not supported.

Exceptions

Type	Condition
NotSupportedException	In case of this feature is not supported.

API Level: 3

CapturePixelFormat

Format of an image to be captured.

Declaration

public CameraPixelFormat CapturePixelFormat { get; set; }

Property Value

Type	Description
CameraPixelFormat	A CameraPixelFormat that specifies the pixel format of captured image.

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

CaptureResolution

Resolution of the captured image.

Declaration

public Size CaptureResolution { get; set; }

Property Value

Type	Description
Size

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Contrast

The contrast level of the camera.

Declaration

public int Contrast { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

ContrastRange

Gets the available contrast level.

Declaration

public Range ContrastRange { get; }

Property Value

Type	Description
Range

Remarks

If the mininum value is greater than the maximum value, it means this feature is not supported.

Exceptions

Type	Condition
NotSupportedException	In case of this feature is not supported.

API Level: 3

Effect

The camera effect mode.

Declaration

public CameraEffectMode Effect { get; set; }

Property Value

Type	Description
CameraEffectMode	A CameraEffectMode that specifies the effect mode.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

EnableTag

The scene mode.

Declaration

public bool EnableTag { get; set; }

Property Value

Type	Description
Boolean	true if EXIF tags are enabled in the JPEG file, otherwise false.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

EncodedPreviewBitrate

The bit rate of the encoded preview.

Declaration

public int EncodedPreviewBitrate { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

EncodedPreviewGopInterval

The GOP(Group Of Pictures) interval of the encoded preview.

Declaration

public int EncodedPreviewGopInterval { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Exposure

The exposure value.

Declaration

public int Exposure { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

ExposureMode

The exposure mode.

Declaration

public CameraExposureMode ExposureMode { get; set; }

Property Value

Type	Description
CameraExposureMode	A CameraExposureMode that specifies the exposure mode.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

ExposureRange

Gets the available exposure value.

Declaration

public Range ExposureRange { get; }

Property Value

Type	Description
Range

Remarks

If the minimum value is greater than the maximum value, it means this feature is not supported.

Exceptions

Type	Condition
NotSupportedException	In case of this feature is not supported.

API Level: 3

FlashMode

The camera's flash mode.

Declaration

public CameraFlashMode FlashMode { get; set; }

Property Value

Type	Description
CameraFlashMode	A CameraFlashMode that specifies the flash mode.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

GeoTag

The geo tag(GPS data) in the EXIF tag.

Declaration

public Location GeoTag { get; set; }

Property Value

Type	Description
Location

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

HdrMode

The mode of the HDR(High dynamic range) capture.

Declaration

public CameraHdrMode HdrMode { get; set; }

Property Value

Type	Description
CameraHdrMode	A CameraHdrMode that specifies the HDR mode.

Remarks

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 event handler set for the HdrCaptureProgress event is invoked.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Hue

The hue level of the camera.

Declaration

public int Hue { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 5

HueRange

Gets the available hue level.

Declaration

public Range? HueRange { get; }

Property Value

Type	Description
Nullable<Range>

Remarks

If HueRange returns null, it means that hue feature is not supported. It can be checked also with IsHueSupported.

See Also

Hue

API Level: 5

ImageDescriptionTag

The camera image description in the EXIF tag.

Declaration

public string ImageDescriptionTag { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

ImageQuality

The quality of the image. The range for the image quality is 1 to 100.

Declaration

public int ImageQuality { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

IsoLevel

The ISO level.

Declaration

public CameraIsoLevel IsoLevel { get; set; }

Property Value

Type	Description
CameraIsoLevel	A CameraIsoLevel that specifies the ISO level.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

LensOrientation

Gets the camera lens orientation angle.

Declaration

public int LensOrientation { get; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

OrientationTag

The camera orientation in the tag.

Declaration

public CameraTagOrientation OrientationTag { get; set; }

Property Value

Type	Description
CameraTagOrientation

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

PanRange

Gets the lower limit and the upper limit for the pan position.

Declaration

public Range PanRange { get; }

Property Value

Type	Description
Range

Remarks

If the minimum value is greater than the maximum value, it means this feature is not supported.

Exceptions

Type	Condition
NotSupportedException	In case of this feature is not supported.

API Level: 3

PreviewFps

The preview frame rate.

Declaration

public CameraFps PreviewFps { get; set; }

Property Value

Type	Description
CameraFps	A CameraFps that specifies the preview frame rate.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

PreviewPixelFormat

The preview data format.

Declaration

public CameraPixelFormat PreviewPixelFormat { get; set; }

Property Value

Type	Description
CameraPixelFormat	A CameraPixelFormat that specifies the pixel format of the preview data.

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

PreviewResolution

Gets or sets the resolution of the preview.

Declaration

public Size PreviewResolution { get; set; }

Property Value

Type	Description
Size

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

PtzType

Sets the type of the PTZ(Pan Tilt Zoom). Mechanical or electronic.

Declaration

public CameraPtzType PtzType { set; }

Property Value

Type	Description
CameraPtzType	A CameraPtzType that specifies the type of the PTZ.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

RecommendedPreviewResolution

Gets the recommended preview resolution.

Declaration

public Size RecommendedPreviewResolution { get; }

Property Value

Type	Description
Size

Remarks

Depending on the capture resolution aspect ratio and the display resolution, the recommended preview resolution is determined.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

SceneMode

The scene mode.

Declaration

public CameraSceneMode SceneMode { get; set; }

Property Value

Type	Description
CameraSceneMode	A CameraSceneMode that specifies the scene mode.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

SoftwareTag

The software information in the EXIF tag.

Declaration

public string SoftwareTag { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

StreamFlip

The stream flip.

Declaration

public Flips StreamFlip { get; set; }

Property Value

Type	Description
Flips	A Flips that specifies the camera flip type.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

StreamRotation

The stream rotation.

Declaration

public Rotation StreamRotation { get; set; }

Property Value

Type	Description
Rotation	A Rotation that specifies the rotation of camera device.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

TheaterMode

The theater mode.

Declaration

public CameraTheaterMode TheaterMode { get; set; }

Property Value

Type	Description
CameraTheaterMode	A CameraTheaterMode that specifies the theater mode.

Remarks

If you want to display the preview image on the external display with the full screen mode, use this property.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

TiltRange

Gets the lower limit and the upper limit for the tilt position.

Declaration

public Range TiltRange { get; }

Property Value

Type	Description
Range

Remarks

If the minimum value is greater than the maximum value, it means this feature is not supported.

Exceptions

Type	Condition
NotSupportedException	In case of this feature is not supported.

API Level: 3

VideoStabilization

Enables or disables the video stabilization feature. If true, video stabilization is enabled, otherwise false.

Declaration

public bool VideoStabilization { get; set; }

Property Value

Type	Description
Boolean

Remarks

If video stabilization is enabled, zero shutter lag is disabled. This feature is used to record a video.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

WhiteBalance

The white balance mode.

Declaration

public CameraWhiteBalance WhiteBalance { get; set; }

Property Value

Type	Description
CameraWhiteBalance	A CameraWhiteBalance that specifies the white balance mode.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

ZoomLevel

The zoom level. The range for the zoom level is received from the ZoomRange property.

Declaration

public int ZoomLevel { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

ZoomRange

Gets the available zoom level.

Declaration

public Range ZoomRange { get; }

Property Value

Type	Description
Range

Remarks

If the minimum value is greater than the maximum value, it means this feature is not supported.

Exceptions

Type	Condition
NotSupportedException	In case of this feature is not supported.

API Level: 3

Methods

ClearFocusArea()

Clears the auto focus area.

Declaration

public void ClearFocusArea()

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

DisableShutterSound(Boolean)

Turn the shutter sound on or off, if it is permitted by policy.

Declaration

public void DisableShutterSound(bool shutterSound)

Parameters

Type	Name	Description
Boolean	shutterSound	Shutter sound On/Off flag

Remarks

If this value is true, shutter sound will be disabled, otherwise enabled. In some countries, this operation is not permitted.

Exceptions

Type	Condition
InvalidOperationException	Disabling shutter sound is not permitted.
ObjectDisposedException	The camera already has been disposed of.

API Level: 4

Feature: http://tizen.org/feature/camera

GetPan()

Gets the current position of the camera.

Declaration

public int GetPan()

Returns

Type	Description
Int32	Returns the camera's horizontal position.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

GetTilt()

Gets the current position of the camera.

Declaration

public int GetTilt()

Returns

Type	Description
Int32	Returns the current vertical position.

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

RemoveGeoTag()

Removes the geo tag(GPS data) in the EXIF(EXchangeable Image File format) tag.

Declaration

public void RemoveGeoTag()

Exceptions

Type	Condition
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

SetAutoFocusArea(Int32, Int32)

Sets the auto focus area.

Declaration

public void SetAutoFocusArea(int x, int y)

Parameters

Type	Name	Description
Int32	x	X position.
Int32	y	Y position.

Remarks

CameraAutoFocusMode should not be the None.

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
InvalidOperationException	In case of any invalid operations.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

SetAutoFocusArea(Point)

Sets the auto focus area.

Declaration

public void SetAutoFocusArea(Point pos)

Parameters

Type	Name	Description
Point	pos	Point structure including X, Y position.

Remarks

CameraAutoFocusMode should not be the None.

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
InvalidOperationException	In case of any invalid operations.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

SetPan(CameraPtzMoveType, Int32)

Sets the position to move horizontally.

Declaration

public void SetPan(CameraPtzMoveType type, int panStep)

Parameters

Type	Name	Description
CameraPtzMoveType	type	The PTZ move type. CameraPtzMoveType.
Int32	panStep	The pan step.

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera

SetTilt(CameraPtzMoveType, Int32)

Sets the position to move vertically.

Declaration

public void SetTilt(CameraPtzMoveType type, int tiltStep)

Parameters

Type	Name	Description
CameraPtzMoveType	type	the PTZ move type.
Int32	tiltStep	The tilt step.

Exceptions

Type	Condition
ArgumentException	In case of invalid parameters.
ObjectDisposedException	The camera already has been disposed of.

API Level: 3

Feature: http://tizen.org/feature/camera