Developer changelog

Utvecklarpanelen har byggts om utifrån vad din integration kan göra. Varje funktion (Embed, OMR, REST API, Import API, LTI) har nu ett kort med omfattning, pris och dokumentation, och de som din app redan använder visas först.

• Ett nytt OMR-avsnitt på kontonivå, med dina jobb, dina krediter och deras historik på ett ställe, eftersom OMR-krediter delas av alla dina appar.
• Prova OMR innan du skriver kod. Playground tar en PDF eller foton, visar sidantalet, kostnaden per sida och vilket saldo som skulle återstå, och kör sedan jobbet när du bekräftar. Resultatet går till nedladdningar av MusicXML, inget hamnar i ditt bibliotek.
• Tydligare appsidor. Personliga token, OAuth2-uppgifter och OMR-åtkomst grupperas per applikation, och de uppgifter som har OMR-omfattningen markeras tydligt.

Öppna den från flat.io/developers.

Vår REST API-specifikation går över till OpenAPI 3.1, OMR API avslutar sin betaperiod, och uppgifter i Flat for Education öppnas upp bortom att bara listas och skapas.

• OMR API är nu stabilt. Endpoints, fält och beteende följer nu vår vanliga avvecklingsprocess innan någon bakåtkompatibel brytande ändring görs. En ny FAQ täcker krediter och fakturering, gränser och bearbetningstider, igenkänningskvalitet och språk samt kommersiell användning och integritet.
• Läs, uppdatera och radera uppgifter i Flat for Education. Om du raderar en uppgift tas även dess inlämningar och elevernas kopior bort; arkivera den i stället om du vill behålla arbetet.
• Kreditreskontra. Ett nytt anrop listar din kredithistorik; saldot finns fortfarande kvar i anropet för OMR-funktioner.
• Finale-filer (.musx) kan importeras, efter bästa förmåga, och import av skannad musik (PDF och bilder) dokumenteras vid skapande av partitur.
• OpenAPI 3.1. Nullbara fält använder 3.1-syntaxen; verktyg som är låsta till OpenAPI 3.0 behöver uppdateras. Fältet mimeType har tagits bort från OMR-filuppladdningar.

• Du styr datalagringen. OMR-jobb anger nu hur länge deras filer sparas (30 dagar som standard), varje MusicXML-jobb har med sitt utgångsdatum, och du kan radera ett jobbs filer och resultat så fort du har hämtat dem.
• Funktionskontroll före inloggning. Anropet för OMR-funktioner fungerar nu utan konto och listar de språk för igenkänning som stöds med deras namn.
• Export av ABC-notation för alla partiturversioner, tillsammans med MusicXML, MIDI och de andra formaten. Precis som MIDI innehåller den inte den fullständiga notgrafiken.
• Free Record-uppgifter kan konfigureras via API:et i Flat for Education.
• Fel som kommer från en extern leverantör (till exempel Google Classroom) innehåller nu leverantörens eget lokaliserade meddelande.

Flat:s OMR-motor är nu tillgänglig programmatiskt via utvecklar-API:t. Skicka PDF-filer eller foton, följ igenkänningsförloppet, granska de identifierade instrumenten och importera sedan resultatet som en redigerbar notskrift i ett Flat-bibliotek eller exportera MusicXML eller MIDI. Det är samma interna modell som driver import av PDF-filer och foton i editorn, nu tillgänglig i större skala för dina egna appar och arbetsflöden.

Det dedikerade OMR-API:t (v2.24.0) bygger vidare på bakgrundsimporten av PDF som lades till vid skapande av partitur i v2.23.0: begär stöd för uppgifter när du importerar en fil och polla uppgiften tills partituret är klart. Se API-ändringsloggen för detaljer om båda versionerna.

Den största uppdateringen av specifikationen sedan 2024, som gör att API:et kommer ikapp två års produktförändringar.

