Developer changelog

Udviklerdashboardet er bygget op omkring, hvad din integration kan. Hver funktion (Embed, OMR, REST API, Import API, LTI) har et kort med omfang, priser og dokumentation, og de funktioner, som din app allerede bruger, vises først.

• Et nyt OMR-afsnit på kontoniveau, med dine job, dine credits og deres historik samlet ét sted, fordi OMR-credits deles af alle dine apps.
• Prøv OMR, før du skriver kode. Playgrounden tager en PDF eller fotos, viser antal sider, prisen pr. side og den saldo, du ville have tilbage, og kører derefter jobbet, når du bekræfter. Output går til MusicXML-downloads; intet havner i dit bibliotek.
• Mere overskuelige app-sider. Personlige tokens, OAuth2-legitimationsoplysninger og OMR-adgang er grupperet pr. applikation, og de legitimationsoplysninger, der har OMR-omfanget, er tydeligt markeret.

Åbn det fra flat.io/developers.

Vores REST API-specifikation går over til OpenAPI 3.1, OMR API’et afslutter sin betaperiode, og opgaver i Flat for Education åbnes nu for mere end blot visning og oprettelse.

• OMR API’et er stabilt. Endpoints, felter og adfærd følger nu vores normale udfasningsproces før enhver inkompatibel ændring. En ny FAQ dækker credits og fakturering, begrænsninger og behandlingstider, genkendelseskvalitet og sprog samt kommerciel brug og privatliv.
• Læs, opdatér og slet opgaver i Flat for Education. Hvis du sletter en opgave, fjernes også dens afleveringer og elevernes kopier; arkivér den i stedet for at bevare arbejdet.
• Credit ledger. Et nyt kald viser din credit-historik; saldoen forbliver på kaldet for OMR capabilities.
• Finale-filer (.musx) kan importeres efter bedste evne, og import af scannet musik (PDF og billeder) er dokumenteret ved oprettelse af partiturer.
• OpenAPI 3.1. Nullable felter bruger 3.1-syntaksen; værktøjer, der er låst til OpenAPI 3.0, skal opdateres. Feltet mimeType er blevet fjernet fra OMR-filuploads.

• Databevaring, som du styrer. OMR-job oplyser nu, hvor længe deres filer gemmes (30 dage som standard), hvert MusicXML-job har sin udløbsdato, og du kan slette et jobs filer og resultater, så snart du har hentet dem.
• Registrering af funktioner før login. Kaldet til OMR-funktioner virker nu uden en konto og viser de understøttede genkendelsessprog med deres navne.
• ABC-notations-eksport for enhver score-revision, sammen med MusicXML, MIDI og de andre formater. Ligesom MIDI indeholder den ikke den fulde gravering.
• Free Record-opgaver kan konfigureres via API'et i Flat for Education.
• Fejl fra en upstream-udbyder (f.eks. Google Classroom) indeholder nu udbyderens egen lokaliserede meddelelse.

Flats OMR-motor er nu tilgængelig programmatisk via udvikler-API'et. Send PDF-filer eller fotos, følg genkendelsesforløbet, gennemgå de registrerede instrumenter, og importér derefter resultatet som et redigerbart partitur i et Flat-bibliotek eller eksportér MusicXML eller MIDI. Det er den samme interne model, der driver import af PDF'er og fotos i editoren, og den er nu tilgængelig i stor skala til dine egne apps og arbejdsgange.

Det dedikerede OMR-API (v2.24.0) bygger videre på den baggrundsimport af PDF'er, der blev tilføjet til oprettelse af partiturer i v2.23.0: bed om opgavestøtte, når du importerer en fil, og forespørg opgaven, indtil partituret er klar. Se API-ændringsloggen for detaljer om begge versioner.

Den største specifikationsopdatering siden 2024, som bringer API'et på højde med to års produktændringer.

