Skip to main content

SoundSyncBeat

Class

Represents a single musical beat used to synchronize effects with music.

  • 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.

Since Lens Scripting v321

Index

Extends

Properties

beatIndex

readonly beatIndex: number

The position of this beat within its measure, starting with 1.

Since

Lens Scripting Version 321


timestamp

readonly timestamp: number

The time in seconds when this beat occurs in the music track.

Since

Lens Scripting Version 321

Methods

getTypeName()

static getTypeName(): TypeName<SoundSyncBeat>

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<SoundSyncBeat>

Since

Lens Scripting Version 321

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.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

ScriptObject.isSame