開発者向け変更履歴

開発者ダッシュボードは、あなたの連携でできることを中心に再構築されました。各機能（Embed、OMR、REST API、Import API、LTI）ごとに、スコープ、料金、ドキュメントをまとめたカードが用意され、すでにアプリで使っている機能が先に表示されます。

• アカウントレベルに新しい OMR セクションを追加。OMR クレジットはすべてのアプリで共有されるため、ジョブ、クレジット、その履歴を 1 か所で確認できます。
• コードを書く前に OMR を試せます。 プレイグラウンドに PDF や写真を入れると、ページ数、1 ページあたりのコスト、実行後の残高が表示され、確認後にジョブを実行します。出力は MusicXML のダウンロードとして提供され、ライブラリには追加されません。
• アプリページがより分かりやすくなりました。 個人トークン、OAuth2 認証情報、OMR アクセスがアプリケーションごとに整理され、OMR スコープを持つ認証情報も分かりやすく表示されます。

flat.io/developers から開けます。

REST API仕様がOpenAPI 3.1に移行し、OMR APIはベータ期間を終了しました。あわせて、Flat for Educationの課題は一覧取得と作成だけでなく、さらに多くの操作に対応しました。

• OMR APIは安定版になりました。 エンドポイント、フィールド、動作は、破壊的変更を行う前に通常の非推奨プロセスに従うようになりました。新しいFAQでは、クレジットと請求、制限と処理時間、認識品質と言語、商用利用とプライバシーを案内しています。
• Flat for Educationで課題の読み取り・更新・削除ができます。課題を削除すると提出物と生徒のコピーも削除されます。作業を残したい場合は、削除ではなくアーカイブしてください。
• クレジット台帳。 新しい呼び出しでクレジット履歴を一覧できます。残高は引き続きOMR capabilities呼び出しで確認できます。
• Finaleファイル (.musx) をインポート可能になりました。これはベストエフォート対応です。また、スキャンした楽譜のインポート（PDFと画像）はスコア作成のドキュメントに追加されました。
• OpenAPI 3.1。 nullableフィールドは3.1の構文を使用します。OpenAPI 3.0に固定されたツールは更新が必要です。mimeType フィールドはOMRファイルアップロードから削除されました。

• データ保持を自分で制御。 OMRジョブで、ファイルが保持される期間が分かるようになりました（デフォルトは30 days）。各MusicXMLジョブには有効期限が含まれ、取得後はいつでもジョブのファイルと結果を削除できます。
• サインイン前の機能確認。 OMR capabilities call はアカウントなしでも利用でき、対応している認識言語をその名前付きで一覧表示します。
• ABC記譜法のエクスポートに対応し、MusicXML、MIDI、その他の形式と同様に、あらゆるスコアのリビジョンを書き出せます。MIDIと同様、完全な組版情報は含まれません。
• Flat for Education で Free Record 課題をAPI経由で設定できるようになりました。
• 上流プロバイダー（たとえば Google Classroom）から返されるエラーには、そのプロバイダー自身のローカライズ済みメッセージが含まれるようになりました。

Flat の OMR エンジンが、開発者向け API からプログラムで利用できるようになりました。PDF や写真を送信し、認識の進行状況を追跡し、検出された楽器を確認したうえで、結果を Flat ライブラリに編集可能な楽譜として取り込んだり、MusicXML や MIDI として書き出したりできます。これは、エディタでの PDF や写真のインポートを支えているのと同じ自社開発モデルであり、今回から自社アプリやワークフロー向けに大規模に利用できるようになりました。

専用の OMR API（v2.24.0）は、v2.23.0 でスコア作成に追加されたバックグラウンド PDF インポートを基盤としています。ファイルをインポートするときにタスク対応をリクエストし、スコアの準備ができるまでタスクをポーリングしてください。両リリースの詳細は API changelog をご覧ください。

2024年以降で最大の仕様アップデートであり、2年分の製品変更にAPIを追従させます。

