Class MetaInfo

Metadata of the current project's Lens.

Index

Constructors

Properties

activationCamera iconPath isIconSet lensApplicability lensClientCompatibilities lensName videoPreviewPath

Methods

isLensNameValid setIcon setVideoPreview

Constructors

`Protected`constructor

new MetaInfo(): MetaInfo
Snap Hidden
Returns MetaInfo

Properties

activationCamera

activationCamera: LensActivationCamera

The camera which will be activated when this Lens is turned on.

`Readonly`iconPath

iconPath: Path

The absolute path to the Lens Icon.

`Readonly`isIconSet

isIconSet: boolean

Whether an Lens icon has been set.

lensApplicability

lensApplicability: LensApplicability[]

Where the Lens can be used.

lensClientCompatibilities

lensClientCompatibilities: LensClientCompatibility[]

lensName

lensName: string

The publicly visible name of the Lens.

`Readonly`videoPreviewPath

videoPreviewPath: Path

Methods

`Static`isLensNameValid

isLensNameValid(lensName: string): boolean
Checks whether the Lens Name is valid. See Project Info guide to learn more.
Parameters
- lensName: string
Returns boolean

setIcon

setIcon(externalPath: Path): void
Sets the icon as the Lens' icon.
Parameters
- externalPath: Path
Returns void

setVideoPreview

setVideoPreview(externalPath: Path): void
Parameters
- externalPath: Path
Returns void