ARVideoBrowser

An augmented reality application to browse and view videos!
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • ARVideoBrowser Scripts
   • Built With
   • Built For
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

🏠 About The Project

ARVideoBrowser is an augmented reality video browser. In this application, you can use the microphone to query for a video using voice. The ARVideoBrowser will then play a video for that voice query. You can then move the video around and increase or decrease the size of the video.

ARVideoBrowser Scripts

ARVideoBrowser-scripts is the other part of this application. It is available here. It returns an URL for a search query, which plays the video. For a more detailed guide on using this, explore the docs here.

Built With

Unity: A cross-platform game engine.

Built For

Devices running iOS and Android. What it means is that this application can also run on AR glasses based on either iOS or Android, with a minor tweak of connecting the microphone toggle to one of the buttons on the glasses.

🏃 Getting Started

To get a local copy up and running, follow these simple example steps.

Prerequisites

Download Unity from here. And if it’s your first time using Unity, take a look at the introductory documentation on Working with Unity.

Installation

1. Clone the repo

   git clone git@github.com:manaspratap/ARVideoBrowser.git

2. Open the root folder of this project in Unity.
3. Inside Unity, open /Assets/Scenes/main.unity.
4. Open Build settings and build for either iOS or Android.

✨ Usage

Once you have this application running:

1. You can toggle the microphone (at bottom left) on.
2. Query for a video using voice.
3. Toggle the microphone off.
4. The ARVideoBrowser will then play a video for that voice query.
5. You can then move the object (video) around.
6. Scale the object either way.
7. And enjoy the video in both landscape and portrait mode.
8. Lastly, if, like me, you would want to know what the application sees in the environment around you, toggle the plane and point cloud (at top left).

Here is a detailed working video of the application:

🗺 Roadmap

See the open issues for a list of proposed features (and known issues).

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 License

Distributed under the MIT License. See LICENSE for more information.

---