Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/TextAliveJp/textalive-app-api/llms.txt

Use this file to discover all available pages before exploring further.

For the latest releases, visit the GitHub releases page. Development history and design notes are recorded on the TextAlive App API Scrapbox page.

​
Version 0.4.0

Current release — published as textalive-app-api@0.4.0 on npm. This version ships the following production dependencies:
PackageVersion
axios^1.6.8
webfontloader^1.6.28
songle-api (optional)^1.2.2
songle-api is an optional dependency. It provides beat and music structure analysis powered by the Songle engine. The package will work without it, but music map data will be fetched from the TextAlive API server rather than computed locally.

​
Deprecations in 0.4.0

The following APIs are deprecated. They remain functional for backwards compatibility but may be removed in a future version. Update your code to use the replacements shown below.
IDataLoader.lyricsId is deprecated. Use the id property on the LyricsInfo object (IDataLoader.lyrics.id) instead. The lyricsId shortcut will not be maintained going forward.
IDataLoader.text is deprecated. Use the text property on the LyricsBody object (IDataLoader.lyricsBody.text) instead. The top-level text shortcut will not be maintained going forward.
Player.setMediaElement() is deprecated. Set the media element by assigning to the IPlayer.mediaElement property directly. The setMediaElement method is a legacy setter that predates the property-based API.
Player.setMediaPosition() is deprecated. Use IPlayer.requestMediaSeek(position) to seek to a position in the media. The setMediaPosition method is superseded by the request-based seek API.
ISongExplorer.findChorusBetween() is deprecated (also exposed as IPlayer.findChorusBetween). Use findChorus(time, options?) instead. The new method accepts a single timestamp and optional search options rather than a start/end range.

​
Package metadata

Build docs developers (and LLMs) love

Get started for freeTalk to us