README.md 2.01 KB
Newer Older
Geoffrey Métais's avatar
Geoffrey Métais committed
1
# VLC for Android
2 3 4 5
This is the official **Android** port of [VLC](https://videolan.org/vlc/).

VLC on Android plays all the same files as the classical version of VLC, and features a media database
for Audio and Video files and stream.
Geoffrey Métais's avatar
Geoffrey Métais committed
6 7

## License
8 9 10
VLC for Android is licensed under GPLv2 (or later). Android libraries makes this, de facto, a GPLv3 application.

VLC engine *(libvlc)* for Android is licensed under LGPL.
Geoffrey Métais's avatar
Geoffrey Métais committed
11 12 13 14

## Build

You will need a recent Linux distribution to build VLC.
15
It should work with Windows 10, and macOS, but there is no official support for this.
Geoffrey Métais's avatar
Geoffrey Métais committed
16 17 18 19 20 21 22

Check our [AndroidCompile wiki page](https://wiki.videolan.org/AndroidCompile/)

## Contribute

VLC is a libre and open source project, we welcome all contributions.

23 24
Just respect our [Code of Conduct](https://wiki.videolan.org/CoC/).

Geoffrey Métais's avatar
Geoffrey Métais committed
25 26
### Pull requests

27
Pull requests can be proposed here or on our [github mirror](https://github.com/videolan/vlc-android).
Geoffrey Métais's avatar
Geoffrey Métais committed
28 29 30

### Sending patches to the mailing list

31
Check [our wiki page on how to send patches](https://wiki.videolan.org/Sending_Patches_VLC/)
Geoffrey Métais's avatar
Geoffrey Métais committed
32 33
Send them to the android mailing list: android@videolan.org, not vlc-devel.

Geoffrey Métais's avatar
Geoffrey Métais committed
34 35
## Issues and feature requests

36
VLC for Android bugtracker is hosted on [VideoLAN gitlab](https://code.videolan.org/videolan/vlc-android/issues)
Geoffrey Métais's avatar
Geoffrey Métais committed
37 38
Please look for existing issues and provide as much useful details as you can (e.g. vlc app version, device and Android version)

39
### Translations:
Geoffrey Métais's avatar
Geoffrey Métais committed
40 41 42
You can help improving translations too by joining the [transifex vlc project](https://www.transifex.com/yaron/vlc-trans/dashboard/)

## LibVLC
43
You can use our LibVLC module to power your own Android media player.
Geoffrey Métais's avatar
Geoffrey Métais committed
44
Have a look at our  [sample codes](https://code.videolan.org/videolan/libvlc-android-samples).
Geoffrey Métais's avatar
Geoffrey Métais committed
45 46 47 48

## support

- Android mailing list: android@videolan.org
49
- bugtracker: https://code.videolan.org/videolan/vlc-android/issues
Geoffrey Métais's avatar
Geoffrey Métais committed
50
- IRC: *#videolan* channel on [freenode](http://freenode.net/)
51
- VideoLAN forum: https://forum.videolan.org/
Geoffrey Métais's avatar
Geoffrey Métais committed
52
- G+ community: https://plus.google.com/u/0/communities/113615952107012455563
53