sintonia/docs/developer-manual/widgets.md

34 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2020-11-10 05:19:28 +01:00
---
title: Widgets
---
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.
2020-11-19 17:59:27 +01:00
## Getting started
2020-12-02 21:06:10 +01:00
Before using the widgets, make sure LibreTime's Public API is enabled in **Settings** > **General**.
2020-12-02 21:06:10 +01:00
![](./widgets-widgets_settings.png)
2020-12-02 21:06:10 +01:00
:::tip Note
LibreTime widgets can't function through VPNs or SSH tunneling. The instance must be accessible from the internet for the widgets to work.
:::
## Streaming player widget
2020-12-02 21:06:10 +01:00
The streaming player widget inserts your LibreTime stream into your website. One example is from [WRCS Community Radio](https://wcrsfm.org/) in Columbus, Ohio, USA.
2020-12-02 21:06:10 +01:00
<iframe frameborder="0" width="400" height="235" src="http://broadcast.wcrsfm.org/embed/player?stream=auto&title=Now Playing"></iframe>
![](./widgets-widgets_player.png)
2020-12-02 21:06:10 +01:00
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](../user-manual/settings.md)). **Auto detect** should be fine for most.
2020-12-02 21:06:10 +01:00
## Show schedule widget
2020-12-02 21:06:10 +01:00
![](./widgets-widgets_schedule.png)
2020-12-02 21:06:10 +01:00
2021-05-27 16:20:34 +02:00
The show schedule widget displays the upcoming shows for the next seven days. There are no customizable settings for this widget.