- FLAC (
audio/flac) - MP3 (
audio/mpeg) - Vorbis in OGG container (
audio/ogg) - Opus in OGG container (
audio/oggoraudio/opus) - All formats listed for your browser on this table
Note: it might be unable to play some particular files.
Note: sometimes it might be unable to play all FLAC and MP3 files (especially in Firefox), in this case restarting the browser may help.
This app utilizes 2 backend players: Aurora.js and SoundManager2.
Aurora.js uses Javascript and HTML5 Audio API to decode and play music, it doesn't use the browser's built-in codec. This app choose Aurora.js for FLAC and MP3 files.
SoundManager2 utilizes the browser's built-in codec, This app choose SoundManager2 for OGG files.
Following commands are available(see script occ in your ownCloud root folder):
./occ music:scan USERNAME1 USERNAME2 ...
This scans all not scanned music files of the user USERNAME and saves the extracted metadata into the music tables in the database. This is also done if you browse the music app web interface. There the scan is done in steps of 20 tracks and the current state is visible at the bottom of the interface.
./occ music:scan --all
This scans music files for all users.
Both of the above commands can be combined with the --debug switch, which enables debug output and shows the memory usage of each scan step.
Warning: This command will delete data! It will remove unavailable tracks from playlists as playlists are linked against the track metadata.
./occ music:reset-database USERNAME1 USERNAME2 ...
This will reset the scanned metadata of the provided users.
./occ music:reset-database --all
This will reset the scanned metadata of all users.
In the settings the URL you need for Ampache is listed and looks like this:
https://cloud.domain.org/index.php/apps/music/ampache/
This is the common path. Some clients append the last part (server/xml.server.php) automatically. If you have connection problems try the longer version of the URL with the server/xml.server.php appended.
To use Ampache you can't use your ownCloud password. Instead, you need to generate APIKEY for Ampache. Go to "Your username" → "Personal", and check section Music/Ampache, where you can generate your key. Enter your ownCloud username and the generated key as password to your client.
Music App can be installed using the App Management in ownCloud. Instructions can be found here.
The current version doesn't scale well for huge music collections. There are plans for a kind of paginated version, which hides the pagination and should be useable as known before. #78
The current music app can't be installed and ownCloud prints following error message: "Application can not be activated because of illegal code". This is due to the appcodechecker in core (which is kind of broken), but you can do the installation if the appcodechecker is deactivated:
- set
appcodecheckertofalseinconfig.php(see the config.sample.php ) - now you can install the app
- afterwards re-enable the appcodechecker
Sometimes translatable strings aren't detected. Try to move the translate attribute
more to the beginning of the HTML element.
git archive HEAD --format=zip --prefix=music/ > build/music.zip
composer install
PHP unit tests
phpunit --coverage-html coverage-html-unit --configuration tests/php/unit/phpunit.xml tests/php/unit
PHP integration tests
cd ../.. # owncloud core
./occ maintenance:install --admin-user admin --admin-pass admin --database sqlite
./occ app:enable music
cd apps/music
phpunit --coverage-html coverage-html-integration --configuration tests/php/integration/phpunit.xml tests/php/integration
Behat acceptance tests
cd tests
cp behat.yml.dist behat.yml
# add credentials for Ampache API to behat.yml
../vendor/bin/behat
For the acceptance tests you need to upload all tracks of the following 3 artists:
- https://www.jamendo.com/de/artist/435725/simon-bowman
- https://www.jamendo.com/de/artist/351716/diablo-swing-orchestra
- https://www.jamendo.com/de/artist/3573/pascalb-pascal-boiseau
update JavaScript libraries
cd js
bower update
The music app implements the Shiva API except the resources /artists/<int:artist_id>/shows, /tracks/<int:track_id>/lyrics and the meta resources. You can use this API under https://own.cloud.example.org/index.php/apps/music/api/.
Beside those mentioned resources following additional resources are implemented:
/api/log/api/collection/api/file/{fileId}/api/scan- Playlist API at
/api/playlist/ - Settings API at
/api/settings - Ampache API at
/ampache/server/xml.server.php
Allows to log a message to ownCloud defined log system.
POST /api/log
Parameters:
{
"message": "The message to log"
}
Response:
{
"success": true
}
Returns all artists with nested albums and each album with nested tracks.
GET /api/collection
Response:
[
{
"id": 2,
"name": "Blind Guardian",
"albums": [
{
"name": "Nightfall in Middle-Earth",
"year": 1998,
"cover": "/index.php/apps/music/api/album/16/cover",
"id": 16,
"tracks": [
{
"title": "A Dark Passage",
"number": 21,
"artistId": 2,
"albumId": 16,
"files": {
"audio/mpeg": "https://own.cloud.example.org/remote.php/webdav/Blind Guardian/1998 - Nightfall in Middle-Earth/21 - A Dark Passage.mp3"
},
"id": 202
},
{
"title": "Battle of Sudden Flame",
"number": 12,
"artistId": 2,
"albumId": 16,
"files": {
"audio/mpeg": "https://own.cloud.example.org/remote.php/webdav/Blind Guardian/1998 - Nightfall in Middle-Earth/12 - Battle of Sudden Flame.mp3"
},
"id": 212
}
]
}
]
},
{
"id": 3,
"name": "blink-182",
"albums": [
{
"name": "Stay Together for the Kids",
"year": 2002,
"cover": "/index.php/apps/music/api/album/22/cover",
"id": 22,
"tracks": [
{
"title": "Stay Together for the Kids",
"number": 1,
"artistId": 3,
"albumId": 22,
"files": {
"audio/mpeg": "https://own.cloud.example.org/remote.php/webdav/blink-182/2002 - Stay Together for the Kids/01 - Stay Together for the Kids.mp3"
},
"id": 243
},
{
"title": "The Rock Show (live)",
"number": 2,
"artistId": 3,
"albumId": 22,
"files": {
"audio/mpeg": "https://own.cloud.example.org/remote.php/webdav/blink-182/2002 - Stay Together for the Kids/02 - The Rock Show (live).mp3"
},
"id": 244
}
]
}
]
}
]