textalivejp / textalive-app-api Goto Github PK

View Code? Open in Web Editor NEW

音楽に合わせてタイミングよく歌詞が動くWebアプリケーション（リリックアプリ）を開発できるJavaScript API / JavaScript API for developing web applications that show lyrics synchronized with the music playback (lyric apps)

License: Other

textalive-app-api's Introduction

TextAlive App API

TextAlive App API は、 音楽に合わせてタイミングよく歌詞が動く Web アプリケーション（リリックアプリ） を開発できる JavaScript 用のライブラリです。

この API を使うと、Web 上の楽曲のサビやビートなどの楽曲地図情報を取得したり、Web 上の歌詞のタイミング情報を取得したりできるようになります。そして、一曲のために作り込んだ演出はもちろんのこと、 TextAlive に登録されている様々な楽曲に合わせて動作する演出をプログラミングできます。

English version available in README.en.md.

使い方

TextAlive App API は script タグで Web サイトに読み込んだり、 npm パッケージ textalive-app-api をインストールすることで使えるようになります。

ほとんどの機能のエントリーポイントになる Player クラスの説明はこちらにあります。このクラスを利用するには TextAlive for Developers Web サイトから開発者登録を行い、アプリトークンを取得する必要があります。詳しくは Web サイトをご覧ください。

`script` タグによる読み込み

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

グローバル変数 TextAliveApp が定義されるので、 const { Player } = TextAliveApp; のように必要なコンポーネントを呼び出して使います。

npm パッケージのインストール

npm install textalive-app-api

import { Player } from "textalive-app-api"; のように必要なコンポーネントをインポートして使います。

開発者向けドキュメント

技術的に分からないことやバグ報告などがあれば、 GitHub Issues か Gitter Chat までお願いいたします。 TextAlive for Developers トップページもぜひご覧ください。

Recommend Projects

textalivejp / textalive-app-api Goto Github PK