Developer changelog

Kehittäjän hallintapaneeli on rakennettu uudelleen sen ympärille, mitä integraatiosi voi tehdä. Jokaiselle ominaisuudelle (Embed, OMR, REST API, Import API, LTI) on oma korttinsa, jossa näkyvät sen laajuus, hinnoittelu ja dokumentaatio. Sovelluksesi jo käyttämät ominaisuudet näytetään ensin.

• Uusi OMR-osio tilitasolla, jossa työsi, krediittisi ja niiden historia ovat yhdessä paikassa, koska OMR-krediitit ovat yhteisiä kaikille sovelluksillesi.
• Kokeile OMR:ää ennen kuin kirjoitat koodia. Playground ottaa PDF:n tai valokuvia, näyttää sivumäärän, sivukohtaisen hinnan ja jäljelle jäävän saldon ja suorittaa työn, kun vahvistat sen. Tulos menee MusicXML-latauksiin, eikä mitään tallennu kirjastoosi.
• Selkeämmät sovellussivut. Henkilökohtaiset tokenit, OAuth2-tunnistetiedot ja OMR-käyttöoikeus on ryhmitelty sovelluksittain, ja tunnistetiedot, joihin kuuluu OMR-laajuus, on merkitty selvästi.

Avaa se osoitteesta flat.io/developers.

REST API -määrityksemme siirtyy OpenAPI 3.1:een, OMR API päättää betajaksonsa, ja Flat for Educationin tehtävissä voi nyt tehdä muutakin kuin listata ja luoda niitä.

• OMR API on vakaa. Päätepisteet, kentät ja toiminta noudattavat nyt tavallista poistokäytäntöämme ennen rikkomia muutoksia. Uusi FAQ käsittelee krediittejä ja laskutusta, rajoituksia ja käsittelyaikoja, tunnistuksen laatua ja kieliä sekä kaupallista käyttöä ja yksityisyyttä.
• Lue, päivitä ja poista tehtäviä Flat for Educationissa. Tehtävän poistaminen poistaa myös sen palautukset ja oppilaiden kopiot; arkistoi se sen sijaan, jos haluat säilyttää työn.
• Credit ledger. Uusi kutsu listaa krediittihistoriasi; saldo pysyy OMR capabilities -kutsussa.
• Finale-tiedostoja (.musx) voi tuoda, parhaan mahdollisen tuen puitteissa, ja skannatun nuottimateriaalin tuonti (PDF:t ja kuvat) on dokumentoitu partituurin luonnin yhteydessä.
• OpenAPI 3.1. Nullable-kentät käyttävät 3.1-syntaksia; OpenAPI 3.0:aan sidotut työkalut on päivitettävä. Kenttä mimeType poistettiin OMR-tiedostolähetyksistä.

• Hallitse tietojen säilytystä itse. OMR-työt kertovat nyt, kuinka kauan niiden tiedostoja säilytetään (oletuksena 30 päivää), jokaisella MusicXML-työllä on oma vanhenemispäivänsä, ja voit poistaa työn tiedostot ja tulokset heti, kun olet noutanut ne.
• Ominaisuuksien tunnistus ennen kirjautumista. OMR-ominaisuuskutsu toimii ilman tiliä ja listaa tuetut tunnistuskielet nimineen.
• ABC-notaation vienti mille tahansa partituurin versiolle MusicXML:n, MIDI:n ja muiden tiedostomuotojen rinnalla. MIDI:n tavoin se ei sisällä täydellistä nuottigrafiikkaa.
• Free Record -tehtävät voidaan määrittää API:n kautta Flat for Educationissa.
• Ylävirran palveluntarjoajalta (esimerkiksi Google Classroomilta) tulevat virheet sisältävät nyt palveluntarjoajan oman lokalisoidun viestin.

Flatin OMR-moottori on nyt käytettävissä ohjelmallisesti kehittäjä-API:n kautta. Lähetä PDF-tiedostoja tai valokuvia, seuraa tunnistuksen etenemistä, tarkista havaitut soittimet ja tuo sitten tulos muokattavana partituurina Flat-kirjastoon tai vie se muodossa MusicXML tai MIDI. Kyseessä on sama Flatin oma malli, joka mahdollistaa PDF- ja valokuvatuonnin editorissa, ja nyt se on saatavilla laajassa mittakaavassa omiin sovelluksiisi ja työnkulkuihisi.

