【Rails】audiojs-railsの導入からオーディオファイル再生までの手順

2022年6月15日 22:17

はじめに

HTML5にはオーディオファイルを埋め込む専用のタグが用意されています。
<audio src="sample/sample.ogg" controls>
<p>音声を再生するには、audioタグをサポートしたブラウザが必要です。</p>
</audio>
このaudioタグをより便利にしたJavaScriptライブラリ「audio.js」を使えば、見た目のカスタマイズやプレイリストの追加が簡単に行えるようになります。
Railsアプリでは「audiojs-rails」というRuby gemsが提供されているので使います。
また、Railsにはaudioタグのヘルパーメソッドが用意されているのでこれも使います。
<%= audio_tag 'sample.mp3' %>

audiojs-railsの導入

Gemfileに以下を追加してbundle installを行います。
※rails serverを起動している場合は再起動してください。
gem 'audiojs-rails'

audiojsの読み込み

app/assets/javascripts/application.jsに以下を追加します。
//= require audiojs

audiojsの初期化・再生プレイヤー設置

Viewに以下を追加します。
<!-- 再生プレイヤー -->
<%= audio_tag 'sample.mp3' %>

<!-- audiojsの初期化 -->
<script>
  audiojs.events.ready(function() {
    var as = audiojs.createAll();
  });
</script>

assetsパスの追加

上記で設置した再生プレイヤーで読み込んでいる「sample.mp3」は、app/assets/audios/に配置することにしましょう。
しかし、このままではアセットパイプラインで配信されないので、assetsパスを追加する必要があります。
config/initializers/assets.rbに以下を追加します。
Rails.application.config.assets.paths << Rails.root.join("app", "assets", "audios")
以下のコマンドでassetsパスが追加されたかを確認します。
$ rails c
> Rails.application.config.assets.paths
=> ["Your Rails app path/app/assets/audios/", ...]
> exit

再生プレイヤーのカスタマイズ(おまけ)

audio.jsで使用しているクラスを上書きすることで、再生プレイヤーの見た目を変更することができます。
/* プレイヤー(再生バー)の高さ、幅、背景色の指定 */
.audiojs { ... }
/* 再生・停止ボタンの高さ、幅、パディングの指定 */
.audiojs .play-pause { ... }
/* 再生・停止ボタンなどの p 要素 */
.audiojs p { ... }
/* 進行状態・ロードの状態を表示する部分 */
.audiojs .scrubber { ... }
/* 進行状態を表示するバーの部分 */
.audiojs .progress { ... }
/* ロード状態を表示するバーの部分 */
.audiojs .loaded { ... }
/* 再生時間の部分 */
.audiojs .time { ... }
.audiojs .error-message { ... }
 /* 再生している曲の情報 */
.track-details { ... }
.track-details:before { ... }

参考

関連記事

【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58