Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-12-13 16:16:36 +01:00
Code Issues Projects Releases Wiki Activity

2017-10-19 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Applied structural markup to the 'rdairplay' chapter of the
	Operations Guide.
This commit is contained in:
Fred Gleason
2017-10-20 02:17:53 -04:00
parent c75eb44271
commit 8f07b45d60
2 changed files with 195 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
ChangeLog
View File

@@ -16193,3 +16193,6 @@
2017-10-19 Fred Gleason <fredg@paravelsystems.com> 2017-10-19 Fred Gleason <fredg@paravelsystems.com>
* Applied structural markup to the 'rdlogedit' chapter of the * Applied structural markup to the 'rdlogedit' chapter of the
Operations Guide. Operations Guide.
2017-10-19 Fred Gleason <fredg@paravelsystems.com>
* Applied structural markup to the 'rdairplay' chapter of the
Operations Guide.

251
docs/opsguide/opsguide.xml
View File

@@ -2536,7 +2536,8 @@
<para> <para>
RDAirPlay is the Rivendell module used to run logs generated by the RDAirPlay is the Rivendell module used to run logs generated by the
RDLogEdit or RDLogManager (for an overview of Rivendell logs, see RDLogEdit or RDLogManager (for an overview of Rivendell logs, see
Chapter Four). It contains a wide array of features for enabling <xref linkend="chapter.rdlogedit"/>).
It contains a wide array of features for enabling
playout of audio content in live assist as well as fully automated playout of audio content in live assist as well as fully automated
environments. environments.
</para> </para>
@@ -2544,10 +2545,13 @@
<sect1 id="sect.rdairplay.log_machines"> <sect1 id="sect.rdairplay.log_machines">
<title>Log Machines</title> <title>Log Machines</title>
<para> <para>
Fundamental to the operation of RDAirPlay is the concept of a log Fundamental to the operation of RDAirPlay is the concept of a
machine. A log machine is a virtual “device” into which a Rivendell <emphasis>log machine</emphasis>.
A log machine is a virtual “device” into which a Rivendell
log may be loaded and executed. RDAirPlay has three such log machines, log may be loaded and executed. RDAirPlay has three such log machines,
called Main Log, Aux 1 Log and Aux 2 Log. Each of these log machines called <computeroutput>Main Log</computeroutput>,
<computeroutput>Aux 1 Log</computeroutput> and
<computeroutput>Aux 2 Log</computeroutput>. Each of these log machines
is completely independent of the others in the sense that different is completely independent of the others in the sense that different
logs can be loaded and executed simultaneously in the respective logs can be loaded and executed simultaneously in the respective
machines. machines.
@@ -2556,7 +2560,7 @@
<sect1 id="sect.rdairplay.layout"> <sect1 id="sect.rdairplay.layout">
<title>Layout</title> <title>Layout</title>
<para> <para>
As shown in Illustration 24, the RDAirPlay main screen consists of As shown in FIXME, the RDAirPlay main screen consists of
four primary areas: the top area, which contains a variety of four primary areas: the top area, which contains a variety of
indicators for use in live assist situations as well as a set of indicators for use in live assist situations as well as a set of
audio meters; the button widget, which occupies the bulk of the audio meters; the button widget, which occupies the bulk of the
@@ -2570,7 +2574,8 @@
<sect2 id="sect.rdairplay.the_wall_clock"> <sect2 id="sect.rdairplay.the_wall_clock">
<title>The Wall Clock</title> <title>The Wall Clock</title>
<para> <para>
In the upper left-hand corner is wall clock indicator, which indicates In the upper left-hand corner is the wall clock indicator, which
indicates
the current system date and time. The style used for displaying times the current system date and time. The style used for displaying times
throughout RDAirPlay can be toggled between 24 hour “military” format throughout RDAirPlay can be toggled between 24 hour “military” format
and the traditional “AM/PM” presentation by clicking once on this and the traditional “AM/PM” presentation by clicking once on this
@@ -2588,30 +2593,35 @@
countdown and timing information. countdown and timing information.
</para> </para>
<para> <para>
The counter can be in one of four possible states: Idle, On Time, The counter can be in one of four possible states:
Under Time or Over Time. If the next upcoming hard timed event does <computeroutput>Idle</computeroutput>,
not have its post point attribute set, then the counter will be in Idle <computeroutput>On Time</computeroutput>,
mode (see Illustration 26). If the attribute is set however, then the <computeroutput>Under Time</computeroutput> or
counter will provide an estimate of how “on-time” the log currently <computeroutput>Over Time</computeroutput>.
The counter will provide an estimate of how “on-time” the log currently
is, on the basis of the current time and events still scheduled to be is, on the basis of the current time and events still scheduled to be
played. played.
</para> </para>
<para> <para>
If the playout is such that the post point will be reached within one If the playout is such that the next hard time will be reached within one
second of its programmed time, then the counter will be in On Time mode second of its programmed time, then the counter will be in
(see Illustration 27). The value shown in the square brackets is the <computeroutput>On Time</computeroutput> mode
scheduled time of the point point. (see FIXME). The value shown in the square brackets is the
scheduled time of the hard-timed event.
</para> </para>
<para> <para>
If the playout is such that the post point will be reached one second If the playout is such that the next hard time will be reached
or more before its programmed time, then the counter will be in Early one second
mode (see Illustration 28). It will also give an indication of how or more before its programmed time, then the counter will be in
<computeroutput>Early</computeroutput>
mode (see FIXME). It will also give an indication of how
much more material would need to be added to make the join on time. much more material would need to be added to make the join on time.
</para> </para>
<para> <para>
If the playout is such that the post point will be reached one second If the playout is such that the next hard time will be reached one
or more after its programmed time, then the counter will be in Late second or more after its programmed time, then the counter will be in
mode (see Illustration 29). It will also give an indication of how <computeroutput>Late</computeroutput>
mode (see FIXME). It will also give an indication of how
much material would need to be removed to make the join on time. much material would need to be removed to make the join on time.
</para> </para>
</sect2> </sect2>
@@ -2631,7 +2641,7 @@
of time it counts down, along with whether it counts to the start of time it counts down, along with whether it counts to the start
of the next transition or the absolute end of the event are both of the next transition or the absolute end of the event are both
configurable in RDADmin. The color of the band that grows as the configurable in RDADmin. The color of the band that grows as the
countdown progresses (shown RED in Illustration 31) will change color countdown progresses (shown RED in FIXME) will change color
to indicate if the currently playing event is the last event before to indicate if the currently playing event is the last event before
a log stopdown. If it is the last, it will be RED, if not, GREEN. a log stopdown. If it is the last, it will be RED, if not, GREEN.
A BLUE band and countdown will also appear to indicate the event's A BLUE band and countdown will also appear to indicate the event's
@@ -2643,9 +2653,12 @@
<para> <para>
Immediately to the right of the pie wedge widget is the next stop Immediately to the right of the pie wedge widget is the next stop
counter. The large numerals indicate the predicted interval of time counter. The large numerals indicate the predicted interval of time
before the next stopdown of the Main Log machine, with the actual before the next stopdown of the
predicted time in the square brackets. If the Main Log is already <computeroutput>Main Log</computeroutput> machine, with the actual
stopped, then the counter simply displays 'Stopped'. predicted time in the square brackets. If the
<computeroutput>Main Log</computeroutput> is already
stopped, then the counter simply displays
<computeroutput>Stopped</computeroutput>.
</para> </para>
</sect2> </sect2>
<sect2 id="sect.rdairplay.the_mode_indicator"> <sect2 id="sect.rdairplay.the_mode_indicator">
@@ -2653,11 +2666,16 @@
<para> <para>
In the upper right-hand corner of the top area is the mode indicator, In the upper right-hand corner of the top area is the mode indicator,
showing the current automation mode of the log machines. Three showing the current automation mode of the log machines. Three
different modes are possible: Automatic, in which all log features, different modes are possible:
including PLAY and SEGUE transitions and hard times are fully <computeroutput>Automatic</computeroutput>, in which all log features,
enabled; LiveAssist, in which no automatic transitions or hard start including <computeroutput>PLAY</computeroutput> and
<computeroutput>SEGUE</computeroutput> transitions and hard times
are fully
enabled; <computeroutput>LiveAssist</computeroutput>, in which no
automatic transitions or hard start
times are executed but automatic crossfades are done between times are executed but automatic crossfades are done between
elements; and Manual, which is very similar to LiveAssist except elements; and <computeroutput>Manual</computeroutput>, which is
very similar to LiveAssist except
that not even automatic crossfades are enabled (thus permitting that not even automatic crossfades are enabled (thus permitting
fully manual crossfade control by means of an external console). fully manual crossfade control by means of an external console).
To change RDAirPlay to a different mode, simply touch the mode To change RDAirPlay to a different mode, simply touch the mode
@@ -2690,21 +2708,29 @@
<para> <para>
As the name implies, the full log widget can be used to view the As the name implies, the full log widget can be used to view the
contents of a log over its entire length. To load a log, touch the contents of a log over its entire length. To load a log, touch the
Select Log button to bring up the Select Log dialog, select the <computeroutput>Select Log</computeroutput> button to bring up the
desired log from the list and then touch Load. The currently loaded Select Log dialog, select the
log can also be saved by touching the Save or Save As buttons, or desired log from the list and then touch
the current log unloaded by touching Unload. See Illustration 36. <computeroutput>Load</computeroutput>. The currently loaded
log can also be saved by touching the
<computeroutput>Save</computeroutput> or
<computeroutput>Save As</computeroutput> buttons, or
the current log unloaded by touching
<computeroutput>Unload</computeroutput>. See FIXME.
</para> </para>
<para> <para>
Once a log is loaded, it can be started at any point by touching an Once a log is loaded, it can be started at any point by touching an
event and then pressing the Play button. Any playing event can event and then pressing the <computeroutput>Play</computeroutput>
button. Any playing event can
likewise be stopped by touching in the event and then pressing the likewise be stopped by touching in the event and then pressing the
Stop button. To cue-up an event so that it is the next to play <computeroutput>Stop</computeroutput> button.
To cue-up an event so that it is the next to play
(indicated by the event being the first with a light green (indicated by the event being the first with a light green
background), touch the event and then press the Make Next button. background), touch the event and then press the
<computeroutput>Make Next</computeroutput> button.
The play parameters of an event can be modified by touching the event, The play parameters of an event can be modified by touching the event,
then pressing the Modify button, bringing up the Edit Event dialog then pressing the Modify button, bringing up the Edit Event dialog
(see Illustration 37). (see FIXME).
</para> </para>
<para> <para>
In addition to having the ability to modify the event's time and In addition to having the ability to modify the event's time and
@@ -2712,17 +2738,21 @@
the event's audio in Cue or set the start position of the audio for the event's audio in Cue or set the start position of the audio for
on-air playback (so as to allow a program to be joined on-air playback (so as to allow a program to be joined
&quot;in progress&quot;, for example). To audition the audio, &quot;in progress&quot;, for example). To audition the audio,
simply press the play button. The slider can be moved to adjust simply press the <computeroutput>Play</computeroutput> button.
The slider can be moved to adjust
where in the audio to audition from. To set the start position, where in the audio to audition from. To set the start position,
press the Start button and then position the slider where you wish press the <computeroutput>Start</computeroutput> button and then
the start to be. The red line on progress display indicates the position the slider where you wish
current start position. Pressing the Start button again returns the start to be. The red line on the progress display indicates the
current start position. Pressing the
<computeroutput>Start</computeroutput> button again returns
the dialog to Audition mode. the dialog to Audition mode.
</para> </para>
<para> <para>
When running a log, it is often desirable to have the currently When running a log, it is often desirable to have the currently
playing event always in sight. To do this, toggle the Scroll playing event always in sight. To do this, toggle the
button on (blue background). <computeroutput>Scroll</computeroutput>
button &quot;ON&quot; (blue background).
</para> </para>
</sect2> </sect2>
<sect2 id="sect.rdairplay.the_button_log_widget"> <sect2 id="sect.rdairplay.the_button_log_widget">
@@ -2730,7 +2760,8 @@
<para> <para>
To the left of the full log widget is the button log widget, To the left of the full log widget is the button log widget,
consisting of a column of seven large buttons adjacent to cart labels. consisting of a column of seven large buttons adjacent to cart labels.
This widget provides another, specialized “view” of the Main Log log This widget provides another, specialized “view” of the
<computeroutput>Main Log</computeroutput> log
machine. Specifically, the first seven currently playing and/or machine. Specifically, the first seven currently playing and/or
next events in that log machine will always be visible here. Events next events in that log machine will always be visible here. Events
visible in the button log will be shown in the full log widget as visible in the button log will be shown in the full log widget as
@@ -2740,7 +2771,8 @@
</para> </para>
<para> <para>
To start an event from the button log, simply touch an event's To start an event from the button log, simply touch an event's
corresponding Start button. Touching the button of a running event corresponding <computeroutput>Start</computeroutput> button.
Touching the button of a running event
will either (depending upon how the system administrator has will either (depending upon how the system administrator has
configured RDAirPlay) stop or pause it. To modify an event's configured RDAirPlay) stop or pause it. To modify an event's
parameters (via the Edit Event dialog), simply double-click the parameters (via the Edit Event dialog), simply double-click the
@@ -2758,55 +2790,92 @@
<sect2 id="sect.rdairplay_adding_an_event"> <sect2 id="sect.rdairplay_adding_an_event">
<title>Adding an Event</title> <title>Adding an Event</title>
<para> <para>
To add an event, touch the ADD button to open the Select Cart dialog, To add an event, touch the <computeroutput>ADD</computeroutput>
pick the desired cart and then touch OK. To place the selected cart button to open the Select Cart dialog,
using the button log widget, simply touch one of the yellow WHERE? pick the desired cart and then touch
<computeroutput>OK</computeroutput>. To place the selected cart
using the button log widget, simply touch one of the yellow
<computeroutput>WHERE?</computeroutput>
buttons. To place it using the full log widget, click the event buttons. To place it using the full log widget, click the event
where you wish it to go and then touch the yellow WHERE? button. where you wish it to go and then touch the yellow
<computeroutput>WHERE?</computeroutput> button.
If, after selecting a cart from the Select Cart dialog, you decide If, after selecting a cart from the Select Cart dialog, you decide
you don't want to add it after all, simply touch the ADD button again you don't want to add it after all, simply touch the
to cancel the operation (see Illustration 39). <computeroutput>ADD</computeroutput> button again
to cancel the operation (see FIXME).
</para>
<para>
Alternatively, if the System Administrator has enabled Drag and Drop
functionality, carts can be dragged directly from an instance of
RDLibrary and dropped into the desired location on RDAirPlay.
</para> </para>
</sect2> </sect2>
<sect2 id="sect.rdairplay_deleting_an_event"> <sect2 id="sect.rdairplay_deleting_an_event">
<title>Deleting an Event</title> <title>Deleting an Event</title>
<para> <para>
To delete an event, touch the DEL button, then touch one of the To delete an event, touch the <computeroutput>DEL</computeroutput>
violet DELETE buttons in the button log widget, or select an event button, then touch one of the
and then touch the violet DELETE button. To cancel the operation, violet <computeroutput>DELETE</computeroutput> buttons in the button
simply touch the DEL button again (see Illustration 40). log widget, or select an event
and then touch the violet <computeroutput>DELETE</computeroutput>
button. To cancel the operation,
simply touch the <computeroutput>DEL</computeroutput> button again
(see FIXME).
</para>
<para>
If the System Administrator has enabled Drag and Drop
functionality, carts can also be deleted by dragging the icon
of the trash can and dropping it onto the appropriate event.
</para> </para>
</sect2> </sect2>
<sect2 id="sect.rdairplay.moving_an_event"> <sect2 id="sect.rdairplay.moving_an_event">
<title>Moving an Event</title> <title>Moving an Event</title>
<para> <para>
To move an event, touch the Move button, then touch one of the violet To move an event, touch the <computeroutput>MOVE</computeroutput>
MOVE buttons in the button log widget, or select an event and then button, then touch one of the violet
touch the violet MOVE button, then touch one of the yellow TO buttons <computeroutput>MOVE</computeroutput> buttons in the button log
widget, or select an event and then
touch the violet <computeroutput>MOVE</computeroutput> button,
then touch one of the yellow <computeroutput>TO</computeroutput>
buttons
in the button log widget, or select an event and then touch the in the button log widget, or select an event and then touch the
yellow TO button. To cancel the operation at any stage, simply touch yellow <computeroutput>TO</computeroutput> button.
the MOVE button again. It is perfectly permissible to move an event To cancel the operation at any stage, simply touch
the <computeroutput>MOVE</computeroutput> button again.
It is perfectly permissible to move an event
between two different log machines. between two different log machines.
</para> </para>
</sect2> </sect2>
<sect2 id="sect.rdairplay.copying_an_event"> <sect2 id="sect.rdairplay.copying_an_event">
<title>Copying an Event</title> <title>Copying an Event</title>
<para> <para>
To copy an event, touch the Copy button, then touch one of the To copy an event, touch the <computeroutput>COPY</computeroutput>
violet COPY buttons in the button log widget, or select an event button, then touch one of the
and then touch the violet COPY button, then touch one of the yellow violet <computeroutput>COPY</computeroutput> buttons in the button
TO buttons in the button log widget, or select an event and then log widget, or select an event
touch the yellow TO button. To cancel the operation at any stage, and then touch the violet <computeroutput>COPY</computeroutput>
simply touch the COPY button again. It is perfectly permissible to button, then touch one of the yellow
<computeroutput>TO</computeroutput> buttons in the button log
widget, or select an event and then
touch the yellow <computeroutput>TO</computeroutput> button.
To cancel the operation at any stage,
simply touch the <computeroutput>COPY</computeroutput> button again.
It is perfectly permissible to
copy an event between two different log machines. copy an event between two different log machines.
</para> </para>
<para>
If the System Administrator has enabled Drag and Drop
functionality, carts can also be copied by simply dragging them
from where they are to the new location where they are wanted.
</para>
</sect2> </sect2>
<sect2 id="sect.rdairplay.the_soundpanel"> <sect2 id="sect.rdairplay.the_soundpanel">
<title>The SoundPanel</title> <title>The SoundPanel</title>
<para> <para>
The SoundPanel is an array of buttons that appears in the right-hand The SoundPanel is an array of buttons that appears in the right-hand
side of RDAirPlay when the Sound Panel button is selected (see side of RDAirPlay when the <computeroutput>Sound Panel</computeroutput>
Illustration 41). Each button can be associated with a particular button is selected (see FIXME). Each button can be associated with
a particular
cart in the Library (either Audio or Macro carts), which is then cart in the Library (either Audio or Macro carts), which is then
played each time the button is clicked. The soundpanel is played each time the button is clicked. The soundpanel is
particularly useful in live assist situations where it is desired to particularly useful in live assist situations where it is desired to
@@ -2819,12 +2888,15 @@
The SoundPanel has multiple panels or “panes” that can scrolled The SoundPanel has multiple panels or “panes” that can scrolled
through by touching the double-left or double-right arrow buttons. through by touching the double-left or double-right arrow buttons.
Each panel has a designator, (displayed just to the right of the Each panel has a designator, (displayed just to the right of the
arrow keys), consisting of the letter 'U' or 'S' followed by a arrow keys), consisting of the letter <computeroutput>U</computeroutput>
number. An 'S' indicates that the panel is a 'system' panel, or <computeroutput>S</computeroutput> followed by a
meaning that its button assignments will show up in all RDAirPlay number. An <computeroutput>S</computeroutput> indicates that the
instances across a given site; while a 'U' indicates a 'user' panel, panel is a 'system' panel,
meaning that its button assignments will show up only on this
particular host system; while a <computeroutput>U</computeroutput>
indicates a 'user' panel,
one which is associated with a particular user and that will one which is associated with a particular user and that will
&quot;follow around&quot; that user where ever he logs in in the &quot;follow around&quot; that user whereever he logs in in the
site. (Depending upon how the system administrator has configured site. (Depending upon how the system administrator has configured
RDAirPlay, you may not have both of these panel types available to RDAirPlay, you may not have both of these panel types available to
you). you).
@@ -2833,21 +2905,34 @@
<sect2 id="sect.rdairplay.programming_a_soundpanel_button"> <sect2 id="sect.rdairplay.programming_a_soundpanel_button">
<title>Programming a SoundPanel Button</title> <title>Programming a SoundPanel Button</title>
<para> <para>
To associate a cart with a panel button, first touch the Setup To associate a cart with a panel button, first touch the
<computeroutput>Setup</computeroutput>
button, which will begin to flash. (Depending upon how the system button, which will begin to flash. (Depending upon how the system
administrator has configured RDAirPlay, the Setup button may be administrator has configured RDAirPlay, the
<computeroutput>Setup</computeroutput> button may be
disabled). Next, touch the button you wish to program, opening the disabled). Next, touch the button you wish to program, opening the
Edit Button dialog (see Illustration 41). Edit Button dialog (see FIXME).
</para> </para>
<para> <para>
Touch the Set Cart button to open the Select Cart dialog and pick a Touch the <computeroutput>Set Cart</computeroutput> button to open
the Select Cart dialog and pick a
cart. To clear the button –i.e. have no cart associated with it – cart. To clear the button –i.e. have no cart associated with it –
touch the Clear button. To assign a custom background color to the touch the <computeroutput>Clear</computeroutput> button. To assign
button, touch the Set Color button. A custom label can be entered a custom background color to the
in the Label field, or the name of the cart will be used by default. button, touch the <computeroutput>Set Color</computeroutput> button.
Touch the OK button when done. When done programming all the A custom label can be entered
desired buttons, touch the Setup button again to toggle off Setup in the <computeroutput>Label</computeroutput> field, or the name of
mode. the cart will be used by default.
Touch the <computeroutput>OK</computeroutput> button when done.
When done programming all the
desired buttons, touch the <computeroutput>Setup</computeroutput>
button again to toggle off <computeroutput>Setup</computeroutput> mode.
</para>
<para>
If the System Administrator has enabled Drag and Drop
functionality, buttons can also be programmed by simply dragging and
dropping a cart (from RDLibrary or from elsewhere in RDAirPlay) onto
the desired button.
</para> </para>
</sect2> </sect2>
</sect1> </sect1>