Song Object
The song object contains detailed information about a song in the library. This is used to retrieve and update song information.
Parameters
Name | Type | Description |
---|---|---|
adjustForCapo | boolean | Determines if the capo value should be applied to transpose the song. |
artist | string | The artist or byline of the song. |
capo | int | The capo to apply to the song. Default is 0. |
chordPosition | enum |
Determine the position of chord placement for the song:
|
chords | Array | Returns an array of objects that provide the preferred variations for chord diagrams. |
chordStyle | enum |
Determines the style of chords to use such as:
|
created | date | The date and time the song was originally created. Readonly. |
diagramPosition | enum |
Determines the placement of chord diagrams when enabled using the showTablature property.
|
dualChordDisplayStyle | enum | Determines if and how dual chords are displayed. This can be one of the following values:
|
duration | number | The duration of the song in seconds. |
favorite | enum |
Determines if the song has been marked as favorited.
|
ID | string | The unique identifier of the song. Readonly. |
imported | boolean | Determines if the song was created through an import process. Readonly. |
instrument | string | The preferred instrument used for the song which effects the chord diagrams that are drawn. |
key | string | The original key of the song. Readonly. |
keywords | string | The keywords set for the song. |
midi | string | The MIDI data associated with the song. |
modified | date | The date and time the song was last modified. Readonly. |
number | string | The song number applied to the song for organization. |
performTransposition | boolean | Determines if transposition should be applied to the song. |
repeatMode | enum |
Determines the audio playback repeat mode set for the song. Options include:
|
restrictions | int | The bitwise mask used to determine the restrictions placed on the song. |
showChords | boolean | Determines if the song's chords are displayed. |
showExpanded | boolean | Determines if the song should be expanded according to it's flow. |
showLyrics | boolean | Determines if the song's lyrics are displayed. |
showMetadata | boolean | Determines if the metadata of the song is displayed. |
showNotes | boolean | Determines if sticky notes are displayed. |
showTablature | boolean | Determines if the chord diagrams are displayed. |
showTitle | boolean | Determines if the song title is displayed. |
stickyNotes | array | Contains an array of sticky notes to be applied to the page. |
styles | object | Contains the basic stylization characteristics of the song. See Styles Object for details. |
tablatureSize | number | The size of the chord diagrams as a percentage of the width of the page. |
tempo | number | The tempo of the song in beats per minute (BPM) |
timeSignature | string | The time signature of the song as expressed like "3/4". |
title | string | The title of the song. |
transposedKey | string | The key to which the song should be transposed into. |
usefile | boolean | Determines if an external file should be used in the display of the song. |
user | string | The unique identifier of the user who created the song. Readonly. |
zoomPointX | number | The X-position of the song when zoom/position remembering is enabled. |
zoomPointY | number | The Y-position of the song when zoom/position remembering is enabled. |
zoomScale | number | The current zoom scale of the song when zoom/position remembering is enabled. |
Example
{ "dualChordDisplayStyle": 0, "diagramPosition": 0, "chordPosition": 0, "chordStyle": 0, "favorite": 0, "zoomPointY": 0, "showNotes": true, "keywords": "", "adjustForCapo": true, "showLyrics": true, "zoomScale": 1, "copyright": "2012 Hillsong Music Publishing (Admin. by EMI Christian Music Publishing)", "chords": [ { "chord": "Bm7", "variation": "x20202" }, { "chord": "A/C#", "variation": "002220" }, { "chord": "D", "variation": "x00232" }, { "chord": "A", "variation": "002220" }, { "chord": "G", "variation": "320003" }, { "chord": "Asus", "variation": "002230" }, { "chord": "Bm", "variation": "224432" }, { "chord": "Dsus", "variation": "xx0233" }, { "chord": "Em", "variation": "022000" } ], "key": "D", "ccli": "6428767", "imported": true, "showExpanded": true, "repeatMode": 1, "transposedKey": "D", "instrument": "guitar", "showMetadata": true, "performTransposition": true, "showTitle": true, "user": "ECF80040-9B21-47A8-AEC7-8E6518F42F88", "restrictions": 436, "tablatureSize": 0.16666, "showChords": true, "ID": "8FB10FA8-4378-4DF2-BCC2-5990BF3B9763", "modified": "2014-07-04T23:47:20-04:00", "zoomPointX": 0, "styles": { "monospacedFontColor": "000000", "fontSize": 14, "chordFontName": "Helvetica", "headerFontColor": "000000", "fontName": "Helvetica", "fontColor": "000000", "headerFontSize": 21, "lineSpacing": 1, "metadataFontName": "Helvetica", "monospacedFontName": "Courier", "monospacedFontSize": 14, "chordFontColor": "000000", "metadataFontColor": "000000", "headerFontName": "Helvetica-Bold", "highlightColor": "FFFFFF", "chordFontSize": 14, "metadataFontSize": 14 }, "usefile": false, "created": "2014-07-04T23:47:20-04:00", "artist": "Hillsong United", "showTablature": false, "title": "Oceans (Where Feet May Fail)", "stickyNotes": [] }