Skip to content

Latest commit

 

History

History
86 lines (80 loc) · 4.67 KB

ScoreDetails.md

File metadata and controls

86 lines (80 loc) · 4.67 KB

FlatApi::ScoreDetails

Properties

Name Type Description Notes
id String The unique identifier of the score
sharing_key String The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) [optional]
title String The title of the score
privacy ScorePrivacy [default to 'private']
user UserPublic
html_url String The url where the score can be viewed in a web browser
subtitle String Subtitle of the score [optional]
lyricist String Lyricist of the score [optional]
arranger String Arranger of the score [optional]
composer String Composer of the score [optional]
description String Description of the creation [optional]
tags Array<String> Tags describing the score [optional]
creation_type ScoreCreationType [optional]
license ScoreLicense [optional]
license_text String Additional license text written on the exported/printed score [optional]
duration_time Float In seconds, an approximative duration of the score [optional]
number_measures Integer 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
collaborators Array<ResourceCollaborator> The list of the collaborators of the score
creation_date Time The date when the score was created
modification_date Time The date of the last revision of the score [optional]
publication_date Time The date when the score was published on Flat [optional]
highlighted_date Time The date when the score was highlighted (featured) on our community [optional]
organization String 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 String If the score has been forked, the unique identifier of the parent score. [optional]
instruments Array<String> 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 the Flat's UI or instruments icons. The format of the strings is `{instrument-group}.{instrument-id}`.
samples Array<String> An array of the audio samples identifiers used the different score parts. The format of the strings is `{instrument-group}.{sample-id}`.
google_drive_file_id String 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&#x3D;{googleDriveFileId}&#x60; [optional]
likes ScoreLikesCounts [optional]
comments ScoreCommentsCounts [optional]
views ScoreViewsCounts [optional]
plays ScorePlaysCounts [optional]
collections Array<String> The List of parent collections, which includes all the collections this score is included. Please note that you might not have access to all of them. [optional]

Example

require 'flat_api'

instance = FlatApi::ScoreDetails.new(
  id: null,
  sharing_key: null,
  title: null,
  privacy: null,
  user: null,
  html_url: null,
  subtitle: null,
  lyricist: null,
  arranger: null,
  composer: null,
  description: null,
  tags: null,
  creation_type: null,
  license: null,
  license_text: null,
  duration_time: null,
  number_measures: null,
  main_tempo_qpm: null,
  main_key_signature: null,
  rights: null,
  collaborators: null,
  creation_date: null,
  modification_date: null,
  publication_date: null,
  highlighted_date: null,
  organization: null,
  parent_score: null,
  instruments: null,
  samples: null,
  google_drive_file_id: null,
  likes: null,
  comments: null,
  views: null,
  plays: null,
  collections: null
)