Coder Social home page Coder Social logo

zshaobo / vlcmedia Goto Github PK

View Code? Open in Web Editor NEW

This project forked from helmers-timo/vlcmedia

0.0 0.0 0.0 682.65 MB

Media Framework plug-in using the Video LAN Codec (libvlc).

License: BSD 3-Clause "New" or "Revised" License

Shell 3.13% C++ 86.34% C 7.16% C# 3.37%

vlcmedia's Introduction

VlcMedia

Unreal Engine 4 Media Framework plug-in using the Video LAN Codec (libvlc).

About

This plug-in is still under development and likely has a lot of remaining issues to be fixed. Use in production is not yet recommended.

Make sure to pull the Tag that matches your Unreal Engine version. If you sync to Master the code may not compile, because it may depend on Engine changes that are not yet available in the UE4 Master branch.

Supported Platforms

This plug-in was last built against Unreal Engine 4.26 and tested against the following platforms:

  • Linux (Ubuntu 16.04)
  • Mac
  • Windows

IMPORTANT: Please note that this repository contains pre-compiled binaries for libvlc and its plug-ins, which are licensed under LGPL. This means that you cannot create monolithic builds of your game without violating LGPL, the UE4 EULA or both. The libvlc libraries must remain dynamic libraries that are bound at run-time - static linking is not allowed - and the licensing related files in /ThirdParty/vlc must be retained.

This also means that this plug-in cannot work on platforms that do not support dynamically linked libraries (i.e. iOS, HTML5) or do not currently implement support for it (i.e. Android, XboxOne).

Epic is in the process of adding plug-in support to monolithic builds, but there is no ETA yet. Once this is supported, you will be able to distribute monolithic game and server builds with VlcMedia, provided that the libvlc libraries and plug-ins remain as separate DLLs.

Prerequisites

A relatively recent version of libvlc is required. The latest stable release (currently 2.2.1) is not sufficient.

For Mac and Windows, the following nightly builds are currently included:

  • macOS: vlc-4.0.0-20180319-0303-dev
  • Win32: vlc-4.0.0-20180319-0303-dev-win32
  • Win64: vlc-4.0.0-20180319-1331-dev-win64

Nightly builds can be downloaded from the VideoLAN web site (see below).

For debugging on Win32 and Win64, you can download debug builds and replace the corresponding files and folders in the VlcMedia/ThirdParty/vlc/ directory.

Linux (Ubuntu 16.04)

A suitable version of libvlc must be installed or compiled from source. If you ship your game on Linux, you will likely want to include libvlc with it, so that users don't have to install it themselves. We will eventually include those binaries in this repository, although it is not clear what distros should be supported and where the builds are coming from. A better workflow needs to be established for this (ue4plugins#17).

To clean up, clone, make and install VLC (including libvlc) into your project, run the VlcMedia/Build/Vlc4LinuxCloneMakeInstall.sh script from within your project's root folder. If you later need to make and re-install VLC from the existing VLC code, run the Vlc4LinuxMakeInstall.sh script instead.

Mac, Windows

All required libraries and plug-ins are included in the ThirdParty directory and work out of the box.

Dependencies

This plug-in requires Visual Studio and either a C++ code project or the full Unreal Engine 4 source code from GitHub. If you are new to programming in UE4, please see the official Programming Guide!

Usage

You can use this plug-in as a project plug-in, or an Engine plug-in.

If you use it as a project plug-in, clone this repository into your project's /Plugins directory and compile your game in Visual Studio. A C++ code project is required for this to work.

If you use it as an Engine plug-in, clone this repository into the /Engine/Plugins/Media directory and compile your game. Full Unreal Engine 4 source code from GitHub is required for this.

References

vlcmedia's People

Contributors

gmpreussner avatar helmers-timo avatar anselm avatar alexei-kondratiev avatar khartnjava avatar steyrboy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.