Developer changelog

Tabloul de bord pentru dezvoltatori a fost refăcut în jurul a ceea ce poate face integrarea ta. Fiecare capabilitate (Embed, OMR, REST API, Import API, LTI) primește un card cu aria sa, prețurile și documentația, iar cele pe care aplicația ta le folosește deja apar primele.

• O nouă secțiune OMR la nivel de cont, cu joburile tale, creditele tale și istoricul lor într-un singur loc, deoarece creditele OMR sunt partajate de toate aplicațiile tale.
• Încearcă OMR înainte să scrii cod. Playground acceptă un PDF sau fotografii, afișează numărul de pagini, costul pe pagină și soldul care ți-ar rămâne, apoi rulează jobul după confirmare. Rezultatul este disponibil pentru descărcare ca MusicXML, nimic nu ajunge în biblioteca ta.
• Pagini de aplicație mai clare. Tokenurile personale, acreditările OAuth2 și accesul OMR sunt grupate pe aplicație, iar acreditările care includ aria OMR sunt evidențiate.

Deschide-l din flat.io/developers.

Specificația noastră REST API trece la OpenAPI 3.1, API-ul OMR își încheie perioada beta, iar temele din Flat for Education se extind dincolo de listare și creare.

• API-ul OMR este stabil. Endpointurile, câmpurile și comportamentul urmează acum procesul nostru obișnuit de depreciere înaintea oricărei modificări incompatibile. Un nou FAQ acoperă creditele și facturarea, limitele și timpii de procesare, calitatea recunoașterii și limbile, precum și utilizarea comercială și confidențialitatea.
• Citiți, actualizați și ștergeți temele în Flat for Education. Ștergerea unei teme elimină și trimiterile ei, precum și copiile elevilor; arhivați-o în schimb dacă vreți să păstrați munca.
• Registrul creditelor. Un nou apel afișează istoricul creditelor; soldul rămâne în apelul pentru capabilitățile OMR.
• Fișierele Finale (.musx) pot fi importate, pe bază de best-effort, iar importul de muzică scanată (PDF și imagini) este documentat la crearea partiturii.
• OpenAPI 3.1. Câmpurile nullable folosesc sintaxa 3.1; instrumentele fixate la OpenAPI 3.0 trebuie actualizate. Câmpul mimeType a fost eliminat din încărcările de fișiere OMR.

• Păstrarea datelor, sub controlul dvs. Joburile OMR indică acum cât timp le sunt păstrate fișierele (30 de zile în mod implicit), fiecare job MusicXML include data de expirare, iar fișierele și rezultatele unui job pot fi șterse imediat ce le-ați colectat.
• Detectarea funcționalităților înainte de autentificare. Apelul pentru capabilitățile OMR funcționează fără cont și listează limbile de recunoaștere acceptate, împreună cu denumirile lor.
• Export de notație ABC pentru orice revizie a unei partituri, alături de MusicXML, MIDI și celelalte formate. La fel ca MIDI, nu include întreaga gravare muzicală.
• Temele Free Record pot fi configurate prin API în Flat for Education.
• Erorile provenite de la un furnizor din amonte (de exemplu, Google Classroom) includ acum propriul mesaj localizat al furnizorului.

Motorul OMR de la Flat este acum disponibil programatic prin API-ul pentru dezvoltatori. Trimiteți fișiere PDF sau fotografii, urmăriți progresul recunoașterii, verificați instrumentele detectate, apoi importați rezultatul ca partitură editabilă într-o bibliotecă Flat sau exportați MusicXML ori MIDI. Este același model intern care stă la baza importului de fișiere PDF și fotografii în editor, acum disponibil la scară pentru propriile aplicații și fluxuri de lucru.

API-ul OMR dedicat (v2.24.0) se bazează pe importul de PDF-uri în fundal adăugat la crearea partituriilor în v2.23.0: solicitați suport pentru task-uri atunci când importați un fișier și interogați task-ul până când partitura este gata. Consultați jurnalul de modificări al API-ului pentru detaliile ambelor versiuni.

Cea mai mare actualizare a specificației din 2024 încoace, care aduce API-ul la zi cu doi ani de schimbări ale produsului.

