Skip to main content

Music & Lyrics

Licensed music, lyrics, and beat sync.

Commonly used

Guides

All APIs in this topic

Reference assets and other modules with a script input and require modules with require('LensStudio:<name>').

Components, assets, and modules

APIDescription
ExternalMusicModuleProvides an interface to the ExternalMusic feature, and opts the Lens into using the feature when present in the scene.
LicensedAudioTrackAssetA Licensed Sounds audio track from Asset LIbrary.

Objects and data

APIDescription
ExternalMusicInfoInformation about an external music track.
FileLicensedSoundProviderA file track provider of the Licensed Sounds from Asset LIbrary.
LyricsRepresents the full set of Lyrics data for tracked music.
LyricsLineRepresents a single line of Lyrics.
LyricsSyncRepresents a single sync/word of a LyricsLine.
LyricsTrackerProvides information about lyrics data for a currently playing track.
SoundSyncRepresents beat synchronization data for a music track.
SoundSyncBeatRepresents a single musical beat used to synchronize effects with music.
SoundSyncTrackerTracks music beats and provides events for beat occurrences and playback state changes.

Enums

APIDescription
LyricsTypeTypes of granularity for lyric data.