Developer changelog

Dashboard developer dibangun ulang berdasarkan apa yang bisa dilakukan integrasi Anda. Setiap kapabilitas (Embed, OMR, REST API, Import API, LTI) memiliki kartu berisi cakupan, harga, dan dokumentasinya, dan yang sudah digunakan aplikasi Anda ditampilkan lebih dulu.

• Bagian OMR baru di tingkat akun, dengan semua job, kredit, dan riwayatnya di satu tempat, karena kredit OMR dibagikan ke semua aplikasi Anda.
• Coba OMR sebelum menulis kode. Playground menerima PDF atau foto, menampilkan jumlah halaman, biaya per halaman, dan sisa saldo setelahnya, lalu menjalankan job setelah Anda mengonfirmasi. Output tersedia sebagai unduhan MusicXML, tidak ada yang masuk ke library Anda.
• Halaman aplikasi yang lebih jelas. Token personal, kredensial OAuth2, dan akses OMR dikelompokkan per aplikasi, dengan penanda yang jelas untuk kredensial yang memiliki cakupan OMR.

Buka dari flat.io/developers.

Spesifikasi REST API kami beralih ke OpenAPI 3.1, OMR API mengakhiri masa beta, dan assignment di Flat for Education kini tidak lagi terbatas pada listing dan pembuatan.

• OMR API kini stabil. Endpoint, field, dan perilakunya sekarang mengikuti proses deprecation kami yang biasa sebelum ada breaking change. FAQ baru membahas credit dan billing, batasan dan waktu pemrosesan, kualitas pengenalan dan bahasa, serta penggunaan komersial dan privasi.
• Baca, ubah, dan hapus assignment di Flat for Education. Menghapus assignment juga akan menghapus submission dan salinan milik siswa; arsipkan saja jika Anda ingin menyimpan hasil kerja.
• Credit ledger. Panggilan baru menampilkan riwayat credit Anda; saldo tetap ada di panggilan OMR capabilities.
• File Finale (.musx) kini bisa diimpor, dengan basis upaya terbaik, dan impor musik hasil pemindaian (PDF dan gambar) didokumentasikan pada pembuatan score.
• OpenAPI 3.1. Field nullable menggunakan sintaks 3.1; tooling yang dipatok ke OpenAPI 3.0 perlu diperbarui. Field mimeType dihapus dari upload file OMR.

• Retensi data dalam kendali Anda. Pekerjaan OMR kini memberi tahu berapa lama file mereka disimpan (30 hari secara default), setiap pekerjaan MusicXML menyertakan tanggal kedaluwarsa, dan Anda dapat menghapus file serta hasil suatu pekerjaan segera setelah Anda mengambilnya.
• Deteksi fitur sebelum masuk. Panggilan kapabilitas OMR berfungsi tanpa akun dan mencantumkan bahasa pengenalan yang didukung beserta namanya.
• Ekspor notasi ABC untuk revisi partitur apa pun, bersama MusicXML, MIDI, dan format lainnya. Seperti MIDI, ekspor ini tidak memuat engraving secara lengkap.
• Tugas Free Record dapat dikonfigurasi melalui API di Flat for Education.
• Error yang berasal dari penyedia upstream (misalnya Google Classroom) kini menyertakan pesan terlokalkan milik penyedia itu sendiri.

Mesin OMR Flat kini tersedia secara terprogram melalui API pengembang. Kirim PDF atau foto, pantau progres pengenalan, tinjau instrumen yang terdeteksi, lalu impor hasilnya sebagai partitur yang dapat diedit ke pustaka Flat atau ekspor sebagai MusicXML atau MIDI. Ini adalah model internal yang sama yang mendukung impor PDF dan foto di editor, dan kini tersedia dalam skala besar untuk aplikasi dan alur kerja Anda sendiri.

API OMR khusus (v2.24.0) dibangun di atas impor PDF latar belakang yang ditambahkan ke pembuatan partitur di v2.23.0: minta dukungan task saat mengimpor file dan poll task tersebut sampai partitur siap. Lihat changelog API untuk detail kedua rilis tersebut.

Pembaruan spesifikasi terbesar sejak 2024, yang menyelaraskan API dengan dua tahun perubahan produk.

