概要

本ドキュメントは、Obscura Plugin APIを使用して拡張機能を開発したい開発者にわかりやすいガイドを提供することを目的としています。詳細な説明を提供し、APIの使用方法を理解しやすくします。 また、多くのサンプルコードも提供し、学習を容易にします。

Obscura Plugin APIへようこそ!APIを使って、開発者は簡単にObscuraアプリケーションの機能を拡張できます。オープンなAPIを提供することで、開発者により創造的な空間を提供し、Obscuraアプリケーションのプラグインエコシステムを豊かにすることを目指しています。

Obscura Plugin APIでできること

Obscuraプラグインはアプリケーションが提供する各種APIを使用して、ライブラリ内のファイルやデータにアクセスすることができます。これにより、次のような要件を簡単に実現できます。

1. メディアアイテムの取得と操作

ライブラリ内のメディア、評価、アーティスト情報などを取得し、自動的なタグ付けやメタデータの更新が行えます。

2. ユーザーインターフェースの拡張

インスペクターパネルへのボタン追加や、プレイヤー画面への独自の情報の表示(オーバーレイ)などが可能です。

3. システム機能の利用

外部サイトからのデータ取得(CORS回避済み)、ファイルシステムの操作、通知の表示などのOSネイティブに近い機能が利用できます。

認証について

REST APIのリクエストには Authorization ヘッダーが必要です。Host Secretは、Obscuraアプリの「設定 > 開発者ツール」から取得できます。

Authorization: Bearer [Host Secret]

クイックスタート

REFERENCE

Plugin JS API

UIの拡張や内部データの操作に。JavaScriptで記述します。

API一覧を見る
ENDPOINT

REST API

外部サービスやスクリプトからの連携に。HTTP経由で操作します。

エンドポイントを見る