Table of Contents

• About the Project
• Screenshots
  • Player
  • Playlist detailed
  • Playlist simple
  • Youtube search
  • Youtube download
• Getting Started
  • Prerequisites
  • Installation and running
• Functionality
• Contributing
• License
• Contact

About The Project

This project is developed in my spare time after work as a proof of concept ionic 4 media player.

Screenshots

Player

Playlist detailed

Playlist simple

Youtube search

Youtube download

Getting started

Prerequisites

Before running this app, node (and perhaps nvm), ionic 4 and angular (and possibly angular -cli) have to be installed

Installation and running

1. Clone the repo

https://github.com/pawelpaszki/ionic-4-media-player.git

2. Install NPM packages

cd ionic-4-media-player && npm install

3. Run in the browser (limited functionality - probably overview only, as the majority of the functionality is only available on Android (did not test on on iOS -> more than likely file related stuff will not work))

ng serve

4. Run on device (-l -> live reload)

ionic cordova run android -l

Functionality and its status

• loading and removing local media to/from the playlist
• playback of local media from the playlist
• rearranging the playlist song by song
• displaying the playlist in card with album image (if present) or in plain list
• marking songs as favourite
• renaming songs
• Persitence:
  • playlist with the info about the songs, including:
    • name
    • favourite flag
    • markedForDeletion flag
    • duration
    • thumbnail
    • and more
  • shuffle (on or off)
  • repeat mode:
    • none
    • song
    • favourite
    • selected songs (select option available in the player component)
    • all
    • part of the song (it can be set to loop through the part of the song by specifying start and end - TODO)
  • selected sort (if any)
• different repeat modes (see repeat mode in the Persistence above)
• turn off timer (specifies when the media playing is to be stopped) (TODO)
• search Youtube API
• remove file from device (TODO)
• download from Youtube

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated, if there is any value to the contribution. To contribute, please:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request with the reasoning behind it

License

Distributed under the MIT License. See LICENSE for more information.

Contact

[email protected]