https://github.com/openframeproject/openframe-video
An Openframe format extension which enables display of videos via omxplayer.
https://github.com/openframeproject/openframe-video
Last synced: 4 months ago
JSON representation
An Openframe format extension which enables display of videos via omxplayer.
- Host: GitHub
- URL: https://github.com/openframeproject/openframe-video
- Owner: OpenframeProject
- Created: 2016-04-23T14:39:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-12-01T16:18:41.000Z (about 6 years ago)
- Last Synced: 2025-08-29T12:42:02.895Z (5 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 4
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Openframe Video
[](https://travis-ci.org/OpenframeProject/Openframe-Video) [](https://coveralls.io/github/OpenframeProject/Openframe-Video?branch=master)
An Openframe format extension which enables display of downloadable videos via omxplayer.
For info on developing your own extensions, see the [Openframe-Extension](https://github.com/OpenframeProject/Openframe-Extension) repo.
### Video settings
Videos are played using [omxplayer](http://elinux.org/Omxplayer). **By default, videos will fill the screen (cropping may occur) and will loop.**
Artworks can pass arguments to omxplayer using the Artwork object's `config` property. Probably the most useful config argument is `--aspect-mode`, which allows an artwork to specify how it should size itself within the display.
```javascript
// an example Artwork object with config
{
"title": "Test Video",
"is_public": false,
"url": "http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_2mb.mp4",
"thumb_url": "",
"author_name": "Test",
"plugins": {},
"format": "openframe-video",
"liked": false,
"id": "571b91b8507bfb8922c89aad",
"ownerId": "56c4802c30eda27c7a0de423",
"created": "2016-04-23T15:16:08.870Z",
"modified": "2016-04-23T15:16:08.870Z",
"options": {
// available options for --aspect-mode are:
// fill: (default) cover entire screen, cropping video
// fit: contain entire video within the screen, no cropping but black boxes
// stretch: warp the video to fill the screen
"--aspect-mode": "fit"
}
}
```