• Import fra 15+ formater. Guitar Pro, MuseScore, ABC-notation, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer og Encore slutter sig til MusicXML og MIDI, og partiturer kan eksporteres som oprindelige .flat-filer.
• Virtuelle samlinger. Alle partiturer, samarbejder og likes erstatter den tidligere mappehierarki i biblioteket, så det matcher det nydesignede Flat-bibliotek.
• Flat for Education. Performance-opgaver med lyd- eller videooptagelser og backingtrack-, metronom- og hastighedsindstillinger; gruppeafleveringer til fælles skrivning; instruktioner med rich text; undergrupper af elever; planlagte og individuelt målrettede Microsoft Teams-opgaver; fyldige beskrivelser og opgavetyper i ressourcebiblioteket.
• Samlet LTI-konfiguration for LTI 1.1 og 1.3, herunder dynamisk registrering. De tidligere legitimationskald for LTI 1.1 er forældede.
• Årlige statistikker over partiturer, antal offentlige partiturer på profiler og fjernelse af nogle få felter, der længe har været forældede.

• Tilføjet metoderne getMP3 og getWAV til lydeksport
• Tilføjet hændelsen exportProgress, så en lang eksport kan vise status

• Brugeres score-lister er offentlige profiler. Når man nu henter en brugers scores, returneres kun deres offentlige scores med ny paginering og sortering, som ændringen annonceret i 2020.
• Score-detaljer viser URL'en til redigering, instrumentnavne og en eventuel planlagt sletningsdato; samlinger angiver antallet af scores; offentlige profiler viser antal likes og afspilninger.
• Flat for Education. Filtrer ressourcebiblioteket efter opgavetype, fag og klassetrin; ressourcer har en beskrivelse af deling og muligheder for privatliv; opgaver kan begrænse nodeafspilning og lydspor; afleveringer understøtter LTI 1.1- og 1.3-karaktertjenester.

• Sideopdelte likes på brugerprofiler samt hvilket produkt en bruger har i sine kontooplysninger.
• Ressourcerettigheder angiver, om den kaldende part er ejeren, en brugersamarbejdspartner eller en gruppesamarbejdspartner, samt datoen, hvor hver samarbejdspartner blev tilføjet. Scoreoplysninger tilføjer hovedtoneart, markeringsdato og organisation.
• Flat for Education. Invitationer kan genbruges flere gange; afleveringer får en bedømt status samt detaljer om afspilning og LTI; en opgave kan kun kopieres til ressourcebiblioteket, hvis den ikke allerede findes der; organisationer får deres egne ressourcebiblioteker med et privatlivsniveau for hele organisationen.

Læs strukturen i det indlæste partitur fra din kode.

• Stemmer og voices: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Noder: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Den nye URL-parameter noAudio deaktiverer lydafspilning
• Rettede setMasterVolume, som kaldte den forkerte underliggende metode

• Understøttelse af jQuery i konstruktøren er fjernet — angiv i stedet et DOM-element eller dets id
• Det publicerede npm-modul leveres med TypeScript-typer
• Separate ES- og UMD-builds

• Opret LTI-links fra elementer i Flat for Education-ressourcebiblioteket, så du kan placere dem direkte i et LMS-kursus.
• Den maksimale karakter på en opgave går fra 100 til 10.000 point.
• Partitursmetadata (undertitel, komponist, tekstforfatter, arrangør, beskrivelse, licens …) kan nu også ryddes via API'et, ikke kun angives.

• Resource Library API (beta). Gennemse og administrer ressourcebiblioteker i Flat for Education med to nye OAuth2-scopes til fuld adgang og skrivebeskyttet adgang. Opgaver kan kopieres til ressourcebiblioteket.
• Teste elever. Opret test-elevkonti i en klasse for at prøve opgaver, som en elev ville gøre.
• Opgaver angiver, hvad du kan gøre med dem (redigere, udgive, arkivere …), om deres vedhæftninger er dedikerede kopier, og eventuelle problemer. Indsendelseshistorikken registrerer kilden til en ændring, når den kommer fra Google Classroom, Microsoft Teams eller et LMS.
• Nulstilling af en indsendelse lader den blive stående i stedet for at slette den; klassemetadata (niveau, færdigheder, størrelse) og Microsoft-logindetaljer på konti vises.
• Partiturrevisioner returnerer deres start- og slutdatoer; partiturbyggere kan aktivere kvarttoner; kopier kan beholde den oprindelige titel.