• Import från 15+ format. Guitar Pro, MuseScore, ABC notation, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer och Encore läggs till utöver MusicXML och MIDI, och partitur kan exporteras som inbyggda .flat-filer.
• Virtuella samlingar. All scores, collaborations och likes ersätter den äldre mapphierarkin i biblioteket, i linje med det omgjorda Flat-biblioteket.
• Flat for Education. Framförandeuppgifter med ljud- eller videoinspelningar och alternativ för backing track, metronom och hastighet; gruppinlämningar för gemensamt skrivande; instruktioner med rik text; elevundergrupper; Microsoft Teams-uppgifter med schemaläggning och individuell tilldelning; fylliga beskrivningar och uppgiftstyper i resursbiblioteket.
• Enhetlig LTI-konfiguration för LTI 1.1 och 1.3, inklusive dynamisk registrering. De tidigare anropen för LTI 1.1-uppgifter är föråldrade.
• Årlig statistik för partitur, antal offentliga partitur på profiler och borttagning av några fält som varit föråldrade länge.

• Lade till metoderna getMP3 och getWAV för ljudexport
• Lade till händelsen exportProgress, så att en lång export kan visa förloppet

• Användares notlistor är nu offentliga profiler. När du listar en användares noter returneras nu bara deras offentliga noter, med ny paginering och sortering, enligt ändringen som tillkännagavs 2020.
• Detaljer för noter visar nu redigerings-URL, instrumentnamn och eventuellt schemalagt raderingsdatum; samlingar visar antal noter; offentliga profiler visar antal gilla-markeringar och uppspelningar.
• Flat for Education. Filtrera resursbiblioteket efter uppgiftstyp, ämne och årskurs; resurser innehåller en beskrivning av delning och integritetsmöjligheter; uppgifter kan begränsa notuppspelning och ljudspår; inlämningar stöder betygstjänster för LTI 1.1 och 1.3.

• Gilla-markeringar på användarprofiler är nu paginerade, och i en användares kontouppgifter visas vilken produkt användaren använder.
• Resursrättigheter anger nu om anroparen är ägare, användarsamarbetspartner eller gruppsamarbetspartner, samt datumet då varje samarbetspartner lades till. Partiturdetaljer innehåller nu huvudtonart, markeringsdatum och organisation.
• Flat for Education. Inbjudningar kan återanvändas flera gånger; inlämningar får en bedömd status samt uppgifter om uppspelning och LTI; en uppgift kan kopieras till resursbiblioteket endast om den inte redan finns där; organisationer får egna resursbibliotek med en integritetsnivå för hela organisationen.

Läs av strukturen i den inlästa notbilden från din kod.

• Stämmor och röster: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Noter: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Den nya URL-parametern noAudio inaktiverar ljuduppspelning
• Åtgärdade att setMasterVolume anropade fel underliggande metod

• Stöd för jQuery i konstruktorn har tagits bort — skicka i stället ett DOM-element eller dess id
• Den publicerade npm-modulen innehåller TypeScript-typer
• Separata ES- och UMD-byggen

• Skapa LTI-länkar från objekt i Flat for Educations resursbibliotek för att lägga dem direkt i en LMS-kurs.
• Maxbetyget för en uppgift höjs från 100 till 10,000 poäng.
• Notmetadata (undertitel, kompositör, textförfattare, arrangör, beskrivning, licens osv.) kan nu rensas via API:et, inte bara anges.

• Resource Library API (beta). Bläddra i och hantera resursbibliotek i Flat for Education med två nya OAuth2-scope för fullständig åtkomst och skrivskyddad åtkomst. Uppgifter kan kopieras till resursbiblioteket.
• Testelevkonton. Skapa elevkonton för test i en klass för att prova uppgifter så som en elev skulle göra.
• Uppgifter anger vad du kan göra med dem (redigera, publicera, arkivera …), om deras bilagor är dedikerade kopior och eventuella problem som uppstått. Inlämningshistoriken registrerar källan till en ändring när den kommer från Google Classroom, Microsoft Teams eller ett LMS.
• När du återställer en inlämning ligger den kvar i stället för att tas bort; klassmetadata (nivå, färdigheter, storlek) och information om Microsoft-inloggning på konton exponeras.
• Notrevisioner returnerar sina start- och slutdatum; notbyggare kan aktivera kvartstoner; kopior kan behålla originaltiteln.