• Impor dari 15+ format. Guitar Pro, MuseScore, ABC notation, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer, dan Encore melengkapi MusicXML dan MIDI, dan partitur dapat diekspor sebagai file .flat native.
• Koleksi virtual. Semua partitur, kolaborasi, dan suka menggantikan hierarki folder lama di perpustakaan, selaras dengan perpustakaan Flat yang telah didesain ulang.
• Flat for Education. Tugas penampilan dengan rekaman audio atau video serta opsi backing track, metronom, dan kecepatan; pengumpulan grup untuk penulisan bersama; instruksi rich text; subgrup siswa; tugas Microsoft Teams yang dijadwalkan dan ditargetkan secara individual; deskripsi lengkap dan jenis tugas di perpustakaan sumber daya.
• Konfigurasi LTI terpadu untuk LTI 1.1 dan 1.3, termasuk pendaftaran dinamis. Panggilan kredensial LTI 1.1 sebelumnya kini tidak lagi disarankan.
• Statistik tahunan untuk partitur, jumlah partitur publik pada profil, dan penghapusan beberapa field yang sudah lama tidak lagi digunakan.

• Menambahkan metode getMP3 dan getWAV untuk ekspor audio
• Menambahkan event exportProgress, sehingga ekspor yang lama dapat menampilkan progres

• Daftar skor pengguna kini menjadi profil publik. Menampilkan daftar skor pengguna sekarang hanya mengembalikan skor publik mereka, dengan pagination dan pengurutan baru, perubahan yang diumumkan pada 2020.
• Detail skor kini menampilkan URL pengeditan, nama instrumen, dan tanggal penghapusan terjadwal jika ada; koleksi menampilkan jumlah skornya; profil publik menampilkan jumlah likes dan plays.
• Flat for Education. Filter pustaka sumber daya berdasarkan jenis tugas, mata pelajaran, dan tingkat kelas; sumber daya memiliki deskripsi berbagi dan kemampuan privasi; tugas dapat membatasi pemutaran not dan trek audio; pengumpulan mendukung layanan penilaian LTI 1.1 dan 1.3.

• Suka pada profil pengguna kini dipaginasi, dan detail akun kini menampilkan produk yang digunakan pengguna.
• Hak akses resource kini menunjukkan apakah pemanggil adalah pemilik, kolaborator pengguna, atau kolaborator grup, beserta tanggal setiap kolaborator ditambahkan. Detail score juga kini menambahkan tanda birama utama, tanggal sorotan, dan organisasi.
• Flat for Education. Undangan dapat digunakan kembali beberapa kali; pengumpulan kini memiliki status dinilai beserta detail playback dan LTI; tugas hanya dapat disalin ke pustaka resource jika belum ada di sana; organisasi kini memiliki pustaka resource sendiri dengan tingkat privasi untuk seluruh organisasi.

Baca struktur score yang dimuat dari kode Anda.

• Part dan voice: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Note: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Parameter URL baru noAudio menonaktifkan pemutaran audio
• Memperbaiki setMasterVolume yang memanggil metode dasar yang salah

• Dukungan untuk jQuery di constructor telah dihapus — gunakan elemen DOM atau id-nya sebagai gantinya
• Modul npm yang dipublikasikan menyertakan tipe TypeScript
• Build ES dan UMD terpisah

• Buat tautan LTI dari item pustaka sumber Flat for Education, untuk menempatkannya langsung di kursus LMS.
• Nilai maksimum pada tugas meningkat dari 100 menjadi 10.000 poin.
• Metadata skor (subtitle, composer, lyricist, arranger, description, license…) kini dapat dikosongkan melalui API, tidak hanya diatur.

• API Resource Library (beta). Telusuri dan kelola resource library Flat for Education, dengan dua scope OAuth2 baru untuk akses penuh dan akses baca-saja. Tugas dapat disalin ke resource library.
• Siswa uji. Buat akun siswa uji dalam kelas untuk mencoba tugas seperti yang akan dialami seorang siswa.
• Tugas melaporkan apa yang dapat Anda lakukan dengannya (mengedit, memublikasikan, mengarsipkan…), apakah lampirannya merupakan salinan khusus, dan masalah apa pun yang ditemukan. Riwayat pengumpulan mencatat sumber perubahan ketika perubahan itu berasal dari Google Classroom, Microsoft Teams, atau LMS.
• Mereset sebuah pengumpulan akan mempertahankannya di tempat alih-alih menghapusnya; metadata kelas (tingkat, keterampilan, ukuran) dan detail masuk Microsoft pada akun kini diekspos.
• Revisi partitur mengembalikan tanggal mulai dan berakhirnya; pembuat partitur dapat mengaktifkan quarter tones; salinan dapat mempertahankan judul asli.

• Birama: getNbMeasures, getMeasuresUuids
• Navigasi: goLeft, goRight, scrollToCursor
• Metronom: getMetronomeMode, setMetronomeMode
• Kecepatan playback: getPlaybackSpeed, setPlaybackSpeed

• Tautan masuk dan token akses terdelegasi. Admin Flat for Education dapat membuat tautan masuk untuk pengguna mana pun di organisasi mereka, atau token akses yang bertindak atas nama pengguna tersebut: ini menjadi dasar untuk portal kustom dan integrasi single sign-on.
• Bahasa Jepang dalam hiragana (ja-HIRA) kini ditambahkan ke locale yang didukung; komentar publik kini menampilkan status moderasinya.
• Ekspor audio mengembalikan set MP3 sebagai trek default jika tersedia. Opsi untuk meminta hanya ekspor yang tersimpan di cache telah dihapus, karena ekspor audio kini selalu disajikan dari cache.

• Pembuat partitur. Buat partitur kosong tanpa mengimpor file MusicXML: berikan daftar instrumen dan, secara opsional, tanda birama, tanda nada dasar, tablature, diagram akor, dan tata letak halaman.
• Flat for Education. Pengguna organisasi dapat dibuat dengan peran tertentu; lembar kerja dapat mengacak latihannya; kiriman siswa mencantumkan latihan yang dikandungnya.

• Track playback. Daftarkan track yang dibuat dan disinkronkan otomatis oleh Flat (playback sebagai MP3), ambil titik sinkronisasi dari file playback terbaru, dan dapatkan URL CDN dari sebuah ekspor di body respons.
• Flat for Education. Guru dapat mereset submission siswa; kelas melaporkan akun yang tidak dapat ditambahkan saat sinkronisasi; assignment dan submission menampilkan status serta tautan Microsoft Teams; salinan assignment dapat dijadwalkan; submission performa menyertakan track audio yang disimpan.
• Profil kini memiliki gambar sampul, dan id pengguna saat ini dapat diambil secara terpisah.

• loadFlatScore kini menerima sharingKey, sehingga partitur yang dibagikan secara privat dapat dimuat
• Menambahkan setTrack, useTrack, dan seekTrackTo untuk mengatur trek audio secara dinamis

• Ekspor nilai. Unduh nilai tugas sebagai file CSV atau Excel.
• Tugas kini menyertakan jenis tugas dan gambar sampul; menyalin tugas dapat menimpa draf yang sudah ada dengan konten dari tugas lain.
• Kolaborator kini menampilkan apakah undangan mereka masih menunggu respons.

• Penilaian melalui API. Tetapkan nilai draf dan final, kembalikan pengumpulan kepada siswa, dan baca penghitung komentar yang dihitung; poin maksimum disimpan bersama nilai.
• Komentar pengumpulan. Buat, tampilkan daftar, perbarui, dan hapus komentar pada sebuah pengumpulan.
• Opsi tugas. Perangkat alat, batas pemutaran, poin maksimum, topik Google Classroom, penugasan ke siswa tertentu, templat terkunci, serta detail tugas LTI, Canvas, dan MusicFirst.
• Admin dapat mengedit nama pengguna, nama, dan email akun terkelola; daftar pengguna dapat difilter berdasarkan lisensi aktif.
• Parameter pengumpulan lama studentComment dan returnFeedback dihapus dan digantikan oleh panggilan penilaian yang baru.

• Arsipkan dan batalkan pengarsipan tugas, serta baca tipe utama sebuah tugas (score baru, template, atau tulisan bersama).
• Pengguna organisasi. Buat akun dengan nama depan dan nama belakang, urutkan dan filter daftar pengguna, hitung pengguna yang cocok dengan filter, dan filter anggota grup berdasarkan sumber sinkronisasinya (Google Classroom, Microsoft Teams, Clever).
• Detail score kini mencantumkan sampel audio yang digunakan untuk playback, dengan daftar instrumen yang dinormalisasi dan tidak lagi bergantung pada sampel.

Kontrol mix dari kode Anda, dan baca apa yang ada di bawah kursor.

• Volume dan mute: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo dan reverb: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Pemeriksaan: getMeasureDetails, getNoteDetails
• Event yang ditambahkan: noteDetails, measureDetails, cursorContext

