Developer changelog

Le tableau de bord développeur a été repensé en fonction de ce que votre intégration peut faire. Chaque capacité (Embed, OMR, REST API, Import API, LTI) a sa propre carte avec sa portée, sa tarification et sa documentation, et celles déjà utilisées par votre application apparaissent en premier.

• Une nouvelle section OMR au niveau du compte, avec vos tâches, vos crédits et leur historique au même endroit, puisque les crédits OMR sont partagés entre toutes vos applications.
• Essayez OMR avant d’écrire du code. Le playground accepte un PDF ou des photos, affiche le nombre de pages, le coût par page et le solde qu’il vous resterait, puis lance la tâche une fois que vous confirmez. Le résultat est offert en téléchargements MusicXML; rien n’est ajouté à votre bibliothèque.
• Des pages d’application plus claires. Les jetons personnels, les identifiants OAuth2 et l’accès OMR sont regroupés par application, et les identifiants qui incluent la portée OMR sont clairement indiqués.

Ouvrez-le à partir de flat.io/developers.

Notre spécification d’API REST passe à OpenAPI 3.1, l’API OMR termine sa période bêta, et les devoirs dans Flat for Education vont maintenant au-delà de la liste et de la création.

• L’API OMR est stable. Les points de terminaison, champs et comportements suivent désormais notre processus habituel de dépréciation avant tout changement incompatible. Une nouvelle FAQ couvre les crédits et la facturation, les limites et les délais de traitement, la qualité de reconnaissance et les langues, ainsi que l’utilisation commerciale et la confidentialité.
• Lisez, mettez à jour et supprimez les devoirs dans Flat for Education. La suppression d’un devoir supprime aussi ses remises et les copies des élèves; archivez-le plutôt si vous voulez conserver le travail.
• Registre des crédits. Un nouvel appel liste l’historique de vos crédits; le solde reste dans l’appel des capacités OMR.
• Les fichiers Finale (.musx) peuvent être importés, selon une approche du possible, et l’importation de musique numérisée (PDF et images) est documentée dans la création d’une partition.
• OpenAPI 3.1. Les champs nullable utilisent la syntaxe 3.1; les outils épinglés à OpenAPI 3.0 doivent être mis à jour. Le champ mimeType a été retiré des téléversements de fichiers OMR.

• Vous contrôlez la conservation des données. Les tâches OMR indiquent maintenant combien de temps leurs fichiers sont conservés (30 jours par défaut), chaque tâche MusicXML inclut sa date d'expiration, et vous pouvez supprimer les fichiers et les résultats d'une tâche dès que vous les avez récupérés.
• Détection des fonctionnalités avant la connexion. L'appel des capacités OMR fonctionne sans compte et dresse la liste des langues de reconnaissance prises en charge avec leur nom.
• Export en notation ABC pour toute révision de partition, en plus de MusicXML, MIDI et des autres formats. Comme le MIDI, il ne comprend pas toute la gravure.
• Les devoirs Free Record peuvent être configurés au moyen de l'API dans Flat for Education.
• Les erreurs provenant d'un fournisseur en amont (Google Classroom, par exemple) incluent maintenant le propre message localisé du fournisseur.

Le moteur OMR de Flat est maintenant accessible de façon programmatique via l’API développeur. Envoyez des PDF ou des photos, suivez la progression de la reconnaissance, vérifiez les instruments détectés, puis importez le résultat comme partition modifiable dans une bibliothèque Flat ou exportez-le en MusicXML ou MIDI. C’est le même modèle interne qui alimente l’importation de PDF et de photos dans l’éditeur, maintenant offert à grande échelle pour vos propres applications et flux de travail.

L’API OMR dédiée (v2.24.0) s’appuie sur l’importation de PDF en arrière-plan ajoutée à la création de partition dans la v2.23.0 : demandez la prise en charge des tâches lors de l’importation d’un fichier, puis interrogez la tâche jusqu’à ce que la partition soit prête. Consultez le journal des modifications de l’API pour en savoir plus sur ces deux versions.

La plus importante mise à jour de la spécification depuis 2024, qui permet à l’API de rattraper deux années d’évolution du produit.

