From fa1b598dda680d36a3060cd2709c072a74502e84 Mon Sep 17 00:00:00 2001 From: user Date: Mon, 22 Apr 2024 23:57:03 +0300 Subject: [PATCH] Regenerate PLUGINS.md --- PLUGINS.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/PLUGINS.md b/PLUGINS.md index edabf4e..fe22cbb 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -1,5 +1,5 @@ - + ## Description and configuration of available plugins ### Table of content: @@ -30,7 +30,7 @@ * [filter.nitter.pick - Pick NitterRecord with specified properties](#filternitterpick---pick-nitterrecord-with-specified-properties) * [filter.nitter.drop - Drop NitterRecord without specified properties.](#filternitterdrop---drop-nitterrecord-without-specified-properties) * [filter.channel - Pick YoutubeVideoRecord with specified properties](#filterchannel---pick-youtubevideorecord-with-specified-properties) - * [filter.channel.notify - Hold upcoming streams records until the start time](#filterchannelnotify---hold-upcoming-streams-records-until-the-start-time) + * [filter.channel.notify - Hold upcoming stream's records until the start time](#filterchannelnotify---hold-upcoming-streams-records-until-the-start-time) * [Actions:](#actions) * [discord.hook - Send record to Discord using webhook](#discordhook---send-record-to-discord-using-webhook) * [execute - Run pre-defined shell command](#execute---run-pre-defined-shell-command) @@ -992,19 +992,19 @@ as well as playlists, and, with login cookies, subscriptions feed. --- -### `filter.channel.notify` - Hold upcoming streams records until the start time +### `filter.channel.notify` - Hold upcoming stream's records until the start time -Determines whether a record represents a Youtube livestream or premiere -with scheduled time, and, if so, hold it waiting until the time comes -instead of passing down the chain immediately. +Determines whether a record represents a Youtube livestream/Premiere +with a scheduled time, and holds it waiting until the time comes +instead of passing down the chain immediately if needed. -If record is not an upcoming Youtube livestream, it gets silently dropped. +If the record is not an upcoming Youtube livestream, it gets silently dropped. #### Entity configuration options: * `name`: name of a specific entity. Used to reference it in `chains` section. Must be unique within a plugin. Required. ##### -* `prior`: output record this many minutes before the live start. Default value is `10`. +* `prior`: output a record this many minutes before the scheduled start of a live broadcast. Default value is `10`. * `include_ongoing`: whether currently live streams should be included. Default value is `false`.