Developer changelog

Muling binuo ang developer dashboard batay sa magagawa ng iyong integration. Bawat capability (Embed, OMR, REST API, Import API, LTI) ay may card na may saklaw, pagpepresyo, at dokumentasyon nito, at mauuna ang mga ginagamit na ng iyong app.

• Isang bagong seksyon ng OMR sa antas ng account, kung saan makikita sa iisang lugar ang iyong mga job, ang iyong mga credit, at ang history ng mga ito, dahil ibinabahagi ang OMR credits ng lahat ng iyong app.
• Subukan ang OMR bago ka magsulat ng code. Tumatanggap ang playground ng PDF o mga larawan, ipinapakita ang bilang ng mga pahina, ang gastos bawat pahina, at ang matitirang balanse mo, saka pinapatakbo ang job kapag nakumpirma mo na. Napupunta ang output sa mga MusicXML download, at walang nalalagay sa iyong library.
• Mas malinaw na mga page ng app. Ang mga personal token, OAuth2 credential, at OMR access ay nakaayos ayon sa application, at malinaw na tinutukoy ang mga credential na may OMR scope.

Buksan ito mula sa flat.io/developers.

Lumilipat ang aming REST API specification sa OpenAPI 3.1, nagtatapos ang beta period ng OMR API, at lumalawak na ang mga takdang-aralin sa Flat for Education lampas sa listing at paggawa.

• Stable na ang OMR API. Ang mga endpoint, field, at behavior ay sumusunod na ngayon sa aming karaniwang proseso ng deprecation bago ang anumang breaking change. May bagong FAQ tungkol sa credits at billing, mga limitasyon at oras ng pagproseso, kalidad ng pagkilala at mga wika, pati komersyal na paggamit at privacy.
• Magbasa, mag-update, at mag-delete ng mga takdang-aralin sa Flat for Education. Kapag nag-delete ng takdang-aralin, matatanggal din ang mga submission nito at ang mga kopya ng mga estudyante; i-archive ito sa halip kung gusto mong panatilihin ang gawa.
• Credit ledger. May bagong call para ilista ang history ng iyong credits; nananatili ang balance sa OMR capabilities call.
• Maaaring i-import ang mga Finale file (.musx), sa best-effort na batayan, at dokumentado na ang pag-import ng na-scan na musika (PDF at mga larawan) sa paggawa ng score.
• OpenAPI 3.1. Ginagamit ng mga nullable field ang 3.1 syntax; kailangang i-update ang tooling na naka-pin sa OpenAPI 3.0. Inalis ang mimeType field mula sa mga OMR file upload.

• Ikaw ang may kontrol sa data retention. Ipinapakita na ngayon ng mga OMR job kung gaano katagal itinatago ang kanilang mga file (30 araw bilang default), may kasamang expiry date na ngayon ang bawat MusicXML job, at maaari mong burahin ang mga file at resulta ng isang job sa sandaling makuha mo na ang mga ito.
• Pagtukoy ng feature bago mag-sign in. Gumagana ang OMR capabilities call kahit walang account at inililista nito ang mga sinusuportahang wika ng pagkilala kasama ang kanilang mga pangalan.
• ABC notation export para sa anumang revision ng score, kasama ng MusicXML, MIDI at iba pang format. Tulad ng MIDI, hindi nito dala ang buong engraving.
• Maaaring i-configure ang mga assignment na Free Record sa pamamagitan ng API sa Flat for Education.
• Ang mga error mula sa upstream provider (halimbawa, Google Classroom) ay may kasama na ngayong sariling naka-localize na mensahe ng provider.

Available na ngayon ang OMR engine ng Flat nang programmatically sa pamamagitan ng developer API. Magpadala ng mga PDF o larawan, subaybayan ang progreso ng pagkilala, suriin ang mga natukoy na instrumento, at pagkatapos ay i-import ang resulta bilang nae-edit na score sa isang library ng Flat o i-export bilang MusicXML o MIDI. Ito rin ang parehong in-house na model na ginagamit para sa pag-import ng PDF at larawan sa editor, at available na ngayon sa mas malaking sukat para sa sarili mong mga app at workflow.

