Developer changelog

El panel para desarrolladores se ha rediseñado en torno a lo que puede hacer tu integración. Cada funcionalidad (Embed, OMR, REST API, Import API, LTI) tiene una tarjeta con su alcance, precios y documentación, y las que tu aplicación ya usa aparecen primero.

• Una nueva sección de OMR a nivel de cuenta, con tus trabajos, tus créditos y su historial en un solo lugar, ya que los créditos de OMR se comparten entre todas tus aplicaciones.
• Prueba OMR antes de escribir código. El playground acepta un PDF o fotos, muestra el número de páginas, el coste por página y el saldo que te quedaría, y luego ejecuta el trabajo cuando lo confirmas. La salida va a descargas de MusicXML; nada se guarda en tu biblioteca.
• Páginas de aplicación más claras. Los tokens personales, las credenciales de OAuth2 y el acceso a OMR se agrupan por aplicación, y se destacan las credenciales que incluyen el alcance de OMR.

Ábrelo desde flat.io/developers.

Nuestra especificación de la API REST pasa a OpenAPI 3.1, la API de OMR cierra su periodo beta y las tareas de Flat for Education se abren a más acciones además de listarlas y crearlas.

• La API de OMR es estable. Los endpoints, campos y el comportamiento siguen ahora nuestro proceso habitual de retirada antes de cualquier cambio incompatible. Una nueva FAQ cubre créditos y facturación, límites y tiempos de procesamiento, calidad del reconocimiento e idiomas, y uso comercial y privacidad.
• Lee, actualiza y elimina tareas en Flat for Education. Al eliminar una tarea también se eliminan sus entregas y las copias de los estudiantes; archívala en su lugar para conservar el trabajo.
• Credit ledger. Una nueva llamada muestra tu historial de créditos; el saldo sigue estando en la llamada de capacidades de OMR.
• Los archivos de Finale (.musx) se pueden importar, dentro de lo posible, y la importación de música escaneada (PDF e imágenes) está documentada en la creación de partituras.
• OpenAPI 3.1. Los campos anulables usan la sintaxis de la versión 3.1; las herramientas fijadas en OpenAPI 3.0 necesitan una actualización. El campo mimeType se ha eliminado de las cargas de archivos de OMR.

• Retención de datos bajo tu control. Los trabajos de OMR ahora indican cuánto tiempo se conservan sus archivos (30 días por defecto), cada trabajo de MusicXML incluye su fecha de caducidad y puedes borrar los archivos y resultados de un trabajo en cuanto los hayas recuperado.
• Detección de funciones antes de iniciar sesión. La llamada de capacidades de OMR funciona sin cuenta y enumera los idiomas de reconocimiento compatibles con sus nombres.
• Exportación de notación ABC para cualquier revisión de la partitura, junto con MusicXML, MIDI y los demás formatos. Al igual que MIDI, no incluye el grabado completo.
• Las tareas Free Record se pueden configurar mediante la API en Flat for Education.
• Los errores procedentes de un proveedor ascendente (por ejemplo, Google Classroom) ahora incluyen el propio mensaje localizado del proveedor.

El motor OMR de Flat ya está disponible de forma programática a través de la API para desarrolladores. Envía archivos PDF o fotos, sigue el progreso del reconocimiento, revisa los instrumentos detectados y luego importa el resultado como una partitura editable en una biblioteca de Flat o exporta MusicXML o MIDI. Es el mismo modelo interno que impulsa la importación de PDF y fotos en el editor, ahora disponible a gran escala para tus propias aplicaciones y flujos de trabajo.

La API de OMR dedicada (v2.24.0) se basa en la importación de PDF en segundo plano añadida a la creación de partituras en v2.23.0: solicita compatibilidad con tareas al importar un archivo y consulta la tarea hasta que la partitura esté lista. Consulta el registro de cambios de la API para conocer los detalles de ambas versiones.

La mayor actualización de la especificación desde 2024, que pone la API al día con dos años de cambios en el producto.

