Developer changelog

Utviklerdashboardet er bygget på nytt rundt det integrasjonen din kan gjøre. Hver funksjon (Embed, OMR, REST API, Import API, LTI) får et kort med omfang, priser og dokumentasjon, og de som appen din allerede bruker, vises først.

• En ny OMR-seksjon på kontonivå, med jobbene dine, kredittene dine og historikken deres samlet på ett sted, siden OMR-kreditter deles av alle appene dine.
• Prøv OMR før du skriver kode. Playground godtar en PDF eller bilder, viser antall sider, kostnaden per side og hvor mange kreditter du ville hatt igjen, og kjører deretter jobben når du bekrefter. Resultatet lastes ned som MusicXML-filer, og ingenting havner i biblioteket ditt.
• Tydeligere appsider. Personlige token, OAuth2-legitimasjon og OMR-tilgang er gruppert per applikasjon, og legitimasjonen som har OMR-omfanget, er tydelig merket.

Åpne det fra flat.io/developers.

Vår REST API-spesifikasjon går over til OpenAPI 3.1, OMR API avslutter betaperioden, og oppgaver i Flat for Education åpnes opp for mer enn bare listing og oppretting.

• OMR API er stabilt. Endepunkter, felt og oppførsel følger nå vår vanlige avviklingsprosess før eventuelle inkompatible endringer. En ny FAQ dekker kreditter og fakturering, grenser og behandlingstider, gjenkjenningskvalitet og språk, samt kommersiell bruk og personvern.
• Les, oppdater og slett oppgaver i Flat for Education. Hvis du sletter en oppgave, fjernes også innleveringene og elevenes kopier; arkiver den i stedet hvis du vil beholde arbeidet.
• Kredittoversikt. Et nytt kall viser kreditthistorikken din; saldoen forblir i kallet for OMR-funksjoner.
• Finale-filer (.musx) kan importeres, etter beste evne, og import av skannet musikk (PDF og bilder) er dokumentert ved opprettelse av partitur.
• OpenAPI 3.1. Nullable-felt bruker 3.1-syntaksen; verktøy som er låst til OpenAPI 3.0 må oppdateres. Feltet mimeType er fjernet fra OMR-filopplastinger.

• Databevaring du styrer selv. OMR-jobber oppgir nå hvor lenge filene deres blir lagret (30 dager som standard), hver MusicXML-jobb har med utløpsdatoen sin, og du kan slette filene og resultatene til en jobb så snart du har hentet dem.
• Funksjonsdeteksjon før innlogging. Kallet for OMR-funksjoner fungerer uten konto og lister opp de støttede gjenkjenningsspråkene med navnene deres.
• Eksport av ABC-notasjon for enhver revisjon av et partitur, sammen med MusicXML, MIDI og de andre formatene. Som MIDI inneholder det ikke hele notasjonsutformingen.
• Free Record-oppgaver kan konfigureres gjennom API-et i Flat for Education.
• Feil som kommer fra en oppstrømsleverandør (for eksempel Google Classroom), har nå leverandørens egen lokaliserte melding.

Flat sin OMR-motor er nå tilgjengelig programmatisk gjennom utvikler-API-et. Send PDF-filer eller bilder, følg gjenkjenningsfremdriften, gjennomgå de oppdagede instrumentene, og importer deretter resultatet som et redigerbart partitur i et Flat-bibliotek eller eksporter MusicXML eller MIDI. Det er den samme interne modellen som brukes til import av PDF-filer og bilder i editoren, nå tilgjengelig i stor skala for dine egne apper og arbeidsflyter.

Det dedikerte OMR-API-et (v2.24.0) bygger videre på bakgrunnsimport av PDF-filer som ble lagt til ved opprettelse av partiturer i v2.23.0: be om task-støtte når du importerer en fil, og poll task-en til partituret er klart. Se API-endringsloggen for detaljer om begge utgivelsene.

Den største spesifikasjonsoppdateringen siden 2024, som bringer API-et på linje med to år med produktendringer.

