Developer changelog

Papan pemuka pembangun dibina semula berdasarkan perkara yang integrasi anda boleh lakukan. Setiap keupayaan (Embed, OMR, REST API, Import API, LTI) mendapat kad dengan skop, harga dan dokumentasi, dan yang sudah digunakan oleh aplikasi anda dipaparkan dahulu.

• Bahagian OMR baharu pada peringkat akaun, dengan tugas anda, kredit anda dan sejarahnya di satu tempat, kerana kredit OMR dikongsi oleh semua aplikasi anda.
• Cuba OMR sebelum anda menulis kod. Playground menerima PDF atau foto, memaparkan bilangan halaman, kos setiap halaman dan baki yang akan tinggal, kemudian menjalankan tugas selepas anda mengesahkan. Output disediakan sebagai muat turun MusicXML, dan tiada apa-apa dimasukkan ke pustaka anda.
• Halaman aplikasi yang lebih jelas. Token peribadi, kelayakan OAuth2 dan akses OMR dikumpulkan mengikut aplikasi, dengan kelayakan yang membawa skop OMR ditandakan dengan jelas.

Bukanya dari flat.io/developers.

Spesifikasi REST API kami beralih ke OpenAPI 3.1, API OMR menamatkan tempoh betanya, dan tugasan Flat for Education kini dibuka lebih jauh daripada sekadar menyenaraikan dan mencipta.

• API OMR kini stabil. Endpoint, medan dan tingkah laku kini mengikut proses penyahgunaan biasa kami sebelum sebarang perubahan yang memutuskan keserasian. FAQ baharu merangkumi kredit dan pengebilan, had dan masa pemprosesan, kualiti pengecaman dan bahasa, serta penggunaan komersial dan privasi.
• Baca, kemas kini dan padam tugasan dalam Flat for Education. Memadam tugasan juga memadamkan penyerahannya dan salinan pelajar; arkibkannya sebagai ganti jika anda mahu mengekalkan kerja tersebut.
• Lejar kredit. Panggilan baharu menyenaraikan sejarah kredit anda; baki kekal pada panggilan keupayaan OMR.
• Fail Finale (.musx) kini boleh diimport, atas dasar usaha terbaik, dan import muzik imbasan (PDF dan imej) didokumentasikan pada penciptaan skor.
• OpenAPI 3.1. Medan nullable menggunakan sintaks 3.1; alat yang ditetapkan pada OpenAPI 3.0 perlu dikemas kini. Medan mimeType telah dibuang daripada muat naik fail OMR.

• Pengekalan data di bawah kawalan anda. Kerja OMR kini memberitahu berapa lama failnya disimpan (lalai 30 days), setiap kerja MusicXML disertakan dengan tarikh luputnya, dan anda boleh memadam fail serta hasil sesuatu kerja sebaik sahaja anda telah mengambilnya.
• Pengesanan ciri sebelum log masuk. Panggilan keupayaan OMR berfungsi tanpa akaun dan menyenaraikan bahasa pengecaman yang disokong berserta namanya.
• Eksport notasi ABC untuk mana-mana semakan skor, bersama MusicXML, MIDI dan format lain. Seperti MIDI, ia tidak membawa maklumat pengukiran penuh.
• Tugasan Free Record kini boleh dikonfigurasikan melalui API dalam Flat for Education.
• Ralat daripada penyedia huluan (contohnya Google Classroom) kini turut membawa mesej setempat milik penyedia itu sendiri.

Enjin OMR Flat kini tersedia secara berprogram melalui API pembangun. Hantar PDF atau foto, ikuti kemajuan pengecaman, semak instrumen yang dikesan, kemudian import hasilnya sebagai skor boleh sunting dalam pustaka Flat atau eksport sebagai MusicXML atau MIDI. Ini ialah model dalaman yang sama yang digunakan untuk import PDF dan foto dalam editor, kini tersedia pada skala besar untuk aplikasi dan aliran kerja anda sendiri.

API OMR khusus (v2.24.0) dibina berasaskan import PDF latar belakang yang ditambahkan pada penciptaan skor dalam v2.23.0: minta sokongan tugasan apabila mengimport fail dan tinjau tugasan tersebut secara berkala sehingga skor siap. Lihat log perubahan API untuk butiran kedua-dua keluaran.

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