• Import din peste 15 formate. Guitar Pro, MuseScore, notația ABC, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer și Encore se alătură MusicXML și MIDI, iar partiturile pot fi exportate ca fișiere .flat native.
• Colecții virtuale. Toate partiturile, colaborările și aprecierile înlocuiesc vechea ierarhie de foldere din bibliotecă, în acord cu biblioteca Flat reproiectată.
• Flat for Education. Teme de interpretare cu înregistrări audio sau video și opțiuni pentru backing track, metronom și viteză; trimiteri de grup pentru scriere colaborativă; instrucțiuni cu text îmbogățit; subgrupuri de elevi; teme Microsoft Teams programate și direcționate individual; descrieri bogate și tipuri de teme în biblioteca de resurse.
• Configurație LTI unificată pentru LTI 1.1 și 1.3, inclusiv înregistrare dinamică. Apelurile anterioare pentru acreditările LTI 1.1 sunt depreciate.
• Statistici anuale despre partituri, numărul de partituri publice din profiluri și eliminarea câtorva câmpuri depreciate de mult timp.

• Au fost adăugate metodele getMP3 și getWAV pentru export audio
• A fost adăugat evenimentul exportProgress, astfel încât un export de durată să poată afișa progresul

• Listele de partituri ale utilizatorilor sunt profiluri publice. Când listați acum partiturile unui utilizator, sunt returnate doar partiturile sale publice, cu paginare și sortare noi, schimbarea anunțată în 2020.
• Detaliile partiturii expun URL-ul de editare, numele instrumentelor și orice dată programată pentru ștergere; colecțiile raportează numărul de partituri; profilurile publice afișează numărul de aprecieri și redări.
• Flat for Education. Filtrați biblioteca de resurse după tipul temei, materie și clasă; resursele includ o descriere a partajării și opțiuni de confidențialitate; temele pot restricționa redarea notelor și pistele audio; trimiterile sunt compatibile cu serviciile de notare LTI 1.1 și 1.3.

• Aprecieri paginate pe profilurile utilizatorilor și produsul folosit de un utilizator în detaliile contului său.
• Drepturile asupra resurselor arată dacă apelantul este proprietarul, un colaborator utilizator sau un colaborator de grup, împreună cu data la care a fost adăugat fiecare colaborator. Detaliile partiturii includ acum armura principală, data evidențierii și organizația.
• Flat for Education. Invitațiile pot fi reutilizate de mai multe ori; trimiterile primesc o stare evaluată, plus detalii despre redare și LTI; o temă poate fi copiată în biblioteca de resurse doar dacă nu este deja acolo; organizațiile primesc propriile biblioteci de resurse, cu un nivel de confidențialitate la nivelul întregii organizații.

Citiți structura partiturii încărcate direct din codul vostru.

• Părți și voci: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Note: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Noul parametru URL noAudio dezactivează redarea audio
• A fost corectată o problemă prin care setMasterVolume apela metoda internă greșită

• A fost eliminat suportul pentru jQuery în constructor — în schimb, transmiteți un element DOM sau id-ul acestuia
• Modulul npm publicat include tipuri TypeScript
• Builduri ES și UMD separate

• Creați linkuri LTI din elementele bibliotecii de resurse Flat for Education, pentru a le plasa direct într-un curs LMS.
• Nota maximă pentru o temă crește de la 100 la 10.000 de puncte.
• Metadatele partiturii (subtitlu, compozitor, autor de versuri, aranjor, descriere, licență…) pot fi acum și golite prin API, nu doar setate.

• Resource Library API (beta). Răsfoiți și gestionați bibliotecile de resurse Flat for Education, cu două noi scope-uri OAuth2 pentru acces complet și acces doar în citire. Temele pot fi copiate în biblioteca de resurse.
• Elevi de test. Creați conturi de elev pentru test într-o clasă, ca să încercați temele așa cum le-ar vedea un elev.
• Temele indică ce puteți face cu ele (edita, publica, arhiva…), dacă atașamentele lor sunt copii dedicate și orice problemă întâlnită. Istoricul predărilor înregistrează sursa unei modificări atunci când aceasta provine din Google Classroom, Microsoft Teams sau un LMS.
• Resetarea unei predări o păstrează în loc să o șteargă; sunt expuse metadatele clasei (nivel, competențe, mărime) și detaliile de autentificare Microsoft din conturi.
• Reviziile partiturii returnează datele lor de început și de sfârșit; generatoarele de partituri pot activa sferturile de ton; copiile pot păstra titlul original.

