Skip to content

Latest commit

聽

History

History
68 lines (59 loc) 路 5.28 KB

ScoreDetails.md

File metadata and controls

68 lines (59 loc) 路 5.28 KB

ScoreDetails

The score and all its details

Properties

Name Type Description Notes
id str The unique identifier of the score
sharing_key str The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) [optional]
title str The title of the score
privacy ScorePrivacy [default to ScorePrivacy.PRIVATE]
user UserPublic
html_url str The url where the score can be viewed in a web browser
edit_html_url str The url where the score can be edited in a web browser
subtitle str Subtitle of the score [optional]
lyricist str Lyricist of the score [optional]
arranger str Arranger of the score [optional]
composer str Composer of the score [optional]
description str Description of the creation [optional]
tags List[str] Tags describing the score [optional]
creation_type ScoreCreationType [optional]
license ScoreLicense [optional]
license_text str Additional license text written on the exported/printed score [optional]
duration_time float In seconds, an approximate duration of the score [optional]
number_measures int The number of measures in the score [optional]
main_tempo_qpm float The main tempo of the score (in QPM) [optional]
main_key_signature float The main key signature of the score (expressed between -7 and 7). [optional]
rights ResourceRights [optional]
collaborators List[ResourceCollaborator] The list of the collaborators of the score
creation_date datetime The date when the score was created
modification_date datetime The date of the last revision of the score [optional]
publication_date datetime The date when the score was published on Flat [optional]
scheduled_deletion_date datetime The date when the score will be definitively deleted. This date can be in the past if the score will be deleted at the next deletion batch, in this case you can display something like "Deleted shortly". Schedule: * For all paying users, the scores will be definitively deleted after 90 days. * For free users, the scores are no longer available after 24 hours, and can be restored with a paying account up to 90 days. [optional]
highlighted_date datetime The date when the score was highlighted (featured) on our community [optional]
organization str If the score has been created in an organization, the identifier of this organization. This property is especially used with the score privacy `organizationPublic`. [optional]
parent_score str If the score has been forked, the unique identifier of the parent score. [optional]
instruments List[str] An array of the instrument identifiers used in the last version of the score. This is mainly used to display a list of the instruments in Flat's UI or instruments icons. The format of the strings is `{instrument-group}.{instrument-id}`.
instruments_names List[str] An array of the instrument names used in the last version of the score. This list is localized and ready-to-display and will match the indexes from the `instruments` list.
samples List[str] An array of the audio sample identifiers used by the different score parts. The format of the strings is `{instrument-group}.{sample-id}`.
google_drive_file_id str If the user uses Google Drive and the score exists on Google Drive, this field will contain the unique identifier of the Flat score on Google Drive. You can access the document using the url: `https://drive.google.com/open?id={googleDriveFileId}` [optional]
likes ScoreLikesCounts [optional]
comments ScoreCommentsCounts [optional]
views ScoreViewsCounts [optional]
plays ScorePlaysCounts [optional]
collections List[str] The list of parent collections this score is included in. Please note that you might not have access to all of them. [optional]
me ScoreDetailsAllOfMe [optional]

Example

from flat_api.models.score_details import ScoreDetails

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

# convert the object into a dict
score_details_dict = score_details_instance.to_dict()
# create an instance of ScoreDetails from a dict
score_details_from_dict = ScoreDetails.from_dict(score_details_dict)

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