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.

C#
Copy
public class CameraSettings : object
Inheritance
CameraSettings

Properties

View Source

AntiShake

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

Declaration
C#
Copy
public bool AntiShake { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

AutoContrast

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

Declaration
C#
Copy
public bool AutoContrast { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

AutoFocusMode

The auto focus mode.

Declaration
C#
Copy
public CameraAutoFocusMode AutoFocusMode { get; set; }
Property Value
Type Description
CameraAutoFocusMode

A CameraAutoFocusMode that specifies the auto focus mode.

API Level: 3
View Source

Brightness

The brightness level of the camera.

Declaration
C#
Copy
public int Brightness { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

BrightnessRange

Gets the available brightness value range.

Declaration
C#
Copy
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.

API Level: 3
View Source

CapturePixelFormat

Format of an image to be captured.

Declaration
C#
Copy
public CameraPixelFormat CapturePixelFormat { get; set; }
Property Value
Type Description
CameraPixelFormat

A CameraPixelFormat that specifies the pixel format of captured image.

API Level: 3
View Source

CaptureResolution

Resolution of the captured image.

Declaration
C#
Copy
public Size CaptureResolution { get; set; }
Property Value
Type Description
Size
API Level: 3
View Source

Contrast

The contrast level of the camera.

Declaration
C#
Copy
public int Contrast { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

ContrastRange

Gets the available contrast value range.

Declaration
C#
Copy
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.

API Level: 3
View Source

Effect

The camera effect mode.

Declaration
C#
Copy
public CameraEffectMode Effect { get; set; }
Property Value
Type Description
CameraEffectMode

A CameraEffectMode that specifies the effect mode.

API Level: 3
View Source

EnableTag

The scene mode.

Declaration
C#
Copy
public bool EnableTag { get; set; }
Property Value
Type Description
Boolean

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

API Level: 3
View Source

EncodedPreviewBitrate

The bit rate of the encoded preview.

Declaration
C#
Copy
public int EncodedPreviewBitrate { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

EncodedPreviewGopInterval

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

Declaration
C#
Copy
public int EncodedPreviewGopInterval { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

Exposure

The exposure value.

Declaration
C#
Copy
public int Exposure { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

ExposureMode

The exposure mode.

Declaration
C#
Copy
public CameraExposureMode ExposureMode { get; set; }
Property Value
Type Description
CameraExposureMode

A CameraExposureMode that specifies the exposure mode.

API Level: 3
View Source

ExposureRange

Gets the available exposure value range.

Declaration
C#
Copy
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.

API Level: 3
View Source

FlashMode

The camera's flash mode.

Declaration
C#
Copy
public CameraFlashMode FlashMode { get; set; }
Property Value
Type Description
CameraFlashMode

A CameraFlashMode that specifies the flash mode.

API Level: 3
View Source

FocusLevel

Gets or sets the camera manual focus level.

Declaration
C#
Copy
public int FocusLevel { get; set; }
Property Value
Type Description
Int32
API Level: 11
View Source

FocusLevelRange

Gets the available manual focus level range.

Declaration
C#
Copy
public Range FocusLevelRange { get; }
Property Value
Type Description
Range
Remarks

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

API Level: 11
View Source

Gain

Gets or sets the camera gain value.

Declaration
C#
Copy
public int Gain { get; set; }
Property Value
Type Description
Int32
API Level: 11
View Source

GainRange

Gets the available gain value range.

Declaration
C#
Copy
public Range GainRange { get; }
Property Value
Type Description
Range
Remarks

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

API Level: 11
View Source

GainStep

Gets the camera gain step value.

Declaration
C#
Copy
public int GainStep { get; }
Property Value
Type Description
Int32
API Level: 11
View Source

GeoTag

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

Declaration
C#
Copy
public Location GeoTag { get; set; }
Property Value
Type Description
Location
API Level: 3
View Source

HdrMode

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

Declaration
C#
Copy
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.

API Level: 3
View Source

Hue

The hue level of the camera.

Declaration
C#
Copy
public int Hue { get; set; }
Property Value
Type Description
Int32
API Level: 5
View Source

HueRange

Gets the available hue value range.

Declaration
C#
Copy
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
API Level: 5
View Source

ImageDescriptionTag

The camera image description in the EXIF tag.

Declaration
C#
Copy
public string ImageDescriptionTag { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

ImageQuality

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

Declaration
C#
Copy
public int ImageQuality { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

IsoLevel

The ISO level.

Declaration
C#
Copy
public CameraIsoLevel IsoLevel { get; set; }
Property Value
Type Description
CameraIsoLevel

A CameraIsoLevel that specifies the ISO level.

API Level: 3
View Source

LensOrientation

Gets the camera lens orientation angle.

Declaration
C#
Copy
public int LensOrientation { get; }
Property Value
Type Description
Int32
API Level: 3
View Source

OrientationTag

The camera orientation in the tag.

Declaration
C#
Copy
public CameraTagOrientation OrientationTag { get; set; }
Property Value
Type Description
CameraTagOrientation
API Level: 3
View Source

PanRange

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

Declaration
C#
Copy
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.

API Level: 3
View Source

PreviewFps

The preview frame rate.

Declaration
C#
Copy
public CameraFps PreviewFps { get; set; }
Property Value
Type Description
CameraFps

A CameraFps that specifies the preview frame rate.

API Level: 3
View Source

PreviewPixelFormat

The preview data format.

Declaration
C#
Copy
public CameraPixelFormat PreviewPixelFormat { get; set; }
Property Value
Type Description
CameraPixelFormat

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

API Level: 3
View Source

PreviewResolution

Gets or sets the resolution of the preview.

Declaration
C#
Copy
public Size PreviewResolution { get; set; }
Property Value
Type Description
Size
API Level: 3
View Source

PtzType

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

Declaration
C#
Copy
public CameraPtzType PtzType { set; }
Property Value
Type Description
CameraPtzType

A CameraPtzType that specifies the type of the PTZ.

API Level: 3
View Source

RecommendedPreviewResolution

Gets the recommended preview resolution.

Declaration
C#
Copy
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.

API Level: 3
View Source

Saturation

Gets or sets the camera saturation value.

Declaration
C#
Copy
public int Saturation { get; set; }
Property Value
Type Description
Int32
API Level: 11
View Source

SaturationRange

Gets the available saturation value range.

Declaration
C#
Copy
public Range SaturationRange { get; }
Property Value
Type Description
Range
Remarks

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

API Level: 11
View Source

SceneMode

The scene mode.

Declaration
C#
Copy
public CameraSceneMode SceneMode { get; set; }
Property Value
Type Description
CameraSceneMode

A CameraSceneMode that specifies the scene mode.

API Level: 3
View Source

Sharpness

Gets or sets the camera sharpness value.

Declaration
C#
Copy
public int Sharpness { get; set; }
Property Value
Type Description
Int32
API Level: 11
View Source

SharpnessRange

Gets the available sharpness value range.

Declaration
C#
Copy
public Range SharpnessRange { get; }
Property Value
Type Description
Range
Remarks

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

API Level: 11
View Source

SoftwareTag

The software information in the EXIF tag.

Declaration
C#
Copy
public string SoftwareTag { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

StreamFlip

The stream flip.

Declaration
C#
Copy
public Flips StreamFlip { get; set; }
Property Value
Type Description
Flips

A Flips that specifies the camera flip type.

API Level: 3
View Source

StreamRotation

The stream rotation.

Declaration
C#
Copy
public Rotation StreamRotation { get; set; }
Property Value
Type Description
Rotation

A Rotation that specifies the rotation of camera device.

API Level: 3
View Source

TheaterMode

The theater mode.

Declaration
C#
Copy
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.

API Level: 3
View Source

TiltRange

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

Declaration
C#
Copy
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.

API Level: 3
View Source

VideoStabilization

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

Declaration
C#
Copy
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.

API Level: 3
View Source

WhiteBalance

The white balance mode.

Declaration
C#
Copy
public CameraWhiteBalance WhiteBalance { get; set; }
Property Value
Type Description
CameraWhiteBalance

A CameraWhiteBalance that specifies the white balance mode.

API Level: 3
View Source

WhiteBalanceTemperature

Gets or sets the camera white balance temperature value.

Declaration
C#
Copy
public int WhiteBalanceTemperature { get; set; }
Property Value
Type Description
Int32
API Level: 11
View Source

WhiteBalanceTemperatureRange

Gets the available camera white balance temperature value range.

Declaration
C#
Copy
public Range WhiteBalanceTemperatureRange { get; }
Property Value
Type Description
Range
Remarks

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

API Level: 11
View Source

WhiteBalanceTemperatureStep

Gets the camera white balance temperature step value.

Declaration
C#
Copy
public int WhiteBalanceTemperatureStep { get; }
Property Value
Type Description
Int32
API Level: 11
View Source

ZoomLevel

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

Declaration
C#
Copy
public int ZoomLevel { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

ZoomRange

Gets the available zoom value range.

Declaration
C#
Copy
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.

API Level: 3

Methods

View Source

ClearFocusArea()

Clears the auto focus area.

Declaration
C#
Copy
public void ClearFocusArea()
API Level: 3
Feature: http://tizen.org/feature/camera
View Source

DisableShutterSound(Boolean)

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

Declaration
C#
Copy
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.

API Level: 4
Feature: http://tizen.org/feature/camera
View Source

GetExtraPreviewBitrate(Int32)

Gets the bitrate of extra preview with given stream ID.

Declaration
C#
Copy
public int GetExtraPreviewBitrate(int streamId)
Parameters
Type Name Description
Int32 streamId

The stream ID.

Returns
Type Description
Int32

A bitrate of extra stream.

API Level: 10
View Source

GetExtraPreviewGopInterval(Int32)

Gets the GOP(Group Of Pictures) interval of extra preview with given stream ID.

Declaration
C#
Copy
public int GetExtraPreviewGopInterval(int streamId)
Parameters
Type Name Description
Int32 streamId

The stream ID.

Returns
Type Description
Int32

A GOP interval of extra preview.

API Level: 10
View Source

GetExtraPreviewRotation()

Gets the rotation of preview frame.

Declaration
C#
Copy
public Rotation GetExtraPreviewRotation()
Returns
Type Description
Rotation

A rotation of preview frame.

View Source

GetExtraPreviewRotation(Int32)

Gets the rotation of preview frame with given stream ID.

Declaration
C#
Copy
public Rotation GetExtraPreviewRotation(int streamId)
Parameters
Type Name Description
Int32 streamId

The stream ID.

Returns
Type Description
Rotation

A rotation of extra preview.

API Level: 10
View Source

GetExtraPreviewStreamInfo(Int32)

Gets the information of extra preview stream.

Declaration
C#
Copy
public ExtraPreviewStreamInfo GetExtraPreviewStreamInfo(int streamId)
Parameters
Type Name Description
Int32 streamId

The stream ID.

Returns
Type Description
ExtraPreviewStreamInfo

A extra stream information.

API Level: 10
View Source

GetPan()

Gets the current position of the camera.

Declaration
C#
Copy
public int GetPan()
Returns
Type Description
Int32

Returns the camera's horizontal position.

API Level: 3
Feature: http://tizen.org/feature/camera
View Source

GetPreviewFrameRotation()

Gets the rotation of preview frame.

Declaration
C#
Copy
public Rotation GetPreviewFrameRotation()
Returns
Type Description
Rotation

A rotation of preview frame.

View Source

GetTilt()

Gets the current position of the camera.

Declaration
C#
Copy
public int GetTilt()
Returns
Type Description
Int32

Returns the current vertical position.

API Level: 3
Feature: http://tizen.org/feature/camera
View Source

RemoveGeoTag()

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

Declaration
C#
Copy
public void RemoveGeoTag()
API Level: 3
Feature: http://tizen.org/feature/camera
View Source

SetAutoFocusArea(Int32, Int32)

Sets the auto focus area.

Declaration
C#
Copy
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.

API Level: 3
Feature: http://tizen.org/feature/camera
View Source

SetAutoFocusArea(Point)

Sets the auto focus area.

Declaration
C#
Copy
public void SetAutoFocusArea(Point pos)
Parameters
Type Name Description
Point pos

Point structure including X, Y position.

Remarks

CameraAutoFocusMode should not be the None.

API Level: 3
Feature: http://tizen.org/feature/camera
View Source

SetExtraPreviewBitrate(Int32, Int32)

Sets the bitrate of extra preview with given stream ID.

Declaration
C#
Copy
public void SetExtraPreviewBitrate(int streamId, int bitrate)
Parameters
Type Name Description
Int32 streamId

The stream ID.

Int32 bitrate

The bitrate for extra preview.

API Level: 10
View Source

SetExtraPreviewGopInterval(Int32, Int32)

Sets The GOP(Group Of Pictures) interval of extra preview with given stream ID.

Declaration
C#
Copy
public void SetExtraPreviewGopInterval(int streamId, int gopInterval)
Parameters
Type Name Description
Int32 streamId

The stream ID.

Int32 gopInterval

The GOP interval for extra preview.

API Level: 10
View Source

SetExtraPreviewStreamInfo(ExtraPreviewStreamInfo)

Sets the information of extra preview stream.

Declaration
C#
Copy
public void SetExtraPreviewStreamInfo(ExtraPreviewStreamInfo info)
Parameters
Type Name Description
ExtraPreviewStreamInfo info

The extra preview stream information.

API Level: 10
View Source

SetPan(CameraPtzMoveType, Int32)

Sets the position to move horizontally.

Declaration
C#
Copy
public void SetPan(CameraPtzMoveType type, int panStep)
Parameters
Type Name Description
CameraPtzMoveType type

The PTZ move type. CameraPtzMoveType.

Int32 panStep

The pan step.

API Level: 3
Feature: http://tizen.org/feature/camera
View Source

SetTilt(CameraPtzMoveType, Int32)

Sets the position to move vertically.

Declaration
C#
Copy
public void SetTilt(CameraPtzMoveType type, int tiltStep)
Parameters
Type Name Description
CameraPtzMoveType type

the PTZ move type.

Int32 tiltStep

The tilt step.

API Level: 3
Feature: http://tizen.org/feature/camera

Extension Methods