Ang nakalaang OMR API (v2.24.0) ay nakabatay sa background na pag-import ng PDF na idinagdag sa paggawa ng score sa v2.23.0: humiling ng suporta sa task kapag nag-i-import ng file at i-poll ang task hanggang maging handa ang score. Tingnan ang API changelog para sa mga detalye ng parehong release.

Ang pinakamalaking pag-update ng specification mula noong 2024, na inaangkop ang API sa dalawang taon ng mga pagbabago sa produkto.

• Mag-import mula sa 15+ format. Ang Guitar Pro, MuseScore, ABC notation, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer, at Encore ay idinagdag sa MusicXML at MIDI, at maaaring i-export ang mga score bilang katutubong .flat na file.
• Virtual collections. Pinapalitan ng all scores, collaborations, at likes ang lumang hierarchy ng mga folder sa library, na tumutugma sa muling idinisenyong Flat library.
• Flat for Education. Mga performance assignment na may audio o video recording at mga opsyon para sa backing track, metronome, at bilis; mga group submission para sa magkatuwang na pagsusulat; mga instruction na may rich text; mga sub-group ng estudyante; mga assignment sa Microsoft Teams na naka-iskedyul at naka-target sa bawat indibidwal; mayayamang paglalarawan at mga uri ng assignment sa resource library.
• Pinag-isang configuration ng LTI para sa LTI 1.1 at 1.3, kabilang ang dynamic registration. Deprecated na ang mga dating tawag sa kredensyal ng LTI 1.1.
• Mga taunang estadistika sa mga score, bilang ng mga pampublikong score sa mga profile, at pag-alis ng ilang field na matagal nang deprecated.

• Idinagdag ang mga paraang getMP3 at getWAV para sa pag-export ng audio
• Idinagdag ang event na exportProgress, para makapagpakita ng progreso ang mahabang pag-export

• Mga pampublikong profile ang mga listahan ng score ng user. Ang paglista ng mga score ng isang user ay nagbabalik na ngayon ng kanilang mga pampublikong score lamang, kasama ang bagong pagination at sorting, ang pagbabagong inanunsyo noong 2020.
• Ipinapakita na ngayon ng mga detalye ng score ang URL sa pag-edit, mga pangalan ng instrumento, at anumang nakaiskedyul na petsa ng pagbura; ipinapakita ng mga koleksyon ang bilang ng kanilang mga score; ipinapakita ng mga pampublikong profile ang bilang ng likes at plays.
• Flat for Education. I-filter ang resource library ayon sa uri ng assignment, subject, at grade; may paglalarawan sa pagbabahagi at mga kakayahan sa privacy ang mga resource; maaaring higpitan ng mga assignment ang pagtugtog ng mga nota at mga audio track; sinusuportahan ng mga submission ang mga grade service ng LTI 1.1 at 1.3.

• Naka-page na ngayon ang mga like sa mga profile ng user, at makikita rin sa mga detalye ng account kung aling produkto ang ginagamit ng isang user.
• Ipinapakita na ngayon ng mga karapatan sa resource kung ang tumatawag ay ang may-ari, isang user collaborator, o isang group collaborator, kasama ang petsa kung kailan idinagdag ang bawat collaborator. Idinagdag din sa mga detalye ng score ang pangunahing key signature, petsa ng pag-highlight, at organisasyon.
• Flat for Education. Maaaring magamit muli ang mga imbitasyon nang ilang beses; may graded state na ngayon ang mga submission kasama ang playback at mga detalye ng LTI; makokopya lang ang isang assignment sa resource library kung wala pa ito roon; at may sarili nang mga resource library ang mga organisasyon na may antas ng privacy para sa buong organisasyon.

Basahin ang istruktura ng na-load na score mula sa iyong code.

• Mga part at voice: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Mga note: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Pinapatay ng bagong URL parameter na noAudio ang audio playback
• Inayos ang setMasterVolume na tumatawag sa maling underlying method