• Import daripada 15+ format. Guitar Pro, MuseScore, notasi ABC, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer dan Encore menyertai MusicXML dan MIDI, dan skor boleh dieksport sebagai fail .flat asli.
• Koleksi maya. Semua skor, kolaborasi dan suka menggantikan hierarki folder lama dalam pustaka, selaras dengan pustaka Flat yang direka semula.
• Flat for Education. Tugasan persembahan dengan rakaman audio atau video serta pilihan trek iringan, metronom dan kelajuan; penyerahan berkumpulan untuk penulisan bersama; arahan teks kaya; subkumpulan pelajar; tugasan Microsoft Teams yang dijadualkan dan disasarkan secara individu; penerangan terperinci dan jenis tugasan dalam pustaka sumber.
• Konfigurasi LTI bersepadu untuk LTI 1.1 dan 1.3, termasuk pendaftaran dinamik. Panggilan kelayakan LTI 1.1 yang terdahulu kini tidak lagi disyorkan.
• Statistik tahunan untuk skor, jumlah skor awam pada profil, serta penyingkiran beberapa medan yang sudah lama tidak lagi disyorkan.

• Menambah kaedah getMP3 dan getWAV untuk eksport audio
• Menambah acara exportProgress, supaya eksport yang mengambil masa lama boleh memaparkan kemajuan

• Senarai skor pengguna kini ialah profil awam. Menyenaraikan skor pengguna kini hanya memulangkan skor awam mereka, dengan pagination dan pengisihan baharu, seperti yang diumumkan pada 2020.
• Butiran skor memaparkan URL suntingan, nama instrumen dan sebarang tarikh pemadaman berjadual; koleksi melaporkan bilangan skor; profil awam memaparkan bilangan suka dan mainan.
• Flat for Education. Tapis pustaka sumber mengikut jenis tugasan, subjek dan gred; sumber disertakan dengan perihalan perkongsian dan keupayaan privasi; tugasan boleh mengehadkan main balik not dan trek audio; penyerahan menyokong perkhidmatan gred LTI 1.1 dan 1.3.

• Suka pada profil pengguna kini dipaginasi, dan produk yang digunakan oleh pengguna dipaparkan dalam butiran akaun mereka.
• Hak sumber kini menyatakan sama ada pemanggil ialah pemilik, kolaborator pengguna atau kolaborator kumpulan, bersama tarikh setiap kolaborator ditambah. Butiran skor kini menambah tanda nada utama, tarikh sorotan dan organisasi.
• Flat for Education. Jemputan boleh digunakan semula beberapa kali; penyerahan mendapat status bergred serta butiran main balik dan LTI; tugasan boleh disalin ke pustaka sumber hanya jika ia belum ada di sana; organisasi mendapat pustaka sumber mereka sendiri dengan tahap privasi seluruh organisasi.

Baca struktur skor yang dimuatkan daripada kod anda.

• Bahagian dan suara: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Not: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Parameter URL baharu noAudio melumpuhkan main balik audio
• Membetulkan setMasterVolume yang memanggil kaedah asas yang salah

• Sokongan untuk jQuery dalam constructor telah dibuang — sebaliknya, berikan elemen DOM atau idnya
• Modul npm yang diterbitkan disertakan dengan jenis TypeScript
• Binaan ES dan UMD yang berasingan

• Cipta pautan LTI daripada item pustaka sumber Flat for Education untuk meletakkannya terus dalam kursus LMS.
• Gred maksimum pada tugasan meningkat daripada 100 kepada 10,000 mata.
• Metadata skor (subtajuk, penggubah, penulis lirik, penggubah susunan, penerangan, lesen…) kini boleh dikosongkan melalui API, bukan hanya ditetapkan.

• API Resource Library (beta). Layari dan urus pustaka sumber Flat for Education, dengan dua skop OAuth2 baharu untuk akses penuh dan baca sahaja. Tugasan boleh disalin ke pustaka sumber.
• Pelajar ujian. Cipta akaun pelajar ujian dalam kelas untuk mencuba tugasan sebagaimana pelajar akan menggunakannya.
• Tugasan kini melaporkan perkara yang anda boleh lakukan dengannya (edit, terbitkan, arkibkan…), sama ada lampirannya ialah salinan khusus, dan sebarang isu yang ditemui. Sejarah penyerahan merekodkan sumber sesuatu perubahan apabila ia datang daripada Google Classroom, Microsoft Teams atau LMS.
• Menetapkan semula penyerahan akan mengekalkannya di tempatnya dan bukannya memadamkannya; metadata kelas (tahap, kemahiran, saiz) dan butiran log masuk Microsoft pada akaun turut didedahkan.
• Revisi skor mengembalikan tarikh mula dan tamat; pembina skor boleh mendayakan suku nada; salinan boleh mengekalkan tajuk asal.