• Takter: getNbMeasures, getMeasuresUuids
• Navigation: goLeft, goRight, scrollToCursor
• Metronom: getMetronomeMode, setMetronomeMode
• Afspilningshastighed: getPlaybackSpeed, setPlaybackSpeed

• Loginlinks og delegerede adgangstokens. Administratorer i Flat for Education kan oprette et loginlink til enhver bruger i deres organisation eller et adgangstoken, der handler på brugerens vegne: grundlaget for tilpassede portaler og integrationer med single sign-on.
• Japansk i hiragana (ja-HIRA) føjes til de understøttede sprog; offentlige kommentarer viser deres moderationsstatus.
• Lydeksporter returnerer MP3-sættet som standardspor, når det findes. Muligheden for kun at anmode om cachelagte eksporter er fjernet, da lydeksporter nu altid leveres fra cachen.

• Partiturgenerator. Opret et tomt partitur uden at importere en MusicXML-fil: angiv en liste over instrumenter og eventuelt taktart, toneart, tablatur, akkorddiagrammer og sidelayout.
• Flat for Education. Organisationsbrugere kan oprettes med en rolle; arbejdsark kan blande deres øvelser; elevers afleveringer viser de øvelser, de indeholder.

• Afspilningsspor. Vis de spor, som Flat genererer og synkroniserer automatisk (afspilning som MP3), hent synkroniseringspunkterne for den nyeste afspilningsfil, og få CDN-URL'en for en eksport i svarteksten.
• Flat for Education. Lærere kan nulstille en elevs aflevering; klasser viser de konti, der ikke kunne tilføjes under en synkronisering; opgaver og afleveringer viser deres Microsoft Teams-status og -links; opgavekopier kan planlægges; performance-afleveringer medtager deres gemte lydspor.
• Profiler får et coverbillede, og den aktuelle brugers id kan hentes separat.

• loadFlatScore accepterer en sharingKey, så en privat delt partitur kan indlæses
• Tilføjet setTrack, useTrack og seekTrackTo for at indstille lydsporet dynamisk

• Eksport af karakterer. Download en opgaves karakterer som en CSV- eller Excel-fil.
• Opgaver har nu en type og et forsidebillede; når du kopierer en opgave, kan du overskrive et eksisterende udkast med indholdet fra en anden opgave.
• Samarbejdspartnere viser, om de stadig afventer en invitation.

• Bedømmelse via API'et. Angiv foreløbige og endelige karakterer, returner en aflevering til en elev, og læs beregnede kommentartællere; det maksimale antal point gemmes sammen med karakteren.
• Afleveringskommentarer. Opret, vis, opdater og slet kommentarer til en aflevering.
• Opgaveindstillinger. Værktøjssæt, en afspilningsgrænse, maksimalt antal point, emner i Google Classroom, tildeling til bestemte elever, låste skabeloner samt detaljer om LTI-, Canvas- og MusicFirst-opgaver.
• Administratorer kan redigere brugernavn, navn og e-mail for en administreret konto; brugerlister kan filtreres efter aktiv licens.
• De gamle parametre for afleveringer, studentComment og returnFeedback, er blevet fjernet til fordel for de nye bedømmelseskald.

• Arkivér og fjern arkivering af opgaver, og læs en opgaves primære type (nyt partitur, skabelon eller delt skrivning).
• Organisationsbrugere. Opret konti med fornavn og efternavn, sortér og filtrér brugerlister, tæl de brugere, der matcher et filter, og filtrér gruppemedlemmer efter deres synkroniseringskilde (Google Classroom, Microsoft Teams, Clever).
• Partiturdetaljer viser de lydsamples, der bruges til afspilning, med en normaliseret instrumentliste, som ikke længere afhænger af samples.

Styr mixet fra din kode, og læs, hvad der ligger under markøren.

• Lydstyrke og mute: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo og rumklang: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Inspektion: getMeasureDetails, getNoteDetails
• Tilføjede events: noteDetails, measureDetails, cursorContext

• Specifikationen skifter til OpenAPI 3.0. Tidligere versioner var beskrevet i OpenAPI 2 (Swagger).
• Partiturer viser en arrangør og statistik over afspilninger; en sletning kan planlægges til at blive udført snart i stedet for at ligge i papirkurven.
• Flat for Education. Bilag til opgaver kan være Google Drive-filer, klasser indeholder deres Microsoft Teams-oplysninger, og uddannelseskonti viser fornavn og efternavn.

