Music & Lyrics
Licensed music, lyrics, and beat sync.
Commonly used
LyricsTrackerProvides information about lyrics data for a currently playing track.SoundSyncTrackerTracks music beats and provides events for beat occurrences and playback state changes.ExternalMusicModuleProvides an interface to the ExternalMusic feature, and opts the Lens into using the feature when present in the scene.
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
| API | Description |
|---|---|
| ExternalMusicModule | Provides an interface to the ExternalMusic feature, and opts the Lens into using the feature when present in the scene. |
| LicensedAudioTrackAsset | A Licensed Sounds audio track from Asset LIbrary. |
Objects and data
| API | Description |
|---|---|
| ExternalMusicInfo | Information about an external music track. |
| FileLicensedSoundProvider | A file track provider of the Licensed Sounds from Asset LIbrary. |
| Lyrics | Represents the full set of Lyrics data for tracked music. |
| LyricsLine | Represents a single line of Lyrics. |
| LyricsSync | Represents a single sync/word of a LyricsLine. |
| LyricsTracker | Provides information about lyrics data for a currently playing track. |
| SoundSync | Represents beat synchronization data for a music track. |
| SoundSyncBeat | Represents a single musical beat used to synchronize effects with music. |
| SoundSyncTracker | Tracks music beats and provides events for beat occurrences and playback state changes. |
Enums
| API | Description |
|---|---|
| LyricsType | Types of granularity for lyric data. |