• Importation à partir de plus de 15 formats. Guitar Pro, MuseScore, ABC notation, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer et Encore s’ajoutent à MusicXML et MIDI, et les partitions peuvent être exportées en fichiers natifs .flat.
• Collections virtuelles. Toutes les partitions, collaborations et mentions J’aime remplacent l’ancienne hiérarchie de dossiers dans la bibliothèque, conformément à la bibliothèque Flat repensée.
• Flat for Education. Travaux d’interprétation avec enregistrements audio ou vidéo et options de piste d’accompagnement, de métronome et de vitesse; remises de groupe pour l’écriture collaborative; consignes en texte enrichi; sous-groupes d’élèves; travaux Microsoft Teams planifiés et attribués individuellement; descriptions enrichies et types de travaux dans la bibliothèque de ressources.
• Configuration LTI unifiée pour LTI 1.1 et 1.3, y compris l’inscription dynamique. Les anciens appels de renseignements d’identification LTI 1.1 sont désormais obsolètes.
• Statistiques annuelles sur les partitions, nombre de partitions publiques sur les profils, et suppression de quelques champs obsolètes depuis longtemps.

• Ajout des méthodes getMP3 et getWAV pour l’exportation audio
• Ajout de l’événement exportProgress afin d’afficher la progression lors d’une exportation longue

• Les listes de partitions d'un utilisateur deviennent des profils publics. La liste des partitions d'un utilisateur ne renvoie maintenant que ses partitions publiques, avec une nouvelle pagination et de nouvelles options de tri, comme annoncé en 2020.
• Les détails d'une partition exposent l'URL de modification, les noms des instruments et toute date de suppression planifiée�a0; les collections indiquent leur nombre de partitions�a0; les profils publics affichent le nombre de mentions J'aime et d'écoutes.
• Flat for Education. Filtrez la bibliothèque de ressources par type de devoir, matière et niveau scolaire�a0; les ressources comprennent une description du partage et des options de confidentialité�a0; les devoirs peuvent restreindre la lecture des notes et les pistes audio�a0; les remises prennent en charge les services de notes LTI 1.1 et 1.3.

• Les mentions J’aime des profils d’utilisateur sont maintenant paginées, et les détails du compte indiquent aussi sur quel produit se trouve un utilisateur.
• Les droits sur les ressources indiquent maintenant si l’appelant est le propriétaire, un collaborateur utilisateur ou un collaborateur de groupe, avec la date d’ajout de chaque collaborateur. Les détails d’une partition incluent aussi l’armure principale, la date de mise en vedette et l’organisation.
• Flat for Education. Les invitations peuvent être réutilisées plusieurs fois; les remises ont maintenant un état noté ainsi que les détails de lecture et LTI; un devoir peut être copié dans la bibliothèque de ressources seulement s’il ne s’y trouve pas déjà; les organisations ont leur propre bibliothèque de ressources avec un niveau de confidentialité à l’échelle de l’organisation.

Lisez la structure de la partition chargée à partir de votre code.

• Portées et voix : getNbParts, getPartsUuids, getMeasureVoicesUuids
• Notes : getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• Le nouveau paramètre d’URL noAudio désactive la lecture audio
• Correction de setMasterVolume, qui appelait la mauvaise méthode sous-jacente

• Suppression de la prise en charge de jQuery dans le constructeur — passez plutôt un élément DOM ou son identifiant
• Le module npm publié inclut les types TypeScript
• Builds ES et UMD séparés

• Créez des liens LTI à partir d’éléments de la bibliothèque de ressources de Flat for Education, pour les placer directement dans un cours d’un LMS.
• La note maximale d’un devoir passe de 100 à 10 000 points.
• Les métadonnées de la partition (sous-titre, compositeur, parolier, arrangeur, description, licence…) peuvent maintenant être effacées via l’API, et pas seulement définies.

• API de bibliothèque de ressources (bêta). Parcourez et gérez les bibliothèques de ressources de Flat for Education, avec deux nouveaux scopes OAuth2 pour l’accès complet et l’accès en lecture seule. Les devoirs peuvent être copiés dans la bibliothèque de ressources.
• Élèves test. Créez des comptes d’élèves test dans une classe pour essayer les devoirs comme le ferait un élève.
• Les devoirs indiquent ce que vous pouvez faire avec eux (modifier, publier, archiver…), si leurs pièces jointes sont des copies dédiées, ainsi que tout problème rencontré. L’historique des remises enregistre l’origine d’une modification lorsqu’elle provient de Google Classroom, Microsoft Teams ou d’un LMS.
• La réinitialisation d’une remise la garde en place au lieu de la supprimer; les métadonnées de la classe (niveau, compétences, taille) et les détails de connexion Microsoft des comptes sont exposés.
• Les révisions de partition retournent leurs dates de début et de fin; les générateurs de partition peuvent activer les quarts de ton; les copies peuvent conserver le titre d’origine.

