Skip to main content

CameraRollModule

Class

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

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Extends

Properties

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Asset.name


onSelectionsUpdated

readonly onSelectionsUpdated: event1<CameraRollMedia[], void>

Event triggered when selections are updated.


selectedMedia

readonly selectedMedia: CameraRollMedia[]

Array of currently selected media objects.


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Asset.uniqueIdentifier

Methods

getDefaultSelectionLimit()

static getDefaultSelectionLimit(): number

Returns the default selection limit for media picker.

Returns

number

Since

Lens Scripting Version 321


getMaxSelectionLimit()

static getMaxSelectionLimit(): number

Returns the maximum allowed selection limit for media picker.

Returns

number

Since

Lens Scripting Version 321


getTypeName()

static getTypeName(): TypeName<CameraRollModule>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<CameraRollModule>

Overrides

Asset.getTypeName


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): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Asset.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Asset.isSame


showMediaPicker()

showMediaPicker(options): void

Opens the device camera roll interface to allow multiple media selection with specified configuration options.

Parameters

ParameterType
optionsShowOptions

Returns

void

Nested types

Classes

ClassDescription
ShowOptionsConfiguration options for displaying the camera roll media picker.