• Importación desde más de 15 formatos. Guitar Pro, MuseScore, notación ABC, PowerTab, Capella, MEI, Overture, TablEdit, Band-in-a-Box, Karaoke MIDI, MuseData, Score Writer, Bagpipe Music Writer y Encore se suman a MusicXML y MIDI, y las partituras pueden exportarse como archivos .flat nativos.
• Colecciones virtuales. Todas las partituras, colaboraciones y me gusta sustituyen la antigua jerarquía de carpetas de la biblioteca, en línea con la biblioteca rediseñada de Flat.
• Flat for Education. Tareas de interpretación con grabaciones de audio o vídeo y opciones de base instrumental, metrónomo y velocidad; entregas en grupo para escritura compartida; instrucciones con texto enriquecido; subgrupos de estudiantes; tareas de Microsoft Teams programadas y dirigidas individualmente; descripciones detalladas y tipos de tarea en la biblioteca de recursos.
• Configuración unificada de LTI para LTI 1.1 y 1.3, incluido el registro dinámico. Las llamadas anteriores de credenciales de LTI 1.1 quedan obsoletas.
• Estadísticas anuales sobre partituras, recuento de partituras públicas en los perfiles y eliminación de algunos campos obsoletos desde hace tiempo.

• Se han añadido los métodos getMP3 y getWAV para la exportación de audio
• Se ha añadido el evento exportProgress para que una exportación larga pueda mostrar el progreso

• Los listados de partituras de los usuarios son perfiles públicos. Al listar ahora las partituras de un usuario, solo se devuelven sus partituras públicas, con nueva paginación y ordenación, tal como se anunció este cambio en 2020.
• Los detalles de la partitura muestran la URL de edición, los nombres de los instrumentos y cualquier fecha de eliminación programada; las colecciones informan del número de partituras; los perfiles públicos muestran los recuentos de Me gusta y reproducciones.
• Flat for Education. Filtra la biblioteca de recursos por tipo de tarea, asignatura y curso; los recursos incluyen una descripción de uso compartido y opciones de privacidad; las tareas pueden restringir la reproducción de notas y las pistas de audio; las entregas son compatibles con los servicios de calificaciones LTI 1.1 y 1.3.

• "Me gusta" paginados en los perfiles de usuario y el producto que usa un usuario en los detalles de su cuenta.
• Los permisos del recurso indican si quien llama es el propietario, un colaborador individual o un colaborador de grupo, junto con la fecha en la que se añadió cada colaborador. Los detalles de la partitura añaden la armadura principal, la fecha de destacado y la organización.
• Flat for Education. Las invitaciones pueden reutilizarse varias veces; las entregas obtienen un estado de calificación, además de detalles de reproducción y LTI; una tarea solo puede copiarse a la biblioteca de recursos si no está ya allí; las organizaciones obtienen sus propias bibliotecas de recursos con un nivel de privacidad para toda la organización.

Lee la estructura de la partitura cargada desde tu código.

• Partes y voces: getNbParts, getPartsUuids, getMeasureVoicesUuids
• Notas: getMeasureNbNotes, getNoteData, playbackPositionToNoteIdx
• El nuevo parámetro de URL noAudio desactiva la reproducción de audio
• Se corrigió setMasterVolume, que llamaba al método interno incorrecto

• Se ha eliminado la compatibilidad con jQuery en el constructor — ahora debes pasar un elemento del DOM o su id
• El módulo npm publicado incluye tipos de TypeScript
• Compilaciones ES y UMD independientes

• Crea enlaces LTI a partir de elementos de la biblioteca de recursos de Flat for Education para colocarlos directamente en un curso de LMS.
• La calificación máxima de una tarea pasa de 100 a 10.000 puntos.
• Los metadatos de la partitura (subtítulo, compositor, letrista, arreglista, descripción, licencia…) ahora también pueden borrarse mediante la API, no solo establecerse.

• Resource Library API (beta). Explora y administra las bibliotecas de recursos de Flat for Education con dos nuevos alcances de OAuth2 para acceso completo y de solo lectura. Las tareas se pueden copiar a la biblioteca de recursos.
• Estudiantes de prueba. Crea cuentas de estudiante de prueba en una clase para probar las tareas como lo haría un estudiante.
• Las tareas indican qué puedes hacer con ellas (editar, publicar, archivar…), si sus archivos adjuntos son copias dedicadas y cualquier problema detectado. El historial de entregas registra el origen de un cambio cuando proviene de Google Classroom, Microsoft Teams o un LMS.
• Al restablecer una entrega, esta se mantiene en su sitio en lugar de eliminarse; se exponen los metadatos de la clase (nivel, habilidades, tamaño) y los datos de inicio de sesión de Microsoft en las cuentas.
• Las revisiones de partituras devuelven sus fechas de inicio y fin; los generadores de partituras pueden habilitar cuartos de tono; las copias pueden conservar el título original.