• Import fra 15+ formater. Guitar Pro, MuseScore, ABC-notasjon, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer og Encore slutter seg til MusicXML og MIDI, og partiturer kan eksporteres som innebygde .flat-filer.
• Virtuelle samlinger. Alle partiturer, samarbeid og likerklikk erstatter det gamle mappehierarkiet i biblioteket, i tråd med det redesignede Flat-biblioteket.
• Flat for Education. Fremføringsoppgaver med lyd- eller videoopptak og alternativer for akkompagnementsspor, metronom og hastighet; gruppeinnleveringer for felles skriving; instruksjoner med rik tekst; undergrupper av elever; planlagte og individuelt målrettede Microsoft Teams-oppgaver; utfyllende beskrivelser og oppgavetyper i ressursbiblioteket.
• Samlet LTI-konfigurasjon for LTI 1.1 og 1.3, inkludert dynamisk registrering. De tidligere legitimasjonskallene for LTI 1.1 er avviklet.
• Årlig statistikk for partiturer, antall offentlige partiturer på profiler og fjerning av noen få felt som har vært avviklet lenge.

• La til metodene getMP3 og getWAV for lydeksport
• La til hendelsen exportProgress, slik at en lang eksport kan vise fremdrift

• Brukerens notelister er offentlige profiler. Når du nå henter en brukers noter, returneres bare de offentlige notene deres, med ny paginering og sortering, endringen som ble annonsert i 2020.
• Notedetaljer viser redigerings-URL-en, instrumentnavn og eventuell planlagt slette­dato; samlinger oppgir antall noter; offentlige profiler viser antall likerklikk og avspillinger.
• Flat for Education. Filtrer ressursbiblioteket etter oppgavetype, fag og klassetrinn; ressurser har en delingsbeskrivelse og personvernmuligheter; oppgaver kan begrense noteavspilling og lydspor; innleveringer støtter LTI 1.1- og 1.3-karaktertjenester.

• Paginerte likerklikk på brukerprofiler, og hvilket produkt en bruker har i kontodetaljene sine.
• Rettigheter for ressurser angir om den som kaller API-et er eieren, en brukersamarbeidspartner eller en gruppesamarbeidspartner, samt datoen da hver samarbeidspartner ble lagt til. Detaljer for partiturer legger til hovedtoneart, dato for fremheving og organisasjon.
• Flat for Education. Invitasjoner kan gjenbrukes flere ganger; innleveringer får en vurdert status samt detaljer om avspilling og LTI; en oppgave kan kopieres til ressursbiblioteket bare hvis den ikke allerede er der; organisasjoner får sine egne ressursbiblioteker med et personvernnivå for hele organisasjonen.

Les strukturen til det innlastede partituret fra koden din.

• Stemmer og voices: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Noter: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Den nye URL-parameteren noAudio deaktiverer lydavspilling
• Rettet en feil der setMasterVolume kalte feil underliggende metode

• Støtte for jQuery i konstruktøren er fjernet — send inn et DOM-element eller elementets id i stedet
• Den publiserte npm-modulen leveres med TypeScript-typer
• Separate ES- og UMD-bygg

• Opprett LTI-lenker fra elementer i ressursbiblioteket i Flat for Education, slik at du kan legge dem direkte inn i et LMS-kurs.
• Maksimal karakter på en oppgave økes fra 100 til 10 000 poeng.
• Partiturmetadata (undertittel, komponist, tekstforfatter, arrangør, beskrivelse, lisens …) kan nå også nullstilles via API-et, ikke bare settes.

• Resource Library API (beta). Bla gjennom og administrer ressursbiblioteker i Flat for Education, med to nye OAuth2-områder for full tilgang og skrivebeskyttet tilgang. Oppgaver kan kopieres til ressursbiblioteket.
• Testelever. Opprett test-elevkontoer i en klasse for å prøve oppgaver slik en elev ville gjort.
• Oppgaver oppgir hva du kan gjøre med dem (redigere, publisere, arkivere …), om vedleggene deres er dedikerte kopier, og eventuelle problemer som har oppstått. Innleveringshistorikken registrerer kilden til en endring når den kommer fra Google Classroom, Microsoft Teams eller en LMS.
• Når du tilbakestiller en innlevering, beholdes den i stedet for å slettes; klassemetadata (nivå, ferdigheter, størrelse) og detaljer om Microsoft-pålogging på kontoer er tilgjengelige.
• Partiturrevisjoner returnerer start- og sluttdatoene sine; partiturbyggere kan aktivere kvarttoner; kopier kan beholde den opprinnelige tittelen.

