flash.media

# CameraRollBrowseOptions - AS3

Package | flash.media
Class | public class CameraRollBrowseOptions
Inheritance | CameraRollBrowseOptions Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

The CameraRollBrowseOptions class defines the initialization options that may be used when using the Camera Roll API to launch the Image Picker. This is presently used only on iOS where the image picker does not occupy the entire screen. On all other platforms and devices these are ignored.

Related API Elements

flash.media.CameraRoll

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | height : Number Specifies the height of the CameraRoll image picker. | CameraRollBrowseOptions
|  | origin : Rectangle Specifies the origin rect of the object that launched CameraRoll image picker. | CameraRollBrowseOptions
|  | width : Number Specifies the width of the CameraRoll image picker. | CameraRollBrowseOptions

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | CameraRollBrowseOptions() Creates a new CameraRollBrowseOptions object. | CameraRollBrowseOptions
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### height

property

`height:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

Specifies the height of the CameraRoll image picker.

Note that this is only a request to create the image picker of this height. However if its not possible to draw the picker of the required size then it is ignored and the system default value is used. Specifying a negative value for the height results in an ArgumentError.

Note that this is presently being used on iOS (iPad) only.

The default value is `0.0.`

Implementation
`public function get height():Number`
`public function set height(value:Number):void`

### origin

property

`origin:Rectangle`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

Specifies the origin rect of the object that launched CameraRoll image picker. This is used to position the image picker in such a way that it does not cover this rectangle. If howeveer the dimensions of the image picker are such that it is not possible to draw it on the screen without overlapping with this rect then the image picker would overlap with it Specifying a negative value for either the width or the height would result in an ArgumentError.

The default value is `0.0.`

Implementation
`public function get origin():Rectangle`
`public function set origin(value:Rectangle):void`

### width

property

`width:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

Specifies the width of the CameraRoll image picker.

The value should be in range of 320 - 600 for iOS devices. If the value is outside that range on iOS5 and above or the application is compiled for AIR 3.1 or later, a value less than 320 is changed to 320 and a value greater than 600 is changed to 600.

Note that this is only a request to create the image picker of this width. However if its not possible to draw the picker of the required size then it is ignored and the system default value is used. Specifying a negative value for the width results in an ArgumentError.

Note that this option is only used on iOS (iPad).

The default value is `0.0.`

Implementation
`public function get width():Number`
`public function set width(value:Number):void`
Constructor Detail

### CameraRollBrowseOptions

()
Constructor

`public function CameraRollBrowseOptions()`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

Creates a new CameraRollBrowseOptions object.

The default values of the newly created object are:

- `width = 0.0`
- `height = 0.0`
- `origin = new Rectangle (0.0, 0.0, 0.0, 0.0)`

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00