• Măsuri: getNbMeasures, getMeasuresUuids
• Navigare: goLeft, goRight, scrollToCursor
• Metronom: getMetronomeMode, setMetronomeMode
• Viteza de redare: getPlaybackSpeed, setPlaybackSpeed

• Linkuri de conectare și tokenuri de acces delegate. Administratorii Flat for Education pot crea un link de conectare pentru orice utilizator din organizația lor sau un token de acces care acționează în numele acelui utilizator: baza pentru portaluri personalizate și integrări single sign-on.
• Japoneza în hiragana (ja-HIRA) se alătură limbilor locale acceptate; comentariile publice își afișează starea de moderare.
• Exporturile audio returnează setul MP3 ca pistă implicită atunci când acesta există. Opțiunea de a solicita doar exporturi din cache a fost eliminată, deoarece exporturile audio sunt acum livrate întotdeauna din cache.

• Generator de partituri. Creează o partitură goală fără să imporți un fișier MusicXML: furnizează o listă de instrumente și, opțional, măsura, armura, tablatura, diagramele de acorduri și aspectul paginii.
• Flat for Education. Utilizatorii organizației pot fi creați cu un rol; fișele de lucru își pot amesteca exercițiile; trimiterile elevilor listează exercițiile pe care le conțin.

• Piste de redare. Listați pistele pe care Flat le generează și le sincronizează automat (redare ca MP3), preluați punctele de sincronizare ale celui mai recent fișier de redare și obțineți URL-ul CDN al unui export în corpul răspunsului.
• Flat for Education. Profesorii pot reseta trimiterea unui elev; clasele raportează conturile care nu au putut fi adăugate în timpul unei sincronizări; temele și trimiterile expun starea și linkurile lor Microsoft Teams; copiile temelor pot fi programate; trimiterile de performanță includ pista audio salvată.
• Profilurile primesc o imagine de copertă, iar id-ul utilizatorului curent poate fi preluat separat.

• loadFlatScore acceptă un sharingKey, astfel încât o partitură partajată privat să poată fi încărcată
• Au fost adăugate setTrack, useTrack și seekTrackTo pentru a seta dinamic pista audio

• Exportul notelor. Descărcați notele unei teme ca fișier CSV sau Excel.
• Temele includ acum tipul lor și o imagine de copertă; copierea unei teme poate suprascrie o ciornă existentă cu conținutul altei teme.
• Colaboratorii arată dacă invitația lor este încă în așteptare.

• Notare prin API. Setați note provizorii și finale, returnați o predare unui elev și citiți contoarele calculate pentru comentarii; punctajul maxim este stocat împreună cu nota.
• Comentarii la predări. Creați, listați, actualizați și ștergeți comentarii la o predare.
• Opțiuni pentru temă. Seturi de instrumente, o limită de redare, punctaj maxim, subiecte Google Classroom, atribuirea către elevi specifici, șabloane blocate și detalii despre temele LTI, Canvas și MusicFirst.
• Administratorii pot edita numele de utilizator, numele și adresa de e-mail ale unui cont gestionat; listele de utilizatori pot fi filtrate după licență activă.
• Vechii parametri de predare studentComment și returnFeedback au fost eliminați în favoarea noilor apeluri de notare.

• Arhivați și dezarhivați temele și citiți tipul principal al unei teme (partitură nouă, șablon sau scriere partajată).
• Utilizatori ai organizației. Creați conturi cu prenume și nume, sortați și filtrați listele de utilizatori, numărați utilizatorii care corespund unui filtru și filtrați membrii grupurilor după sursa lor de sincronizare (Google Classroom, Microsoft Teams, Clever).
• Detaliile partiturii listează mostrele audio folosite la redare, cu o listă normalizată de instrumente care nu mai depinde de mostre.

Controlează mixajul din codul tău și vezi ce se află sub cursor.

• Volum și dezactivare sunet: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo și reverberație: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Inspectare: getMeasureDetails, getNoteDetails
• Evenimente adăugate: noteDetails, measureDetails, cursorContext

