Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-10-19 17:11:15 +02:00
Code Issues Projects Releases Wiki Activity

2023-12-05 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Rewrote and expanded the 'Events' section of the 'RDLogManager'
	chapter of the Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
2023-12-05 14:14:40 -05:00
parent 6071fd7b23
commit b01a4f5e6f
7 changed files with 233 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
ChangeLog
View File

@@ -24516,3 +24516,6 @@
2023-12-05 Fred Gleason <fredg@paravelsystems.com>
* Reduced the minimum size of rdairplay(1) to 1280x870 so as to fit
on a 1280x1024 display.
2023-12-05 Fred Gleason <fredg@paravelsystems.com>
* Rewrote and expanded the 'Events' section of the 'RDLogManager'
chapter of the Operations Guide.

4
docs/opsguide/Makefile.am
View File

@@ -285,6 +285,10 @@ OPSGUIDE_IMAGES = appendix.library_searches.full_list.png\
rdlogmanager.edit_event_assignment_dialog.png\
rdlogmanager.edit_grid_dialog.png\
rdlogmanager.editing_event.png\
rdlogmanager.events.importation_parameters.png\
rdlogmanager.events.post_import_events.png\
rdlogmanager.events.pre_import_events.png\
rdlogmanager.events.scheduling_parameters.png\
rdlogmanager.generate_log_dialog.png\
rdlogmanager.generate_log_dialog_fully_merged.png\
rdlogmanager.generate_log_dialog_music_merge_required.png\

BIN
docs/opsguide/rdlogmanager.events.importation_parameters.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB

BIN
docs/opsguide/rdlogmanager.events.post_import_events.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.4 KiB

BIN
docs/opsguide/rdlogmanager.events.pre_import_events.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/opsguide/rdlogmanager.events.scheduling_parameters.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

307
docs/opsguide/rdlogmanager.xml
View File