• Birama: getNbMeasures, getMeasuresUuids
• Navigasi: goLeft, goRight, scrollToCursor
• Metronom: getMetronomeMode, setMetronomeMode
• Kelajuan main balik: getPlaybackSpeed, setPlaybackSpeed

• Pautan log masuk dan token akses terwakil. Pentadbir Flat for Education boleh mencipta pautan log masuk untuk mana-mana pengguna dalam organisasi mereka, atau token akses yang bertindak bagi pihak pengguna tersebut: asas untuk portal tersuai dan integrasi daftar masuk tunggal.
• Bahasa Jepun dalam hiragana (ja-HIRA) kini ditambah kepada lokal yang disokong; komen awam memaparkan status penyederhanaannya.
• Eksport audio memulangkan set MP3 sebagai trek lalai apabila tersedia. Pilihan untuk meminta eksport yang dicache sahaja telah dibuang, kerana eksport audio kini sentiasa disajikan daripada cache.

• Pembina skor. Cipta skor kosong tanpa mengimport fail MusicXML: berikan senarai instrumen dan, secara pilihan, tanda masa, tanda nada, tablatur, grid kord dan susun atur halaman.
• Flat for Education. Pengguna organisasi boleh dicipta dengan peranan; lembaran kerja boleh mengocak latihan mereka; penyerahan pelajar menyenaraikan latihan yang dikandunginya.

• Trek main balik. Senaraikan trek yang dijana dan disegerakkan secara automatik oleh Flat (main balik sebagai MP3), dapatkan titik penyegerakan bagi fail main balik terkini, dan peroleh URL CDN bagi eksport dalam badan respons.
• Flat for Education. Guru boleh menetapkan semula penyerahan pelajar; kelas melaporkan akaun yang tidak dapat ditambah semasa penyegerakan; tugasan dan penyerahan mendedahkan status dan pautan Microsoft Teams masing-masing; salinan tugasan boleh dijadualkan; penyerahan persembahan menyertakan trek audio yang disimpan.
• Profil kini mempunyai gambar kulit, dan id pengguna semasa boleh didapatkan secara berasingan.

• loadFlatScore menerima sharingKey, jadi skor yang dikongsi secara peribadi boleh dimuatkan
• Menambah setTrack, useTrack dan seekTrackTo untuk menetapkan trek audio secara dinamik

• Eksport gred. Muat turun gred sesuatu tugasan sebagai fail CSV atau Excel.
• Tugasan menyertakan jenisnya dan imej kulit hadapan; menyalin tugasan boleh menulis ganti draf sedia ada dengan kandungan tugasan lain.
• Kolaborator menunjukkan sama ada jemputan mereka masih dalam keadaan menunggu.

• Pemarkahan melalui API. Tetapkan gred draf dan gred akhir, pulangkan penyerahan kepada pelajar, dan baca kiraan komen yang dikira; mata maksimum disimpan bersama gred.
• Komen penyerahan. Cipta, senaraikan, kemas kini dan padam komen pada penyerahan.
• Pilihan tugasan. Set alat, had main balik, mata maksimum, topik Google Classroom, tugaskan kepada pelajar tertentu, templat dikunci, serta butiran tugasan LTI, Canvas dan MusicFirst.
• Pentadbir boleh mengedit nama pengguna, nama dan e-mel akaun terurus; senarai pengguna boleh ditapis mengikut lesen aktif.
• Parameter penyerahan lama studentComment dan returnFeedback telah dibuang dan digantikan dengan panggilan pemarkahan baharu.

• Arkibkan dan nyaharkibkan tugasan, serta baca jenis utama sesuatu tugasan (skor baharu, templat atau penulisan dikongsi).
• Pengguna organisasi. Cipta akaun dengan nama pertama dan nama keluarga, isih dan tapis senarai pengguna, kira pengguna yang sepadan dengan sesuatu penapis, dan tapis ahli kumpulan mengikut sumber penyegerakan mereka (Google Classroom, Microsoft Teams, Clever).
• Butiran skor menyenaraikan sampel audio yang digunakan untuk main balik, dengan senarai instrumen ternormal yang tidak lagi bergantung pada sampel.

Kawal mix daripada kod anda, dan baca apa yang berada di bawah kursor.

• Volume dan bisu: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo dan reverb: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Pemeriksaan: getMeasureDetails, getNoteDetails
• Acara ditambah: noteDetails, measureDetails, cursorContext

• Spesifikasi kini beralih ke OpenAPI 3.0. Versi terdahulu diterangkan dalam OpenAPI 2 (Swagger).
• Skor kini mendedahkan penggubah dan statistik jumlah mainnya; pemadaman boleh dijadualkan untuk dijalankan tidak lama lagi dan bukannya dibiarkan dalam tong sampah.
• Flat for Education. Lampiran tugasan boleh berupa fail Google Drive, kelas menyertakan butiran Microsoft Teams, dan akaun Education mendedahkan nama pertama dan nama keluarga.