• Specificația trece la OpenAPI 3.0. Versiunile anterioare erau descrise în OpenAPI 2 (Swagger).
• Partiturile expun informații despre aranjor și statisticile de redare; o ștergere poate fi programată să ruleze în scurt timp, în loc să rămână în coșul de gunoi.
• Flat for Education. Atașamentele temelor pot fi fișiere Google Drive, clasele includ detaliile lor Microsoft Teams, iar conturile educaționale expun prenumele și numele de familie.

• Modificările metadatelor ajung în editor în timp real. Când actualizezi prin API titlul, subtitlul, compozitorul, textierul sau textul licenței unei partituri, modificarea este trimisă în timp real către editorii deschiși și este salvată o versiune nouă. Descrierile pot fi de două ori mai lungi (2,000 de caractere).
• Predările din Education își expun starea (creată, predată, returnată); metadatele reviziilor returnează ultimul eveniment de modificare.
• Turca se alătură limbilor acceptate; profilurile publice spun dacă un cont aparține echipei Flat.

• A fost adăugat getMIDI
• getMusicXML returnează acum un Uint8Array la nivelul superior — răspunsul nu mai include proprietatea .data
• voiceIdx al cursorului se numește acum voiceIdxInStaff

Actualizat pentru lansarea embed.

• SDK-ul se încarcă acum implicit de la flat-embed.com
• Au fost eliminate acțiunea învechită edit și evenimentul edit
• A fost eliminat setNoteColor

• Mai multe formate de import. Fișierele Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar și MuseScore pot fi importate, iar importurile acceptă un nume de fișier.
• Colecțiile pot fi listate sub o colecție părinte și raportează data creării; partiturile listează colecțiile din care fac parte.
• Comentariile contextuale sunt ancorate la un portativ după identificator, nu după index, iar drepturile resursei indică dacă apelantul este colaborator.

• API-ul Colecțiilor. Creați, listați, actualizați, ștergeți și restaurați colecții, listați partiturile din acestea și adăugați sau eliminați partituri, cu trei noi scope-uri OAuth2 pentru acces doar în citire, doar pentru adăugare și acces complet.
• Partiturile pot fi restaurate din coșul de gunoi; ștergerea unei partituri fără drepturi de administrator îi anulează în schimb partajarea din contul dvs.; o copie poate avea ca destinație o colecție anume.
• Comentariile pot fi filtrate după tip (document sau inline).
• Exporturile de părți folosesc acum identificatori de parte în loc de indecși și, din septembrie 2019, lista de partituri a unui utilizator returnează doar partituri publice.

• Gestionarea conturilor organizației. Administratorii pot actualiza conturile gestionate, le pot șterge sau le pot converti în conturi de consumator; listele de utilizatori și invitații folosesc paginare bazată pe cursor.
• Clasele primesc o stare inactivă care poate fi reactivată și raportează domeniul Canvas LMS și secțiunea Clever; temele primesc o stare de ciornă și un tip de atașament pentru exerciții.
• Profilurile expun o temă și instrumentele cântate.

• A fost adăugată metoda focusScore pentru a oferi focalizare de la tastatură integrării
• Proprietate nouă defaultMode în configurația editorului

• Primele API-uri pentru educație sunt publice. Gestionează clase, teme și predări, conturi de organizație și invitații, credențiale LTI, precum și grupurile și utilizatorii unei organizații: tot ce are nevoie o integrare școlară.
• Acces cu domenii de autorizare. Noile scope-uri OAuth2 acoperă clasele, temele și administrarea organizației, fiecare și cu o variantă doar pentru citire, astfel încât o integrare să ceară doar ce are nevoie.

Codul tău poate acum să verifice cum este configurată încorporarea și să o transforme într-un editor.

• Metode adăugate: getEmbedConfig, setEditorConfig, edit
• Eveniment adăugat: edit

SDK-ul învață să încarce partituri din MusicXML și să raporteze ce face cititorul.

• Metode adăugate: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Evenimente adăugate: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Teste de integrare adăugate

Prima versiune publică a API-ului REST Flat. Citiți și gestionați contul, partiturile, utilizatorii și grupurile din propriile aplicații și scripturi, cu OAuth2 pentru a acționa în numele altor utilizatori Flat.

Tot ce a urmat de atunci este consemnat în jurnalul de modificări al API-ului, iar documentația pentru dezvoltatori acoperă autentificarea, referința și ghidurile.