https://github.com/ashbaldry/howler

Shiny extension of howler.js
https://github.com/ashbaldry/howler

audio r shiny

Last synced: 3 months ago
JSON representation

Shiny extension of howler.js

• Host: GitHub
• URL: https://github.com/ashbaldry/howler
• Owner: ashbaldry
• License: other
• Created: 2021-06-25T20:45:56.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-04T18:52:07.000Z (5 months ago)
• Last Synced: 2024-07-06T18:22:07.557Z (4 months ago)
• Topics: audio, r, shiny
• Language: R
• Homepage: https://ashbaldry.github.io/howler
• Size: 7.22 MB
• Stars: 15
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - ashbaldry/howler - Shiny extension of howler.js (R)

README

        


[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![Codecov test coverage](https://codecov.io/gh/ashbaldry/howler/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ashbaldry/howler?branch=main)

[![R-CMD-check](https://github.com/ashbaldry/howler/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ashbaldry/howler/actions/workflows/R-CMD-check.yaml)

# {howler}  - Interactive Audio Player 

`{howler}` is a package that utilises the [howler.js](https://github.com/goldfire/howler.js) library to play audio on the modern web. 

## Installation

This package is available on CRAN and r-universe. To install the latest version: 

```r

install.packages("devtools")

devtools::install_github("ashbaldry/howler")

```

## Usage

The HTML way to include an audio file in any shiny application/web page is to use the `` tag. This can generally only handle one audio file, and cannot (easily) be manipulated from the server side. 

```r

tags$audio(src = "audio/sound.mp3", type = "audio/mp3", autoplay = NA, controls = NA)

```

howler.js uses the [Web Audio API](https://webaudio.github.io/web-audio-api/), and with this we are able to create an audio player that can solve both of the above issues and more:

```r

library(shiny)

library(howler)

ui <- fluidPage(

  title = "howler Example",

  howler(

    elementId = "sound", 

    tracks = list("Track 1" = "audio/track_1.mp3", "Track 2" = "audio/track_2.mp3"),

    auto_continue = TRUE,

    auto_loop = TRUE,

    seek_ping_rate = 1000

  ),

  howlerPreviousButton("sound"),

  howlerPlayPauseButton("sound"),

  howlerNextButton("sound")

)

server <- function(input, output, session) {

  observe({

    req(input$sound_seek)

    if (round(input$sound_seek) == 10) {

      pauseHowl("sound")

    } else if (round(input$sound_seek) == 20) {

      changeTrack("sound", "Track 2")

    }

  })

}

shinyApp(ui, server)

```

### Module

The `{howler}` package also includes a lightweight module `howlerModuleUI` and `howlerModuleServer` that adds a bit of styling to replicate the style of a standard `` HTML player.

![Howler module UI](man/figures/howler_module.png)

## Examples

All examples are available in the [Examples](https://github.com/ashbaldry/howler/tree/main/inst/examples) directory and can be run locally by installing the `{howler}` package:

- [Basic Player](https://github.com/ashbaldry/howler/tree/main/inst/examples/basic)

- [Full Controls](https://github.com/ashbaldry/howler/tree/main/inst/examples/full)

- [Module Player](https://github.com/ashbaldry/howler/tree/main/inst/examples/module)

- [Server-Side Controls](https://github.com/ashbaldry/howler/tree/main/inst/examples/server)