# CameraOptionsType

Simple object for specifying options to showCamera.

Availability
0.8
0.8
9.2.0
Extends
Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# allowEditing

Availability
0.8
9.2.0
allowEditing :Boolean

Specifies if the media should be editable after capture/selection.

Default: false


# androidback

Availability
9.0.0
androidback :Callback<FailureResponse>

Function to call if the user presses the back button.

On Android, this property is considered only if overlay is also set. If the user presses the back button on the phone this callback function will be called. The camera view stays open and you will need to call Ti.Media.hideCamera(); if you want to close it.


# animated

Availability
0.8
9.2.0
animated :Boolean

Specifies if the dialog should be animated upon showing and hiding.

Default: true


# arrowDirection

Availability
0.8
9.2.0
arrowDirection :Number

Controls the type of arrow and position of the popover.

This property is only used if the camera is displayed in a popover (inPopOver is true).


# autohide

Availability
3.2.0
0.8
9.2.0
autohide :Boolean

Specifies if the camera should be hidden automatically after the media capture is completed.

On Android, this property is considered only if overlay is also set. When an overlay is not set, the default Android Camera Activity is used, which is only capable of reporting back the results of one taken photo, making autohide meaningless in that context.

Default: true


# autorotate

Availability
3.4.0
9.2.0
autorotate :Boolean

Determines if the camera preview should rotate or not.

Set to false to disable rotating the camera preview. The camera preview will remain in the same orientation it was opened in.

Set to true to allow the camera preview to rotate when the device rotates. Black bars will appear and disappear as the device is rotated.

Default: true


# cancel

Availability
0.8
0.8
9.2.0
cancel :Callback<FailureResponse>

Function to call if the user presses the cancel button.


# error

Availability
0.8
0.8
9.2.0
error :Callback<FailureResponse>

Function to call upon receiving an error.


# inPopOver

Availability
0.8
9.2.0
inPopOver :Boolean

Show the camera in a popover.

Use inPopOver: true on iPad to display the camera view in a popover.

Default: false


# mediaTypes

Availability
5.4.0
0.8
9.2.0
mediaTypes :Array<String>

Array of media type constants to allow. Note: If you want to select live photos, iOS only allows you to select existing live photos from the gallery, capturing new live photos is not supported by iOS public API, yet.

Default: Both photo and video allowed.


# overlay

Availability
0.8
0.8
9.2.0
overlay :Titanium.UI.View

View to added as an overlay to the camera UI (on top).

On iOS, the overlay view is usually used in conjunction with showControls: false. The transform property can be used to scale and position the camera preview inside the overlay view.

Default: no overlay view


# popoverView

Availability
0.8
9.2.0
popoverView :Titanium.UI.View

View to position the camera or photo gallery popover on top of.

This property is only used if the camera is displayed in a popover (inPopOver is true).


# saveToPhotoGallery

Availability
0.8
0.8
9.2.0
saveToPhotoGallery :Boolean

Specifies if the media should be saved to the photo gallery upon successful capture.

Default: false


# showControls

Availability
0.8
9.2.0
showControls :Boolean

Indicates if the built-in camera controls should be displayed.

Default: true


# success

Availability
0.8
0.8
9.2.0
success :Callback<CameraMediaItemType>

Function to call when the camera is closed after a successful capture/selection.


# transform

Availability
0.8
9.2.0

Transformation matrix to apply to the camera or photogallery view.

Can be used to size and position the camera or photogallery view behind an overlay view. iOS 10 note: There was a known iOS 10 issue caused by Apple that breaks the native camera transformation. Apple fixed this issue in the iOS 10.2 release.

Default: identity matrix


# videoMaximumDuration

Availability
5.4.0
0.8
9.2.0
videoMaximumDuration :Number

Maximum duration (in milliseconds) to allow video capture before completing.


# videoQuality

Availability
5.4.0
0.8
9.2.0
videoQuality :Number

Constant to indicate the video quality during capture.


# whichCamera

Availability
5.4.0
whichCamera :Number

Opens the camera with the specified camera direction.

This API can be assigned the following constants: