# Background Data

Background data is used by Sonolus app to drive a background's rendering.

# Resource Type

JSON resource.

.json is the only supported format, and must also be GZip compressed.

# Syntax

type BackgroundData = {
    aspectRatio: number
    fit: 'width' | 'height' | 'contain' | 'cover'
    color: string
}

# aspectRatio

Aspect ratio of the background image.

# fit

Fitting strategy when background image aspect ratio does not match screen aspect ratio.

# color

HTML color string for background color.

Supported formats: #RGB, and #RRGGBB.

# Examples

{
    "aspectRatio": 1.778,
    "fit": "cover",
    "color": "#000000"
}