• Takter: getNbMeasures, getMeasuresUuids
• Navigasjon: goLeft, goRight, scrollToCursor
• Metronom: getMetronomeMode, setMetronomeMode
• Avspillingshastighet: getPlaybackSpeed, setPlaybackSpeed

• Påloggingslenker og delegerte tilgangstoken. Administratorer i Flat for Education kan opprette en påloggingslenke for en hvilken som helst bruker i organisasjonen sin, eller et tilgangstoken som handler på vegne av den brukeren: grunnlaget for egendefinerte portaler og integrasjoner med enkel pålogging.
• Japansk i hiragana (ja-HIRA) er nå blant de støttede språkvariantene; offentlige kommentarer viser modereringsstatusen sin.
• Lydeksporter returnerer MP3-settet som standardspor når det finnes. Muligheten til å be om bare mellomlagrede eksporter er fjernet, siden lydeksporter nå alltid leveres fra hurtigbufferen.

• Partiturbygger. Opprett et tomt partitur uten å importere en MusicXML-fil: oppgi en liste med instrumenter og eventuelt taktart, toneart, tablatur, grepdiagrammer og sideoppsett.
• Flat for Education. Organisasjonsbrukere kan opprettes med en rolle; arbeidsark kan blande rekkefølgen på oppgavene sine; elevinnleveringer viser hvilke oppgaver de inneholder.

• Avspillingsspor. List opp sporene Flat genererer og synkroniserer automatisk (avspilling som MP3), hent synkroniseringspunktene for den nyeste avspillingsfilen, og få CDN-URL-en til en eksport i svarteksten.
• Flat for Education. Lærere kan tilbakestille en elevinnlevering; klasser rapporterer kontoene som ikke kunne legges til under en synkronisering; oppgaver og innleveringer viser Microsoft Teams-status og -lenker; oppgavekopier kan planlegges; fremføringsinnleveringer inkluderer det lagrede lydsporet sitt.
• Profiler får et omslagsbilde, og id-en til gjeldende bruker kan hentes separat.

• loadFlatScore godtar en sharingKey, slik at en privat delt partitur kan lastes inn
• La til setTrack, useTrack og seekTrackTo for å angi lydsporet dynamisk

• Karaktereksport. Last ned karakterene for en oppgave som en CSV- eller Excel-fil.
• Oppgaver har nå en type og et omslagsbilde; når du kopierer en oppgave, kan du overskrive et eksisterende utkast med innholdet fra en annen oppgave.
• Samarbeidspartnere viser om de fortsatt er en ventende invitasjon.

• Vurdering via API-et. Angi utkastkarakterer og endelige karakterer, returner en innlevering til en elev, og les beregnede kommentartellere; maks poengsum lagres sammen med karakteren.
• Innleveringskommentarer. Opprett, list opp, oppdater og slett kommentarer på en innlevering.
• Oppgavealternativer. Verktøysett, en grense for avspilling, maks poengsum, emner i Google Classroom, tildeling til bestemte elever, låste maler og detaljer for LTI-, Canvas- og MusicFirst-oppgaver.
• Administratorer kan redigere brukernavn, navn og e-post for en administrert konto; brukeroppføringer kan filtreres etter aktiv lisens.
• De gamle innleveringsparametrene studentComment og returnFeedback ble fjernet til fordel for de nye vurderingskallene.

• Arkiver og gjenopprett oppgaver, og les hovedtypen til en oppgave (nytt partitur, mal eller delt skriving).
• Organisasjonsbrukere. Opprett kontoer med fornavn og etternavn, sorter og filtrer brukeroversikter, tell brukerne som samsvarer med et filter, og filtrer gruppemedlemmer etter synkroniseringskilden deres (Google Classroom, Microsoft Teams, Clever).
• Detaljer for partiturer viser lydsamplene som brukes ved avspilling, med en normalisert instrumentliste som ikke lenger er avhengig av samplene.

Styr miksen fra koden din, og les hva som ligger under markøren.

• Volum og demping: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo og romklang: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Inspeksjon: getMeasureDetails, getNoteDetails
• Nye hendelser: noteDetails, measureDetails, cursorContext