Erillinen OMR-API (v2.24.0) perustuu taustalla toimivaan PDF-tuontiin, joka lisättiin partituurin luontiin versiossa v2.23.0: pyydä tehtävätukea tiedostoa tuotaessa ja kyselytä tehtävää, kunnes partituuri on valmis. Katso molempien julkaisujen tiedot API-muutoslokista.

Suurin määritys päivitys sitten vuoden 2024, joka tuo API:n ajan tasalle kahden vuoden tuotemuutosten kanssa.

• Tuo yli 15 muodosta. Guitar Pro, MuseScore, ABC-notaatio, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer ja Encore liittyvät MusicXML:n ja MIDI:n rinnalle, ja nuotit voidaan viedä alkuperäisinä .flat-tiedostoina.
• Virtuaalikokoelmat. Kaikki nuotit, yhteistyöt ja tykkäykset korvaavat kirjaston vanhan kansiohierarkian Flatin uudistetun kirjaston mukaisesti.
• Flat for Education. Esitystehtävät ääni- tai videotallenteilla sekä taustanauha-, metronomi- ja nopeusasetuksilla; ryhmäpalautukset yhteistä kirjoittamista varten; rich text -ohjeet; opiskelijoiden alaryhmät; ajoitetut ja yksilöllisesti kohdennetut Microsoft Teams -tehtävät; monipuoliset kuvaukset ja tehtävätyypit resurssikirjastossa.
• Yhtenäinen LTI-määritys LTI 1.1:lle ja 1.3:lle, mukaan lukien dynaaminen rekisteröinti. Aiemmat LTI 1.1:n tunnistetietokutsut ovat vanhentuneita.
• Vuosittaiset tilastot nuoteista, julkisten nuottien määrät profiileissa sekä muutamien pitkään vanhentuneiden kenttien poistaminen.

• Lisättiin metodit getMP3 ja getWAV äänen vientiä varten
• Lisättiin exportProgress-tapahtuma, jotta pitkä vienti voi näyttää edistymisen

• Käyttäjien partituuriluettelot ovat julkisia profiileja. Käyttäjän partituureja listattaessa palautetaan nyt vain hänen julkiset partituurinsa, ja mukana ovat uusi sivutus ja lajittelu, kuten vuonna 2020 ilmoitetussa muutoksessa.
• Partituurin tiedot näyttävät muokkaus-URL-osoitteen, soitinnimet ja mahdollisen ajastetun poistopäivän; kokoelmat ilmoittavat partituuriensa määrän; julkisissa profiileissa näkyvät tykkäysten ja toistokertojen määrät.
• Flat for Education. Suodata resurssikirjastoa tehtävätyypin, oppiaineen ja vuosiluokan mukaan; resursseissa on jakamiskuvaus ja yksityisyysasetukset; tehtävät voivat rajoittaa nuottien toistoa ja ääniraitoja; palautukset tukevat LTI 1.1:n ja 1.3:n arviointipalveluja.

• Käyttäjäprofiilien tykkäykset on nyt sivutettu, ja tilitiedoissa näkyy, mitä tuotetta käyttäjä käyttää.
• Resurssioikeudet kertovat, onko kutsuja omistaja, käyttäjäyhteistyökumppani vai ryhmäyhteistyökumppani, sekä päivämäärän, jolloin kukin yhteistyökumppani lisättiin. Nuotin tiedot sisältävät nyt pääsävellajin, korostuspäivän ja organisaation.
• Flat for Education. Kutsuja voi käyttää uudelleen useita kertoja; palautuksiin lisätään arvioitu tila sekä toisto- ja LTI-tiedot; tehtävän voi kopioida resurssikirjastoon vain, jos se ei ole siellä jo ennestään; organisaatiot saavat omat resurssikirjastonsa ja koko organisaation kattavan tietosuojatason.

Lue ladatun nuotin rakenteen tiedot omasta koodistasi.