• Ændringer i metadata vises nu direkte i editoren. Når du opdaterer et værks titel, undertitel, komponist, tekstforfatter eller licenstekst via API'et, sendes ændringen i realtid til åbne editorer, og en ny version gemmes. Beskrivelser kan nu være dobbelt så lange (2,000 tegn).
• Afleveringer i Education viser nu deres status (oprettet, afleveret, returneret); metadata for revisioner returnerer den seneste ændringshændelse.
• Tyrkisk er nu blandt de understøttede sprog; offentlige profiler angiver, om en konto tilhører Flat-teamet.

• Tilføjet getMIDI
• getMusicXML returnerer nu et Uint8Array på øverste niveau — svaret indeholder ikke længere en .data-egenskab
• Markørens voiceIdx hedder nu voiceIdxInStaff

Opdateret til embed-udgivelsen.

• SDK'en indlæses nu som standard fra flat-embed.com
• Den forældede edit-handling og edit-hændelse er fjernet
• setNoteColor er fjernet

• Flere importformater. Guitar Pro-filer (GP3, GP4, GP5, GPX, GP), PowerTab-, TuxGuitar- og MuseScore-filer kan importeres, og import understøtter et filnavn.
• Samlinger kan vises under en overordnet samling og angiver deres oprettelsesdato; partiturer viser de samlinger, de tilhører.
• Kontekstuelle kommentarer forankres til en nodegruppe via identifikator i stedet for via indeks, og ressource-rettigheder angiver, om den kaldende part er en samarbejdspartner.

• Collections API. Opret, vis, opdater, slet og gendan samlinger, vis deres partiturer, og tilføj eller fjern partiturer, med tre nye OAuth2-scopes til skrivebeskyttet adgang, kun tilføjelse og fuld adgang.
• Partiturer kan gendannes fra papirkurven; hvis du sletter et partitur uden administratorrettigheder, fjernes delingen fra din konto i stedet; en kopi kan målrettes en bestemt samling.
• Kommentarer kan filtreres efter type (dokument eller indlejret).
• Eksport af stemmer bruger nu stemme-id'er i stedet for indekser, og fra september 2019 returnerer en brugers partiturfortegnelse kun offentlige partiturer.

• Administration af organisationskonti. Administratorer kan opdatere administrerede konti, slette dem eller konvertere dem til forbrugerkonti; bruger- og invitationslister bruger markørbaseret paginering.
• Klasser får en inaktiv tilstand, som kan aktiveres igen, og angiver deres Canvas LMS-domæne og Clever-sektion; opgaver får en kladdetilstand og en vedhæftningstype til øvelser.
• Profiler viser et tema og de instrumenter, der spilles.

• Tilføjet metoden focusScore for at give indlejringen tastaturfokus
• Ny egenskab defaultMode i editorens konfiguration

• De første Education-API'er er offentlige. Administrer klasser, opgaver og afleveringer, organisationskonti og invitationer, LTI-legitimationsoplysninger samt en organisations grupper og brugere: alt, hvad en skoleintegration har brug for.
• Afgrænset adgang. Nye OAuth2-scopes dækker klasser, opgaver og organisationsadministration, hver med en skrivebeskyttet variant, så en integration kun anmoder om det, den har brug for.

Din kode kan nu kontrollere, hvordan embed er konfigureret, og gøre det til en editor.

• Tilføjede metoder: getEmbedConfig, setEditorConfig, edit
• Tilføjet hændelse: edit

SDK'et kan nu indlæse partiturer fra MusicXML og rapportere, hvad læseren foretager sig.

• Tilføjede metoder: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Tilføjede hændelser: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Tilføjede integrationstests

Den første offentlige udgivelse af Flats REST API. Læs og administrer din konto, partiturer, brugere og grupper fra dine egne apps og scripts, med OAuth2 til at handle på vegne af andre Flat-brugere.

Alt siden da er registreret i API-ændringsloggen, og udviklerdokumentationen dækker godkendelse, reference og vejledninger.