Class CameraRollModule

Provides an interface to the device’s camera roll and allows users to select multiple media.

Hierarchy (View Summary)

Asset
- CameraRollModule

Index

Properties

name onSelectionsUpdated selectedMedia uniqueIdentifier

Methods

getDefaultSelectionLimit getMaxSelectionLimit getTypeName hideMediaPicker isOfType isSame showMediaPicker

Properties

name

name: string

The name of the Asset in Lens Studio.

`Readonly`onSelectionsUpdated

onSelectionsUpdated: event1<CameraRollMedia[], void>

Event triggered when selections are updated.

`Readonly`selectedMedia

selectedMedia: CameraRollMedia[]

Array of currently selected media objects.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

`Static`getDefaultSelectionLimit

getDefaultSelectionLimit(): number
Returns the default selection limit for media picker.

Returns number

`Static`getMaxSelectionLimit

getMaxSelectionLimit(): number
Returns the maximum allowed selection limit for media picker.

Returns number

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Asset.getTypeName

hideMediaPicker

hideMediaPicker(): void
Closes the device camera roll interface.

Returns void

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Asset.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Asset.isSame

showMediaPicker

showMediaPicker(options: ShowOptions): void
Opens the device camera roll interface to allow multiple media selection with specified configuration options.
Parameters
- options: ShowOptions
Returns void