https://github.com/dplesca/go-omxremote
browser based omxplayer remote
https://github.com/dplesca/go-omxremote
golang omxplayer omxremote raspberry-pi svelte tailwindcss
Last synced: 7 days ago
JSON representation
browser based omxplayer remote
- Host: GitHub
- URL: https://github.com/dplesca/go-omxremote
- Owner: dplesca
- License: mit
- Created: 2016-03-04T16:08:06.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-02-10T15:07:37.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T19:09:57.794Z (almost 2 years ago)
- Topics: golang, omxplayer, omxremote, raspberry-pi, svelte, tailwindcss
- Language: Go
- Size: 2.3 MB
- Stars: 17
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-omxremote
Control raspberry pi omxplayer from the browser (including mobile browsers). It has absolutely zero dependencies. To install just [download the latest release](https://github.com/dplesca/go-omxremote/releases) and run it. For help run it with the `-h` flag. Example usage (you can of course add it in your path and run it as a systemd service, unit file example below):
`./go-omxremote -bind :some-port -media path/to/video/files`
Command flags:
```
-bind string
Address to bind on. If this value has a colon, as in ":8000" or
"127.0.0.1:9001", it will be treated as a TCP address.
(default ":31415")
-media string
path to look for videos in (default ".")
-omx string
omx options (default "-o hdmi")
```
The project is geared towards mobile usage, the interface has been tested on both Android and iOS devices. This project is intended to be used with local files only, to add YouTube playback functionality please [check out this fork](https://github.com/luizpestana/go-omxremote/tree/feat/add-youtube-dl).
### Exposed HTTP API
This application exposes a simple, minimal HTTP API for interfacing with the player. The exposed endpoints are:
- POST /start/:hash - starts playback for a video file
- POST /player/pause - toggles pause/play for video playback
- POST /player/stop - stops playback
- POST /player/forward - seeks forward in video (30 seconds)
- POST /player/backward - seeks backward in video (30 seconds)
- POST /player/up - seeks forward in video (10 minutes)
- POST /player/down - seeks backward in video (10 minutes)
- POST /player/subs - switches subs stream
One important note is that the `start` call does not return until the playback is stopped, so your request will probably time out.
### Example systemd unit file
A minimal systemd unit file. It makes `go-omxremote` a service so you can control it between sessions and/or don't need a tmux/screen to keep it open.
```
[Unit]
Description="omxremote go web service"
[Service]
User=pi
Group=pi
Restart=on-failure
ExecStart=/usr/local/bin/go-omxremote -media /path/to/media/files
WorkingDirectory=/home/pi
[Install]
WantedBy=multi-user.target
```
### Modify it
- Clone repo
- make some changes
- build again: `go build`
### Credits
It's written in go. The front-end is written in html with a little sprinkled [htmx](https://htmx.org/), the style uses [picocss](https://v2.picocss.com/).