Skip to content

Titanium.Media.CameraOptionsType

Simple object for specifying options to showCamera.

Properties #

allowEditing#

Type: Boolean

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

androidback#

Type: 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#

Type: Boolean

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

arrowDirection#

Type: 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#

Type: 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.

autorotate#

Type: 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.

cancel#

Type: Callback<FailureResponse>

Function to call if the user presses the cancel button.

error#

Type: Callback<FailureResponse>

Function to call upon receiving an error.

inPopOver#

Type: Boolean

Show the camera in a popover.

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

mediaTypes#

Type: 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.

open#

Type: Callback<CameraOpen>

Function to call when the camera is shown

overlay#

Type: 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.

popoverView#

Type: 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).

recording#

Type: Callback<CameraRecordingCallback>

Function to call during recording. Returns size and duration.

saveToPhotoGallery#

Type: Boolean

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

showControls#

Type: Boolean

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

success#

Type: Callback<CameraMediaItemType>

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

targetImageHeight#

Type: Number

Maximum height of the saved image. Depending on your phone and your value this might not be
exactly the value you specify. Check Ti.Media.cameraOutputSizes first.

targetImageWidth#

Type: Number

Maximum width of the saved image. Depending on your phone and your value this might not be
exactly the value you specify. Check Ti.Media.cameraOutputSizes first.

transform#

Type: Titanium.UI.Matrix2D

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.

videoMaximumDuration#

Type: Number

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

videoQuality#

Type: Number

Constant to indicate the video quality during capture.

whichCamera#

Type: Number

Opens the camera with the specified camera direction.

zoomEnabled#

Type: Boolean

Specifies if pinch to zoom is enabled or not.

Titanium SDK Documentation