• Spesifikasi kini beralih ke OpenAPI 3.0. Versi sebelumnya dijelaskan dalam OpenAPI 2 (Swagger).
• Partitur kini menampilkan arranger dan statistik play-nya; penghapusan dapat dijadwalkan untuk segera dijalankan alih-alih tetap berada di trash.
• Flat for Education. Lampiran tugas kini dapat berupa file Google Drive, kelas menyertakan detail Microsoft Teams, dan akun pendidikan menampilkan nama depan dan nama belakang.

• Perubahan metadata langsung diterapkan di editor. Saat Anda memperbarui judul, subjudul, komposer, penulis lirik, atau teks lisensi sebuah partitur melalui API, perubahan itu dikirim ke editor yang sedang terbuka secara real-time, dan versi baru disimpan. Deskripsi kini bisa dua kali lebih panjang (2,000 karakter).
• Pengumpulan di Flat for Education kini menampilkan statusnya (created, turned in, returned); metadata revisi mengembalikan peristiwa modifikasi terakhir.
• Bahasa Turki kini termasuk dalam locale yang didukung; profil publik menunjukkan apakah sebuah akun milik tim Flat.

• Menambahkan getMIDI
• getMusicXML sekarang mengembalikan Uint8Array di level teratas — respons tidak lagi memiliki properti .data
• voiceIdx kursor sekarang menjadi voiceIdxInStaff

Diperbarui untuk rilis embed.

• SDK kini dimuat dari flat-embed.com secara default
• Aksi edit dan event edit yang sudah usang telah dihapus
• setNoteColor telah dihapus

• Lebih banyak format impor. File Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar, dan MuseScore kini dapat diimpor, dan impor juga menerima nama file.
• Koleksi dapat ditampilkan di bawah koleksi induk dan menyertakan tanggal pembuatannya; partitur mencantumkan koleksi tempat partitur tersebut berada.
• Komentar kontekstual ditautkan ke paranada berdasarkan identifier alih-alih indeks, dan hak resource menunjukkan apakah pemanggil adalah kolaborator.

• API Collections. Buat, daftarkan, perbarui, hapus, dan pulihkan collection, tampilkan daftar score di dalamnya, serta tambahkan atau hapus score, dengan tiga scope OAuth2 baru untuk akses read-only, add-only, dan akses penuh.
• Score dapat dipulihkan dari trash; menghapus score tanpa hak admin hanya akan membatalkan pembagiannya dari akun Anda; salinan dapat ditargetkan ke collection tertentu.
• Komentar dapat difilter berdasarkan jenis (document atau inline).
• Export part kini menggunakan identifier part alih-alih indeks, dan mulai September 2019 daftar score milik pengguna hanya mengembalikan score publik.

• Pengelolaan akun organisasi. Admin dapat memperbarui akun terkelola, menghapusnya, atau mengubahnya menjadi akun konsumen; daftar pengguna dan undangan kini menggunakan paginasi berbasis kursor.
• Kelas kini memiliki status nonaktif yang dapat diaktifkan kembali, dan melaporkan domain Canvas LMS serta bagian Clever-nya; tugas kini memiliki status draf dan jenis lampiran latihan.
• Profil kini menampilkan tema dan instrumen yang dimainkan.

• Menambahkan metode focusScore untuk memberi fokus keyboard ke embed
• Properti defaultMode baru di konfigurasi editor

• API pendidikan pertama kini bersifat publik. Kelola kelas, tugas dan pengumpulan, akun organisasi dan undangan, kredensial LTI, serta grup dan pengguna dalam organisasi: semua yang dibutuhkan integrasi sekolah.
• Akses berskala. Scope OAuth2 baru mencakup kelas, tugas, dan administrasi organisasi, masing-masing dengan varian hanya-baca, sehingga integrasi hanya meminta yang memang dibutuhkannya.

Kode Anda sekarang dapat memeriksa bagaimana embed dikonfigurasi dan mengubahnya menjadi editor.

• Metode yang ditambahkan: getEmbedConfig, setEditorConfig, edit
• Event yang ditambahkan: edit

SDK kini dapat memuat partitur dari MusicXML dan melaporkan apa yang sedang dilakukan pembaca.

• Metode yang ditambahkan: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Event yang ditambahkan: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Pengujian integrasi ditambahkan

Rilis publik pertama API REST Flat. Baca dan kelola akun, partitur, pengguna, dan grup Anda dari aplikasi dan skrip Anda sendiri, dengan OAuth2 untuk bertindak atas nama pengguna Flat lainnya.

Semua perubahan sejak saat itu dicatat dalam changelog API, dan dokumentasi developer mencakup autentikasi, referensi, dan panduan.