• Stemmat ja äänet: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Nuotit: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Uusi URL-parametri noAudio poistaa äänen toiston käytöstä
• Korjattu virhe, jossa setMasterVolume kutsui väärää taustalla olevaa metodia

• jQuery-tuki on poistettu konstruktorista — välitä sen sijaan DOM-elementti tai sen id
• Julkaistu npm-moduuli sisältää TypeScript-tyypit
• Erilliset ES- ja UMD-versiot

• Luo LTI-linkkejä Flat for Educationin resurssikirjaston kohteista, jotta voit lisätä ne suoraan LMS-kurssille.
• Tehtävän enimmäispistemäärä nousee 100:sta 10 000 pisteeseen.
• Partituurin metatiedot (alaotsikko, säveltäjä, sanoittaja, sovittaja, kuvaus, lisenssi…) voidaan nyt myös tyhjentää API:n kautta, ei vain asettaa.

• Resource Library API (beta). Selaa ja hallinnoi Flat for Educationin resurssikirjastoja kahden uuden OAuth2-scope-määrityksen avulla: toinen täydelle käyttöoikeudelle ja toinen vain luku -käytölle. Tehtäviä voi kopioida resurssikirjastoon.
• Testioppilaat. Luo luokkaan testioppilastilejä, jotta voit kokeilla tehtäviä oppilaan näkökulmasta.
• Tehtävät kertovat, mitä niillä voi tehdä (muokata, julkaista, arkistoida…), ovatko niiden liitteet omia kopioita ja mitä ongelmia niissä on havaittu. Palautushistoria tallentaa muutoksen lähteen, kun se tulee Google Classroomista, Microsoft Teamsista tai LMS:stä.
• Palautuksen nollaaminen pitää sen paikallaan sen sijaan, että se poistettaisiin; luokan metatiedot (taso, taidot, koko) ja tilien Microsoft-kirjautumistiedot ovat saatavilla.
• Partituuriversiot palauttavat alku- ja loppupäivänsä; partituurinluojat voivat ottaa käyttöön neljäsosasävelaskeleet; kopiot voivat säilyttää alkuperäisen otsikon.

• Tahdit: getNbMeasures, getMeasuresUuids
• Navigointi: goLeft, goRight, scrollToCursor
• Metronomi: getMetronomeMode, setMetronomeMode
• Toistonopeus: getPlaybackSpeed, setPlaybackSpeed

• Kirjautumislinkit ja delegoidut käyttöoikeustokenit. Flat for Educationin ylläpitäjät voivat luoda kirjautumislinkin organisaationsa mille tahansa käyttäjälle tai käyttöoikeustokenin, joka toimii kyseisen käyttäjän puolesta: perusta mukautetuille portaaleille ja kertakirjautumisintegraatioille.
• Japani hiraganalla (ja-HIRA) lisättiin tuettuihin kielialueisiin; julkisissa kommenteissa näkyy niiden moderointitila.
• Ääniviennit palauttavat MP3-joukon oletusraitana, kun sellainen on olemassa. Vaihtoehto pyytää vain välimuistiin tallennettuja vientitiedostoja poistettiin, koska ääniviennit toimitetaan nyt aina välimuistista.

• Partituurin luonti. Luo tyhjä partituuri ilman MusicXML-tiedoston tuontia: anna soitinluettelo ja halutessasi tahtilaji, etumerkintä, tabulatuuri, sointukaaviot ja sivuasettelu.
• Flat for Education. Organisaation käyttäjiä voidaan luoda roolin kanssa; tehtävämonisteet voivat sekoittaa harjoituksiaan; opiskelijoiden palautukset listaavat niiden sisältämät harjoitukset.

• Toistoraidat. Listaa raidat, jotka Flat luo ja synkronoi automaattisesti (toisto MP3-muodossa), hae uusimman toistotiedoston synkronointipisteet ja nouda viennin CDN-URL vastausrunkoon.
• Flat for Education. Opettajat voivat nollata oppilaan palautuksen; luokat ilmoittavat tilit, joita ei voitu lisätä synkronoinnin aikana; tehtävät ja palautukset näyttävät Microsoft Teams -tilansa ja -linkkinsä; tehtäväkopiot voidaan ajastaa; suorituspalautukset sisältävät tallennetun ääniraitansa.
• Profiileihin lisätään kansikuva, ja nykyisen käyttäjän id voidaan hakea erikseen.

