Textalive-app-api NPM

TextAlive App API

TextAlive App API is the JavaScript API for developing web applications that show lyrics synchronized with the music playback (lyric apps) -- as opposed to lyric videos in which each frame is statically rendered as an image.

This API allows the applications to retrieve music scene descriptions of a musical piece on the web, such as beat timings, repetitive segments, etc. It also allows retrieving lyrics information, such as lyrics text, timings of each character being vocalized, and morphological analysis results.

The API decouples the applications from concrete musical pieces by introducing abstract data types of music scene descriptions and lyrics. The applications can synchronize to the musical pieces registered to TextAlive.

For the English overview of the TextAlive project, please refer to the academic project page.

日本語は README.md にあります。

TextAlive

Usage

TextAlive App API can be used by script tags in an HTML document or by installing the npm package textalive-app-api.

The primary entry point to the API features is the Player class. To use it, you would need an application token that can be retrieved in the TextAlive for Developers website. Please note that all of the API documents are bi-lingual -- written in both Japanese and English.

`script` tags

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script src="https://unpkg.com/textalive-app-api/dist/index.js"></script>

The global variable TextAliveApp is defined after these lines of code. The API components can be retrieved through the variable e.g., const { Player } = TextAliveApp;.