Class CameraSettings

    Definition

    Namespace:
    Tizen.Multimedia
    Assembly:
    Tizen.Multimedia.Camera.dll

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

    public class CameraSettings
    Inheritance
    object
    CameraSettings

    Properties

    View Source

    AntiShake

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

    Declaration
    public bool AntiShake { get; set; }
    Property Value
    Type Description
    bool
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    AutoContrast

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

    Declaration
    public bool AutoContrast { get; set; }
    Property Value
    Type Description
    bool
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    Brightness

    The brightness level of the camera.

    Declaration
    public int Brightness { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    BrightnessRange

    Gets the available brightness value range.

    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
    System.NotSupportedException

    In case of this feature is not supported.

    View Source

    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
    System.ArgumentException

    In case of invalid parameters.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    CaptureResolution

    Resolution of the captured image.

    Declaration
    public Size CaptureResolution { get; set; }
    Property Value
    Type Description
    Size
    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameters.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    Contrast

    The contrast level of the camera.

    Declaration
    public int Contrast { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    ContrastRange

    Gets the available contrast value range.

    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
    System.NotSupportedException

    In case of this feature is not supported.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    EnableTag

    The scene mode.

    Declaration
    public bool EnableTag { get; set; }
    Property Value
    Type Description
    bool

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

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    EncodedPreviewBitrate

    The bit rate of the encoded preview.

    Declaration
    public int EncodedPreviewBitrate { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    EncodedPreviewGopInterval

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

    Declaration
    public int EncodedPreviewGopInterval { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    Exposure

    The exposure value.

    Declaration
    public int Exposure { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    ExposureRange

    Gets the available exposure value range.

    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
    System.NotSupportedException

    In case of this feature is not supported.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    FocusLevel

    Gets or sets the camera manual focus level.

    Declaration
    public int FocusLevel { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    FocusLevelRange

    Gets the available manual focus level range.

    Declaration
    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.

    Exceptions
    Type Condition
    System.NotSupportedException

    Focus level is not supported.

    View Source

    Gain

    Gets or sets the camera gain value.

    Declaration
    public int Gain { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GainRange

    Gets the available gain value range.

    Declaration
    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.

    Exceptions
    Type Condition
    System.NotSupportedException

    Gain is not supported.

    View Source

    GainStep

    Gets the camera gain step value.

    Declaration
    public int GainStep { get; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GeoTag

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

    Declaration
    public Location GeoTag { get; set; }
    Property Value
    Type Description
    Location
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    Hue

    The hue level of the camera.

    Declaration
    public int Hue { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    HueRange

    Gets the available hue value range.

    Declaration
    public Range? HueRange { get; }
    Property Value
    Type Description
    Range?
    Remarks

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

    See Also
    Hue
    View Source

    ImageDescriptionTag

    The camera image description in the EXIF tag.

    Declaration
    public string ImageDescriptionTag { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    LensOrientation

    Gets the camera lens orientation angle.

    Declaration
    public int LensOrientation { get; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    OrientationTag

    The camera orientation in the tag.

    Declaration
    public CameraTagOrientation OrientationTag { get; set; }
    Property Value
    Type Description
    CameraTagOrientation
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.NotSupportedException

    In case of this feature is not supported.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ArgumentException

    In case of invalid parameters.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    PreviewResolution

    Gets or sets the resolution of the preview.

    Declaration
    public Size PreviewResolution { get; set; }
    Property Value
    Type Description
    Size
    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameters.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    Saturation

    Gets or sets the camera saturation value.

    Declaration
    public int Saturation { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SaturationRange

    Gets the available saturation value range.

    Declaration
    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.

    Exceptions
    Type Condition
    System.NotSupportedException

    Saturation is not supported.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    Sharpness

    Gets or sets the camera sharpness value.

    Declaration
    public int Sharpness { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SharpnessRange

    Gets the available sharpness value range.

    Declaration
    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.

    Exceptions
    Type Condition
    System.NotSupportedException

    Sharpness is not supported.

    View Source

    SoftwareTag

    The software information in the EXIF tag.

    Declaration
    public string SoftwareTag { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.NotSupportedException

    In case of this feature is not supported.

    View Source

    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
    bool
    Remarks

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

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    WhiteBalanceTemperature

    Gets or sets the camera white balance temperature value.

    Declaration
    public int WhiteBalanceTemperature { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    WhiteBalanceTemperatureRange

    Gets the available camera white balance temperature value range.

    Declaration
    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.

    Exceptions
    Type Condition
    System.NotSupportedException

    WhiteBalanceTemperatureRange is not supported.

    View Source

    WhiteBalanceTemperatureStep

    Gets the camera white balance temperature step value.

    Declaration
    public int WhiteBalanceTemperatureStep { get; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    ZoomRange

    Gets the available zoom value range.

    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
    System.NotSupportedException

    In case of this feature is not supported.

    Methods

    View Source

    ClearFocusArea()

    Clears the auto focus area.

    Declaration
    public void ClearFocusArea()
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    DisableShutterSound(bool)

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

    Declaration
    public void DisableShutterSound(bool shutterSound)
    Parameters
    Type Name Description
    bool 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
    System.InvalidOperationException

    Disabling shutter sound is not permitted.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GetExtraPreviewBitrate(int)

    Gets the bitrate of extra preview with given stream ID.

    Declaration
    public int GetExtraPreviewBitrate(int streamId)
    Parameters
    Type Name Description
    int streamId

    The stream ID.

    Returns
    Type Description
    int

    A bitrate of extra stream.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GetExtraPreviewGopInterval(int)

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

    Declaration
    public int GetExtraPreviewGopInterval(int streamId)
    Parameters
    Type Name Description
    int streamId

    The stream ID.

    Returns
    Type Description
    int

    A GOP interval of extra preview.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GetExtraPreviewRotation(int)

    Gets the rotation of preview frame with given stream ID.

    Declaration
    public Rotation GetExtraPreviewRotation(int streamId)
    Parameters
    Type Name Description
    int streamId

    The stream ID.

    Returns
    Type Description
    Rotation

    A rotation of extra preview.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GetExtraPreviewStreamInfo(int)

    Gets the information of extra preview stream.

    Declaration
    public ExtraPreviewStreamInfo GetExtraPreviewStreamInfo(int streamId)
    Parameters
    Type Name Description
    int streamId

    The stream ID.

    Returns
    Type Description
    ExtraPreviewStreamInfo

    A extra stream information.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GetPan()

    Gets the current position of the camera.

    Declaration
    public int GetPan()
    Returns
    Type Description
    int

    Returns the camera's horizontal position.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    GetTilt()

    Gets the current position of the camera.

    Declaration
    public int GetTilt()
    Returns
    Type Description
    int

    Returns the current vertical position.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    RemoveGeoTag()

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

    Declaration
    public void RemoveGeoTag()
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SetAutoFocusArea(int, int)

    Sets the auto focus area.

    Declaration
    public void SetAutoFocusArea(int x, int y)
    Parameters
    Type Name Description
    int x

    X position.

    int y

    Y position.

    Remarks

    CameraAutoFocusMode should not be the None.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameters.

    System.InvalidOperationException

    In case of any invalid operations.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    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
    System.ArgumentException

    In case of invalid parameters.

    System.InvalidOperationException

    In case of any invalid operations.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SetExtraPreviewBitrate(int, int)

    Sets the bitrate of extra preview with given stream ID.

    Declaration
    public void SetExtraPreviewBitrate(int streamId, int bitrate)
    Parameters
    Type Name Description
    int streamId

    The stream ID.

    int bitrate

    The bitrate for extra preview.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SetExtraPreviewGopInterval(int, int)

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

    Declaration
    public void SetExtraPreviewGopInterval(int streamId, int gopInterval)
    Parameters
    Type Name Description
    int streamId

    The stream ID.

    int gopInterval

    The GOP interval for extra preview.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SetExtraPreviewStreamInfo(ExtraPreviewStreamInfo)

    Sets the information of extra preview stream.

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

    The extra preview stream information.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SetPan(CameraPtzMoveType, int)

    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.

    int panStep

    The pan step.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameters.

    System.ObjectDisposedException

    The camera has already been disposed.

    View Source

    SetTilt(CameraPtzMoveType, int)

    Sets the position to move vertically.

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

    the PTZ move type.

    int tiltStep

    The tilt step.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameters.

    System.ObjectDisposedException

    The camera has already been disposed.

    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX