Interface IPhotography

Interface IPhotography - used to get and set camera settings.

Namespace: VisioForge.Core.Types.X.Photography

Assembly: VisioForge.Core.dll

Syntax

public interface IPhotography

Methods

GetAperture(out uint)

Gets the aperture.

Declaration

bool GetAperture(out uint aperture)

Parameters

Type	Name	Description
uint	aperture	The aperture.

Returns

Type	Description
bool	true if successful, false otherwise.

GetColorToneMode(out PhotographyColorToneMode)

Gets the color tone mode.

Declaration

bool GetColorToneMode(out PhotographyColorToneMode mode)

Parameters

Type	Name	Description
PhotographyColorToneMode	mode	The mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetEVCompensation(out float)

Get the ev compensation value.

Declaration

bool GetEVCompensation(out float ev_comp)

Parameters

Type	Name	Description
float	ev_comp	The ev comp.

Returns

Type	Description
bool	true if successful, false otherwise.

GetExposureMode(out PhotographyExposureMode)

Gets the exposure mode.

Declaration

bool GetExposureMode(out PhotographyExposureMode exposureMode)

Parameters

Type	Name	Description
PhotographyExposureMode	exposureMode	The exposure mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetExposureTime(out uint)

Get the fixed exposure time (in ms).

Declaration

bool GetExposureTime(out uint exposureTime)

Parameters

Type	Name	Description
uint	exposureTime	The exposure.

Returns

Type	Description
bool	true if successful, false otherwise.

GetFlashMode(out PhotographyFlashMode)

Gets the flash mode.

Declaration

bool GetFlashMode(out PhotographyFlashMode flash_mode)

Parameters

Type	Name	Description
PhotographyFlashMode	flash_mode	The flash mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetFlickerMode(out PhotographyFlickerReductionMode)

Gets the flicker mode.

Declaration

bool GetFlickerMode(out PhotographyFlickerReductionMode mode)

Parameters

Type	Name	Description
PhotographyFlickerReductionMode	mode	The mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetFocusMode(out PhotographyFocusMode)

Gets the focus mode.

Declaration

bool GetFocusMode(out PhotographyFocusMode mode)

Parameters

Type	Name	Description
PhotographyFocusMode	mode	The mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetISO(out uint)

Get the ISO value (light sensivity).

Declaration

bool GetISO(out uint iso_speed)

Parameters

Type	Name	Description
uint	iso_speed	The iso speed.

Returns

Type	Description
bool	true if successful, false otherwise.

GetNoiseReduction(out PhotographyNoiseReduction)

Gets the noise reduction.

Declaration

bool GetNoiseReduction(out PhotographyNoiseReduction noise_reduction)

Parameters

Type	Name	Description
PhotographyNoiseReduction	noise_reduction	The noise reduction.

Returns

Type	Description
bool	true if successful, false otherwise.

GetSceneMode(out PhotographySceneMode)

Gets the scene mode.

Declaration

bool GetSceneMode(out PhotographySceneMode scene_mode)

Parameters

Type	Name	Description
PhotographySceneMode	scene_mode	The scene mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetWhiteBalanceMode(out PhotographyWhiteBalanceMode)

Gets the white balance mode.

Declaration

bool GetWhiteBalanceMode(out PhotographyWhiteBalanceMode wb_mode)

Parameters

Type	Name	Description
PhotographyWhiteBalanceMode	wb_mode	The wb mode.

Returns

Type	Description
bool	true if successful, false otherwise.

GetZoom(out float)

Gets the zoom.

Declaration

bool GetZoom(out float zoom)

Parameters

Type	Name	Description
float	zoom	The zoom.

Returns

Type	Description
bool	true if successful, false otherwise.

PrepareForCapture()

Start preparations for capture. Preparations can take indeterminate amount of time and func callback is called after preparations are done. Image capture will begin after callback returns.

Declaration

bool PrepareForCapture()

Returns

Type	Description
bool	true if successful, false otherwise.

SetAperture(uint)

Sets the aperture.

Declaration

bool SetAperture(uint aperture)

Parameters

Type	Name	Description
uint	aperture	The aperture.

Returns

Type	Description
bool	true if successful, false otherwise.

SetAutoFocus(bool)

Sets the automatic focus.

Declaration

void SetAutoFocus(bool on)

Parameters

Type	Name	Description
bool	on	if set to true [on].

SetColorToneMode(PhotographyColorToneMode)

Sets the color tone mode.

Declaration

bool SetColorToneMode(PhotographyColorToneMode tone_mode)

Parameters

Type	Name	Description
PhotographyColorToneMode	tone_mode	The tone mode.

Returns

Type	Description
bool	true if successful, false otherwise.

SetEVCompensation(float)

Sets the ev compensation.

Declaration

bool SetEVCompensation(float ev_comp)

Parameters

Type	Name	Description
float	ev_comp	The ev comp.

Returns

Type	Description
bool	true if successful, false otherwise.

SetExposureMode(PhotographyExposureMode)

Sets the exposure mode.

Declaration

bool SetExposureMode(PhotographyExposureMode value)

Parameters

Type	Name	Description
PhotographyExposureMode	value	The value.

Returns

Type	Description
bool	true if successful, false otherwise.

SetExposureTime(uint)

Set the fixed exposure time (in ms).

Declaration

bool SetExposureTime(uint exposure)

Parameters

Type	Name	Description
uint	exposure	The exposure.

Returns

Type	Description
bool	true if successful, false otherwise.

SetFlashMode(PhotographyFlashMode)

Sets the flash mode.

Declaration

bool SetFlashMode(PhotographyFlashMode flash_mode)

Parameters

Type	Name	Description
PhotographyFlashMode	flash_mode	The flash mode.

Returns

Type	Description
bool	true if successful, false otherwise.

SetFlickerMode(PhotographyFlickerReductionMode)

Sets the flicker mode.

Declaration

bool SetFlickerMode(PhotographyFlickerReductionMode mode)

Parameters

Type	Name	Description
PhotographyFlickerReductionMode	mode	The mode.

Returns

Type	Description
bool	true if successful, false otherwise.

SetFocusMode(PhotographyFocusMode)

Sets the focus mode.

Declaration

bool SetFocusMode(PhotographyFocusMode mode)

Parameters

Type	Name	Description
PhotographyFocusMode	mode	The mode.

Returns

Type	Description
bool	true if successful, false otherwise.

SetISO(uint)

Sets the ISO.

Declaration

bool SetISO(uint iso_speed)

Parameters

Type	Name	Description
uint	iso_speed	The iso speed.

Returns

Type	Description
bool	true if successful, false otherwise.

SetNoiseReduction(PhotographyNoiseReduction)

Sets the noise reduction.

Declaration

bool SetNoiseReduction(PhotographyNoiseReduction noise_reduction)

Parameters

Type	Name	Description
PhotographyNoiseReduction	noise_reduction	The noise reduction.

Returns

Type	Description
bool	true if successful, false otherwise.

SetSceneMode(PhotographySceneMode)

Sets the scene mode.

Declaration

bool SetSceneMode(PhotographySceneMode scene_mode)

Parameters

Type	Name	Description
PhotographySceneMode	scene_mode	The scene mode.

Returns

Type	Description
bool	true if successful, false otherwise.

SetWhiteBalanceMode(PhotographyWhiteBalanceMode)

Sets the white balance mode.

Declaration

bool SetWhiteBalanceMode(PhotographyWhiteBalanceMode wb_mode)

Parameters

Type	Name	Description
PhotographyWhiteBalanceMode	wb_mode	The wb mode.

Returns

Type	Description
bool	true if successful, false otherwise.

SetZoom(float)

Sets the zoom.

Declaration

bool SetZoom(float zoom)

Parameters

Type	Name	Description
float	zoom	The zoom.

Returns

Type	Description
bool	true if successful, false otherwise.