• 15超の形式からインポート。 Guitar Pro、MuseScore、ABC記譜法、PowerTab、Capella、MEI、Overture、TablEdit、Band-in-a-Box、Karaoke MIDI、MuseData、Score Writer、Bagpipe Music Writer、EncoreがMusicXMLとMIDIに加わり、さらにスコアをネイティブの.flatファイルとしてエクスポートできます。
• 仮想コレクション。 すべてのスコア、コラボレーション、いいねが、ライブラリ内の従来のフォルダー階層に代わって導入され、再設計されたFlatライブラリに対応します。
• Flat for Education. 音声または動画の録音、伴奏トラック、メトロノーム、速度オプション付きの演奏課題、共同作成向けのグループ提出、リッチテキストの指示、学生サブグループ、スケジュール設定および個別指定されたMicrosoft Teams課題、リソースライブラリ内の充実した説明と課題タイプに対応しました。
• LTI 1.1と1.3の統合LTI設定。動的登録を含みます。従来のLTI 1.1認証情報呼び出しは非推奨になりました。
• スコアの年間統計、プロフィール上の公開スコア数、および長らく非推奨だった一部フィールドの削除。

• 音声を書き出すためのメソッド getMP3 と getWAV を追加しました
• 長時間の書き出しで進行状況を表示できるよう、exportProgress イベントを追加しました

• ユーザーの楽譜一覧は公開プロフィールになります。 ユーザーの楽譜一覧を取得すると、2020年に告知された変更により、公開されている楽譜のみが返され、新しいページネーションと並び替えにも対応しました。
• 楽譜の詳細では編集用URL、楽器名、予定されている削除日が公開されます。コレクションでは楽譜数が返され、公開プロフィールでは「いいね」数と再生数が表示されます。
• Flat for Education. リソースライブラリを課題タイプ、教科、学年で絞り込めます。リソースには共有に関する説明とプライバシー設定機能が追加され、課題では音符の再生とオーディオトラックを制限できます。提出物は LTI 1.1 と 1.3 の成績サービスに対応しました。

• ユーザープロフィールの「いいね」のページネーション対応と、アカウント詳細でユーザーが利用している製品を確認できるようになりました。
• リソースの権限に、呼び出し元が所有者、ユーザーコラボレーター、グループコラボレーターのいずれかであることと、各コラボレーターが追加された日付が含まれるようになりました。スコアの詳細には、主調の調号、ハイライト日、組織が追加されました。
• Flat for Education. 招待を複数回再利用できるようになりました。提出には採点済み状態に加えて、再生とLTIの詳細が追加されました。課題は、まだ存在しない場合にのみリソースライブラリへコピーできます。組織ごとのプライバシーレベルを備えた、組織専用のリソースライブラリも利用できます。

コードから読み込まれた楽譜の構造を取得できるようになりました。

• パートと声部: getNbParts, getPartsUuids, getMeasureVoicesUuids
• 音符: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• 新しいURLパラメータ noAudio で音声再生を無効化
• setMasterVolume が誤った内部メソッドを呼び出していた問題を修正

• コンストラクターでの jQuery のサポートを削除 — 代わりに DOM 要素またはその id を渡してください
• 公開されている npm モジュールに TypeScript 型定義が含まれています
• ES ビルドと UMD ビルドを別々に提供

• Flat for Education のリソースライブラリアイテムから LTIリンクを作成 し、LMS のコースに直接配置できるようになりました。
• 課題の最高点を 100 点から 10,000 点に引き上げました。
• 楽譜のメタデータ（サブタイトル、作曲者、作詞者、編曲者、説明、ライセンスなど）は、設定だけでなく API からクリアできるようになりました。

• Resource Library API（ベータ版） Flat for Education のリソースライブラリを参照・管理できるようになり、フルアクセス用と読み取り専用用の 2 つの新しい OAuth2 スコープが追加されました。課題はリソースライブラリにコピーできます。
• テスト生徒。 クラス内にテスト用の生徒アカウントを作成し、生徒と同じように課題を試せます。
• 課題では、実行できる操作（編集、公開、アーカイブなど）、添付ファイルが専用コピーかどうか、発生した問題が返されます。提出履歴には、Google Classroom、Microsoft Teams、または LMS からの変更である場合、その変更元が記録されます。
• 提出をリセットしても削除されず、そのまま保持されます。クラスのメタデータ（レベル、スキル、人数）と、アカウントの Microsoft サインイン情報も公開されます。
• 楽譜リビジョンでは開始日と終了日が返されます。楽譜ビルダーでは四分音を有効にできます。コピーでは元のタイトルを保持できます。

