You are here

README.txt in AudioField 7

AUDIOFIELD.MODULE
--------------------------------------------------------------------------------
This module allows embedding an audio file in a CCK field
This module is for adding new field that allows embedding an mp3 audio.

This module will use the built-in HTML5 MP3 Player to play your audio files by
default, but you may choose one of several other supported players:
1. WordPress Audio Player
    http://wpaudioplayer.com/download
    * Note: make sure you should download the standalone edition
2. XSPF Slim Player
    https://sourceforge.net/projects/musicplayer/files/latest/download
3. XSPF Button Player
    http://prdownloads.sourceforge.net/musicplayer/button_player-0.1.zip
4. SoundManager 2
    http://www.schillmania.com/projects/soundmanager2/
5. Flowplayer
    Install the Flowplayer module
    http://drupal.org/project/flowplayer
6. jPlayer
    Install the jPlayer module
    http://drupal.org/project/jplayer
6. wavesurfer.js 2.0
    https://github.com/katspaugh/wavesurfer.js/

The resulting folder structure should resemble the following (you may need to
rename the folders and files to match):

> The standalone WordPress player should be at:
/sites/all/libraries/player/audio-player/player.swf

> The XSPF slim player should be at:
/sites/all/libraries/player/xspf_player_slim.swf

> The XSPF button player should be at:
/sites/all/libraries/player/button/musicplayer.swf

> The Sound Manager 2 player should be at:
/sites/all/libraries/player/soundmanager2

> The jPlayer player should be at:
/sites/all/libraries/player/jplayer/jquery.jplayer.min.js

> The wavesurfer.js player should be at:
/sites/all/libraries/player/wavesurfer/dist/wavesurfer.min.js

This module gives you the ability to choose the audio player you would like to
use on your web site from many audio players, from the configuration page.

Finally you have to put any mp3 audio file at "\sites\all\libraries\player\"
and you have to name it as Sample_Track.mp3, this step just to gives the ability
to test all audio players before you choose your default audio player

API:
Originally this module supports mp3, wav, ogg, opus, and webm audio files.
Other modules can extend this support by implementing hook_audiofield_players().

DISPLAY FORMATTERS
--------------------------------------------------------------------------------
The display formatter is called "AudioField Player". You can choose which type
of player you want to use, as well as other settings in the formatter settings
located under Content -> Fields -> Manage Display.

MAINTAINERS
--------------------------------------------------------------------------------
Tamer Zoubi - <tamerzg@gmail.com>
Daniel Moberly - <daniel.moberly@gmail.com>

File

README.txt
View source
  1. AUDIOFIELD.MODULE
  2. --------------------------------------------------------------------------------
  3. This module allows embedding an audio file in a CCK field
  4. This module is for adding new field that allows embedding an mp3 audio.
  5. This module will use the built-in HTML5 MP3 Player to play your audio files by
  6. default, but you may choose one of several other supported players:
  7. 1. WordPress Audio Player
  8. http://wpaudioplayer.com/download
  9. * Note: make sure you should download the standalone edition
  10. 2. XSPF Slim Player
  11. https://sourceforge.net/projects/musicplayer/files/latest/download
  12. 3. XSPF Button Player
  13. http://prdownloads.sourceforge.net/musicplayer/button_player-0.1.zip
  14. 4. SoundManager 2
  15. http://www.schillmania.com/projects/soundmanager2/
  16. 5. Flowplayer
  17. Install the Flowplayer module
  18. http://drupal.org/project/flowplayer
  19. 6. jPlayer
  20. Install the jPlayer module
  21. http://drupal.org/project/jplayer
  22. 6. wavesurfer.js 2.0
  23. https://github.com/katspaugh/wavesurfer.js/
  24. The resulting folder structure should resemble the following (you may need to
  25. rename the folders and files to match):
  26. > The standalone WordPress player should be at:
  27. /sites/all/libraries/player/audio-player/player.swf
  28. > The XSPF slim player should be at:
  29. /sites/all/libraries/player/xspf_player_slim.swf
  30. > The XSPF button player should be at:
  31. /sites/all/libraries/player/button/musicplayer.swf
  32. > The Sound Manager 2 player should be at:
  33. /sites/all/libraries/player/soundmanager2
  34. > The jPlayer player should be at:
  35. /sites/all/libraries/player/jplayer/jquery.jplayer.min.js
  36. > The wavesurfer.js player should be at:
  37. /sites/all/libraries/player/wavesurfer/dist/wavesurfer.min.js
  38. This module gives you the ability to choose the audio player you would like to
  39. use on your web site from many audio players, from the configuration page.
  40. Finally you have to put any mp3 audio file at "\sites\all\libraries\player\"
  41. and you have to name it as Sample_Track.mp3, this step just to gives the ability
  42. to test all audio players before you choose your default audio player
  43. API:
  44. Originally this module supports mp3, wav, ogg, opus, and webm audio files.
  45. Other modules can extend this support by implementing hook_audiofield_players().
  46. DISPLAY FORMATTERS
  47. --------------------------------------------------------------------------------
  48. The display formatter is called "AudioField Player". You can choose which type
  49. of player you want to use, as well as other settings in the formatter settings
  50. located under Content -> Fields -> Manage Display.
  51. MAINTAINERS
  52. --------------------------------------------------------------------------------
  53. Tamer Zoubi -
  54. Daniel Moberly -