• Inalis ang suporta para sa jQuery sa constructor — magpasa na lang ng DOM element o ng id nito
• Ang na-publish na npm module ay may kasamang mga TypeScript type
• Magkahiwalay na ES at UMD build

• Gumawa ng mga LTI link mula sa mga item sa resource library ng Flat for Education, para mailagay ang mga ito nang direkta sa isang kurso sa LMS.
• Ang maximum na grado sa isang assignment ay mula 100 naging 10,000 puntos.
• Ang metadata ng score (subtitle, composer, lyricist, arranger, description, license…) ay maaari nang i-clear sa pamamagitan ng API, at hindi lang i-set.

• Resource Library API (beta). I-browse at pamahalaan ang mga resource library ng Flat for Education, gamit ang dalawang bagong OAuth2 scope para sa buong access at read-only na access. Maaaring kopyahin ang mga assignment sa resource library.
• Mga test student. Gumawa ng mga testing student account sa isang klase para subukan ang mga assignment gaya ng karanasan ng isang estudyante.
• Iniuulat ng mga assignment kung ano ang maaari mong gawin sa mga ito (i-edit, i-publish, i-archive…), kung ang kanilang mga attachment ay mga nakalaang kopya, at anumang problemang naranasan. Itinatala ng history ng submission ang pinagmulan ng isang pagbabago kapag ito ay mula sa Google Classroom, Microsoft Teams o isang LMS.
• Kapag ni-reset ang isang submission, nananatili ito sa lugar sa halip na mabura; ang metadata ng klase (antas, mga kasanayan, laki) at ang mga detalye ng Microsoft sign-in sa mga account ay inilalantad.
• Ibinabalik ng mga score revision ang kanilang mga petsa ng simula at pagtatapos; maaaring i-enable ng mga score builder ang quarter tones; maaaring panatilihin ng mga kopya ang orihinal na pamagat.

• Mga measure: getNbMeasures, getMeasuresUuids
• Pag-navigate: goLeft, goRight, scrollToCursor
• Metronome: getMetronomeMode, setMetronomeMode
• Bilis ng playback: getPlaybackSpeed, setPlaybackSpeed

• Mga sign-in link at delegated access token. Makakagawa ang mga admin ng Flat for Education ng sign-in link para sa sinumang user sa kanilang organisasyon, o ng access token na kumikilos para sa user na iyon: pundasyon ito para sa mga custom portal at mga integrasyon ng single sign-on.
• Idinagdag ang Japanese sa hiragana (ja-HIRA) sa mga sinusuportahang locale; ipinapakita na ngayon ng mga pampublikong komento ang kanilang estado ng pagmo-moderate.
• Ibinabalik na ng mga audio export ang MP3 set bilang default na track kapag mayroon nito. Inalis ang opsyong humiling ng mga naka-cache na export lamang, dahil lahat ng audio export ay inihahatid na ngayon mula sa cache.

• Score builder. Gumawa ng blangkong score nang hindi nag-i-import ng MusicXML file: magbigay ng listahan ng mga instrumento at, kung gusto, ng time signature, key signature, tablature, chord grids, at page layout.
• Flat for Education. Maaaring gumawa ng mga user ng organisasyon na may role; maaaring i-shuffle ng mga worksheet ang kanilang mga exercise; inililista ng mga submission ng estudyante ang mga exercise na nilalaman ng mga ito.

• Mga playback track. Ilista ang mga track na awtomatikong ginagawa at sini-sync ng Flat (playback bilang MP3), kunin ang mga synchronization point ng pinakabagong playback file, at kunin ang CDN URL ng isang export sa response body.
• Flat for Education. Maaaring i-reset ng mga guro ang submission ng isang estudyante; iniuulat ng mga klase ang mga account na hindi maidagdag habang nagsi-sync; inilalantad ng mga assignment at submission ang kanilang estado at mga link sa Microsoft Teams; maaaring iiskedyul ang mga kopya ng assignment; taglay ng mga performance submission ang kanilang naka-save na audio track.
• Nagkakaroon na ng cover picture ang mga profile, at maaaring kunin nang hiwalay ang id ng kasalukuyang user.

