Titanium SDK

# PhotoGalleryOptionsType

Simple object for specifying options to openPhotoGallery.

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.

# allowMultiple

Availability
6.0.0
9.2.0
allowMultiple :Boolean

Specifies if the user should be able to select multiple photos.

The allowMultiple property is only available on Android API 18 and above.

# allowTranscoding

Availability
8.1.0
9.2.0
allowTranscoding :Boolean

Specifies if the video should be transcoded (using highest quality preset) . If set to false no video transcoding will be performed.

Default: true

# animated

Availability
0.8
9.2.0
animated :Boolean

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

Default: true

# autohide

Availability
0.8
9.2.0
autohide :Boolean

Specifies if the photo gallery should be hidden automatically after the media selection is completed.

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.

# maxImages

Availability
12.5.0
maxImages :Boolean

Specifies the number of images a user can select at maximum.

Only available on Android API 21 and above and with allowMultiple:true

# mediaTypes

Availability
7.3.0
0.8
9.2.0
mediaTypes :Array<String>

Array of media type constants to allow.

Live photos is only supported on the iOS platform, starting with iOS 9.1. If you want to allow live photos with MEDIA_TYPE_LIVEPHOTO, you also need to specify at least MEDIA_TYPE_PHOTO as a fallback. If you do not allow live photos, they still can be selected, but will be represented as a normal static photo.

This API can be assigned the following constants:

Default: Only photo and video allowed.

# pathOnly

Availability
12.5.0
pathOnly :Boolean

Do not include the blob in the result

# popoverView

Availability
0.8
9.2.0
popoverView :Titanium.UI.View

View to position the photo gallery popover on top of.

# selectionLimit

Availability
9.2.0
selectionLimit :Boolean

Specifies number of media item that can be selected.

Setting this property to zero allows you to select maximum number of media supported by system. This will work only when <Titanium.Media.allowMultiple> is true.

# success

Availability
0.8
0.8
9.2.0
success :Callback<CameraMediaItemType> | Callback<CameraMediaMultipleItemsType>

Function to call when the photo gallery is closed after a successful selection.

If <Titanium.Media.allowMultiple> is true, then CallbackCameraMediaMultipleItemsType will be invoked. Otherwise CallbackCameraMediaItemType will be invoked for single selection.

Contents