埋め込み方法
これは、能動的音楽鑑賞サービスSongle(ソングル)をあなたのウェブページで簡単に利用することができるSongle外部埋め込みプレーヤです。あなたにプログラミングの知識があれば、音楽理解技術により解析された音楽地図を利用した、アプリケーションを開発することもできます。
埋め込むには、次のコードをあなたのウェブページの外部埋め込みプレーヤの表示したい位置に貼り付けます。ソングルに登録されている楽曲を指定することで、埋め込む楽曲を切り替えることもできます。
<div data-api="songle-widget-api-example" data-url="www.youtube.com/watch?v=PqJNc9KVIZE" id="songle-widget"></div>
<script src="https://widget.songle.jp/v1/widgets.js"></script>
概要
Songle Widget API は Songle Widget を JavaScript から操作するための機能です。
1. 利用準備
この機能を利用するためには、埋め込みコードに任意の文字列が設定された data-api 属性を追加するか、このサービスが提供する API スクリプトをあなたのウェブサイト上で事前に読み込んでおきます。
A. 埋め込みコードから利用する
<div data-api="songle-widget-api-example" data-url="www.youtube.com/watch?v=PqJNc9KVIZE" id="songle-widget"></div>
<script src="https://widget.songle.jp/v1/widgets.js"></script>
B. API スクリプトから利用する
<script src="https://widget.songle.jp/v1/api.js"></script>
window.onload =
function()
{
var songleWidgetElement =
SongleWidgetAPI.createSongleWidgetElement({
api: "songle-widget-api-example",
url: "www.youtube.com/watch?v=PqJNc9KVIZE"
});
document.body.appendChild(songleWidgetElement);
}
埋め込みコードの data-api 属性に与える任意の文字列は、複数のプレーヤを利用する際に各プレーヤを操作するために必要になるため、ユニークであることが推奨されます。
2. Hello,Songle Widget!!
Songle Widget の準備が完了すると window.onSongleWidgetReady が実行されます。
window.onSongleWidgetReady =
function(apiKey, songleWidget)
{
console.log("Hello,Songle Widget!!");
}
3. サンプルプログラム
音楽プレーヤの操作以外にも音楽理解技術による拍などをブラウザのイベントとして処理することができます。
window.onSongleWidgetReady =
function(apiKey, songleWidget)
{
songleWidget.on("beatPlay",
function(e)
{
switch(e.beat.position)
{
case 1:
// 1 拍目の処理をここに記述
console.log("1st beat");
break;
case 2:
// 2 拍目の処理をここに記述
console.log("2nd beat");
break;
case 3:
// 3 拍目の処理をここに記述
console.log("3rd beat");
break;
case 4:
// 4 拍目の処理をここに記述
console.log("4th beat");
break;
}
});
songleWidget.play(); // 再生開始
}
動作要件
| ウェブブラウザ | バージョン |
|---|---|
| Microsoft Internet Explorer | 9,10,11 |
| Microsoft Edge | 14 |
| Mozilla Firefox | 48 |
| Google Chrome | 52 (recommended) |
| Safari | 9 |
| Opera | 39 |
| Android Browser | 51 |
| Google Chrome for Android | 51 |
関連ドキュメント
- JavaScript API — 埋め込んだウィジェットをスクリプトから操作する (
SongleWidgetクラス・イベント・制御メソッド) - REST API — 楽曲の解析データ (ビート・コード・メロディ・サビ) を取得する
- プラグイン — 写真・図形・音楽地図などの拡張プラグイン、および埋め込みオプション