Skip to content

polybiusproxy/hxCodec

Repository files navigation

hxCodec

A Haxe library which adds native video playback on HaxeFlixel and OpenFL.

hxCodec is powered by libVLC.

Click here to check the roadmap

Instructions

  1. Install the latest stable version of hxCodec by running the following haxelib command.

    haxelib install hxCodec

    You can also install it through Git to get the latest changes.

    haxelib git hxCodec https://github.com/polybiusproxy/hxCodec
  2. Add this code in the project.xml file.

    <haxelib name="hxCodec" if="desktop || mobile" />

    OPTIONAL: Some defines you can add to your project

    <!-- LibVLC Logging for hxCodec -->
    <haxedef name="HXC_LIBVLC_LOGGING" if="debug" />

Linux Specific Instructions

In order to build a application with the library on Linux, you have to install libvlc and libvlccore from your distro's package manager.

Debian based distributions:

sudo apt-get install libvlc-dev libvlccore-dev 

Arch based distributions:

sudo pacman -S vlc 

Usage Example

Check out the Samples Folder for examples on how to use this library.

Licensing

hxCodec is made available under the Mozilla Public License 2.0*. Check LICENSE for more information.

*Haxelib does not support MPL2.0; therefore, regardless of what Haxelib reports, this library's license is still MPL2.0.

libVLC is the engine of VLC released under the LGPLv2 License (or later). Check VideoLAN.org for more information.

Credits

Avatar UserName Involvement
polybiusproxy Creator of hxCodec
datee Creator of HaxeVLC
MAJigsaw77 Programmer, Android & Linux support
EliteMasterEric Additional Programmer
RapperGF Rendering Overhaul & Testing
swordcube Testing Linux support
Jonnycat macOS support
FutureDorito iOS support
mcagabe19 iOS support