From 40a8e213358ef0f4afb2f951fae6add3f9d829a5 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Sun, 21 Jun 2020 11:52:41 -0400 Subject: [PATCH] Reworking menus --- docs/_config.yml | 26 ++++- docs/_data/nav.yml | 2 + docs/_includes/navbar.html | 8 +- docs/_layouts/splash.html | 2 +- docs/{playout-history.md => analytics.md} | 17 ++- docs/library.md | 127 ++++++++++++++++------ docs/playlists-smartblocks.md | 65 ----------- docs/podcasts-webstreams.md | 56 ---------- docs/scheduling-shows.md | 61 ++++++++++- docs/stats.md | 14 --- 10 files changed, 201 insertions(+), 177 deletions(-) rename docs/{playout-history.md => analytics.md} (93%) delete mode 100644 docs/playlists-smartblocks.md delete mode 100644 docs/podcasts-webstreams.md delete mode 100644 docs/stats.md diff --git a/docs/_config.yml b/docs/_config.yml index 50d035a7f..cc79c367a 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -5,7 +5,6 @@ baseurl: "" # The subpath of your site, e.g. /blog url: "" # The base hostname & protocol for your site, e.g. http://example.com layouts_dir: _layouts -data_dir: _data includes_dir: _includes favicon: favicon.ico @@ -20,4 +19,27 @@ headbuttontext: Get LibreTime # Build settings plugins: - - kramdown \ No newline at end of file + - kramdown + +# Navigation +docsdrop: +- page: Broadcasting Live + url: live-broadcast +- page: Intelligent Library + url: library +- page: Playout History + url: analytics +- page: Scheduling Shows + url: scheduling-shows +- page: Troubleshooting + url: troubleshooting + +admindocsdrop: +- page: Admin Guides + url: guides + +topnav: +- page: Github + url: https://github.com/LibreTime/libretime +- page: Sponsor + url: https://opencollective.com/libretime \ No newline at end of file diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index 78a4634ab..f824070be 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -3,6 +3,8 @@ docsdrop: url: live-broadcast - page: Intelligent Library url: library +- page: Playout History + url: analytics - page: Scheduling Shows url: scheduling-shows diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html index 239a2363c..f5efe1505 100644 --- a/docs/_includes/navbar.html +++ b/docs/_includes/navbar.html @@ -15,14 +15,16 @@ Docs
- {% for item in site.data.nav.docsdrop %} + {% for item in site.docsdrop %} {{ item.page }} {% endfor %}
- More Docs + {% for item in site.admindocsdrop %} + {{ item.page }} + {% endfor %}
- {% for item in site.data.nav.topnav %} + {% for item in site.topnav %}
  • {{ item.page }}
    • diff --git a/docs/_layouts/splash.html b/docs/_layouts/splash.html index 6d3cf9b6d..b0b2524a3 100644 --- a/docs/_layouts/splash.html +++ b/docs/_layouts/splash.html @@ -187,7 +187,7 @@
    - +
    diff --git a/docs/playout-history.md b/docs/analytics.md similarity index 93% rename from docs/playout-history.md rename to docs/analytics.md index 99826f3a9..af43464ce 100644 --- a/docs/playout-history.md +++ b/docs/analytics.md @@ -1,6 +1,7 @@ --- layout: default -title: Playout History +title: Analytics +git: analytics.md --- @@ -281,3 +282,17 @@ Replace host, user and password values with appropriate values for your external Then make the new script executable and create a cron job to launch it every minute, as in step 8 above. Steps 3 to 7 above should be carried out on the external web server so that it can convert the two temporary files uploaded via FTP into public schedule data. If you have secure shell access (SSH) to the remote web server, you could write a script to use the secure copy command (scp) instead of ftp. + +--- + +## Streaming Listener Statistics + +The Listener Stats page on the Analytics menu shows graphs of listener connections to the configured streaming servers for the selected date and time range.  On the right side, a green **Status** indicator shows **OK** if the connection to the streaming server is active. + +![](img/portfolio/stream-stats.jpg) + +If the status indicator is red, check that the **Admin User** and **Admin Password** settings are correct under **Additional Options** for the named mount point, such as *libretime\_128*, on the **Streams** page of the **Settings** menu. + +By default, statistics for the last 24 hours of streaming are shown. To change this date and time range, click the calendar and clock icons in the lower left corner of the page, then click the magnifying glass icon. + +> To choose which particular streams should have statistics displayed, click the check boxes for the individual colour-coded mount points, just below the graph. diff --git a/docs/library.md b/docs/library.md index ad8100e13..e1abeb339 100644 --- a/docs/library.md +++ b/docs/library.md @@ -1,10 +1,10 @@ --- layout: default -title: Dashboard and Calendar - +title: Library +git: library.md --- -# Dashboard {#dashboard} +## Dashboard {#dashboard} The Dashboard is divided into two sections a Library section divided between Tracks, Playlists, Smart Blocks, Webstreams, and Podcasts, with the **Scheduled @@ -50,8 +50,7 @@ column, and have a pink background. ![](img/end-gap.png) -Removing content from a running show ------------------------------------- +### Removing content from a running show If a show is overbooked, which means the total playout duration is longer than the time allowed for the show, a brown row indicates that the item will be faded @@ -82,8 +81,7 @@ were removed from LibreTime's library (main storage or watched folders) subsequently. Items which are included in forthcoming shows cannot be removed from the Library via the LibreTime interface. -Adding content to a running show --------------------------------- +### Adding content to a running show After you have found the items that you want using the search tools, you can then drag and drop them from the library table on the left side of the page into @@ -124,56 +122,117 @@ Multiple insertion points can be enabled, so that the same item is inserted into the schedule at different times. For example, you may wish to play a news report every hour, or a station ident after every five music files. -# Calendar {#calendar} +--- -The Calendar page of the LibreTime administration interface has three views: **day**, **week** and **month**, which can be switched using the grey buttons in the top right corner. By default, the **month** view is shown, with today's date highlighted by a pale grey background. +## Playlists {#playlists} -![](img/Screenshot451-Calendar.png) +### Creating a new playlist -In the top left corner of the page, you can go back or forward through the **Calendar** by clicking on the buttons which have a small grey triangle in a white circle. Click the **today** button to jump to today's date in the current view. (The **today** button will be greyed out if you are already viewing that date). In the **day** or **week** views, there is also a drop-down menu which allows you to set the resolution displayed for the calendar, ranging from one minute per row to sixty minutes per row. +You can create a new playlist on the toolbar of the **Playlists** page. -![](img/Screenshot452-Calendar_resolution.png) +![](img/Playlist-Editor.png) -## Editing a show +Enter a **Name** and **Description** for the playlist, then click the **Save** button. Setting good quality metadata here will help you find the playlist using the search box later, so you should be as descriptive as possible. -Show configuration and metadata can be changed at any time, except for **Date/Time Start** and **Record from Line In?** options, which are fixed after broadcast of that show commences. Click the show in the Calendar, and select **Edit Show** from the pop-up context menu. This opens the **Update Show** box, which is almost exactly the same as the **Add this Show** box. Click the **+ Update show** button at the top or bottom of the box when you are done. +### Adding content to a playlist -![](img/Screenshot459-Update_show.png) +With a playlist open, drag and drop items from the search results on the left into the playlist on the right. Jingles and voice tracks can be added before, after or between music items. -Episodes of repeating shows also have an **Instance Description** field in which you can add details for that particular episode. Click the episode in the Calendar, click **Edit** on the pop-up menu, then click **Edit this instance**. After entering an Instance Description, click the **+ Update show** button. +After adding files to the playlist, the total playlist time is displayed in the top right corner. The duration of an individual file is shown in each row of the playlist in a white font, and beneath this figure the time since the beginning of the playlist is displayed in a smaller light grey font. This elapsed time figure can be used as a time check for voice tracks, although this option may limit the re-usability of the voice track. -![](img/Screenshot583-Show_instance_description_vC9ooiT.png) +To audition a playlist file in your web browser, click the white triangle button on the left side of its row. (If the format of the file is not supported by your browser, the triangle in this button will be greyed out). If audition of the file format is supported, a pop-up window will open, with the playlist starting at the file you clicked. -Alternatively, individual shows can be clicked on and dragged to new days and times in the calendar. However, LibreTime will not allow you to drag a future show into the past, or drag and drop instances of a repeated show. In the **Day** and **Week** views, show length can be adjusted by clicking on the lower edge of the show box, and dragging the edge of the box upwards or downwards. The new show length is calculated automatically. +Click the small white **x** icon on the right hand side of each row to remove a file from the playlist. You can also drag and drop files to re-order them, or click the **Shuffle** button to re-order files automatically. -## Adding content to a show +When your playlist is complete, click the **New** button in the top left corner to create another playlist, click the close icon (a white cross in a black circle) in the top right corner, or browse to another page of the LibreTime interface. -To add content to a show, click the show in any view on the Calendar, and select **Schedule Tracks** from the pop-up menu. Shows that do not yet contain any scheduled content are marked with a red exclamation mark icon, to the right of the show start and end times in the top bar. Shows partially filled with content have a yellow exclamation mark icon. During playout of the show, a green play icon will also be shown in the top bar. +If you want to edit the playlist content or metadata later, you can find it by **Title**, **Creator**, **Last Modified** date, **Length**, **Owner** or **Year** using one of the search tools on the Library page. Click the playlist in the search results list, and then click **Edit** from the pop-up menu. You can also **Preview** the entire playlist in a pop-up audition window, **Duplicate** or **Delete** one of your playlists from this menu. -![](img/Screenshot488-Add_remove_content.png) +## Smartblocks {#smartblocks} -The **Schedule Tracks** action opens a window with the name of the show. Like when using the **Now Playing** page, you can search for content items and add them to the show schedule on the right side of the page. Refer to the *Now Playing* chapter for details. +### Creating a Smartblock -When your show has all the required content, click the **OK** button in the bottom right corner to close the window. Back in the **Calendar**, click the show and select **View** from the pop-up menu to view a list of content now included in the show. +![](img/Smartblock-options.png) -![](img/Screenshot489-Show_Content.png) +Smart blocks are automatically filled with media files from the LibreTime library, according to the criteria that you specify. This feature is intended to save staff time, compared to selecting items for a playlist manually, and can be used to schedule shows that operate in a consistent format. -The **Contents of Show** window is a read-only interface featuring an orange bar which indicates how much media has been added to the show. Click the **OK** button in the bottom right corner, or the white **x** icon in the top right corner, to close the window. +To create a smart block, click the **Smartblocks** button on the left sidebar, and select **New** from the toolbar. Like a playlist, smart blocks can have a title and description, which you can edit. This helps you find relevant smart blocks in searches. -![](img/Screenshot353-Contents_of_show.png) +Fill out the smart block's **Name**, **Search Criteria**, and **Limit to** sections. The search criteria can be any one of LibreTime's metadata categories, such as **Title**, **Creator** or **Genre**. The modifier depends on whether the metadata in question contains letters or numbers. For example, **Title** has modifiers including *contains* and *starts with*, whereas the modifiers for **BPM** include *is greater than* and *is in the range*. -## Removing content from a show +If you have a large number of files which meet the criteria that you specify, you may wish to limit the duration of the smart block using the **Limit to** field, so that it fits within the show you have in mind. Select **hours**, **minutes** or **items** from the drop-down menu, and click the **Generate** button again, if it is a static smart block. Then click the **Save** button. -To remove an individual item from a show, click on the show in the **Calendar**, and select **Schedule Tracks** from the pop-up menu. In the window which opens, click any item you wish to remove from the show, then click **Delete** on the pop-up menu, or check the box in the item's row then click the **Remove** icon at the top of the table. To remove all files and playlists from a show, click on the show in the **Calendar**, and select **Clear Show** from the pop-up menu.  +> Note: Smart Blocks by default will never overflow the Time Limit. For instance if you set a time limit of 1 hour. It will add tracks to the schedule until it can't add any more tracks without exceeding the hour. This is to prevent tracks from being cut-off because they exceed the time limit of a show. +> +> If you want a smartblock to schedule tracks until it is longer than the Time Limit you can check "Allow last track to exceed time limit". This will make LibreTime add tracks that meet the criteria until it equals or is longer than the time limit. This is helpful for avoiding dead air on shows that are being autoscheduled. -## Deleting an upcoming show +![](img/Smartblock-advanced.png) -To delete an upcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete Instance and All Following** from the pop-up menu. +You can also set the **smart block type**. A **Static** smart block will save the criteria and generate the block content immediately. This enables you to edit the contents of the block in the **Library** page before adding it to a show. A **Dynamic** smart block will only save the criteria, and the specific content will be generated at the time the block is added to a show. After that, the content of the show can be changed or re-ordered in the **Now Playing** page.  -![](img/Screenshot490-Delete_this_instance.png) +Click the **plus button** on the left to add OR criteria, such as **Creator** containing *beck* OR *jimi*. To add AND criteria, such as **Creator** containing *jimi* AND BPM in the range *120* to *130*, click the **plus button** on the right. (The criteria are not case sensitive). Click **Preview** to see the results. -You cannot delete or remove content from shows that have already played out. These shows have only one option on the pop-up menu, which is **View**. +> If you see the message *0 files meet the criteria*, it might mean that the files in the Library have not been tagged with the correct metadata. See the chapter [Preparing media](preparing-media) for tips on tagging content. -## Cancelling playout +![](img/Smartblock-content.png) -If you wish to cancel playout of a show while it is running, click on the show in the **Calendar** and select **Cancel Show** from the pop-up menu. This action cannot be undone. +If you don't like the ordering which is generated, click the **Shuffle** button, or drag and drop the smart block contents into the order that you prefer. You can also remove items or add new items manually from the Library. Changes to static smart block contents are saved automatically when you add items, remove or re-order them, or click the **Generate** button. Click the **Save** button in the upper right corner to save any changes to smart block criteria. + +By default, a smart block will not contain repeated items, which will limit the duration of the block if you do not have sufficient items meeting the specified criteria in your **Library**. To override the default behaviour, check the **Allow Repeat Tracks** box. The **Sort tracks by** menu offers the options of **random**, **newest** or **oldest** items first. + +Smart blocks can be added to shows in the same way as a manually created playlist is added. Smart blocks can also be added to one or more playlists. In the case of a playlist containing a static smart block, click **Expand Static Block** to view the contents. For a dynamic smart block, you can review the criteria and duration limit by clicking **Expand Dynamic Block**. + +Once created, smart blocks can be found under the Smartblocks tab and refined at any time. They can be re-opened by right-clicking on the smart block and selecting **Edit** from the pop-up menu. + +--- + +## Podcasts {#podcasts} + +The Podcasts page allows you add subscriptions to podcasts which are often used to syndicated audio files using a URL called a RSS feed. This allows your LibreTime instance to automatically download new shows from the web. + +In order to add a podcast you need to get the RSS feed. All podcasts available on iTunes have a RSS feed but it is sometimes hidden. See this issue on our github page [#510](https://github.com/LibreTime/libretime/issues/510) for more information. RSS feeds that do not end in *.xml* may be accepted by LibreTime but might fail to download episodes; in that case, download the episode using a podcast client such as [gpodder](https://gpodder.github.io/) and then manually upload and schedule the episode. Podcast feeds coming from Anchor.fm have been known to have this issue. + +The podcast interfaces provides you with the ability to generate [Smartblocks](smartblocks) that can be used in conjunction with [Autoloading Playlists](../calendar/#autoloading-playlist) to schedule the newest episode of a podcast without human intervention. + + + + + + +### Podcasts Dashboard + +![](img/Podcasts_Dashboard.png) + +The podcasts dashboard is similar to the tracks view, allowing you to add, edit, and remove +podcasts by the toolbar, in addition to sorting by columns. + +To add a podcast, click on the **+ Add** button on the toolbar and provide the podcast's RSS feed, which usually ends in *.xml*. +Once the podcast's feed is recognized, the editor pane opens for the podcast. + +### Editor + +![](img/Podcasts_Editor.png) + +In the podcasts editor, you can rename the podcast, update settings for the podcast, and manage episodes. +A search box is available to search for episodes within the feed. + +- To import an episode directly into LibreTime, double-click on an episode or select it and click **+ Import**. The podcast will appear under tracks with the Podcast Name as the Album. +- To delete an episode from LibreTime, select the episode and click on the red trash can on the toolbar. +- If you would like LibreTime to automatically download the latest episodes of a podcast, make sure *Download latest episodes* is checked. This can be used in conjunction with Smartblocks and Playlists to automate downloading and scheduling shows that are received via podcast feed. + +## Webstreams {#webstreams} + + + + + +### Adding a webstream +A web stream URL and metadata can be added to the LibreTime library, so that a remote stream can be searched for and scheduled to be *pulled* into a show. For example, at the top of the hour your station may pull a news report from journalists working in another studio. This is a different concept from **Master Source** and **Show Source** remote streams which are *pushed* into the LibreTime playout schedule. + +To add a web stream, click the **+ New** button on the left side of the Webstreams page. Like a playlist, web streams in the Library can have a title and **Description**, which may help you find them in searches later. + +![](img/webstream.jpg) + +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). diff --git a/docs/playlists-smartblocks.md b/docs/playlists-smartblocks.md deleted file mode 100644 index a97df8824..000000000 --- a/docs/playlists-smartblocks.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default -title: Playlists and Smartblocks - ---- - -## Playlists {#playlists} - -### Creating a new playlist - -You can create a new playlist on the toolbar of the **Playlists** page. - -![](img/Playlist-Editor.png) - -Enter a **Name** and **Description** for the playlist, then click the **Save** button. Setting good quality metadata here will help you find the playlist using the search box later, so you should be as descriptive as possible. - -### Adding content to a playlist - -With a playlist open, drag and drop items from the search results on the left into the playlist on the right. Jingles and voice tracks can be added before, after or between music items. - -After adding files to the playlist, the total playlist time is displayed in the top right corner. The duration of an individual file is shown in each row of the playlist in a white font, and beneath this figure the time since the beginning of the playlist is displayed in a smaller light grey font. This elapsed time figure can be used as a time check for voice tracks, although this option may limit the re-usability of the voice track. - -To audition a playlist file in your web browser, click the white triangle button on the left side of its row. (If the format of the file is not supported by your browser, the triangle in this button will be greyed out). If audition of the file format is supported, a pop-up window will open, with the playlist starting at the file you clicked. - -Click the small white **x** icon on the right hand side of each row to remove a file from the playlist. You can also drag and drop files to re-order them, or click the **Shuffle** button to re-order files automatically. - -When your playlist is complete, click the **New** button in the top left corner to create another playlist, click the close icon (a white cross in a black circle) in the top right corner, or browse to another page of the LibreTime interface. - -If you want to edit the playlist content or metadata later, you can find it by **Title**, **Creator**, **Last Modified** date, **Length**, **Owner** or **Year** using one of the search tools on the Library page. Click the playlist in the search results list, and then click **Edit** from the pop-up menu. You can also **Preview** the entire playlist in a pop-up audition window, **Duplicate** or **Delete** one of your playlists from this menu. - -## Smartblocks {#smartblocks} - -### Creating a Smartblock - -![](img/Smartblock-options.png) - -Smart blocks are automatically filled with media files from the LibreTime library, according to the criteria that you specify. This feature is intended to save staff time, compared to selecting items for a playlist manually, and can be used to schedule shows that operate in a consistent format. - -To create a smart block, click the **Smartblocks** button on the left sidebar, and select **New** from the toolbar. Like a playlist, smart blocks can have a title and description, which you can edit. This helps you find relevant smart blocks in searches. - -Fill out the smart block's **Name**, **Search Criteria**, and **Limit to** sections. The search criteria can be any one of LibreTime's metadata categories, such as **Title**, **Creator** or **Genre**. The modifier depends on whether the metadata in question contains letters or numbers. For example, **Title** has modifiers including *contains* and *starts with*, whereas the modifiers for **BPM** include *is greater than* and *is in the range*. - -If you have a large number of files which meet the criteria that you specify, you may wish to limit the duration of the smart block using the **Limit to** field, so that it fits within the show you have in mind. Select **hours**, **minutes** or **items** from the drop-down menu, and click the **Generate** button again, if it is a static smart block. Then click the **Save** button. - -> Note: Smart Blocks by default will never overflow the Time Limit. For instance if you set a time limit of 1 hour. It will add tracks to the schedule until it can't add any more tracks without exceeding the hour. This is to prevent tracks from being cut-off because they exceed the time limit of a show. -> -> If you want a smartblock to schedule tracks until it is longer than the Time Limit you can check "Allow last track to exceed time limit". This will make LibreTime add tracks that meet the criteria until it equals or is longer than the time limit. This is helpful for avoiding dead air on shows that are being autoscheduled. - -![](img/Smartblock-advanced.png) - -You can also set the **smart block type**. A **Static** smart block will save the criteria and generate the block content immediately. This enables you to edit the contents of the block in the **Library** page before adding it to a show. A **Dynamic** smart block will only save the criteria, and the specific content will be generated at the time the block is added to a show. After that, the content of the show can be changed or re-ordered in the **Now Playing** page.  - -Click the **plus button** on the left to add OR criteria, such as **Creator** containing *beck* OR *jimi*. To add AND criteria, such as **Creator** containing *jimi* AND BPM in the range *120* to *130*, click the **plus button** on the right. (The criteria are not case sensitive). Click **Preview** to see the results. - -> If you see the message *0 files meet the criteria*, it might mean that the files in the Library have not been tagged with the correct metadata. See the chapter [Preparing media](preparing-media) for tips on tagging content. - -![](img/Smartblock-content.png) - -If you don't like the ordering which is generated, click the **Shuffle** button, or drag and drop the smart block contents into the order that you prefer. You can also remove items or add new items manually from the Library. Changes to static smart block contents are saved automatically when you add items, remove or re-order them, or click the **Generate** button. Click the **Save** button in the upper right corner to save any changes to smart block criteria. - -By default, a smart block will not contain repeated items, which will limit the duration of the block if you do not have sufficient items meeting the specified criteria in your **Library**. To override the default behaviour, check the **Allow Repeat Tracks** box. The **Sort tracks by** menu offers the options of **random**, **newest** or **oldest** items first. - -Smart blocks can be added to shows in the same way as a manually created playlist is added. Smart blocks can also be added to one or more playlists. In the case of a playlist containing a static smart block, click **Expand Static Block** to view the contents. For a dynamic smart block, you can review the criteria and duration limit by clicking **Expand Dynamic Block**. - -Once created, smart blocks can be found under the Smartblocks tab and refined at any time. They can be re-opened by right-clicking on the smart block and selecting **Edit** from the pop-up menu. diff --git a/docs/podcasts-webstreams.md b/docs/podcasts-webstreams.md deleted file mode 100644 index 847f7cc33..000000000 --- a/docs/podcasts-webstreams.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default -title: Podcasts and Webstreams - ---- - -## Podcasts {#podcasts} - -The Podcasts page allows you add subscriptions to podcasts which are often used to syndicated audio files using a URL called a RSS feed. This allows your LibreTime instance to automatically download new shows from the web. - -In order to add a podcast you need to get the RSS feed. All podcasts available on iTunes have a RSS feed but it is sometimes hidden. See this issue on our github page [#510](https://github.com/LibreTime/libretime/issues/510) for more information. RSS feeds that do not end in *.xml* may be accepted by LibreTime but might fail to download episodes; in that case, download the episode using a podcast client such as [gpodder](https://gpodder.github.io/) and then manually upload and schedule the episode. Podcast feeds coming from Anchor.fm have been known to have this issue. - -The podcast interfaces provides you with the ability to generate [Smartblocks](smartblocks) that can be used in conjunction with [Autoloading Playlists](../calendar/#autoloading-playlist) to schedule the newest episode of a podcast without human intervention. - - - - - - -### Podcasts Dashboard - -![](img/Podcasts_Dashboard.png) - -The podcasts dashboard is similar to the tracks view, allowing you to add, edit, and remove -podcasts by the toolbar, in addition to sorting by columns. - -To add a podcast, click on the **+ Add** button on the toolbar and provide the podcast's RSS feed, which usually ends in *.xml*. -Once the podcast's feed is recognized, the editor pane opens for the podcast. - -### Editor - -![](img/Podcasts_Editor.png) - -In the podcasts editor, you can rename the podcast, update settings for the podcast, and manage episodes. -A search box is available to search for episodes within the feed. - -- To import an episode directly into LibreTime, double-click on an episode or select it and click **+ Import**. The podcast will appear under tracks with the Podcast Name as the Album. -- To delete an episode from LibreTime, select the episode and click on the red trash can on the toolbar. -- If you would like LibreTime to automatically download the latest episodes of a podcast, make sure *Download latest episodes* is checked. This can be used in conjunction with Smartblocks and Playlists to automate downloading and scheduling shows that are received via podcast feed. - -## Webstreams {#webstreams} - - - - - -### Adding a webstream -A web stream URL and metadata can be added to the LibreTime library, so that a remote stream can be searched for and scheduled to be *pulled* into a show. For example, at the top of the hour your station may pull a news report from journalists working in another studio. This is a different concept from **Master Source** and **Show Source** remote streams which are *pushed* into the LibreTime playout schedule. - -To add a web stream, click the **+ New** button on the left side of the Webstreams page. Like a playlist, web streams in the Library can have a title and **Description**, which may help you find them in searches later. - -![](img/webstream.jpg) - -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). diff --git a/docs/scheduling-shows.md b/docs/scheduling-shows.md index cfd5c0dab..257b13350 100644 --- a/docs/scheduling-shows.md +++ b/docs/scheduling-shows.md @@ -1,8 +1,11 @@ --- layout: default title: Scheduling Shows +git: scheduling-shows.md --- +## Scheduling Shows +
    @@ -81,4 +84,60 @@ When media is playing, the **On Air** indicator at the top will turn red. ![](img/on-air-status.png) You can listen to your stream by going to `yourserverIP:8000` or by clicking the **Listen** button under the On Air -indicator. \ No newline at end of file +indicator. + +--- + +## Calendar Functions {#calendar} + +The Calendar page of the LibreTime administration interface has three views: **day**, **week** and **month**, which can be switched using the grey buttons in the top right corner. By default, the **month** view is shown, with today's date highlighted by a pale grey background. + +![](img/Screenshot451-Calendar.png) + +In the top left corner of the page, you can go back or forward through the **Calendar** by clicking on the buttons which have a small grey triangle in a white circle. Click the **today** button to jump to today's date in the current view. (The **today** button will be greyed out if you are already viewing that date). In the **day** or **week** views, there is also a drop-down menu which allows you to set the resolution displayed for the calendar, ranging from one minute per row to sixty minutes per row. + +![](img/Screenshot452-Calendar_resolution.png) + +### Editing a show + +Show configuration and metadata can be changed at any time, except for **Date/Time Start** and **Record from Line In?** options, which are fixed after broadcast of that show commences. Click the show in the Calendar, and select **Edit Show** from the pop-up context menu. This opens the **Update Show** box, which is almost exactly the same as the **Add this Show** box. Click the **+ Update show** button at the top or bottom of the box when you are done. + +![](img/Screenshot459-Update_show.png) + +Episodes of repeating shows also have an **Instance Description** field in which you can add details for that particular episode. Click the episode in the Calendar, click **Edit** on the pop-up menu, then click **Edit this instance**. After entering an Instance Description, click the **+ Update show** button. + +![](img/Screenshot583-Show_instance_description_vC9ooiT.png) + +Alternatively, individual shows can be clicked on and dragged to new days and times in the calendar. However, LibreTime will not allow you to drag a future show into the past, or drag and drop instances of a repeated show. In the **Day** and **Week** views, show length can be adjusted by clicking on the lower edge of the show box, and dragging the edge of the box upwards or downwards. The new show length is calculated automatically. + +### Adding content to a show + +To add content to a show, click the show in any view on the Calendar, and select **Schedule Tracks** from the pop-up menu. Shows that do not yet contain any scheduled content are marked with a red exclamation mark icon, to the right of the show start and end times in the top bar. Shows partially filled with content have a yellow exclamation mark icon. During playout of the show, a green play icon will also be shown in the top bar. + +![](img/Screenshot488-Add_remove_content.png) + +The **Schedule Tracks** action opens a window with the name of the show. Like when using the **Now Playing** page, you can search for content items and add them to the show schedule on the right side of the page. Refer to the *Now Playing* chapter for details. + +When your show has all the required content, click the **OK** button in the bottom right corner to close the window. Back in the **Calendar**, click the show and select **View** from the pop-up menu to view a list of content now included in the show. + +![](img/Screenshot489-Show_Content.png) + +The **Contents of Show** window is a read-only interface featuring an orange bar which indicates how much media has been added to the show. Click the **OK** button in the bottom right corner, or the white **x** icon in the top right corner, to close the window. + +![](img/Screenshot353-Contents_of_show.png) + +### Removing content from a show + +To remove an individual item from a show, click on the show in the **Calendar**, and select **Schedule Tracks** from the pop-up menu. In the window which opens, click any item you wish to remove from the show, then click **Delete** on the pop-up menu, or check the box in the item's row then click the **Remove** icon at the top of the table. To remove all files and playlists from a show, click on the show in the **Calendar**, and select **Clear Show** from the pop-up menu.  + +### Deleting an upcoming show + +To delete an upcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete Instance and All Following** from the pop-up menu. + +![](img/Screenshot490-Delete_this_instance.png) + +You cannot delete or remove content from shows that have already played out. These shows have only one option on the pop-up menu, which is **View**. + +### Cancelling playout + +If you wish to cancel playout of a show while it is running, click on the show in the **Calendar** and select **Cancel Show** from the pop-up menu. This action cannot be undone. \ No newline at end of file diff --git a/docs/stats.md b/docs/stats.md deleted file mode 100644 index 10296e2de..000000000 --- a/docs/stats.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: default -title: Streaming Listener Statistics ---- - -The Listener Stats page on the Analytics menu shows graphs of listener connections to the configured streaming servers for the selected date and time range.  On the right side, a green **Status** indicator shows **OK** if the connection to the streaming server is active. - -![](img/portfolio/stream-stats.jpg) - -If the status indicator is red, check that the **Admin User** and **Admin Password** settings are correct under **Additional Options** for the named mount point, such as *libretime\_128*, on the **Streams** page of the **Settings** menu. - -By default, statistics for the last 24 hours of streaming are shown. To change this date and time range, click the calendar and clock icons in the lower left corner of the page, then click the magnifying glass icon. - -> To choose which particular streams should have statistics displayed, click the check boxes for the individual colour-coded mount points, just below the graph.