Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.85 KB

ScoreCreation.md

File metadata and controls

37 lines (28 loc) · 2.85 KB
Raw

ScoreCreation

Properties

Name Type Description Notes
title str 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]
collection str 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 str 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]
builder_data ScoreCreationBuilderData [optional]
filename str If this is an imported file, its filename [optional]
data str 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. [optional]
data_encoding str The optional encoding of the score data. This property must match the encoding used for the `data` property. [optional]
source ScoreSource [optional]

Example

from flat_api.models.score_creation import ScoreCreation

# TODO update the JSON string below
json = "{}"
# create an instance of ScoreCreation from a JSON string
score_creation_instance = ScoreCreation.from_json(json)
# print the JSON string representation of the object
print ScoreCreation.to_json()

# convert the object into a dict
score_creation_dict = score_creation_instance.to_dict()
# create an instance of ScoreCreation from a dict
score_creation_form_dict = score_creation.from_dict(score_creation_dict)

[Back to Model list] [Back to API list] [Back to README]