• Suntingan metadata kini sampai ke editor secara langsung. Apabila anda mengemas kini tajuk, subtajuk, komposer, penulis lirik atau teks lesen sesuatu skor melalui API, perubahan itu dihantar ke editor yang sedang dibuka dalam masa nyata, dan versi baharu disimpan. Deskripsi kini boleh dua kali lebih panjang (2,000 aksara).
• Penyerahan Education kini mendedahkan statusnya (created, turned in, returned); metadata semakan memulangkan peristiwa pengubahsuaian terakhir.
• Bahasa Turki kini ditambah kepada locale yang disokong; profil awam menyatakan sama ada sesuatu akaun milik pasukan Flat.

• Menambahkan getMIDI
• getMusicXML kini memulangkan Uint8Array pada peringkat teratas — respons tidak lagi mengandungi sifat .data
• voiceIdx kursor kini ialah voiceIdxInStaff

Dikemas kini untuk keluaran embed.

• SDK kini dimuatkan daripada flat-embed.com secara lalai
• Tindakan edit dan peristiwa edit yang telah ditamatkan sokongan kini dibuang
• setNoteColor dibuang

• Lebih banyak format import. Fail Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar dan MuseScore kini boleh diimport, dan import menerima nama fail.
• Koleksi kini boleh disenaraikan di bawah koleksi induk dan memaparkan tarikh penciptaannya; skor menyenaraikan koleksi yang dianggotainya.
• Komen kontekstual ditambat pada staf menggunakan pengecam dan bukannya indeks, dan hak sumber menyatakan sama ada pemanggil ialah kolaborator.

• API Collections. Cipta, senaraikan, kemas kini, padam dan pulihkan koleksi, senaraikan skor di dalamnya, serta tambah atau buang skor, dengan tiga skop OAuth2 baharu untuk akses baca sahaja, tambah sahaja dan akses penuh.
• Skor boleh dipulihkan daripada tong sampah; memadam skor tanpa hak pentadbir akan menyahkongsi skor itu daripada akaun anda; satu salinan boleh disasarkan kepada koleksi tertentu.
• Komen boleh ditapis mengikut jenis (dokumen atau sebaris).
• Eksport bahagian kini menggunakan pengecam bahagian dan bukannya indeks, dan mulai September 2019 senarai skor pengguna hanya memulangkan skor awam.

• Pengurusan akaun organisasi. Pentadbir boleh mengemas kini akaun terurus, memadamkannya atau menukarkannya kepada akaun pengguna; penyenaraian pengguna dan jemputan menggunakan penomboran halaman berasaskan kursor.
• Kelas kini mempunyai keadaan tidak aktif yang boleh diaktifkan semula, serta melaporkan domain Canvas LMS dan seksyen Clever; tugasan kini mempunyai keadaan draf dan jenis lampiran latihan.
• Profil memaparkan tema dan instrumen yang dimainkan.

• Menambah kaedah focusScore untuk memberikan fokus papan kekunci pada embed
• Sifat defaultMode baharu dalam konfigurasi editor

• API pendidikan pertama kini tersedia secara umum. Urus kelas, tugasan dan penyerahan, akaun dan jemputan organisasi, kelayakan LTI, serta kumpulan dan pengguna dalam sesebuah organisasi: semua yang diperlukan oleh integrasi sekolah.
• Akses berskop. Skop OAuth2 baharu meliputi kelas, tugasan dan pentadbiran organisasi, masing-masing dengan varian baca sahaja, supaya integrasi hanya meminta apa yang diperlukannya.

Kod anda kini boleh memeriksa cara embed dikonfigurasikan dan menukarkannya menjadi editor.

• Kaedah ditambah: getEmbedConfig, setEditorConfig, edit
• Acara ditambah: edit

SDK kini boleh memuatkan skor daripada MusicXML dan melaporkan apa yang sedang dilakukan oleh pembaca.

• Kaedah ditambah: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Acara ditambah: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Ujian integrasi ditambah

Keluaran awam pertama untuk REST API Flat. Baca dan urus akaun, skor, pengguna dan kumpulan anda daripada aplikasi dan skrip anda sendiri, dengan OAuth2 untuk bertindak bagi pihak pengguna Flat yang lain.

Segala perubahan selepas itu direkodkan dalam log perubahan API, dan dokumentasi pembangun merangkumi pengesahan, rujukan dan panduan.