Skip to main content

SoundSync

Class

Represents beat synchronization data for a music track.

  • 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

allBeatsTimestampMS

readonly allBeatsTimestampMS: number[]

Timestamps of all beats in the music track in milliseconds.


beatPeriodMS

readonly beatPeriodMS: number

The interval between consecutive beats in milliseconds.


beatsPerMinute

readonly beatsPerMinute: number

Tempo of the music track expressed as beats per minute (BPM).


downbeatsTimestampsMS

readonly downbeatsTimestampsMS: number[]

Timestamps of downbeats in milliseconds.


numBeatsInMeasure

readonly numBeatsInMeasure: number

Number of beats in each musical measure of this music track.


trackDurationSeconds

readonly trackDurationSeconds: number

Total duration of the track in seconds.

Methods

getTypeName()

static getTypeName(): TypeName<SoundSync>

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

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