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.

​
Package manager

Install textalive-app-api from npm: 
npm install textalive-app-api

​
ES module import

import { Player } from "textalive-app-api";

​
CommonJS require

const { Player } = require("textalive-app-api");

​
TypeScript types

TypeScript type definitions are bundled with the package at dist/textalive-app-api.d.ts and are automatically picked up by the TypeScript compiler — no separate @types package is needed. The exports field in package.json routes imports to the correct build:
ConditionFile
import (ESM)dist/index.es.js
require (CJS)dist/index.js
typesdist/textalive-app-api.d.ts

​
CDN

Load the API directly in an HTML file without a build step. The API depends on axios, so you must include it before the API script: 
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script src="https://unpkg.com/textalive-app-api/dist/index.js"></script>
After both scripts load, the global variable TextAliveApp is defined. Destructure it to access API classes: 
const { Player } = TextAliveApp;

const player = new Player({
  app: { token: "your_app_token_here" },
});

​
App token

An app token is required for the player to connect to the TextAlive API server and load song and lyrics data. Without a valid token, calls to createFromSongUrl will fail.
Obtain a token by registering your application at developer.textalive.jp. Pass the token via PlayerOptions.app.token when constructing a Player: 
import { Player, PlayerOptions } from "textalive-app-api";

const options: PlayerOptions = {
  app: {
    token: "your_app_token_here",
  },
  // Optional: a DOM element to host the audio widget.
  mediaElement: document.querySelector("#media"),
};

const player = new Player(options);
The app property on PlayerOptions accepts a PlayerAppOptions object:
PropertyTypeDescription
tokenstringRequired. Your application token from developer.textalive.jp.
parametersParameterWidget[]Optional list of adjustable parameters exposed to a TextAlive host.
Do not hard-code your app token in public repositories. Use an environment variable or a build-time injection mechanism to keep it out of version control.

​
Optional dependencies

The package declares songle-api as an optional peer dependency. If songle-api is installed alongside textalive-app-api, the player can use the SongleTimer for richer music-synchronised playback. Without it, the default timer is used. 
npm install textalive-app-api songle-api

Build docs developers (and LLMs) love

Get started for freeTalk to us