README.txt 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. _ _ __ __ _ _
  2. /\ | (_) | \/ | | | | |
  3. / \ _ _ __| |_ ___ | \ / | ___ __| |_ _| | ___
  4. / /\ \| | | |/ _` | |/ _ \ | |\/| |/ _ \ / _` | | | | |/ _ \
  5. / ____ \ |_| | (_| | | (_) | | | | | (_) | (_| | |_| | | __/
  6. /_/ \_\__,_|\__,_|_|\___/ |_| |_|\___/ \__,_|\__,_|_|\___|
  7. =================================================================
  8. Standard Audio Module - ArOZ Online BETA Standard Functional Module
  9. # Introduction
  10. The standard audio module for ArOZ Online BETA allow user to play
  11. audio files within the system and support ArOZ background worker.
  12. # Functions
  13. 1. Audio Controls include "Play", "Pause", "Stop", "Next Song",
  14. "Previous Song", "Vol up", "Vol Down", "Repeat Mode".
  15. 2. Song list generated from "uploads/" directory
  16. 3. Download Mode (Enable via bottom menu)
  17. 4. Upload Mode (Require ArOZ Online Upload Manager)
  18. 5. Share Mode (Require IMUS QuickSend portable)
  19. # API
  20. ## Index.php - Standard playing interface
  21. The Standard Audio Modules support API callback with GET variables.
  22. The following are the format and examples for API access:
  23. Audio/?share=file_path_to_audio_file&display=display_file_name&id=file_id_in_list
  24. file_path_to_audio_file is the path to the files under uploads/.
  25. display_file_name is the converted name for the file.
  26. file_id_in_list is the id for the required audio in playlist.
  27. For Example:
  28. Audio/?share=uploads/inith47726973616961206e6f204b616a6974737520454434205375622045737061c3b16f6c.mp3
  29. &display=Grisaia no Kajitsu ED4 Sub Español&id=6
  30. will play the file with path:
  31. uploads/inith47726973616961206e6f204b616a6974737520454434205375622045737061c3b16f6c.mp3
  32. and display the song name as:
  33. Grisaia no Kajitsu ED4 Sub Español
  34. which is located in the playlist of item number:
  35. 6
  36. ## Using the standard playing interface for playing external audio source
  37. The standard playing interface can be used to play external audio source with the following command:
  38. Audio/?share=url_to_file&display=display_file_name&id=-1
  39. For example,
  40. Audio/?share=http://example.com/test.mp3&display=Testing Song&id=-1
  41. The above url will play the audio at:
  42. http://example.com/test.mp3
  43. And display it as:
  44. Testing Song
  45. (C)IMUS Laboratory 2016-2017
  46. Licensed under MIT