• Takter: getNbMeasures, getMeasuresUuids
• Navigering: goLeft, goRight, scrollToCursor
• Metronom: getMetronomeMode, setMetronomeMode
• Uppspelningshastighet: getPlaybackSpeed, setPlaybackSpeed

• Inloggningslänkar och delegerade åtkomsttoken. Administratörer i Flat for Education kan skapa en inloggningslänk för vilken användare som helst i sin organisation, eller en åtkomsttoken som agerar för den användarens räkning: grunden för anpassade portaler och integrationer med enkel inloggning.
• Japanska i hiragana (ja-HIRA) läggs till bland de språkversioner som stöds; offentliga kommentarer visar nu sin modereringsstatus.
• Vid ljudexport returneras MP3-uppsättningen som standardspår när en sådan finns. Möjligheten att begära endast cachade exporter har tagits bort, eftersom ljudexporter nu alltid levereras från cache.

• Partiturbyggare. Skapa ett tomt partitur utan att importera en MusicXML-fil: ange en lista med instrument och, om du vill, taktart, tonart, tabulatur, ackorddiagram och sidlayout.
• Flat for Education. Organisationsanvändare kan skapas med en roll; arbetsblad kan blanda ordningen på sina övningar; elevinlämningar listar vilka övningar de innehåller.

• Uppspelningsspår. Lista spåren som Flat genererar och synkar automatiskt (uppspelning som MP3), hämta synkroniseringspunkterna för den senaste uppspelningsfilen och få CDN-URL:en för en export i svarstexten.
• Flat for Education. Lärare kan återställa en elevs inlämning; klasser rapporterar de konton som inte kunde läggas till under en synkronisering; uppgifter och inlämningar visar sitt Microsoft Teams-status och sina länkar; kopior av uppgifter kan schemaläggas; prestationsinlämningar innehåller sitt sparade ljudspår.
• Profiler har nu en omslagsbild, och den aktuella användarens id kan hämtas separat.

• loadFlatScore stöder sharingKey, så att en privat delad notskrift kan läsas in
• setTrack, useTrack och seekTrackTo har lagts till för att ställa in ljudspåret dynamiskt

• Betygsexport. Ladda ner en uppgifts betyg som en CSV- eller Excel-fil.
• Uppgifter har en typ och en omslagsbild; när du kopierar en uppgift kan du skriva över ett befintligt utkast med innehållet från en annan uppgift.
• För medarbetare visas om de fortfarande har en väntande inbjudan.

• Betygsättning via API:t. Ange preliminära och slutliga betyg, returnera en inlämning till en elev och läs beräknade kommentarsräknare; maxpoängen lagras tillsammans med betyget.
• Inlämningskommentarer. Skapa, lista, uppdatera och ta bort kommentarer på en inlämning.
• Uppgiftsalternativ. Verktygsuppsättningar, en uppspelningsgräns, maxpoäng, ämnen i Google Classroom, tilldelning till specifika elever, låsta mallar samt information om LTI-, Canvas- och MusicFirst-uppgifter.
• Administratörer kan redigera användarnamn, namn och e-postadress för ett hanterat konto; användarlistor kan filtreras efter aktiv licens.
• De gamla inlämningsparametrarna studentComment och returnFeedback har tagits bort till förmån för de nya anropen för betygsättning.

• Arkivera och återställ uppgifter, och läs en uppgifts huvudsakliga typ (ny notskrift, mall eller delat skrivande).
• Organisationsanvändare. Skapa konton med för- och efternamn, sortera och filtrera användarlistor, räkna användarna som matchar ett filter och filtrera gruppmedlemmar efter deras synkkälla (Google Classroom, Microsoft Teams, Clever).
• Information om en notskrift listar de ljudsamplingar som används vid uppspelning, med en normaliserad instrumentlista som inte längre beror på samplingarna.

Styr mixen från din kod och läs av vad som finns under markören.

• Volym och ljud av: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo och reverb: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Inspektion: getMeasureDetails, getNoteDetails
• Nya händelser: noteDetails, measureDetails, cursorContext

• Specifikationen går över till OpenAPI 3.0. Tidigare versioner beskrevs i OpenAPI 2 (Swagger).
• Partitur visar nu arrangör och statistik över uppspelningar; en radering kan schemaläggas att köras inom kort i stället för att ligga kvar i papperskorgen.
• Flat for Education. Bilagor till uppgifter kan vara filer från Google Drive, klasser innehåller sina uppgifter för Microsoft Teams och utbildningskonton visar för- och efternamn.

• Metadataändringar når redigeraren direkt. När du uppdaterar en nots titel, undertitel, kompositör, textförfattare eller licenstext via API:t skickas ändringarna till öppna redigerare i realtid och en ny version sparas. Beskrivningar kan nu vara dubbelt så långa (2,000 characters).
• Inlämningar i Flat for Education visar nu sin status (skapad, inlämnad, återlämnad); revisionsmetadata returnerar den senaste ändringshändelsen.
• Turkiska läggs till bland de språk som stöds; offentliga profiler anger om ett konto tillhör Flat-teamet.

• getMIDI har lagts till
• getMusicXML returnerar nu en Uint8Array på toppnivån — svaret innehåller inte längre någon .data-egenskap
• Markörens voiceIdx heter nu voiceIdxInStaff

Uppdaterat för embed-versionen.

• SDK:n laddas nu från flat-embed.com som standard
• Den föråldrade åtgärden edit och händelsen edit har tagits bort
• setNoteColor har tagits bort

• Fler importformat. Filer från Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar och MuseScore kan importeras, och vid import kan ett filnamn anges.
• Samlingar kan listas under en överordnad samling och visar sitt skapandedatum; notblad listar de samlingar de tillhör.
• Kontextuella kommentarer förankras till en notrad med identifierare i stället för index, och resursrättigheter anger om anroparen är en medarbetare.

• Collections API. Skapa, lista, uppdatera, radera och återställ samlingar, lista deras partitur samt lägg till eller ta bort partitur, med tre nya OAuth2-scope för skrivskyddad åtkomst, endast tillägg och full åtkomst.
• Partitur kan återställas från papperskorgen; om du raderar ett partitur utan administratörsrättigheter tas det i stället bort från delningen till ditt konto; en kopia kan riktas till en viss samling.
• Kommentarer kan filtreras efter typ (dokument eller infogade).
• Export av stämmor använder nu stäm-ID:n i stället för index, och från september 2019 returnerar listningen av en användares partitur endast publika partitur.

• Hantering av organisationskonton. Administratörer kan uppdatera hanterade konton och ta bort dem eller konvertera dem till vanliga konsumentkonton; listor över användare och inbjudningar använder cursor-baserad paginering.
• Klasser får en inaktiv status som kan aktiveras igen, och rapporterar sin Canvas LMS-domän och Clever-sektion; uppgifter får en utkaststatus och en bilagetyp för övningar.
• Profiler visar ett tema och vilka instrument som spelas.

• Metoden focusScore har lagts till för att ge inbäddningen tangentbordsfokus
• Ny egenskap defaultMode i redigerarens konfiguration

• De första API:erna för utbildning är nu offentliga. Hantera klasser, uppgifter och inlämningar, organisationskonton och inbjudningar, LTI-uppgifter samt en organisations grupper och användare: allt som en skolintegration behöver.
• Begränsad åtkomst. Nya OAuth2-scope omfattar klasser, uppgifter och organisationsadministration, alla med en skrivskyddad variant, så att en integration bara begär den åtkomst den behöver.

Din kod kan nu kontrollera hur inbäddningen är konfigurerad och göra om den till en redigerare.

• Metoder tillagda: getEmbedConfig, setEditorConfig, edit
• Händelse tillagd: edit

SDK:et kan nu läsa in partitur från MusicXML och rapportera vad läsaren gör.

• Metoder har lagts till: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Händelser har lagts till: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Integrationstester har lagts till

Den första publika versionen av Flats REST API. Läs och hantera ditt konto, noter, användare och grupper från dina egna appar och skript, med OAuth2 för att agera på andra Flat-användares vägnar.

Allt sedan dess finns dokumenterat i API-ändringsloggen, och utvecklardokumentationen täcker autentisering, referensen och guider.