Metadata-Version: 2.1
Name: tkvlc
Version: 1.0.0
Summary: A Minimal python-vlc Tkinter Helper Library
Home-page: https://gitlab.com/SafwanLjd/PyTkinterVLC
Download-URL: https://gitlab.com/SafwanLjd/PyTkinterVLC/-/archive/1.0.0/PyTkinterVLC-1.0.0.tar.gz
Author: Safwan Ljd
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE

# PyTkinterVLC

This is a simplified version of the [Official VLC Tkinter Example](https://github.com/oaubert/python-vlc/blob/master/examples/tkvlc.py) made to fit my personal needs.

* _Works on Windows [Tested on Windows 10 64-Bit]_
* _Works on Linux (Xorg) [Tested on Arch Linux 64-Bit With DWM]_
* _Probably Won't Work on macOS [Not Tested]_


## Installation
```bash
pip install tkvlc
```


## Usage
### Example
```python
import tkvlc

exampleVideoURL = "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4"
exampleVideoTitle = "Bunny Video"
exampleIconPath = "./icons/vlcCone.ico"

player = tkvlc.Player(video=exampleVideoURL, title=exampleVideoTitle, iconPath=exampleIconPath)
player.start()
```


### Video Player Key Bindings
* Space = Pause/Resume
* Up Arrow = Increase Volume By 5%
* Down Arrow = Decrease Volume By 5%
* Right Arrow = Go Forward 30 seconds
* Left Arrow = Go Backward 30 seconds
* F = Toggle fullscreen
* M = Mute/Unmute
* Q = Quit
* E = Quit