• Spesifikasjonen går over til OpenAPI 3.0. Tidligere versjoner var beskrevet i OpenAPI 2 (Swagger).
• Partiturer viser arrangør og statistikk for avspillinger; sletting kan planlegges til å kjøres om kort tid i stedet for å bli liggende i papirkurven.
• Flat for Education. Vedlegg til oppgaver kan være Google Drive-filer, klasser inkluderer informasjon om Microsoft Teams, og utdanningskontoer viser fornavn og etternavn.

• Endringer i metadata vises direkte i editoren. Når du oppdaterer et verks tittel, undertittel, komponist, tekstforfatter eller lisenstekst via API-et, sendes endringen til åpne editorer i sanntid, og en ny versjon lagres. Beskrivelser kan være dobbelt så lange (2,000 tegn).
• Innleveringer i Education viser statusen sin (opprettet, levert inn, returnert); metadata for revisjoner returnerer den siste endringshendelsen.
• Tyrkisk er nå blant de støttede språkene; offentlige profiler viser om en konto tilhører Flat-teamet.

• La til getMIDI
• getMusicXML returnerer nå en Uint8Array på øverste nivå — svaret har ikke lenger en .data-egenskap
• Markørens voiceIdx heter nå voiceIdxInStaff

Oppdatert for embed-utgivelsen.

• SDK-en lastes nå som standard fra flat-embed.com
• Den utdaterte handlingen edit og hendelsen edit er fjernet
• setNoteColor er fjernet

• Flere importformater. Guitar Pro- (GP3, GP4, GP5, GPX, GP), PowerTab-, TuxGuitar- og MuseScore-filer kan importeres, og importer godtar et filnavn.
• Samlinger kan listes under en overordnet samling og oppgi opprettelsesdatoen; partiturer viser hvilke samlinger de tilhører.
• Kontekstuelle kommentarer forankres til en нотelinje ved hjelp av identifikator i stedet for indeks, og ressursrettigheter angir om den som kaller er en samarbeidspartner.

• Collections API. Opprett, list opp, oppdater, slett og gjenopprett samlinger, list opp partiturene deres, og legg til eller fjern partiturer, med tre nye OAuth2-scope for skrivebeskyttet tilgang, kun tilleggstilgang og full tilgang.
• Partiturer kan gjenopprettes fra papirkurven; å slette et partitur uten administratorrettigheter fjerner i stedet delingen fra kontoen din; en kopi kan målrettes mot en bestemt samling.
• Kommentarer kan filtreres etter type (dokument eller inline).
• Eksport av stemmer bruker nå stemmeidentifikatorer i stedet for indekser, og fra september 2019 returnerer en brukers partiturliste bare offentlige partiturer.

• Administrasjon av organisasjonskontoer. Administratorer kan oppdatere administrerte kontoer, slette dem eller gjøre dem om til forbrukerkontoer; lister over brukere og invitasjoner bruker markørbasert paginering.
• Klasser får en inaktiv status som kan aktiveres på nytt, og rapporterer Canvas LMS-domene og Clever-seksjon; oppgaver får en kladdstatus og en vedleggstype for øvelser.
• Profiler eksponerer et tema og instrumentene som spilles.

• La til metoden focusScore for å gi innbyggingen tastaturfokus
• Ny egenskap defaultMode i redaktørkonfigurasjonen

• De første Education-API-ene er offentlige. Administrer klasser, oppgaver og innleveringer, organisasjonskontoer og invitasjoner, LTI-legitimasjon samt grupper og brukere i en organisasjon: alt en skoleintegrasjon trenger.
• Avgrenset tilgang. Nye OAuth2-scope dekker klasser, oppgaver og organisasjonsadministrasjon, hver med en skrivebeskyttet variant, slik at en integrasjon bare ber om det den trenger.

Koden din kan nå kontrollere hvordan innebyggingen er konfigurert og gjøre den om til et redigeringsprogram.

• Lagt til metoder: getEmbedConfig, setEditorConfig, edit
• Lagt til hendelse: edit

SDK-en lærer å laste partiturer fra MusicXML og å rapportere hva leseren gjør.

• La til metoder: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• La til hendelser: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• La til integrasjonstester

Den første offentlige utgivelsen av Flat sin REST API. Les og administrer kontoen, partiturene, brukerne og gruppene dine fra dine egne apper og skript, med OAuth2 for å handle på vegne av andre Flat-brukere.

Alt siden den gang er dokumentert i API-endringsloggen, og utviklerdokumentasjonen dekker autentisering, referansen og veiledninger.