Skip to contents

Save a sonification as a video with a moving chart

Source: R/video.R
sonify_video.Rd

sonify_video() makes an MP4 video of your sonification: a chart of the data, with a playhead that moves across it and marks that fill in as each note plays, and the sound as the soundtrack. Videos are handy where audio players aren't allowed, like a GitHub README, social media or slides.

Usage

sonify_video(
  x,
  path,
  plot = NULL,
  title = NULL,
  subtitle = NULL,
  caption = NULL,
  x_label = NULL,
  y_label = NULL,
  theme = NULL,
  title_position = c("plot", "panel"),
  point_color = NULL,
  playhead_color = "#c8102e",
  highlight_color = "#f2efe6",
  width = 1280,
  height = 720,
  fps = 12
)

Arguments

x

A sonification made by sonify_data(), sonify_histogram() or sonify_density().

path

Where to save the video. Must end in .mp4.

plot

Optional. A chart made with sonify_plot() from this same sonification, customized however you like.

title, subtitle, caption

Optional text for the chart.

x_label, y_label

Axis labels. By default, the names of the columns you mapped.

theme

Optional. A ggplot2 theme, complete (like ggplot2::theme_classic()) or partial (like ggplot2::theme(plot.title = ggplot2::element_text(size = 24))). It's added last, so it overrides soundeR's defaults.

title_position

"plot" (the default) lines titles and captions up with the whole image; "panel" lines them up with the plot panel.

point_color

Color for the dots (or bars, or curve). With more than one voice, one color per voice, in order or named by voice; by default each voice gets its own color from a colorblind-friendly palette.

playhead_color, highlight_color

Colors for the moving playhead and the band behind the row that's playing.

width, height

Size of the video in pixels.

fps

Frames per second. Higher is smoother but slower to make.

Value

path, invisibly.

Details

The chart is the one sonify_plot() draws. To change more than the title, labels and theme, build it yourself with sonify_plot(), add to it like any ggplot, and pass it in with plot =.

Examples

if (FALSE) { # \dontrun{
luge_finals |>
  sonify_data(time = behind, time_scale = 1, sequence = event, instrument = "piano") |>
  sonify_video(
    "luge.mp4",
    title = "Fractions of a second",
    subtitle = "Each note is a sled crossing the finish line",
    x_label = "Seconds behind the winner",
    theme = ggplot2::theme_classic()
  )
} # }