• 小節: getNbMeasures, getMeasuresUuids
• ナビゲーション: goLeft, goRight, scrollToCursor
• メトロノーム: getMetronomeMode, setMetronomeMode
• 再生速度: getPlaybackSpeed, setPlaybackSpeed

• サインインリンクと委任アクセストークン。 Flat for Education の管理者は、所属組織の任意のユーザー向けにサインインリンク、またはそのユーザーの代理として動作するアクセストークンを作成できます。これは、カスタムポータルやシングルサインオン連携の基盤になります。
• ひらがなの日本語 (ja-HIRA) が対応ロケールに追加され、公開コメントではモデレーション状態が表示されるようになりました。
• 音声書き出しでは、MP3 セットが存在する場合はそれがデフォルトトラックとして返されます。音声書き出しは常にキャッシュから配信されるようになったため、キャッシュ済みの書き出しのみを要求するオプションは削除されました.

• スコアビルダー。 MusicXML ファイルを読み込まなくても空のスコアを作成できます。楽器のリストに加えて、必要に応じて拍子記号、調号、タブ譜、コードグリッド、ページレイアウトを指定できます。
• Flat for Education。 組織のユーザーは役割を指定して作成できるようになりました。ワークシートでは演習をシャッフルでき、学生の提出物には含まれる演習が一覧表示されます。

• 再生トラック。 Flat が自動生成して同期するトラック（MP3 の再生）を一覧でき、最新の再生ファイルの同期ポイントを取得できるようになりました。さらに、エクスポートの CDN URL をレスポンス本文で取得できます。
• Flat for Education. 教師は生徒の提出をリセットできます。クラスでは、同期中に追加できなかったアカウントが報告されます。課題と提出には Microsoft Teams の状態とリンクが含まれます。課題のコピーはスケジュール設定でき、パフォーマンス提出には保存済みの音声トラックが含まれます。
• プロフィールにカバー画像が追加され、現在のユーザーの id を単独で取得できるようになりました。

• loadFlatScore が sharingKey を受け取れるようになり、非公開で共有されたスコアを読み込めるようになりました
• オーディオトラックを動的に設定するために、setTrack、useTrack、seekTrackTo を追加しました

• 成績のエクスポート。 課題の成績を CSV または Excel ファイルとしてダウンロードできます。
• 課題には種類とカバー画像が設定され、課題をコピーすると、別の課題の内容で既存の下書きを上書きできます。
• 共同編集者には、招待がまだ保留中かどうかが表示されます。

• APIによる採点。 下書き評価と最終評価を設定し、提出物を生徒に返却し、計算済みのコメント数を取得できます。満点は評価とともに保存されます。
• 提出コメント。 提出物へのコメントの作成、一覧取得、更新、削除ができます。
• 課題オプション。 ツールセット、再生回数の上限、満点、Google Classroom のトピック、特定の生徒への割り当て、ロックされたテンプレート、LTI、Canvas、MusicFirst の課題の詳細に対応しました。
• 管理者は管理対象アカウントのユーザー名、名前、メールアドレスを編集でき、ユーザー一覧は有効なライセンスで絞り込めます。
• 以前の提出パラメーター studentComment と returnFeedback は廃止され、新しい採点用の呼び出しに置き換えられました。

• 課題をアーカイブ／アーカイブ解除でき、課題のメインタイプ（新しい楽譜、テンプレート、共有ライティング）を取得できるようになりました。
• 組織ユーザー。 名と姓を指定してアカウントを作成し、ユーザー一覧の並べ替えや絞り込み、フィルターに一致するユーザー数の取得、さらにグループメンバーを同期元（Google Classroom、Microsoft Teams、Clever）で絞り込めるようになりました。
• 楽譜の詳細に、再生で使われるオーディオサンプルが表示されるようになりました。また、サンプルに依存しない正規化された楽器リストも提供されます。

コードからミックスを制御し、カーソル下の内容を取得できます。

• 音量とミュート: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• ソロとリバーブ: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• 詳細取得: getMeasureDetails, getNoteDetails
• 追加されたイベント: noteDetails, measureDetails, cursorContext

• 仕様が OpenAPI 3.0 に移行しました。 以前のバージョンは OpenAPI 2（Swagger）で記述されていました。
• 楽譜で編曲者と再生統計を取得できるようになりました。削除はごみ箱に置いたままにせず、まもなく実行するようスケジュールできます。
• Flat for Education. 課題の添付ファイルに Google Drive のファイルを使えるようになり、クラスには Microsoft Teams の詳細が含まれるようになりました。Education アカウントでは名と姓も取得できます。