• Mesures : getNbMeasures, getMeasuresUuids
• Navigation : goLeft, goRight, scrollToCursor
• Métronome : getMetronomeMode, setMetronomeMode
• Vitesse de lecture : getPlaybackSpeed, setPlaybackSpeed

• Liens de connexion et jetons d’accès délégués. Les administrateurs de Flat for Education peuvent créer un lien de connexion pour n’importe quel utilisateur de leur organisation, ou un jeton d’accès qui agit au nom de cet utilisateur : la base de portails personnalisés et d’intégrations d’authentification unique.
• Le japonais en hiragana (ja-HIRA) s’ajoute aux langues prises en charge; les commentaires publics affichent désormais leur état de modération.
• Les exportations audio renvoient l’ensemble MP3 comme piste par défaut lorsqu’il existe. L’option permettant de demander uniquement des exportations mises en cache a été supprimée, puisque les exportations audio sont maintenant toujours servies à partir du cache.

• Créateur de partitions. Créez une partition vierge sans importer de fichier MusicXML : fournissez une liste d’instruments et, au besoin, l’indication de mesure, l’armure, la tablature, les grilles d’accords et la mise en page.
• Flat for Education. Les utilisateurs d’une organisation peuvent être créés avec un rôle ; les feuilles d’exercices peuvent mélanger leurs exercices ; les remises des élèves listent les exercices qu’elles contiennent.

• Pistes de lecture. Listez les pistes que Flat génère et synchronise automatiquement (lecture en MP3), récupérez les points de synchronisation du plus récent fichier de lecture et obtenez l’URL CDN d’une exportation dans le corps de la réponse.
• Flat for Education. Les enseignants peuvent réinitialiser la remise d’un élève; les classes signalent les comptes qui n’ont pas pu être ajoutés lors d’une synchronisation; les devoirs et les remises exposent leur état Microsoft Teams et leurs liens; les copies de devoirs peuvent être planifiées; les remises de performance incluent leur piste audio enregistrée.
• Les profils ont maintenant une image de couverture, et l’identifiant de l’utilisateur courant peut être récupéré séparément.

• loadFlatScore accepte maintenant un sharingKey, ce qui permet de charger une partition partagée en privé
• Ajout de setTrack, useTrack et seekTrackTo pour définir dynamiquement la piste audio

• Export des notes. Téléchargez les notes d’un devoir en format CSV ou dans un fichier Excel.
• Les devoirs incluent maintenant leur type et une image de couverture; la copie d’un devoir peut remplacer le contenu d’un brouillon existant par celui d’un autre devoir.
• Les collaborateurs indiquent maintenant si leur invitation est toujours en attente.

• Notation via l’API. Définissez des notes provisoires et finales, retournez une remise à un élève et consultez les compteurs de commentaires calculés ; le nombre maximal de points est enregistré avec la note.
• Commentaires de remise. Créez, listez, mettez à jour et supprimez des commentaires sur une remise.
• Options de devoir. Ensembles d’outils, limite de lecture, nombre maximal de points, sujets Google Classroom, attribution à des élèves précis, gabarits verrouillés, et détails des devoirs LTI, Canvas et MusicFirst.
• Les administrateurs peuvent modifier le nom d’utilisateur, le nom et le courriel d’un compte géré ; les listes d’utilisateurs peuvent être filtrées selon la licence active.
• Les anciens paramètres de remise studentComment et returnFeedback ont été supprimés au profit des nouveaux appels de notation.

• Archivez et désarchivez des devoirs, et consultez le type principal d’un devoir (nouvelle partition, modèle ou rédaction partagée).
• Utilisateurs de l’organisation. Créez des comptes avec un prénom et un nom de famille, triez et filtrez les listes d’utilisateurs, comptez les utilisateurs correspondant à un filtre et filtrez les membres d’un groupe selon leur source de synchronisation (Google Classroom, Microsoft Teams, Clever).
• Les détails d’une partition listent les échantillons audio utilisés pour la lecture, avec une liste normalisée des instruments qui ne dépend plus des échantillons.

Contrôlez le mixage depuis votre code et consultez ce qui se trouve sous le curseur.

• Volume et sourdine : getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo et réverbération : setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Inspection : getMeasureDetails, getNoteDetails
• Événements ajoutés : noteDetails, measureDetails, cursorContext

• La spécification passe à OpenAPI 3.0. Les versions précédentes étaient décrites en OpenAPI 2 (Swagger).
• Les partitions exposent désormais un arrangeur ainsi que leurs statistiques d’écoutes ; une suppression peut être planifiée pour être exécutée rapidement au lieu de rester dans la corbeille.
• Flat for Education. Les pièces jointes des devoirs peuvent être des fichiers Google Drive, les classes incluent leurs renseignements Microsoft Teams, et les comptes éducation exposent un prénom et un nom de famille.