• loadFlatScore hyväksyy sharingKey-avaimen, joten yksityisesti jaettu nuotti voidaan ladata
• Lisätty setTrack, useTrack ja seekTrackTo ääniraidan asettamiseen dynaamisesti

• Arvosanojen vienti. Lataa tehtävän arvosanat CSV- tai Excel-tiedostona.
• Tehtävillä on tyyppi ja kansikuva; tehtävää kopioitaessa olemassa oleva luonnos voidaan korvata toisen tehtävän sisällöllä.
• Yhteistyökumppaneista näkyy, onko kutsu edelleen avoinna.

• Arviointi API:n kautta. Aseta luonnos- ja lopulliset arvosanat, palauta palautus opiskelijalle ja lue lasketut kommenttilaskurit; enimmäispistemäärä tallennetaan arvosanan yhteyteen.
• Palautuskommentit. Luo, listaa, päivitä ja poista palautuksen kommentteja.
• Tehtäväasetukset. Työkalukokonaisuudet, toistorajoitus, enimmäispistemäärä, Google Classroom -aiheet, tehtävän antaminen tietyille opiskelijoille, lukitut pohjat sekä LTI-, Canvas- ja MusicFirst-tehtävien tiedot.
• Ylläpitäjät voivat muokata hallitun tilin käyttäjätunnusta, nimeä ja sähköpostiosoitetta; käyttäjälistauksia voi suodattaa aktiivisen lisenssin mukaan.
• Vanhat palautusparametrit studentComment ja returnFeedback poistettiin uusien arviointikutsujen tieltä.

• Arkistoi ja poista tehtäviä arkistosta sekä lue tehtävän päätyyppi (uusi partituuri, malli tai jaettu kirjoitus).
• Organisaation käyttäjät. Luo tilejä etu- ja sukunimellä, lajittele ja suodata käyttäjälistauksia, laske suodatinta vastaavat käyttäjät ja suodata ryhmien jäseniä synkronointilähteen perusteella (Google Classroom, Microsoft Teams, Clever).
• Partituurin tiedoissa luetellaan toistossa käytetyt audionäytteet, ja mukana on normalisoitu soitinluettelo, joka ei enää riipu näytteistä.

Hallitse miksausta omasta koodistasi ja lue, mitä kohdistimen alla on.

• Äänenvoimakkuus ja mykistys: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo ja kaiku: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Tarkastelu: getMeasureDetails, getNoteDetails
• Lisätyt tapahtumat: noteDetails, measureDetails, cursorContext

• Määritys siirtyy OpenAPI 3.0:aan. Aiempia versioita kuvattiin OpenAPI 2:ssa (Swagger).
• Nuoteilla on saatavilla sovittaja ja niiden toistotilastot; poiston voi ajastaa tapahtumaan pian sen sijaan, että se jäisi roskakoriin.
• Flat for Education. Tehtävien liitteet voivat olla Google Drive -tiedostoja, luokissa näkyvät niiden Microsoft Teams -tiedot, ja education-tilit tuovat esiin etu- ja sukunimen.

• Metatietojen muokkaukset päivittyvät editoriin reaaliajassa. Kun päivität API:n kautta partituurin otsikon, alaotsikon, säveltäjän, sanoittajan tai lisenssitekstin, muutos välitetään avoinna oleviin editoreihin reaaliajassa ja uusi versio tallennetaan. Kuvaukset voivat nyt olla kaksinkertaisen pitkiä (2,000 merkkiä).
• Education-palautukset kertovat nyt tilansa (luotu, palautettu, palautettu tarkistettavaksi); revisiometatiedot palauttavat viimeisimmän muokkaustapahtuman.
• Turkki on nyt tuettujen kielten joukossa; julkisista profiileista näkyy, kuuluuko tili Flat-tiimiin.

• Lisätty getMIDI
• getMusicXML palauttaa nyt ylimmällä tasolla Uint8Array-arvon — vastauksessa ei enää ole .data-ominaisuutta
• Kohdistimen voiceIdx on nyt voiceIdxInStaff

