Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 2.29 KB

ScoreCreationFileImport.md

File metadata and controls

30 lines (24 loc) · 2.29 KB
Raw

FlatApi::ScoreCreationFileImport

Properties

Name Type Description Notes
title String The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the title contained in the file (e.g. `movement-title` or `credit-words` for MusicXML files). - Use the name of the file for files from a specified `source` (e.g. Google Drive) or the one in the `filename` property - Set a default title (e.g. "New Music Score") [optional]
privacy ScorePrivacy [optional][default to 'private']
collection String Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be stored in the `root` directory. [optional]
google_drive_folder String If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory. [optional]
filename String If this is an imported file, its filename [optional]
data String The data of the score file. It must be a MusicXML 3 file (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`), a MIDI file (`audio/midi`) or a Flat.json (aka Adagio.json) file. Binary payloads (`vnd.recordare.musicxml` and `audio/midi`) can be encoded in Base64, in this case the `dataEncoding` property must match the encoding used for the API request.
data_encoding String The optional encoding of the score data. This property must match the encoding used for the `data` property. [optional]

Example

require 'flat_api'

instance = FlatApi::ScoreCreationFileImport.new(
  title: null,
  privacy: null,
  collection: null,
  google_drive_folder: null,
  filename: null,
  data: null,
  data_encoding: null
)