Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lidel/pls.watch

Minimalistic YouTube / Imgur / SoundCloud Looper & Playlist Manager
https://github.com/lidel/pls.watch

imgur pls soundcloud youtube

Last synced: 4 days ago
JSON representation

Minimalistic YouTube / Imgur / SoundCloud Looper & Playlist Manager

Awesome Lists containing this project

README

        

# pls.watch: The Minimalistic Media Looper

[![Build Status](https://travis-ci.org/lidel/pls.watch.svg?branch=master)](https://travis-ci.org/lidel/pls.watch)

> Create shareable loops and playlists using simple URL tokens.

A snowball of JavaScript antipatterns that turned into an avalanche of features.
Supports YouTube for video (with playlist import), Imgur for images (with gifv support) and SoundCloud for audio.

Deployed at https://pls.watch

## Table of Contents

- [Background](#background)
- [URL Parameters](#url-parameters)
- [YouTube](#youtube)
- [Imgur](#imgur)
- [SoundCloud](#soundcloud)
- or [any External URL](#any-external-url)
- [Known Issues](#known-issues)
(Fixing autoplay and background playback in Google Chrome/Chromium, etc)
- [Companion UserScript](#companion-userscript)
- [Contribute](#contribute)
- [License](#license)

## Background

Scratching own itches.

At the time YouTube did not provide any way to specify end timestamp when sharing a link to a video.
The amount of distractions and advertisements on third party sites that provided this functionality was abysmal.

Out of frustration, `pls.watch` was born as a clean way to:

- share specific fragment of YouTube video
- display content without any distractions such as related videos or ads
- create playlists with mixed content from YouTube, Imgur (image/gifv) and SoundCloud (audio)
- guarantee backward-compatible API to create clean permalinks (see [URL Parameters](#url-parameters))

## URL Parameters

The most basic loop is one video with optional range:
```
#v=[&t=[;]]
```
Time format is `1h2m3s` or just a number of seconds.

### YouTube

YouTube-compatible syntax is also supported, enabling use by a simple domain swap in URLs: `?v=[[#|&|:]t=[;]]`

**Advanced Loops**

A YouTube video can have more than one interval. Intervals are chained with the `+` sign:
```
#v=&t=;+;+...
```

To chain intervals from multiple videos just append another `&v=(...)` at the end of URL:
```
#v=&t=;+;&v=&t=;+;`
```

**Playlist Import**

To generate `v=(...)` items from `` and start autoplay from ``-th element:
```
#list=&index=
```

YouTube URLs are supported transparently: if `` is inside of the playlist specified by `` on ``-th position, it will be deduplicated:
```
#v=&list=&index=
```
If URL already had some videos `` will be recalculated.

**Override Video Volume**

To cap YouTube sound volume at a preferred level (global setting):
```
&volume=
```
Level is a number between 0 (muted) and 100 (max volume).

**Override Video Quality**

To cap YouTube quality at a preferred level (global setting):
```
&quality=
```
Current list of available levels can be found in [YouTube Player API Reference](https://developers.google.com/youtube/iframe_api_reference#Playback_quality).

**Override Playback Rate**

The default playback rate is `1`, which indicates that the video is playing at normal speed. Playback rates may include values like `0.25`, `0.5`, `1`, `1.5`, and `2`. It is a global flag (sets speed of all YouTube videos in playlist).
```
&speed=
```
Current list of available playback rates can be found in [YouTube Player API Reference](https://developers.google.com/youtube/iframe_api_reference#Playback_rate).

### Imgur

By default image is displayed forever (useful for GIFs). A slideshow can be created with simplified `t` parameter:

```
#i=.jpg[&t=]
```

Example: https://pls.watch/#i=lkD38.gifv&t=3&i=cJjBEQP.jpg&t=1s&i=vo9DPpp.gif&t=3s

Note: [GIF intervals](https://pls.watch/#i=zvATqgs) are automatically rendered as [GIFV](https://imgur.com/blog/2014/10/09/introducing-gifv/).

### SoundCloud

Single track interval:

```
#s=/[&t=[;]]
```

Example: https://pls.watch/#s=sacredbones/pharmakon-body-betrays-itself&t=0s;17s

Playlists (sets) are lazy-inlined on first play:

```
#s=/sets/
```

Example: https://pls.watch/#s=erasedtapes/sets/erased-tapes-collection-iv

### Any External URL

#### Generic HTML5 Player

Similar to YouTube Player - main difference is format for `videoId`.

Currently, to be detected, `videoId` has to begin with `http` and end with: `.mp3`, `.mp4`, `.ogg`, `.ogv` or `.webm`.

Example: https://pls.watch/#v=https://vt.tumblr.com/tumblr_npa1dkYP1U1urdxm4.mp4&t=4s;5s

#### Generic Image Player

Similar to Imgur Player but if `videoId` starts with `http` it loads the URL and naïvely believes it is an image.

Example: https://pls.watch/#i=https://ipfs.io/ipfs/QmYHNYAaYK5hm3ZhZFx5W9H6xydKDGimjdgJMrMSdnctEm

### Global

**Random Mode**

```
&random
```

This parameter will force playback of all intervals in semi-random order (normalized random: current interval will not be played twice in a row).

**Playlist Editor**

```
&editor
```

This parameter will force playlist editor to be visible from the start.

## Keyboard Commands

Press ? to toggle help screen listing available shortcuts.

## Known Issues

### Autoplay does not work in Google Chrome/Chromium

Chrome made the decision not to allow autoplay of video/audio content unless muted, to prevent annoying webpage content.
There is no fix for this, but every user can opt-out and restore autoplay by opening `chrome://flags/#autoplay-policy`, changing it to `No user gesture is required` and restarting the browser:

![enabling autoplay in Chrome](https://user-images.githubusercontent.com/157609/42972002-5c8dd0a8-8bae-11e8-9a7f-fbcd49a694a0.png)

### Playback pauses when tab is not active in Google Chrome/Chromium

The fix is the same as above (change `chrome://flags/#autoplay-policy`).
See [issue #151](https://github.com/lidel/pls.watch/issues/151#issuecomment-190417962) for historical context.

## Companion UserScript

There is a simple [UserScript](https://openuserjs.org/about/Userscript-Beginners-HOWTO) that adds a button on supported pages to open current resource in the app.

### Installation

Click to install: https://pls.watch/pls.watch.user.js

It may require preinstalled browser extension:

- Firefox: [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/)
- Chrome/Opera: [Tampermonkey](http://tampermonkey.net)

### Examples

#### YouTube

> ![](https://user-images.githubusercontent.com/157609/38982703-d78075d8-43c2-11e8-9c06-8020e3bab500.png)

#### Imgur

> ![](https://cloud.githubusercontent.com/assets/157609/17445828/cfc2705a-5b46-11e6-8e2a-c12940b998b7.png)

#### SoundCloud

> ![](https://cloud.githubusercontent.com/assets/157609/7513707/80d419c8-f4b6-11e4-9413-3d6ede9bd5d0.png)

## Contribute

Ideas and bug reports are most welcome.

## License

- [Underscore.js](http://underscorejs.org/), [jQuery](https://jquery.com/), [mCustomScrollbar](https://github.com/malihu/malihu-custom-scrollbar-plugin) and [toastr](https://github.com/CodeSeven/toastr) are under [MIT license](http://opensource.org/licenses/MIT)
- [Black Felt](http://subtlepatterns.com/black-felt/) is under [CC-BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/)

The pls.watch itself is released under [CC0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).