• Les modifications des m�e9tadonn�e9es sont appliqu�e9es en direct dans l'�e9diteur. Quand vous mettez �e0 jour par l'API le titre, le sous-titre, le compositeur, le parolier ou le texte de licence d'une partition, ces changements sont transmis en temps r�e9el aux �e9diteurs ouverts, et une nouvelle version est enregistr�e9e. Les descriptions peuvent maintenant �eatre deux fois plus longues (2,000 caract�e8res).
• Les remises de Flat for Education exposent leur �e9tat (cr�e9�e9e, remise, retourn�e9e) ; les m�e9tadonn�e9es de r�e9vision renvoient le dernier �e9v�e9nement de modification.
• Le turc s'ajoute aux langues prises en charge ; les profils publics indiquent si un compte appartient �e0 l'�e9quipe Flat.

• Ajout de getMIDI
• getMusicXML renvoie maintenant un Uint8Array au niveau supérieur — la réponse ne contient plus de propriété .data
• Le voiceIdx du curseur s’appelle maintenant voiceIdxInStaff

Mise à jour pour la version de l’embed.

• Le SDK se charge maintenant depuis flat-embed.com par défaut
• Suppression de l’action edit et de l’événement edit, désormais obsolètes
• Suppression de setNoteColor

• Davantage de formats d’importation. Les fichiers Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar et MuseScore peuvent être importés, et l’importation accepte un nom de fichier.
• Les collections peuvent être listées sous une collection parente et indiquer leur date de création; les partitions listent les collections auxquelles elles appartiennent.
• Les commentaires contextuels sont rattachés à une portée par identifiant plutôt que par index, et les droits sur les ressources indiquent si l’appelant est un collaborateur.

• API Collections. Créez, listez, mettez à jour, supprimez et restaurez des collections, listez leurs partitions, et ajoutez ou retirez des partitions, avec trois nouvelles portées OAuth2 pour l’accès en lecture seule, en ajout seulement et complet.
• Les partitions peuvent être restaurées de la corbeille; supprimer une partition sans droits d’administration la retire simplement du partage avec votre compte; une copie peut cibler une collection précise.
• Les commentaires peuvent être filtrés par type (document ou inline).
• Les exportations de parties utilisent maintenant des identifiants de partie plutôt que des index, et depuis septembre 2019 la liste des partitions d’un utilisateur ne renvoie que les partitions publiques.

• Gestion des comptes d’organisation. Les administrateurs peuvent mettre à jour les comptes gérés, les supprimer ou les convertir en comptes individuels; les listes d’utilisateurs et d’invitations utilisent une pagination par curseur.
• Les classes ont maintenant un état inactif qui peut être réactivé, et indiquent leur domaine Canvas LMS et leur section Clever; les devoirs ont maintenant un état brouillon et un type de pièce jointe exercice.
• Les profils affichent maintenant un thème et les instruments pratiqués.

• Ajout de la méthode focusScore pour donner le focus clavier à l’intégration
• Nouvelle propriété defaultMode dans la configuration de l’éditeur

• Les premières API pour l’éducation sont publiques. Gérez les classes, les devoirs et les remises, les comptes d’organisation et les invitations, les identifiants LTI, ainsi que les groupes et les utilisateurs d’une organisation : tout ce dont une intégration scolaire a besoin.
• Accès par portée. De nouvelles portées OAuth2 couvrent les classes, les devoirs et l’administration des organisations, chacune avec une variante en lecture seule, pour qu’une intégration ne demande que ce dont elle a besoin.

Votre code peut maintenant inspecter la façon dont l’embed est configuré et le transformer en éditeur.

• Méthodes ajoutées : getEmbedConfig, setEditorConfig, edit
• Événement ajouté : edit

Le SDK peut maintenant charger des partitions à partir de MusicXML et indiquer ce que fait le lecteur.

• Méthodes ajoutées : getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Événements ajoutés : scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Tests d’intégration ajoutés

Première version publique de l’API REST de Flat. Lisez et gérez votre compte, vos partitions, vos utilisateurs et vos groupes depuis vos propres applications et scripts, avec OAuth2 pour agir au nom d’autres utilisateurs de Flat.

Tous les changements depuis sont consignés dans le journal des modifications de l’API, et la documentation pour les développeurs couvre l’authentification, la référence et les guides.