@@ -243,13 +243,14 @@
<sect1 xml:id="sect.rdlogmanager.events">
<title>Events</title>
<para>
An RDLogManager event is a set of rules that define a series of log
An RDLogManager event is a set of rules that define a series of zero
or more log
elements (audio carts, macro carts, markers, etc) that should be
inserted into a log, along with the appropriate log event parameters
(transition type, time type, etc) that should be associated with them.
(transition type, time type, etc) to be associated with them.
The actual elements to be inserted can be specified directly within
the event itself, or imported from a data file generated by an
external scheduling system. Up to two such external scheduling
external scheduling system. Up to two such external scheduling
sources can be defined for each service. While for convenience sake
these are designated as 'Traffic' and 'Music' within RDLogManager,
they can each be used anywhere a means of importing external
@@ -289,89 +290,233 @@
</mediaobject>
</para>
<para>
The Edit Event dialog consists of two main parts: a Library cart
The Editing Event dialog consists of two main parts: a Library cart
picker widget on the left side, and an area showing the various event
parameters on the right. Audio contained within audio carts can be
sampled by selecting the desired cart and then touching the
<computeroutput>Play</computeroutput>
button. Programming an event basically consists of specifying four
things: its log parameters (transition and time types), the list of
<computeroutput>Pre-Import</computeroutput> events, the event import
(if any) and the list of
<computeroutput>Post-Import</computeroutput> events.
The first matter to be decided is if the event
should have a hard start time: if so, then the
<computeroutput>Use hard start time</computeroutput>
check box in the TIMED START section should be ticked. Ticking this box
will enable all of the usual hard start parameters to be specified.
If an automatic timed start is not desired, then it is possible to
check the <computeroutput>Cue to this event</computeroutput> checkbox
in the <computeroutput>PREPOSITION LOG</computeroutput> section.
This will cause RDLogManager to place a hard time with a 'Make Next'
attribute on the first item of the event – effectively, causing the
event to be automatically “cued up” at the scheduled time – something
that can be particularly handy for keeping spot breaks in sync when
&quot;overscheduling&quot; music.
auditioned by selecting the desired cart and then touching the
<computeroutput>Play</computeroutput> button.
</para>
<para>
Next, if it is desired to have RDLogManager try to insert
material automatically from the Autofill List to ensure that the event
has the length indicated by its parent clock, the
<computeroutput>Use Autofill</computeroutput> box in
the <computeroutput>ENFORCING LENGTH</computeroutput> section
should be checked. (Configuring the
Autofill List is covered in detail in the Rivendell Technical and
Administration Guide). If Autofill is enabled, it is also possible
to tick the
<computeroutput>Warn if fill is under or over</computeroutput> checkbox
to have RDLogManager
generate a warning if it was unable to properly fill the event when
the log was generated.
</para>
<para>
Next, the list of log events (if any) to be inserted before the data
import should be placed in the
<computeroutput>PRE-IMPORT CARTS</computeroutput> list. For audio or
macro carts, these can be simply dragged and dropped from the Library
cart list on the left-hand side of the dialog. Meta events can be
inserted by right-clicking on the list and selecting the desired
element. It is also possible to edit or delete elements and set the
transition type of each element through the right-click menu.
</para>
<para>
The <computeroutput>IMPORT</computeroutput> section then defines
which (if any) source will be used
for importing external scheduling events into the log. Either
<computeroutput>Music</computeroutput>,
<computeroutput>Traffic</computeroutput> or
<computeroutput>None</computeroutput> can be selected. If
<computeroutput>Music</computeroutput> or
<computeroutput>Traffic</computeroutput> is selected,
then RDLogManager will import any events from those sources that fall
within the start and end times of the event (as supplied by the
parent clock). These start and end times can be further broadened by
means of 'slop factors' entered into the Import carts scheduled
controls (this is sometimes necessary to get the import to work
properly with certain external scheduler systems). The transition
types to be used for the first and subsequent imported elements can
be specified with the <computeroutput>First cart has a</computeroutput>
and <computeroutput>Imported carts have a</computeroutput>
controls. If <computeroutput>Music</computeroutput> has been selected
as the import source, it is
also possible to specify the event to use to import traffic breaks
embedded in the music log with the
<computeroutput>Import inline traffic</computeroutput> with the
control. (Configuration of the actual parser parameters for data
importation is covered in the Rivendell Technical and Administration
Guide).
</para>
<para>
Finally, the list of log events (if any) to be inserted after the
data import should be placed in the
<computeroutput>POST-IMPORT CARTS</computeroutput> list.
Configuration of the events works very similarly to that of the
<computeroutput>PRE-IMPORT CARTS</computeroutput> list.
Programming an event basically consists of specifying four
things:
</para>
<itemizedlist mark="opencircle">
<listitem>
<para>
Scheduling parameters (transition and time types)
</para>
</listitem>
<listitem>
<para>
Pre-import events
</para>
</listitem>
<listitem>
<para>
Importation parameters
</para>
</listitem>
<listitem>
<para>
Post-import events
</para>
</listitem>
</itemizedlist>
<sect4 xml:id="sect.rdlogmanager.events.scheduling_parameters">
<title>Scheduling Parameters</title>
<para>
Scheduling parameters are set in the
<computeroutput>PRE-POSITION LOG</computeroutput>,
<computeroutput>TIMED START</computeroutput>,
<computeroutput>TRANSITIONS</computeroutput> and
<computeroutput>ENFORCING LENGTH</computeroutput> sections of the
dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdlogmanager.events.scheduling_parameters.png" width="100mm" />
</imageobject>
<caption><para>Scheduling Parameters</para></caption>
</mediaobject>
</para>
<para>
If the event is to have a hard start time, then the
<computeroutput>Use hard start time</computeroutput>
check box in the <computeroutput>TIMED START</computeroutput>
section should be ticked; enabling
all of the usual hard start parameters to be specified.
(For details on hard start time parameters see
<xref linkend="sect.rdlogedit.time_and_time_types"/>).
</para>
<para>
If an automatic timed start is not desired, then it is possible to
check the <computeroutput>Cue to this event</computeroutput> checkbox
in the <computeroutput>PRE-POSITION LOG</computeroutput> section;
thus causing RDLogManager to place a hard time with a 'Make Next'
attribute on the first item of the event – effectively, causing the
event to be automatically “cued up” at the scheduled time – something
that can be particularly handy for keeping spot breaks in sync when
&quot;overscheduling&quot; music.
</para>
<para>
If it is desired to have RDLogManager try to insert
material automatically from the Autofill List to ensure that the event
has the length indicated by its parent clock, the
<computeroutput>Use Autofill</computeroutput> box in
the <computeroutput>ENFORCING LENGTH</computeroutput> section
should be checked. (See
<xref linkend="sect.rdadmin.manage_services.general.configure_autofill_carts"/>
for details).
If the <computeroutput>Use Autofill</computeroutput> checkbox is
ticked, then it is also possible to tick the
<computeroutput>Warn if fill is under or over</computeroutput> checkbox
to have RDLogManager generate a warning if it was unable to properly
fill the event when the log was merged.
</para>
<para>
Autofill is for cases where one wants to generate an event insertion in
the log (typically spots from the traffic system) of a given fixed
length. The classic use is for filling a break in a satellite-fed
program. One way to do that is to ensure that the traffic system always
provides events that add up to the correct duration, but that can be
tedious to do in certain traffic systems, so ‘Autofill’ is a way to
have Rivendell automatically make up any shortfall when filling breaks.
</para>
<para>
There are a few basic caveats:
</para>
<itemizedlist mark="opencircle">
<listitem>
<para>
Each Rivendell Service has a list of carts to be used for autofill
purposes (see
<xref linkend="sect.rdadmin.manage_services.general.configure_autofill_carts"/>
for details). The algorithm used to do the autofill is fairly
basic (essentially, &quot;use the
longest cart in the list that will fit until no more will
fit&quot;), so a good strategy is to create <emphasis>one</emphasis>
cart for each ’standard’ length (:60, :30, :10, :05, :02, etc) and
load up each with lots of &quot;filler&quot; material of the
appropriate length.
</para>
</listitem>
<listitem>
<para>
If the traffic system provides <emphasis>too many</emphasis> spots
in a break, it will overflow and the break will run long. This is
where the ‘Warn if fill is over/under…’ checkbox becomes especially
useful. Ticking that will cause a warning to be generated in the
Exception Report generated when importing the schedule.
</para>
</listitem>
<listitem>
<para>
The autofill happens <emphasis>when the log import happens</emphasis>,
not at log play-out time! Once a log is fully produced (generated,
merged and voice-tracked), autofill is done; “baked in” as it were.
</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 xml:id="sect.rdlogmanager.events.pre_import_events">
<title>Pre-Import Events</title>
<para>
Pre-import event parameters are set in the
<computeroutput>PRE-IMPORT EVENTS</computeroutput> section of the
dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdlogmanager.events.pre_import_events.png" width="100mm" />
</imageobject>
<caption><para>Pre-Import Event List</para></caption>
</mediaobject>
</para>
<para>
Pre-import events are a list of log events to be inserted
before any events are imported from an external schedule. For audio or
macro carts, these can be simply dragged and dropped from the Library
cart list on the left-hand side of the dialog. Meta events
(such as log notes or voice tracker markers) can be
inserted by right-clicking on the list and selecting the desired
type of element. It is also possible to edit or delete elements and
set the transition type of each element by doing a right-click on the
respective item in the list.
</para>
</sect4>
<sect4 xml:id="sect.rdlogmanager.events.importation_parameters">
<title>Importation Parameters</title>
<para>
Importation parameters are set in the
<computeroutput>IMPORT</computeroutput> section of the dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdlogmanager.events.importation_parameters.png" width="100mm" />
</imageobject>
<caption><para>Importation Parameters</para></caption>
</mediaobject>
</para>
<para>
This section is used to specify which (if any) source will be used
for importing external scheduling events into the log. Either
<computeroutput>None</computeroutput>,
<computeroutput>From Traffic</computeroutput>,
<computeroutput>From Music</computeroutput> or
<computeroutput>Select from</computeroutput> can be selected.
If <computeroutput>Traffic</computeroutput> or
<computeroutput>Music</computeroutput> is selected,
then RDLogManager will import any events from those sources that fall
within the start and end times of the event (as supplied by the
parent clock) inclusive. These start and end times can be further
broadened by
means of 'slop factors' entered into the
<computeroutput>
Import carts scheduled &lt;X&gt; prior to the start of this event.
</computeroutput>
and
<computeroutput>
Import carts scheduled &lt;X&gt; after the end of this event.
</computeroutput>
controls (this is sometimes necessary to get the import to work
properly with certain external scheduler systems). The transition
types to be used for the first and subsequent imported elements can
be specified with the <computeroutput>First cart has a</computeroutput>
and <computeroutput>Imported carts have a</computeroutput>
controls. If <computeroutput>Music</computeroutput> has been selected
as the import source, it is
also possible to specify the event to use to import traffic breaks
embedded in the music log with the
<computeroutput>Import inline traffic</computeroutput> with the
control. (For details on configuring inline traffic breaks, see
<xref linkend="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters"/>).
</para>
<para>
Selecting <computeroutput>Select from</computeroutput> will cause
RDLogManager to use Rivendell's built-in music scheduler to
import one cart, in accordance with the Group, separations and
Schedule Codes configured.
</para>
</sect4>
<sect4 xml:id="sect.rdlogmanager.events.post_import_events">
<title>Post-Import Events</title>
<para>
Post-import event parameters are set in the
<computeroutput>POST-IMPORT EVENTS</computeroutput> section of the
dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdlogmanager.events.post_import_events.png" width="100mm" />
</imageobject>
<caption><para>Post-Import Event List</para></caption>
</mediaobject>
</para>
</sect4>
<para>
The color of the event (as seen in the Edit Clock dialog) can be set
by touching the <computeroutput>Color</computeroutput> button.