• Compases: getNbMeasures, getMeasuresUuids
• Navegación: goLeft, goRight, scrollToCursor
• Metrónomo: getMetronomeMode, setMetronomeMode
• Velocidad de reproducción: getPlaybackSpeed, setPlaybackSpeed

• Enlaces de inicio de sesión y tokens de acceso delegados. Los administradores de Flat for Education pueden crear un enlace de inicio de sesión para cualquier usuario de su organización, o un token de acceso que actúe en nombre de ese usuario: la base para portales personalizados e integraciones de inicio de sesión único.
• El japonés en hiragana (ja-HIRA) se suma a los idiomas compatibles; los comentarios públicos muestran su estado de moderación.
• Las exportaciones de audio devuelven el conjunto MP3 como pista predeterminada cuando existe. Se eliminó la opción de solicitar solo exportaciones en caché, ya que las exportaciones de audio ahora siempre se sirven desde la caché.

• Generador de partituras. Crea una partitura en blanco sin importar un archivo MusicXML: indica una lista de instrumentos y, opcionalmente, el compás, la armadura, la tablatura, los diagramas de acordes y el diseño de página.
• Flat for Education. Los usuarios de la organización pueden crearse con un rol; las hojas de ejercicios pueden mezclar sus ejercicios; las entregas de los estudiantes enumeran los ejercicios que contienen.

• Pistas de reproducción. Enumera las pistas que Flat genera y sincroniza automáticamente (reproducción como MP3), recupera los puntos de sincronización del archivo de reproducción más reciente y obtén la URL de CDN de una exportación en el cuerpo de la respuesta.
• Flat for Education. Los profesores pueden restablecer la entrega de un alumno; las clases informan de las cuentas que no se pudieron añadir durante una sincronización; las tareas y entregas exponen su estado y enlaces de Microsoft Teams; las copias de tareas se pueden programar; las entregas de interpretación incluyen su pista de audio guardada.
• Los perfiles incorporan una imagen de portada, y el id del usuario actual puede recuperarse por separado.

• loadFlatScore acepta una sharingKey, por lo que se puede cargar una partitura compartida de forma privada
• Se han añadido setTrack, useTrack y seekTrackTo para configurar la pista de audio dinámicamente

• Exportación de calificaciones. Descarga las calificaciones de una tarea como archivo CSV o Excel.
• Las tareas incluyen su tipo y una imagen de portada; al copiar una tarea, se puede sobrescribir un borrador existente con el contenido de otra tarea.
• Los colaboradores muestran si su invitación sigue pendiente.

• Calificación a través de la API. Define calificaciones provisionales y finales, devuelve una entrega a un alumno y consulta contadores de comentarios calculados; la puntuación máxima se guarda con la calificación.
• Comentarios de entregas. Crea, lista, actualiza y elimina comentarios en una entrega.
• Opciones de tareas. Conjuntos de herramientas, un límite de reproducción, puntuación máxima, temas de Google Classroom, asignación a alumnos concretos, plantillas bloqueadas y detalles de las tareas de LTI, Canvas y MusicFirst.
• Los administradores pueden editar el nombre de usuario, el nombre y el correo electrónico de una cuenta gestionada; los listados de usuarios se pueden filtrar por licencia activa.
• Los antiguos parámetros de entrega studentComment y returnFeedback se eliminaron en favor de las nuevas llamadas de calificación.

• Archiva y desarchiva tareas y consulta el tipo principal de una tarea (partitura nueva, plantilla o escritura compartida).
• Usuarios de la organización. Crea cuentas con nombre y apellidos, ordena y filtra listados de usuarios, cuenta los usuarios que coinciden con un filtro y filtra los miembros de grupos por su fuente de sincronización (Google Classroom, Microsoft Teams, Clever).
• Los detalles de la partitura enumeran las muestras de audio usadas en la reproducción, con una lista de instrumentos normalizada que ya no depende de las muestras.

Controla la mezcla desde tu código y consulta lo que hay bajo el cursor.

• Volumen y silencio: getMasterVolume, setMasterVolume, getPartVolume, setPartVolume, mutePart, unmutePart
• Solo y reverberación: setPartSoloMode, unsetPartSoloMode, getPartSoloMode, getPartReverb, setPartReverb
• Inspección: getMeasureDetails, getNoteDetails
• Eventos añadidos: noteDetails, measureDetails, cursorContext