Päivitetty embed-julkaisua varten.

• SDK ladataan nyt oletusarvoisesti osoitteesta flat-embed.com
• Vanhentunut edit-toiminto ja edit-tapahtuma on poistettu
• setNoteColor on poistettu

• Lisää tuontimuotoja. Guitar Pro -tiedostoja (GP3, GP4, GP5, GPX, GP), PowerTab-, TuxGuitar- ja MuseScore-tiedostoja voi tuoda, ja tuonti hyväksyy tiedostonimen.
• Kokoelmat voidaan listata ylätason kokoelman alla, ja ne ilmoittavat luontipäivänsä; partituurit listaavat kokoelmat, joihin ne kuuluvat.
• Kontekstuaaliset kommentit ankkuroidaan tunnisteen perusteella viivastoon indeksin sijaan, ja resurssin käyttöoikeudet kertovat, onko kutsuja yhteistyökumppani.

• Collections API. Luo, listaa, päivitä, poista ja palauta kokoelmia, listaa niiden nuotit sekä lisää tai poista nuotteja. Mukana on myös kolme uutta OAuth2-scopea vain lukuoikeuteen, vain lisäämiseen ja täyteen käyttöoikeuteen.
• Nuotteja voi palauttaa roskakorista; jos poistat nuotin ilman ylläpitäjän oikeuksia, sen jakaminen tililtäsi poistetaan sen sijaan; kopion voi kohdistaa tiettyyn kokoelmaan.
• Kommentteja voi suodattaa tyypin mukaan (asiakirja tai rivinsisäinen).
• Stemmojen viennissä käytetään nyt stemmatunnisteita indeksien sijaan, ja syyskuusta 2019 alkaen käyttäjän nuottilistaus palauttaa vain julkiset nuotit.

• Organisaatiotilien hallinta. Ylläpitäjät voivat päivittää hallinnoituja tilejä sekä poistaa ne tai muuntaa ne kuluttajatileiksi; käyttäjä- ja kutsuluettelot käyttävät kursoriin perustuvaa sivutusta.
• Luokille tulee passiivinen tila, joka voidaan aktivoida uudelleen, ja ne ilmoittavat Canvas LMS -verkkotunnuksensa ja Clever-osionsa; tehtäville tulee luonnostila ja harjoitusliitetyyppi.
• Profiilit näyttävät teeman ja soitetut soittimet.

• Lisätty focusScore-metodi, jolla upotus saa näppäimistöfokuksen
• Uusi defaultMode-ominaisuus editorin asetuksissa

• Ensimmäiset Education-rajapinnat ovat nyt julkisia. Hallitse luokkia, tehtäviä ja palautuksia, organisaatiotilejä ja kutsuja, LTI-tunnistetietoja sekä organisaation ryhmiä ja käyttäjiä: kaikkea, mitä koulun integraatio tarvitsee.
• Rajattu käyttöoikeus. Uudet OAuth2-scope-määrittelyt kattavat luokat, tehtävät ja organisaation hallinnan, ja jokaisesta on myös vain luku -versio, jotta integraatio pyytää vain tarvitsemansa oikeudet.

Koodisi voi nyt tarkistaa, miten embed on määritetty, ja muuttaa sen editoriksi.

• Lisätyt metodit: getEmbedConfig, setEditorConfig, edit
• Lisätty tapahtuma: edit

SDK osaa nyt ladata nuotteja MusicXML:stä ja ilmoittaa, mitä lukija tekee.

• Lisätyt metodit: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Lisätyt tapahtumat: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Lisätyt integraatiotestit

Flatin REST API:n ensimmäinen julkinen julkaisu. Lue ja hallinnoi tiliäsi, partituureja, käyttäjiä ja ryhmiä omista sovelluksistasi ja skripteistäsi OAuth2:n avulla, kun toimit muiden Flat-käyttäjien puolesta.

Kaikki sen jälkeen on kirjattu API-muutoslokiin, ja kehittäjädokumentaatio kattaa todennuksen, viitemateriaalin ja oppaat.