• Tumatanggap na ang loadFlatScore ng sharingKey, kaya maaaring i-load ang isang pribadong ibinahaging score
• Idinagdag ang setTrack, useTrack at seekTrackTo para dynamic na maitakda ang audio track

• Mga export ng grado. I-download ang mga grado ng isang takdang-aralin bilang CSV o Excel file.
• May uri at cover image ang mga takdang-aralin; kapag kinopya ang isang takdang-aralin, puwedeng mapatungan ang isang kasalukuyang draft ng nilalaman ng ibang takdang-aralin.
• Ipinapakita sa mga collaborator kung nakabinbin pa ang kanilang imbitasyon.

• Pagmamarka sa pamamagitan ng API. Magtakda ng draft at final na marka, ibalik ang isang pagsusumite sa estudyante, at basahin ang mga nabilang na komento; ang pinakamataas na puntos ay nakaimbak kasama ng marka.
• Mga komento sa pagsusumite. Gumawa, maglista, mag-update, at magtanggal ng mga komento sa isang pagsusumite.
• Mga opsyon sa assignment. Mga toolset, limitasyon sa playback, pinakamataas na puntos, mga paksa sa Google Classroom, pagtatalaga sa mga partikular na estudyante, mga naka-lock na template, at mga detalye ng mga assignment sa LTI, Canvas, at MusicFirst.
• Maaaring i-edit ng mga admin ang username, pangalan, at email ng isang managed account; maaaring i-filter ang mga listahan ng user ayon sa aktibong lisensya.
• Inalis ang dating mga parameter ng pagsusumite na studentComment at returnFeedback kapalit ng mga bagong tawag sa pagmamarka.

• I-archive at alisin sa archive ang mga takdang-aralin, at basahin ang pangunahing uri ng isang takdang-aralin (bagong score, template, o shared writing).
• Mga user ng organisasyon. Gumawa ng mga account na may first name at last name, ayusin at i-filter ang mga listahan ng user, bilangin ang mga user na tumutugma sa isang filter, at i-filter ang mga miyembro ng grupo ayon sa kanilang sync source (Google Classroom, Microsoft Teams, Clever).
• Inililista na ng mga detalye ng score ang mga audio sample na ginagamit sa playback, kasama ang isang normalized na listahan ng instrumento na hindi na nakadepende sa mga sample.

Kontrolin ang mix mula sa iyong code, at basahin kung ano ang nasa ilalim ng cursor.

• Volume at mute: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo at reverb: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Pagsisiyasat: getMeasureDetails, getNoteDetails
• Mga idinagdag na event: noteDetails, measureDetails, cursorContext

• Lumilipat ang espesipikasyon sa OpenAPI 3.0. Inilarawan ang mga naunang bersyon sa OpenAPI 2 (Swagger).
• Ipinapakita na ngayon ng mga score ang arranger at ang kanilang estadistika ng mga play; maaaring mag-iskedyul ng pagtanggal na maisagawa agad sa halip na manatili sa trash.
• Flat for Education. Ang mga attachment sa assignment ay maaari nang maging mga file sa Google Drive, kasama na ngayon sa mga klase ang kanilang mga detalye sa Microsoft Teams, at ipinapakita ng mga education account ang unang pangalan at apelyido.

• Umaabot nang live sa editor ang mga pagbabago sa metadata. Kapag in-update sa pamamagitan ng API ang pamagat, subtitle, composer, lyricist, o teksto ng lisensya ng isang score, agad itong ipinapadala sa mga bukas na editor nang real time, at sine-save ang isang bagong bersyon. Maaari nang maging dalawang beses ang haba ng mga paglalarawan (2,000 character).
• Ipinapakita na ngayon ng mga submission sa Education ang kanilang estado (created, turned in, returned); ibinabalik ng metadata ng revision ang huling kaganapan ng pagbabago.
• Kasama na ang Turkish sa mga sinusuportahang locale; ipinapahiwatig ng mga pampublikong profile kung kabilang ang isang account sa Flat team.

