diff --git a/docs/_docs/webstreams.md b/docs/_docs/webstreams.md index 6f53960a9..7f21b27bc 100644 --- a/docs/_docs/webstreams.md +++ b/docs/_docs/webstreams.md @@ -18,4 +18,4 @@ To add a web stream, click the **+ New** button on the left side of the Webstrea The **Stream URL** setting must include the *port number* (such as 8000) and *mount point* (such as remote\_stream) of the remote stream, in addition to the streaming server name. A **Default Length** for the remote stream can also be set. If the stream is added at the end of a show which becomes overbooked as a result, it will be faded out when the show ends. -Note: LibreTime checks the remote webstream's status upon editing stream settings, so an offline stream will result in an error. There are many tools such as [BUTT](https://danielnoethen.de/butt/) and [MIXXX](https://www.mixxx.org) that can be used to send a test stream to LibreTime can save it; read more [here](../live-shows-with-mixxx/index.md). +Note: LibreTime checks the remote webstream's status upon editing stream settings, so an offline stream will result in an error. There are many tools such as [BUTT](https://danielnoethen.de/butt/) and [MIXXX](https://www.mixxx.org) that can be used to send a test stream to LibreTime can save it; read more [here](/docs/live-broadcast). diff --git a/docs/_docs/widgets.md b/docs/_docs/widgets.md index 30aa6862d..f34310730 100644 --- a/docs/_docs/widgets.md +++ b/docs/_docs/widgets.md @@ -4,6 +4,26 @@ category: interface layout: article --- -One example of a widget, from WRCS, community radio in Columbus, Ohio, USA. +Bring your Libretime broadcast to your website with embeddable widgets! Libretime comes with two widgets: a streaming player and a schedule. Both widgets use iframes to display and can be placed wherever embeddable code can on a website. - \ No newline at end of file +## Getting Started + +Before using the widgets, make sure Libretime's Public API is enabled in **Settings** > **General**. + +![](/img/widgets_settings.png) + +## Streaming Player Widget + +The streaming player widget inserts your Libretime stream into your website. One example is from [WRCS Community Radio](http://wcrsfm.org/) in Columbus, Ohio, USA. + + + +![](/img/widgets_player.png) + +From **Widgets** > **Player**, enter a title for your streaming widget and select what stream you'd like to use. All selectible streams must first be configured in **Settings** > **Streams** (see [Settings](/docs/settings)). **Auto detect** should be fine for most. + +## Show Schedule Widget + +![](/img/widgets_schedule.png) + +The show schedule widget displays the upcoming shows for the next seven days. There are no customizable settings for this widget. \ No newline at end of file diff --git a/docs/img/widgets_player.png b/docs/img/widgets_player.png new file mode 100644 index 000000000..1df933647 Binary files /dev/null and b/docs/img/widgets_player.png differ diff --git a/docs/img/widgets_schedule.png b/docs/img/widgets_schedule.png new file mode 100644 index 000000000..bca143d95 Binary files /dev/null and b/docs/img/widgets_schedule.png differ diff --git a/docs/img/widgets_settings.png b/docs/img/widgets_settings.png new file mode 100644 index 000000000..f1451077e Binary files /dev/null and b/docs/img/widgets_settings.png differ