Video Settings 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
advanceSpeed number The amount of time it takes to wait until the slide automatically advances to the next slide. If set to 0, no automatic advancing is performed.
animationSpeed number The speed of the animation between slides.
backgroundColor string The background color of the slide as expressed as an HTML color.
backgroundFillMode enum This is an enumeration that defines how the background media is rendered when it does not fit exactly. Supported values are:
  • Scale To Fill = 0
    Scales the content to fit the size of itself by changing the aspect ratio of the content if necessary.
  • Scale Aspect Fit = 1
    Scales the content to fit the size of the view by maintaining the aspect ratio. any remaining area of the view’s bounds is transparent.
  • Scale Aspect Fill = 2
    Scales the content to fill the size of the view. some portion of the content may be clipped to fill the view’s bounds.
blackout boolean Determines if blackout mode is currently available.
ccliNumber string The CCLI number of the organization to appear in the slide footer.
fontName string The name of the font to use for displaying text in the slide. Default is "Verdana-Bold".
fontSize number The size of the font in the slide in points.
footerPosition string Determines the position of the footer. This can be either "off", "bottom" or "top".
footerScale number The footer font size is set to the slide font size multiplied by this value.
foregroundColor string The color of the slide text as expressed as an HTML color code.
global boolean Determines if global settings or song-specific settings should be used.
gradientColor string The color applied to the gradient mask image. Default is 000000.
gradientStyle string The only supported gradient style is currently "Fade".
margins Object The margins of the slide as expressed as a percentage of the width of the slide. Properties of the object are numbers for top, left, bottom and right.
mirrorMode boolean Determines if stage monitor mode is currently enabled.
mode string The current external video mode. Options include "off", "projector" and "stage".
playbackRate number The playback rate of motion background videos. The default value is 1.0 or normal speed.
shadowColor string The color of the text shadow. This is set to 0000007F by default, or a semi-translucent black.
shadowScale number Determines how large the shadow behind text should appear.
showBackground boolean Determines if the background should be displayed. If false, the color black is displayed.
showBackgroundMedia boolean Determines if the background image or motion video should be displayed. If turned off, the background color will be displayed.
showGradient boolean Determines if the gradient should be overlaid above the background media or colors.
showLyrics boolean Determines if the lyrics should be displayed.
showLyrics boolean Determines if the song's lyrics are displayed.
song Song Basic song information about the current song used for setting non-global properties. This includes the song identifier, title, etc.
strokeWidth number The width of the stroke surrounding the text in points. Default is 1.0.
textAlignment string The alignment of the text in the slide. This can be either "left", "center" or "right". Default is "center".
verticalAlignment string The vertical alignment of text in the slide. This can be either "top", "center", or "bottom".
wrapText string Determines how text wrapping can be blocked. Set to "off" to allow text to wrap or "slide" to adjust the font to fit the width of the slide.

Example

{
    "verticalAlignment": "center",
    "footerScale": 0.333334,
    "showBackground": true,
    "playbackRate": 1,
    "margins": {
        "left": 0.04,
        "top": 0.04,
        "bottom": 0.04,
        "right": 0.04
    },
    "shadowScale": 0.5,
    "blackout": false,
    "global": true,
    "song": {
        "ID": "22275A4E-38D4-4106-84C3-67F891E4C820",
        "title": "Sample Song",
        "usefile": false,
        "key": "G"
    },
    "footerPosition": "bottom",
    "animationSpeed": 0.5,
    "shadowColor": "0000007F",
    "showBackgroundMedia": false,
    "strokeWidth": 1,
    "backgroundColor": "000000",
    "gradientColor": "000000",
    "fontName": "Verdana-Bold",
    "showLyrics": true,
    "showGradient": true,
    "mode": "off",
    "fontSize": 40,
    "advanceSpeed": 0,
    "textAlignment": "center",
    "gradientStyle": "Fade",
    "mirrorMode": false,
    "ccliNumber": null,
    "wrapText": "slide",
    "foregroundColor": "FFFFFF",
    "backgroundFillMode": 2
}