Class Lyrics

Example

const externalMusicModule = require("LensStudio:ExternalMusicModule") as ExternalMusicModule;

@component
export class LyricsExample extends BaseScriptComponent {
    // Make sure an AudioTrack asset is included in the scene. It determines the track that plays.
    // If you see errors, make sure that "Bundled" is unchecked (disabled) on the AudioTrack.
    @input audioAsset: AudioTrackAsset;

    onAwake() {
        const lyricsTracker = externalMusicModule.getLyricsTracker();
        
        lyricsTracker.onLyricsAvailable.add(() => {
            const fullLyrics = lyricsTracker.fullLyrics;

            // Iterate through all lines in the lyrics data
            fullLyrics.lines.forEach(line => {

                // Iterate through all syncs in the line
                line.syncs.forEach(sync => {
                    // Calculate start time for this sync
                    const startTime = line.offset + sync.offset;
                    
                    // Calculate end time for this sync
                    const endTime = line.offset + sync.offsetEnd;

                    // Note that these times can be compared to current playback time using lyricsTracker.playbackPosition.

                    // Get text for this sync
                    // Note: For RichSync lyrics data, each sync text will be a single word or whitespace between words.
                    // For LineSync lyrics data, each sync will be the full line of text.
                    const text = sync.text;
                });
            });
        });
    }
}

Copy