aiqihz / vlc-ios Goto Github PK

This is the official mirror repository of VLC for iOS and tvOS application.

You can find the official repository here.

It's currently written in Objective-C / Swift and uses VLCKit, a libvlc wrapper.

• Requirements
• Building
  • VLC-iOS
  • Custom VLCKit
  • Beginner's Guide
• Contribute
  • Pull request
  • Commit
  • Gitlab issues
• Communication
  • Forum
  • Issues
  • IRC
• Code of Conduct
• License
• More

• Xcode 11.0+
• macOS 10.12+
• Cocoapods 1.4+

1. Clone VLC-iOS:

   git clone https://code.videolan.org/videolan/vlc-ios.git

2. Run the command [sudo] gem install cocoapods (and then [sudo] arch -x86_64 gem install ffi on Apple Silicon devices).

3. Run pod install (or arch -x86_64 pod install on Apple Silicon devices).

4. Open VLC.xcworkspace.

5. Hit "Build and Run".

Mostly for debugging or advanced users, you might want to have a custom local VLCKit build.

1. Clone VLCKit:

   git clone https://code.videolan.org/videolan/VLCKit.git

2. Inside the VLCKit folder, run the following command:

   ./compileAndBuildVLCKit.sh -a ${MYARCH}

   MYARCH can be x86_64 or aarch64.

   Add -d for a debug build (to have valid stack straces and asserts).

   Add -n if you want to use you own VLC repository for VLCKit (See VLCKit README.md).

3. Replace the MobileVLCKit.framework with the one you just built.

   Inside your vlc-ios folder, after a pod update, do:

   cd Pods/MobileVLCKit

   rm -rf MobileVLCKit.framework

   ln -s ${VLCKit}/build/MobileVLCKit.framework

4. Hit "Build and Run".

Can't get your project to build or run? Head over to the beginner's guide for help on common issues beginners tend to run into.

If you can't find your problem on the guide, please feel free to submit an issue.

Pull request are more than welcome! If you do submit one, please make sure to use a descriptive title and description.

We try to follow a simple set of rules, outlined by this guide.

Additionally, commit messages should have all the information needed to understand the commit easily as the following:

    Subject: Brief description

    Description in detail if needed.

    ticket related action

    UPnP: Remove iOS 7 compatibility code

    Closes #166