• メタデータの編集がエディターにリアルタイムで反映されるようになりました。 API で楽譜のタイトル、サブタイトル、作曲者、作詞者、またはライセンス文を更新すると、その変更が開いているエディターにリアルタイムで反映され、新しいバージョンが保存されます。説明文は従来の2倍の長さ（2,000文字）まで設定できます。
• Education の提出物で状態（created、turned in、returned）を取得できるようになりました。リビジョンのメタデータでは最後の変更イベントが返されます。
• サポート対象のロケールにトルコ語が追加されました。公開プロフィールには、そのアカウントが Flat チームに属しているかどうかが表示されます。

• getMIDI を追加
• getMusicXML はトップレベルで Uint8Array を返すようになりました — レスポンスに .data プロパティは含まれなくなりました
• カーソルの voiceIdx は voiceIdxInStaff になりました

embed リリースに合わせて更新しました。

• SDK はデフォルトで flat-embed.com から読み込まれるようになりました
• 非推奨だった edit アクションと edit イベントを削除しました
• setNoteColor を削除しました

• インポート形式を追加。 Guitar Pro（GP3、GP4、GP5、GPX、GP）、PowerTab、TuxGuitar、MuseScore のファイルをインポートできるようになり、インポート時にファイル名も指定できます。
• コレクションを親コレクション配下で一覧できるようになり、作成日も返されます。スコアには、それらが属するコレクションの一覧が表示されます。
• コンテキストコメントは、インデックスではなく識別子で譜表にアンカーされるようになり、リソースの権限には呼び出し元が共同編集者かどうかが示されます。

• Collections API。 コレクションの作成、一覧取得、更新、削除、復元、コレクション内の楽譜一覧の取得、楽譜の追加・削除が可能になり、読み取り専用、追加専用、フルアクセス用の 3 つの新しい OAuth2 スコープが追加されました。
• 楽譜をゴミ箱から復元できるようになりました。管理者権限なしで楽譜を削除すると、代わりにその楽譜はあなたのアカウントとの共有が解除されます。また、コピー先として特定のコレクションを指定できます。
• コメントを種類（ドキュメントまたはインライン）で絞り込めるようになりました。
• パートのエクスポートでは、インデックスではなくパート識別子を使うようになりました。また、2019 年 9 月以降、ユーザーの楽譜一覧では公開楽譜のみが返されます。

• 組織アカウントの管理。 管理者は管理対象アカウントを更新し、削除したりコンシューマーアカウントに変換したりできます。ユーザー一覧と招待一覧ではカーソルベースのページネーションを使用します。
• クラスに再度有効化できる非アクティブ状態が追加され、Canvas LMS のドメインと Clever のセクションも返されるようになりました。課題には下書き状態と、exercise 添付タイプが追加されました。
• プロフィールではテーマと演奏する楽器が公開されます。

• 埋め込みにキーボードフォーカスを与える focusScore メソッドを追加
• エディター設定に新しい defaultMode プロパティを追加

• Education API の最初のセットが公開されました。 クラス、課題、提出物、組織アカウントと招待、LTI 認証情報、そして組織内のグループとユーザーを管理できます。学校向け連携に必要なものをひととおり扱えます。
• スコープによるアクセス制御。 新しい OAuth2 スコープは、クラス、課題、組織管理をカバーし、それぞれに読み取り専用のバリアントがあります。これにより、連携は必要な権限だけを要求できます。

embed がどのように設定されているかをコードから確認し、エディターとして有効化できるようになりました。

• 追加されたメソッド: getEmbedConfig, setEditorConfig, edit
• 追加されたイベント: edit

SDK が MusicXML から楽譜を読み込めるようになり、ビューアで何が行われているかを通知できるようになりました。

• 追加されたメソッド: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• 追加されたイベント: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• 統合テストを追加

Flat の REST API の最初の一般公開版です。OAuth2 を使ってほかの Flat ユーザーに代わって操作しながら、自分のアプリやスクリプトからアカウント、楽譜、ユーザー、グループの読み取りと管理ができます。

それ以降の変更はすべて API 変更履歴 に記録されており、開発者向けドキュメント では認証、リファレンス、ガイドを確認できます。