• Idinagdag ang getMIDI
• Ang getMusicXML ay nagbabalik na ngayon ng isang Uint8Array sa pinakamataas na antas — wala na sa tugon ang property na .data
• Ang voiceIdx ng cursor ay voiceIdxInStaff na ngayon

Na-update para sa release ng embed.

• Ang SDK ay naglo-load na ngayon mula sa flat-embed.com bilang default
• Inalis ang deprecated na edit action at edit event
• Inalis ang setNoteColor

• Mas maraming format para sa import. Puwede nang i-import ang mga file na Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar, at MuseScore, at tumatanggap na rin ng filename ang pag-import.
• Maaaring ilista ang mga collection sa ilalim ng isang parent collection at ipakita ang petsa ng pagkakagawa ng mga ito; inililista naman ng mga score ang mga collection kung saan sila nabibilang.
• Naka-anchor na ngayon ang mga contextual comment sa isang staff gamit ang identifier sa halip na index, at isinasaad ng mga karapatan sa resource kung collaborator ang tumatawag.

• Collections API. Gumawa, maglista, mag-update, mag-delete at mag-restore ng mga collection, ilista ang mga score ng mga ito, at magdagdag o mag-alis ng mga score, gamit ang tatlong bagong OAuth2 scope para sa read-only, add-only, at full access.
• Maaaring i-restore ang mga score mula sa trash; ang pag-delete ng score nang walang admin rights ay mag-aalis na lang ng pagkaka-share nito sa iyong account; ang isang kopya ay maaaring ituro sa isang partikular na collection.
• Maaaring i-filter ang mga komento ayon sa uri (document o inline).
• Gumagamit na ngayon ang mga part export ng mga part identifier sa halip na mga index, at mula Setyembre 2019 ang listing ng mga score ng isang user ay mga pampublikong score na lang ang ibinabalik.

• Pamamahala ng account ng organisasyon. Maaaring i-update ng mga admin ang mga pinamamahalaang account, at burahin ang mga ito o i-convert sa mga consumer account; gumagamit ang mga listahan ng user at imbitasyon ng cursor-based pagination.
• Nagkaroon ang mga klase ng inactive na estado na maaaring i-activate muli, at iniuulat na ngayon ang kanilang Canvas LMS domain at Clever section; nagkaroon ang mga assignment ng draft na estado at uri ng attachment na exercise.
• Ipinapakita na ngayon ng mga profile ang isang tema at ang mga instrumentong tinutugtog.

• Idinagdag ang paraang focusScore para ilagay ang keyboard focus sa embed
• Bagong property na defaultMode sa config ng editor

• Pampubliko na ang mga unang education API. Pamahalaan ang mga klase, takdang-aralin at pagsusumite, mga account at imbitasyon ng organisasyon, mga kredensyal ng LTI, at ang mga grupo at user ng isang organisasyon: lahat ng kailangan ng isang integrasyon sa paaralan.
• Scoped access. Sinasaklaw ng mga bagong OAuth2 scope ang mga klase, takdang-aralin at pangangasiwa ng organisasyon, bawat isa ay may read-only na bersyon, para humingi lang ang isang integrasyon ng talagang kailangan nito.

Maaari na ngayong siyasatin ng iyong code kung paano naka-configure ang embed at gawin itong editor.

• Idinagdag na mga method: getEmbedConfig, setEditorConfig, edit
• Idinagdag na event: edit

Natuto na ang SDK na mag-load ng mga score mula sa MusicXML at mag-ulat kung ano ang ginagawa ng reader.

• Idinagdag na mga method: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Idinagdag na mga event: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Idinagdag na mga integration test

Ang unang pampublikong release ng REST API ng Flat. Basahin at pamahalaan ang iyong account, mga score, mga user at mga group mula sa sarili mong mga app at script, gamit ang OAuth2 para kumilos sa ngalan ng ibang mga user ng Flat.

Nakatala ang lahat mula noon sa changelog ng API, at saklaw ng dokumentasyon para sa developer ang authentication, ang reference at mga gabay.