• La especificación pasa a OpenAPI 3.0. Las versiones anteriores se describían en OpenAPI 2 (Swagger).
• Las partituras exponen un arreglista y sus estadísticas de reproducciones; una eliminación puede programarse para ejecutarse en breve en lugar de quedarse en la papelera.
• Flat for Education. Los archivos adjuntos de las tareas pueden ser archivos de Google Drive, las clases incluyen sus datos de Microsoft Teams y las cuentas educativas exponen nombre y apellido.

• Las ediciones de metadatos llegan al editor al instante. Al actualizar mediante la API el título, subtítulo, compositor, letrista o texto de licencia de una partitura, el cambio se envía en tiempo real a los editores abiertos y se guarda una nueva versión. Las descripciones ahora pueden ser el doble de largas (2,000 caracteres).
• Las entregas de Education ahora muestran su estado (creada, entregada, devuelta); los metadatos de revisión devuelven el último evento de modificación.
• El turco se suma a los idiomas compatibles; los perfiles públicos indican si una cuenta pertenece al equipo de Flat.

• Se ha añadido getMIDI
• getMusicXML ahora devuelve un Uint8Array en el nivel superior — la respuesta ya no incluye una propiedad .data
• voiceIdx del cursor ahora es voiceIdxInStaff

Actualizado para la versión del embed.

• El SDK ahora se carga desde flat-embed.com de forma predeterminada
• Se han eliminado la acción edit y el evento edit, que estaban obsoletos
• Se ha eliminado setNoteColor

• Más formatos de importación. Se pueden importar archivos de Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar y MuseScore, y la importación admite un nombre de archivo.
• Las colecciones pueden mostrarse dentro de una colección principal e informar de su fecha de creación; las partituras muestran las colecciones a las que pertenecen.
• Los comentarios contextuales se anclan a un pentagrama mediante un identificador en lugar de un índice, y los permisos del recurso indican si quien realiza la llamada es colaborador.

• Collections API. Crea, lista, actualiza, elimina y restaura colecciones, lista sus partituras y añade o quita partituras, con tres nuevos scopes de OAuth2 para acceso de solo lectura, solo adición y acceso completo.
• Las partituras se pueden restaurar desde la papelera; al eliminar una partitura sin derechos de administrador, se deja de compartir con tu cuenta en su lugar; una copia puede dirigirse a una colección concreta.
• Los comentarios se pueden filtrar por tipo (documento o en línea).
• Las exportaciones de partes ahora usan identificadores de parte en lugar de índices y, desde septiembre de 2019, el listado de partituras de un usuario solo devuelve partituras públicas.

• Gestión de cuentas de organización. Los administradores pueden actualizar las cuentas gestionadas, eliminarlas o convertirlas en cuentas de usuario; los listados de usuarios e invitaciones usan paginación basada en cursores.
• Las clases incorporan un estado inactivo que puede volver a activarse, e informan de su dominio de Canvas LMS y su sección de Clever; las tareas incorporan un estado de borrador y un tipo de archivo adjunto de ejercicio.
• Los perfiles muestran un tema y los instrumentos que se tocan.

• Se añadió el método focusScore para dar el foco del teclado a la incrustación
• Nueva propiedad defaultMode en la configuración del editor

• Las primeras API de Education ya son públicas. Gestiona clases, tareas y entregas, cuentas de organización e invitaciones, credenciales LTI, y los grupos y usuarios de una organización: todo lo que necesita una integración escolar.
• Acceso por ámbitos. Los nuevos scopes de OAuth2 cubren clases, tareas y administración de la organización, cada uno con una variante de solo lectura, para que una integración solo solicite lo que necesita.

Tu código ahora puede comprobar cómo está configurada la inserción y convertirla en un editor.

• Métodos añadidos: getEmbedConfig, setEditorConfig, edit
• Evento añadido: edit

El SDK ahora puede cargar partituras desde MusicXML e informar de lo que está haciendo el lector.

• Métodos añadidos: getAutoZoom, setAutoZoom, loadMusicXML, getMusicXML
• Eventos añadidos: scoreLoaded, cursorPosition, rangeSelection, pause, stop, fullscreen, print
• Pruebas de integración añadidas

La primera versión pública de la API REST de Flat. Lee y gestiona tu cuenta, partituras, usuarios y grupos desde tus propias aplicaciones y scripts, con OAuth2 para actuar en nombre de otros usuarios de Flat.

Todo lo posterior está registrado en el registro de cambios de la API, y la documentación para desarrolladores cubre la autenticación, la referencia y las guías.