/hxvlc

A Haxe/OpenFL library for @:native video playback using libVLC.

Primary LanguageCMIT LicenseMIT

hxvlc

A Haxe/OpenFL library for @:native video playback using libVLC.

Supported Platforms

  • Windows (x86_64 only)
  • MacOS (x86_64 and arm64 only)
  • Linux
  • Android (arm64, armv7a, x86, and x86_64 only)
  • iOS (arm64 and simulator only)

Caution

These platforms need to be compiled using Lime targeting cpp to work.

Installation

To install hxvlc, follow these steps:

  1. Haxelib Installation
    • Install the library using Haxelib: 
      haxelib install hxvlc
  2. Git Installation (for latest updates)
    • Alternatively, clone the repository using Git: 
      haxelib git hxvlc https://github.com/MAJigsaw77/hxvlc.git
  3. Project Configuration
    • Add the following code to your project.xml file: 
      <section if="cpp">
	<haxelib name="hxvlc" if="desktop || mobile" />
</section>

Dependencies

On Linux you need to install vlc from your distro's package manager.

Commands list

Debian based distributions (Debian):

sudo apt-get install vlc libvlc-dev libvlccore-dev vlc-bin

Arch based distributions (Arch):

sudo pacman -S vlc

Fedora based distributions (Fedora):

sudo dnf install vlc

Red Hat Enterprise Linux (RHEL):

sudo dnf install epel-release
sudo dnf install vlc

openSUSE based distributions (openSUSE):

sudo zypper install vlc

Gentoo based distributions (Gentoo):

sudo emerge media-video/vlc

Slackware based distributions (Slackware):

sudo slackpkg install vlc

Void Linux (Void Linux):

sudo xbps-install -S vlc

NixOS (NixOS):

nix-env -iA nixpkgs.vlc

Getting Started

  • Explore the Samples Folder for examples of using this library with OpenFL and Flixel.

  • Visit the API Documentation for detailed information on available functionalities.

Licensing

hxvlc is made available under the MIT License. Check LICENSE for more information.

libVLC is released under the LGPLv2 (or later) License.

For more information, visit VideoLAN.org.