diff --git a/ChangeLog b/ChangeLog index d7f15f8e..5b2cb262 100644 --- a/ChangeLog +++ b/ChangeLog @@ -16180,3 +16180,5 @@ 2017-10-17 Fred Gleason * Added the text of the 'Generating and Maintaining Logs with RDLogEdit' chapter to the Ops Guide. +2017-10-18 Fred Gleason + * Finished transcribing previous text into the Ops Guide. diff --git a/docs/opsguide/opsguide.xml b/docs/opsguide/opsguide.xml index 5e54b6ae..80283e87 100644 --- a/docs/opsguide/opsguide.xml +++ b/docs/opsguide/opsguide.xml @@ -2200,6 +2200,3640 @@ + + + Running Logs with RDAirPlay + + Overview + + RDAirPlay is the Rivendell module used to run logs generated by the + RDLogEdit or RDLogManager (for an overview of Rivendell logs, see + Chapter Four). It contains a wide array of features for enabling + playout of audio content in live assist as well as fully automated + environments. + + + + Log Machines + + Fundamental to the operation of RDAirPlay is the concept of a log + machine. A log machine is a virtual “device” into which a Rivendell + 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 + is completely independent of the others in the sense that different + logs can be loaded and executed simultaneously in the respective + machines. + + + + Layout + + As shown in Illustration 24, the RDAirPlay main screen consists 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 + audio meters; the button widget, which occupies the bulk of the + left-hand side of the screen; the right-hand side, which displays + either a SoundPanel array or a full log width; and the edit buttons + in the lower left-hand corner of the screen. + + + The top area contains the following indicators: + + + The Wall Clock + + In the upper left-hand corner is wall clock indicator, which indicates + the current system date and time. The style used for displaying times + throughout RDAirPlay can be toggled between 24 hour “military” format + and the traditional “AM/PM” presentation by clicking once on this + display. If the system administrator has enabled it, this display + will also flash RED to indicate possible clock inaccuracy due to loss + of master clock synchronization. + + + + The Post Point Counter + + Immediately to the right of the wall clock is the Post Point Counter. + A post point is an attribute applied to a log event with a hard time + type. The post point counter uses this information to display + countdown and timing information. + + + The counter can be in one of four possible states: Idle, On Time, + Under Time or Over Time. If the next upcoming hard timed event does + not have its post point attribute set, then the counter will be in Idle + mode (see Illustration 26). If the attribute is set however, then 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 + played. + + + If the playout is such that the post point will be reached within one + second of its programmed time, then the counter will be in On Time mode + (see Illustration 27). The value shown in the square brackets is the + scheduled time of the point point. + + + If the playout is such that the post point will be reached one second + or more before its programmed time, then the counter will be in Early + mode (see Illustration 28). It will also give an indication of how + much more material would need to be added to make the join on time. + + + If the playout is such that the post point will be reached one second + or more after its programmed time, then the counter will be in Late + mode (see Illustration 29). It will also give an indication of how + much material would need to be removed to make the join on time. + + + + The Audio Meter + + Immediately beneath the wall clock and post point counter is the audio + meter. The meter shows the current peak levels of audio being played + out of RDAirPlay, with '0' level referenced to -16 dBFS. + + + + The Pie Wedge Widget + + In the top center of the top area is the pie wedge widget. This + widget counts down the final few seconds of each event. The length + 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 + configurable in RDADmin. The color of the band that grows as the + countdown progresses (shown RED in Illustration 31) will change color + 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 BLUE band and countdown will also appear to indicate the event's + talk time (if talk time markers have been set in the underlying cart). + + + + The Next Stop Counter + + Immediately to the right of the pie wedge widget is the next stop + counter. The large numerals indicate the predicted interval of time + before the next stopdown of the Main Log machine, with the actual + predicted time in the square brackets. If the Main Log is already + stopped, then the counter simply displays 'Stopped'. + + + + 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 + different modes are possible: Automatic, in which all log features, + including PLAY and SEGUE transitions and hard times are fully + enabled; LiveAssist, in which no automatic transitions or hard start + times are executed but automatic crossfades are done between + elements; and Manual, which is very similar to LiveAssist except + that not even automatic crossfades are enabled (thus permitting + fully manual crossfade control by means of an external console). + To change RDAirPlay to a different mode, simply touch the mode + indicator until the desired mode is indicated. + + + + The Label Area + + Immediately below the next stop counter and mode indicator is the + label area. Text messages can be made to appear here (by means of + RML commands) to signal the operator concerning the state of the + system or need to take some kind of action. + + + + The Right-Hand Side + + Directly below the label area is the right-hand side. The right-hand + side can display either a SoundPanel array or a full log widget for + each of the three log machines, selected by clicking the appropriate + button in the lower right-hand corner of the screen. (NOTE: + depending upon how the system administrator has configured the + system, not all of the log machine buttons may be visible on your + system). + + + + The Full Log Widget + + 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 + Select Log button to bring up the Select Log dialog, select the + desired log from the list and then touch Load. The currently loaded + log can also be saved by touching the Save or Save As buttons, or + the current log unloaded by touching Unload. See Illustration 36. + + + 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 + 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 + (indicated by the event being the first with a light green + background), touch the event and then press the Make Next button. + The play parameters of an event can be modified by touching the event, + then pressing the Modify button, bringing up the Edit Event dialog + (see Illustration 37). + + + In addition to having the ability to modify the event's time and + transition parameters, the Edit Event dialog can be used to audition + 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 + "in progress", for example). To audition the audio, + simply press the play button. The slider can be moved to adjust + where in the audio to audition from. To set the start position, + press the Start button and then position the slider where you wish + the start to be. The red line on progress display indicates the + current start position. Pressing the Start button again returns + the dialog to Audition mode. + + + When running a log, it is often desirable to have the currently + playing event always in sight. To do this, toggle the Scroll + button on (blue background). + + + + 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. + This widget provides another, specialized “view” of the Main Log log + machine. Specifically, the first seven currently playing and/or + 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 + having a green background. Unlike the full log widget, the button + log is always visible, regardless of which display has been selected + for the right-hand side. + + + To start an event from the button log, simply touch an event's + corresponding Start button. Touching the button of a running event + will either (depending upon how the system administrator has + configured RDAirPlay) stop or pause it. To modify an event's + parameters (via the Edit Event dialog), simply double-click the + event's cart label. + + + + + Editing a Log + + It is possible to edit the log loaded into any of the three log + machines by means of the log edit buttons in the lower left-hand corner + of the screen. + + + Adding an Event + + To add an event, touch the ADD button to open the Select Cart dialog, + pick the desired cart and then touch OK. To place the selected cart + using the button log widget, simply touch one of the yellow WHERE? + 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. + 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 + to cancel the operation (see Illustration 39). + + + + Deleting an Event + + To delete an event, touch the DEL button, then touch one of the + violet DELETE buttons in the button log widget, or select an event + and then touch the violet DELETE button. To cancel the operation, + simply touch the DEL button again (see Illustration 40). + + + + Moving an Event + + To move an event, touch the Move button, then touch one of the violet + MOVE buttons in the button log widget, or select an event and then + touch the violet MOVE button, then touch one of the yellow TO buttons + 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 + the MOVE button again. It is perfectly permissible to move an event + between two different log machines. + + + + Copying an Event + + To copy an event, touch the Copy button, then touch one of the + violet COPY buttons in the button log widget, or select an event + and then touch the violet COPY button, then touch one of the yellow + TO buttons 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 the COPY button again. It is perfectly permissible to + copy an event between two different log machines. + + + + The SoundPanel + + The SoundPanel is an array of buttons that appears in the right-hand + side of RDAirPlay when the Sound Panel button is selected (see + Illustration 41). Each button can be associated with a particular + cart in the Library (either Audio or Macro carts), which is then + played each time the button is clicked. The soundpanel is + particularly useful in live assist situations where it is desired to + drop in some piece of audio on a live, improvised basis. + + + + Panel Types + + The SoundPanel has multiple panels or “panes” that can scrolled + through by touching the double-left or double-right arrow buttons. + Each panel has a designator, (displayed just to the right of the + arrow keys), consisting of the letter 'U' or 'S' followed by a + number. An 'S' indicates that the panel is a 'system' panel, + meaning that its button assignments will show up in all RDAirPlay + instances across a given site; while a 'U' indicates a 'user' panel, + one which is associated with a particular user and that will + "follow around" that user where ever he logs in in the + site. (Depending upon how the system administrator has configured + RDAirPlay, you may not have both of these panel types available to + you). + + + + Programming a SoundPanel Button + + To associate a cart with a panel button, first touch the Setup + button, which will begin to flash. (Depending upon how the system + administrator has configured RDAirPlay, the Setup button may be + disabled). Next, touch the button you wish to program, opening the + Edit Button dialog (see Illustration 41). + + + Touch the Set Cart button to open the Select Cart dialog and pick a + 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 + button, touch the Set Color button. A custom label can be entered + in the Label field, or the name of the cart will be used by default. + Touch the OK button when done. When done programming all the + desired buttons, touch the Setup button again to toggle off Setup + mode. + + + + + + + Generating Logs with RDLogManager + + Overview + + RDLogManager is a tool for generating Rivendell logs. It is different + from RDLogEdit in that, instead of building logs line-by-line, + it allows log structures to be defined by a series of rules (called + events and clocks) that are then plugged into a time framework + (called a grid). This grid is then used to automatically generate + logs on an as-needed basis. Each Rivendell service has its own, + separately defined grid, thus allowing for separate log generation + rules for each service. This system of rules allows for very + powerful, modular features, including the ability to import and use + scheduling data from various external third party systems, such as + music schedulers and traffic and billing systems. + + + RDLogManager also includes facilities for generating reports. Reports + are data outputs that detail whether certain events aired as + scheduled, and under what circumstances. Reports are available in + various formats. Some are intended to be read by humans, while + others are intended for use by other, external software systems as a + means of reconciling exported schedules. + + + When RDLogManager is started, it displays its main menu (see + Illustration 42). + + + + Grids + + Each Rivendell service has an RDLogManager grid. To see the list of + available grids, touch the Edit Grids button to open the Log Grids + dialog (see Illustration 43). + + + To open a particular grid, select its service name and touch the Edit + button (see Illustration 44). + + + Each grid has slots for every hour of every day of the broadcast week + – 168 slots in all. By specifying a particular clock to go into each + of these slots, a set of rules that RDLogManager can use to generate + a log for any given day of the week is built up. To specify a clock, + simply touch the particular hour of interest to open up the Select + Log Clock dialog (see Illustration 45). + + + Click the desired clock, then touch the OK button. To clear the + assignment of any clock to the selected hour, touch the Clear button, + then OK. + + + It is possible to 'drill down' directly to the underlying + configuration of a clock (to be covered shortly) by right-clicking on + the relevant hour in a grid and selecting Edit Clock. + + + + Clocks + + An RDLogManager clock is a collection of RDLogManager events, + arranged in terms of their start time (relative to the beginning of + the hour) and length. It basically can be thought of as the + "schedule" of an hour – any hour. Once defined, a clock + can be plugged into any hour of a grid of any service, thus making + for easy modularization and changes to a service's schedule. + + + To see the list of available clocks, touch the Edit Clocks button in + RDLogManager's Main Menu to open the Log Clocks dialog (see + Illustration 46). Each RDLogManager clock can be assigned a + three-letter code and color, as an aid in identifying it when + assigned to grids. To add a new clock, touch the Add button, or to + edit a clock's parameters, click on it and touch the Edit button. + In each case, the Edit Clock dialog (see Illustration 47) will open. + Clocks can also be deleted by touching the Delete button or renamed + by touching the Rename button. + + + The Edit Clock dialog consists of three main sections: a tabular + list of events in chronological order, a graphical depiction of the + clock in the traditional “broadcast clock” format, and a series of + action buttons across the bottom. The clock's three-letter code is + set by means of the Code: field in the upper right-hand corner of the + table area. Its color can be set by touching the Color button. To + save the clock without exiting the dialog, touch the Save or Save As + buttons. To add a new event to the clock, touch the Add button, or + to edit an existing entry touch the Edit button. In either case, + the Edit Event Assignment dialog will open (see Illustration 48). To + delete an entry, touch the Delete button. As in the case of grids, + it is possible to 'drill down' into the underlying RDLogManager + event by right-clicking on the respective entry in the clock event + table and selecting Edit Event. + + + The Edit Event Assignment dialog simply consists of an Event field + for the name of the RDLogManager event and Start Time: and End Time: + fields for the start and end times relative to the start of the + hour. A list of available events can be brought up by touching the + Select button to bring up the Log Events dialog. + + + Each clock can be designated as being associated with one or more + services. This can make finding the correct clock for a given + service much faster, as the Filter control on the List Clocks dialog + can then be used. To program these associations, touch the Services + List button in the Edit Clock dialog to bring up the Service + Associations dialog (see Illustration 49). + + + To designate a service as being valid for this clock, select the + services name in the Available Services list and then touch the Add + >> button. Likewise, to deselect a service, select its name in the + Enabled Services list and then touch the << Remove button. + + + + Events + + An RDLogManager event is a set of rules that define a series of 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. + 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 + 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 + scheduling data into the system is needed, regardless of whether such + data actually references commercial or musical material or not. + + + To see the list of available RDLogManager events, touch the Edit + Events button on the RDLogManager Main Menu to open the Log Events + dialog (see Illustration 50). It is possible to filter the list of + available events to only those used for a particular service by + selecting the service in the Filter: control. To add a new event, + touch the Add button, or to edit an event's parameters, click on it + and touch the Edit button. In each case, the Edit Event dialog (see + Illustration 51) will open. Events can also be deleted by touching + the Delete button or renamed by touching the Rename button. + + + The Edit 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 Play + button. Programming an event basically consists of specifying four + things: its log parameters (transition and time types), the list of + pre-import events, the event import (if any) and the list of + post-import events. The first matter to be decided is if the event + should have a hard start time: if so, then the Use hard start time + box in the TIMED START section should be checked. Checking 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 Cue to this event box in the PREPOSITION LOG 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 + "overscheduling" music. + + + Next, if it is desired to have RDLogManager try to insert + automatically material from the Autofill List to ensure that the event + has the length indicated by its parent clock, the Use Autofill box in + the ENFORCING LENGTH 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 check the Warn if fill is under or over box to have RDLogManager + generate a warning if it was unable to properly fill the event when + the log was generated. + + + Next, the list of log events (if any) to be inserted before the data + import should be placed in the PRE-IMPORT CARTS 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. + + + The IMPORT section then defines which (if any) source will be used + for importing external scheduling events into the log. Either Music, + Traffic or None can be selected. If Music or Traffic 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 First cart has a and Imported carts have a + controls. If Music 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 Import inline traffic with the + control. (Configuration of the actual parser parameters for data + importation is covered in the Rivendell Technical and Administration + Guide). + + + Finally, the list of log events (if any) to be inserted after the + data import should be placed in the POST-IMPORT CARTS list. + Configuration of the events work very similarly to that of the + PRE-IMPORT CARTS list. + + + The color of the event (as seen in the Edit Clock dialog) can be set + by touching the Color button. The list of services for which this + event is valid can be edited by touching the Services List button. + To save the event without exiting the dialog, touch the Save or Save + As buttons. + + + + Generating Logs + + After all of the appropriate hours have been populated in a service's + grid, it's time to start generating logs. To do this, touch the + Generate Logs button in RDLogManager's Main Menu to open the Generate + Log dialog (see Illustration 52). + + + Depending upon how many external scheduling sources are involved, + generating a log involves one, two or three steps. Before performing + any of the steps, it is first necessary to select the relevant + service for which to generate the log (using the Service: control) + and the log date (either by entering the date in the Date: control + or by touching the Select button and picking it off of the calendar). + + + In all cases, a new log is initially generated by touching the Create + New Log button. If the log for the selected date and service does not + already exist, it will be created at this point (becoming visible in + RDLogEdit). It the log already exists, it will be overwritten. + (NOTE: if completed voicetracks exist in the old log, they will be + deleted when the log is overwritten!) + + + When generating a log, RDLogManager will look for possible problems + (such as scheduled carts that are missing in the Library) and + generate an exception report if it finds any. + + + Once generated, the status lights in the Generate Log dialog indicate + which (if any) additional import data are needed to complete the log. + Two types of status light exist: Available, which indicates if the + required data file is available to RDLogManager, and Merged, + indicating whether the data has been merged into the log as yet. + Each light can show one of three different colors: GREEN, meaning + "yes", RED, meaning "no" and WHITE, meaning + "not required". + + + For an example, see Illustration 53. This is showing a log that has + been generated and has music data available but not yet merged. To + perform the merge, touch the Merge Music button. The dialog now + changes to that shown in Illustration 54, indicating that Music data + has been merged but that traffic data is still needed. Once a log + has reached this state – that of having any necessary music data + merged – it can be voicetracked without having to wait for traffic + data to become available. Traffic data can be merged at any time + before, during or after the generation of voicetracks. The actual + traffic merge is performed by touching the Merge Traffic button, + resulting in a dialog like that shown in Illustration 55. (NOTE: + the configuration of the various data file names and parser parameters + needed for data import is done in the RDAdmin module and is covered + in the Rivendell Technical and Administration Guide). + + + It is important to note that the sequence of operations from the + example above is typical, but may vary depending upon how the system + administrator has configured RDLogManager at each site. Some services, + for example, will have no music data, only traffic, so the music + indicator lights will be "whited out" accordingly. + + + + Generating Reports + + A Rivendell report is a data output that details whether certain + events aired as scheduled, and under what circumstances. Reports are + available in various formats. Some are intended to be directly read + by humans, while others are intended for use by other, external + software systems as a means of reconciling exported schedules. + + + Rivendell has the ability to filter the data that go into any + particular report on the basis of the type of material played (traffic + spots, music or all), the playing service(s) and the originating + host(s). The configuration of reports is done in the RDAdmin module + and is covered in the Rivendell Technical and Administration Guide. + Once configured however, reports are actually generated by the + RDLogManager module. + + + To generate a report, touch the Manage Reports button on the + RDLogManager Main Menu to open the Select Service dialog (see + Illustration 56). The dialog will show each service on the system, + along with the date of the oldest data available for generating + reports. Touch the Generate Reports button to open the Select Report + Dates dialog (see Illustration 57). The desired report can be + selected with the Report: control, and the start and end dates of the + report specified with the Start Date: and End Date: controls, + respectively (NOTE: not all reports are capable of being generated so + as to span more than one day). Once the parameters are set, touch the + Generate Report button to write out the report. + + + Purging Old Report Data + + Rivendell keeps the raw data used to generate reports indefinitely, + until manually purged out of the system. Periodic purging of old + data is a good idea from the standpoint of minimizing the amount of + system resources utilized, and can be done by selecting the desired + service and then touching the Purge Data button in the Select + Service dialog, opening up a calendar dialog (see Illustration 58). + Each date that has data eligible for purging will be shown in bold. + To purge a particular day, select it and the touch the Purge Data + button. (NOTE: once purged, no reports can be generated for that + particular service/date, so be sure that all required reports have + been produced before purging!) + + + + + + + VoiceTracking + + Voicetracking in Rivendell + + Voicetracking is a capability wherein custom "one-off" + content is created and inserted into logs, making it possible to + create programming that sounds very spontaneous and "live". + In Rivendell, such voicetracks are placed into a special type of audio + cart known as a voicetrack cart. These carts are automatically + created, deleted and managed by the voicetracker interface (part of + the RDLogEdit module), with no manual user intervention required. + The voicetracker module also includes extensive capabilities for + allowing customization of the transitions between log elements. + + + Prerequisites + + Before beginning voicetracking for a particular service, a + voicetracker group and pool of available cart numbers must be + configured in the RDAdmin module. These procedures are detailed in + the Rivendell Technical and Administration Guide. + + + + VoiceTrack Markers + + A voicetrack marker is a meta event that can be inserted into a log + as a "placeholder" to others to indicate where a voicetrack + is to be recorded. Track markers can be inserted by RDLogEdit, + RDLogManager events or even embedded in data generated by external + schedulers. + + + + + Using the Voicetrack Interface + + The VoiceTracker Dialog + + To voicetrack a log, start the RDLogEdit module (see Illustration 19), + highlight the desired log and touch the VoiceTracker button, opening + the VoiceTracker dialog (see Illustration 59). This dialog consists + of three major parts: the waveform area, the log list and the control + buttons. + + + The waveform area is in the upper center part of the dialog, and + consists of four "panes". The upper three display waveform + depictions while the fourth contains audition control buttons, an + audio meter and various counters. Directly below this is the log + list, showing a copy of the currently loaded log. The control + buttons occupy the bottom and right-hand edges of the dialog. + + + + Editing Transitions + + When an event is selected in the log list, a graphical depiction of + the transition into that event is loaded into the waveform area. + If the selected event and its prior event in the log is not a + voicetrack or track marker, then the selected event will be + displayed in the third pane of the waveform area and the previous + event displayed in the first pane. If the selected event or its + prior event is a voicetrack or track marker, then voicetrack or + marker will be displayed in the second pane of the waveform area. + + + Once selected, a transition can be auditioned by touching the play + button in the fourth pane of the waveform area. Play will start + from the left-hand edge of the topmost waveform. This start + location can be adjusted by dragging the topmost waveform to the + left or right by means of the mouse or touchscreen. If the + transition type of the selected event is SEGUE, it is also possible + to adjust the degree of audio overlap by dragging the second or + third waveform as well. It's possible to “undo” changes made in + the segue overlap by right-clicking on the waveform and selecting + Undo Segue Changes from the menu. To make the overlap permanent, + touch the Save button. To restore the transition to its default + state (calculated on the basis of segue markers from the Library) + touch the Do Over button. The transition type can be changed by + right-clicking on an event and selecting the desired transition + type from the menu. + + + + Inserting and Deleting Track Markers + + It is possible to insert a new voicetrack marker by selecting the + desired location in the log list and touching the Insert Track + button. An existing voicetrack marker can likewise by deleted by + selecting it in the log list and touching the Delete Track button. + + + + Moving Between Track Markers + + It is possible to move directly to the next or previous voicetrack + marker simply by touching the Next Track or Previous Track buttons, + respectively. + + + + Recording a Voicetrack + + Once the desired voicetrack marker has been selected, the process + of recording a voicetrack consists of four steps, each initiated by + one of the four square control buttons in the upper right-hand + corner of the dialog. (See Illustration 50). + + + To begin, touch the topmost Start button. This will cause the + audio in the topmost pane to begin playing, with a cursor to show + playback position (see Illustration 61). To begin the actual + recording, touch the Record button (see Illustration 62). To start + the following event (in the third pane), touch the second Start + button (see Illustration 63). Finally, to stop recording, touch + the Save button (see Illustration 64). The record process can be + canceled at any time by touching the Abort button, restoring the + transition to its default state. It is also possible to undo a + completed voicetrack by touching the Do Over button. + + + Once completed, the segue overlaps into and out of a voicetrack can + be adjusted in the same manner as for simple transitions –i.e. by + dragging the appropriate waveforms with the mouse. + + + + Adjusting Transition Levels + + It is possible to adjust the audio fade levels applied during + transitions by means of rubber bands on the waveform displays. + These are green lines with small square targets. To adjust a rubber + band, use the mouse to grab one of the targets and drag it to the + desired location. + + + + Importing Voicetracks + + In addition to recording in realtime, it's possible to import a + voicetrack directly from an audio file. To do so, select the + desired voicetrack marker and then touch the Import button to open + the Import/Export Audio dialog (see Illustration 5). (For more + information on using the Import/Export Audio dialog, see Section + 3.1.0 Importing Audio from a File). Once imported, the voicetrack + can be manipulated in the same manner as those that were directly + recorded. + + + + Hitting the Post + + If the event following a voicetrack has its Talk Time markers set, + it is possible to set the transition so that the end of the + voicetrack automatically aligns with the end of the Talk Time + (commonly referred to as hitting the post). To do this, simply + touch the Hit Post button. + + + + + + + Rivendell Macro Langauge + + Overview + + Rivendell Macro Language (or RML for short) is a set of commands + implemented within Rivendell that can be used to program the system + to take various actions. A wide variety of commands exist, ranging + from control of outboard gear (such as switchers and GPIO devices) + to control of various aspects of log playout in RDAirPlay, to + Rivendell user management. + + + + Protocol + + The Normal form of a command takes the following syntax: + + + cmd [arg] [...]! + + + + + cmd + + + + A command mneumonic consisting of two alpha-numeric characters + indicating the action to be performed. + + + + + + arg + + + + Zero or more arguments, delimited by spaces or, if the last + argument, by ! (see below) + + + + + + ! + + + + The ASCII character 33, indicating the end of the command sequence. + + + + + + + + Command Delivery + + To be executed by a Rivendell system, an appropriate command should be + delivered to UDP ports 5858 or 5859 on said system, using the SOCK_DGRAM + connectionless protocol. Commands delivered to port 5858 may receive a + reply back to the originating IP address at UDP socket 5860 to indicated + command success/failure, while commanders delivered to 5859 will be + processed, but no reply made. + + + + + Command Reply + + If delivered to UDP port 5858, each command may receive a reply, + formulated as follows: + + + rpy +|- + + + + + rpy + + + + The full command string (including arguments) originally received + + + + + + + + + + + ACK response, indicates success of the command. + + + + + + - + + + + NAK response, indicates failure of the command. + + + + + + + + Specifying Color + + In places where a color can be specified as a macro argument, the + following predefined values are valid: + + + white + red + green + blue + cyan + magenta + yellow + gray + lightGray + black + darkRed + darkGreen + darkBlue + darkCyan + darkMagenta + darkYellow + darkGray + + + + + Binary Data + + Certain commands (e.g. SO and UO) + have the ability to transmit arbitrary binary data in addition to textual + characters. Such arbitrary binary data can be specified by means of + escape codes as follows: + + + %hexcode + + + + + + hexcode + + + Two digit numeric value of the byte to send in hexidecimal. + + + + + + For example, the sequence 'TEST' followed by a carriage return/newline + could be specified as: + + + TEST%0D%0A + + + + + Commands + + <command>Air Gate [AG]</command> + + + + Module + ripcd8 + + + Mnemonic + AG + + + + + Process an RML only if the On-Air flag is ON. + + + AG + rml! + + + Execute RML rml only if the On-Air flag on + the local machine is ON. + + + + + <command>Add Next [PX]</command> + + + + Module + rdairplay1 + + + Mnemonic + PX + + + + + Insert a cart in a log in the next to play position. + + + PX + mach + cart! + + + Insert cart cart> in the next to play + position on log machine mach. + + + + + <command>Binary Serial Out [BO]</command> + + + + Module + ripcd8 + + + Mnemonic + BO + + + + + Output a string of binary codes. + + + BO + portnum + hexcode + ..! + + + Output a string of binary codes represented by + hexcode .. on + serial port portnum! + + + + + <command>Clear Serial Trap [SC]</command> + + + + Module + ripcd8 + + + Mnemonic + SC + + + + + Clear a serial trap. + + + SC + portnum + cart + string! + + + SC + portnum + cart! + + + SC + portnum! + + + Clear a serial trap. The three argument form will clear all traps on + port that reference + cart and string. + The two argument form will clear all traps on + port that reference + cart, while the one argument form will + clear all traps on port. + + + + + <command>Command Send [CC]</command> + + + + Module + ripcd8 + + + Mnemonic + CC + + + + + Send RML to a remote host. + + + CC + dest + [:udpport] + rml! + + + Send the RML command rml to + dest.dest may be + either a Rivendell host name or an IP address. A UDP port value may be + optionally specified as udpport (default + value 5859). + + + + + <command>Connect Jack Ports [JC]</command> + + + + Module + ripcd8 + + + Mnemonic + JC + + + + + Connect a JACK input port to an output port. + + + JC + output + input! + + + Attempt to connect JACK input port input + to output. + + + + + <command>Console Label [CL]</command> + + + + Module + ripcd8 + + + Mnemonic + CL + + + + + Set the label on a control surface. + + + CL + matrix + surface + chan + label! + + + On matrix matrix, set the input + chan module label of control surface + surface to label. + + + + + <command>Copy Cut [CP]</command> + + + + Module + rdcatchd8 + + + Mnemonic + CP + + + + + Copy cut audio and metadata. + + + CP + srccart + srccut + dstcart + dstcut! + + + Copy the audio and metadata from cut number + srccut in cart + srccart to cut number + dstcut in cart + dstcart. The destination cart/cut must + already exist. + + + + + <command>Cut Event [CE]</command> + + + + Module + rdcatchd8 + + + Mnemonic + CE + + + + + Place a cut event at the current location of an active RDCatch recording. + + + CE + decknum + eventnum! + + + Place a cut event with event number + eventnum at the current position of the + active recording in RDCatch Deck + decknum. + + + + + <command>Database Backup [DB]</command> + + + + Module + ripcd8 + + + Mnemonic + DB + + + + + Backup the Rivendell database. + + + DB + filename! + + + Create a backup copy of the active Rivendell database in + filename. + + + + + <command>Disconnect Jack Ports [JD]</command> + + + + Module + ripcd8 + + + Mnemonic + JD + + + + + Disconnect a JACK input port from an output port. + + + JD + output + input! + + + Attempt to disconnect JACK input port input + from output. + + + + + <command>Duck Panel Button [PD]</command> + + + + Module + rdairplay1 + + + Mnemonic + PD + + + + + Set the duck level of a SoundPanel button in RDAirPlay. + + + PD + panel + col + row + level + fade + [mport]! + + + Set the duck level of button at column, + row> of panel + panel. + Panel: S1...S50 or + U1...U50; + C for panel means + currently selected panel. + If col and/or row + is 0: duck all buttons in + col or row. + If playing, the audio fades to level + (in dbFS) in fade msecs. + If specified, only stop carts playing on panel port + mport. The duck level will be set to 0 after + the playback is finished, or the button is stopped or reset. + + + + + <command>Execute Breakaway [DX]</command> + + + + Module + rdcartslots1 + + + Mnemonic + DX + + + + + Execute a breakaway. + + + DX + slotlen! + + + Execute a breakaway of length len (in mS) + using the autofill carts configured for the service currently loaded + in the slot slot. The slot must be in + Breakaway mode. If a breakaway is currently executing, it will + immediately be aborted and a new one started. Passing a '0' for + len will cause any currently executing + breakaway immediately to be aborted and input audio restored. + + + + + <command>Execute Cart [EX]</command> + + + + Module + rdcatchd8 + + + Mnemonic + EX + + + + + Execute a macro cart. + + + EX + cartnum! + + + Execute macro cart cartnum on the local host. + + + + + <command>Fire Salvo [FS]</command> + + + + Module + ripcd8 + + + Mnemonic + FS + + + + + Execute a switcher salvo. + + + FS + matrix + salvo! + + + Fire salvo number salvo on matrix + matrix. + + + + + <command>GPI Enable [GE]</command> + + + + Module + ripcd8 + + + Mnemonic + GE + + + + + Enable/disable a GPI line. + + + GE + matrix + type + gpinum + state! + + + Enable or disable the GPI line of type type + indicated by gpinum on matrix + matrix. Possible types are: + + + + + I + Input + + + O + Output + + + + + + + <command>GPI Enable [GE]</command> (old format, deprecated) + + + + Module + ripcd8 + + + Mnemonic + GE + + + + + Enable/disable a GPI line. + + + GE + matrix + gpinum + state! + + + Enable or disable the GPI line indicated by + gpinum on matrix + matrix. + + + + + <command>GPI Set [GI]</command> + + + + Module + ripcd8 + + + Mnemonic + GI + + + + + Set action in response to a GPIO event. + + + GI + matrix + type + gpinum + state + cart! + + + Execute the macro cart cart upon transition + of the GPIO of type type and line + gpinum on matrix + matrix to state. + Possible types are: + + + + + I + Input + + + O + Output + + + + + + + <command>GPI Set [GI]</command> (old format, deprecated) + + + + Module + ripcd8 + + + Mnemonic + GI + + + + + Set action in response to a GPIO event. + + + GI + matrix + gpinum + state + cart! + + + Execute the macro cart cart upon transition + of the GPIO of line gpinum on matrix + matrix to state. + + + + + <command>GPO Set [GO]</command> + + + + Module + ripcd8 + + + Mnemonic + GO + + + + + Set the state of a GPIO line. + + + GO + matrix + type + gponum + state + length! + + + Command GPIO line gponum of type + type on matrix + matrix> to state + for length> mS. A length of + 0 indicates to hold the state indefinitely. + Possible types are: + + + + + I + Input + + + O + Output + + + + + Possible states are: + + + + + 0 + OFF + + + 1 + ON + + + -1 + Passthrough hardware input (valid only for Input type) + + + + + + + <command>GPO Set [GO]</command> (old format, deprecated) + + + + Module + ripcd8 + + + Mnemonic + GO + + + + + Set the state of a GPIO line. + + + GO + matrix + gponum + state + length! + + + Command GPIO line gponum on matrix + matrix> to state + for length> mS. A length of + 0 indicates to hold the state indefinitely. + + + + + <command>Insert Serial Trap [SI]</command> + + + + Module + ripcd8 + + + Mnemonic + SI + + + + + Insert a serial trap to detect a character sequence. + + + SI + portnum + cart + string! + + + Insert a serial trap to execute the macro cart + cart upon receipt of + string on serial port + port. + + + + + <command>Label Panel [PC]</command> + + + + Module + rdairplay1 + + + Mnemonic + PC + + + + + Set the label of a SoundPanel button in RDAirPlay. + + + PC + panel + col + row + label + color! + + + Set the button at col, + row of panel panel + to have a text label of label and a + background color of color. + Panel: S1...S50 or + U1...U50; + C for panel means + currently selected panel. + + + + + <command>Load Log [LL]</command> + + + + Module + rdairplay1 + + + Mnemonic + LL + + + + + Load a log into RDAirPlay. + + + LL + mach + [logname] + [startline]! + + + Load the log logname in log machine + mach. After loading, start the log at line + startline if it is >=0. If + startline is -2, the log will be started at + the first event if that event does not have a 'stop' transition. + Default startline=-1. If no + log> is specified, the machine's current log + is unloaded. + + + + + <command>Load Panel [PE]</command> + + + + Module + rdairplay1 + + + Mnemonic + PE + + + + + Load a cart into a SoundPanel button in RDAirPlay. + + + PE + panel + col + row + cart! + + + Load cart cart into the button at + col,row of panel + panel. + Panel: S1...S50 or + U1...U50; + C for panel means + currently selected panel. + + + + + <command>Load Slot [DL]</command> + + + + Module + rdcartslots1 + + + Mnemonic + DL + + + + + Load an RDCartSlots slot. + + + This command has two syntaxes, depending upon the mode of the slot. + + + Cart Deck Mode syntax: + + + DL + slot + cart! + + + Load the cart cart into the + slot slot. Passing a '0' for + cart will cause the slot to be unloaded. + This command will be ignored if the slot is currently playing. + + + Breakaway Mode syntax: + + + DL + slot + svcname! + + + Set the slot slot to use service + svcname. Omitting the + svcname argument will cause the slot to be + unloaded. This command will be ignored if the slot is currently + executing a breakaway. + + + + + <command>Login [LO]</command> + + + + Module + ripcd8 + + + Mnemonic + LO + + + + + Change the active Rivendell user context. + + + LO + user + password! + + + Set the current Rivendell user to user. + If no arguments are supplied, log out the station --i.e. revert to the + default user. + + + + + <command>Macro Timer [MT]</command> + + + + Module + ripcd8 + + + Mnemonic + MT + + + + + Timer for running macro carts. + + + MT + timernum + timeout + cart! + + + Set the macro timer timernum to execute macro + cart cart in + timeout milliseconds. Setting + timeout to 0 disables + the timer. Sixteen macro timers (numbered 1-16) are available on each + Rivendell host. + + + + + <command>Make Next [MN]</command> + + + + Module + rdairplay1 + + + Mnemonic + MN + + + + + Load changes to a currently loaded log in RDAirPlay. + + + RL + mach + line! + + + Set the next event for log machine mach to + line line>. + + + + + <command>Message Box [MB]</command> + + + + Module + ripcd8 + + + Mnemonic + MB + + + + + Display a popup message box on a host display. + + + MB + display + severity + msg! + + + Display the text msg in a popup window on X + display display, with an icon to indicate + severity. Valid values of + severity are: + + + + 1 + Information + + + 2 + Warning + + + 3 + Critical + + + + + + <command>Pause Panel [PU]</command> + + + + Module + rdairplay1 + + + Mnemonic + PU + + + + + Pause a SoundPanel button in RDAirPlay. + + + PU + panel + col + row + [mport]! + + + Pause the button at col, + row of panel panel. + Panel: S1...S50 or + U1...U50; + C for panel means + currently selected panel. + If col and/or row + is 0: pause all playing buttons in + col or row. + If specified, start the playout on panel port + mport. + + + + + <command>Play Panel [PP]</command> + + + + Module + rdairplay1 + + + Mnemonic + PP + + + + + Load a cart into a SoundPanel button in RDAirPlay. + + + PP + panel + col + row + [mport] + [0|1]! + + + Play the button at col, + row of panel panel. + Panel: S1...S50 or + U1...U50; + C for panel means + currently selected panel. + If col and/or row + is 0: Start the first loaded button that is not + active. If specified, start the playout on panel port + mport. The started panel will stay active when + finished, if the 5th argument is 1. + + + + + <command>Play Slot [DP]</command> + + + + Module + rdcartslots1 + + + Mnemonic + DP + + + + + Play an RDCartSlots slot. + + + DP + slot! + + + Play the cart currently loaded in the slot + slot. The slot must be in Cart Deck mode. This command will be + ignored if the slot is unloaded or already playing. + + + + + <command>Refresh Log [RL]</command> + + + + Module + rdairplay1 + + + Mnemonic + RL + + + + + Load changes to a currently loaded log in RDAirPlay. + + + RL + mach! + + + Refresh the log currently loaded in log machine + mach. + + + + + <command>Run Shell Command [RN]</command> + + + + Module + ripcd8 + + + Mnemonic + RN + + + + + Run a shell command. + + + RN + cmd! + + + Run the shell command cmd. + + + + + <command>Select Widget [PW]</command> + + + + Module + rdairplay1 + + + Mnemonic + PW + + + + + Select right-hand widget in RDAirPlay. + + + PW + mach! + + + Select right-hand widget to log-machine mach + or 0 for sound panel. + + + + + <command>Serial Out [SO]</command> + + + + Module + ripcd8 + + + Mnemonic + SO + + + + + Output a string on a serial port. + + + SO + portnum + data! + + + Output data on serial port + portnum. data can + consist of arbitrary binary data as well as textual characters (see + Binary Data above). + + + + + <command>Serial Reload [SY]</command> + + + + Module + ripcd8 + + + Mnemonic + SY + + + + + Reload the configuration for a serial port. + + + SY + portnum! + + + Reload the configuration for serial port + portnum. Normally, this should only be + issued by RDAdmin following a configuration change. + + + + + <command>Set Color Label [LC]</command> + + + + Module + rdairplay1 + + + Mnemonic + LC + + + + + Display a color message in the label widget on RDAirPlay. + + + LC + color + string! + + + Display string> in color + color in the message widget. + + + + + <command>Set Default Now & Next Cart [SN]</command> + + + + Module + rdairplay1 + + + Mnemonic + SN + + + + + Set the default Now & Next cart. + + + SN + now|next + mach + cart! + + + Set the default Now & Next cart for log + mach to cart. + + + + + <command>Set Display [SD]</command> + + + + Module + ripcd8 + + + Mnemonic + SD + + + + + Set a console display. + + + SD + matrix + display + line + col + attr + label! + + + On matrix matrix, set the console display + display to label, + starting at position line, + col and using message attributes + attr. + + + The message attributes value is constructed as follows: + + + + Bit 7 + Display mode + + + Bits 6,5 + Video attribute + + + Bit 2,1,0 + Message Text Color + + + + Display Mode: + + + + 0 + Overwrite text + + + 1 + Insert text + + + + Video Attribute: + + + + 00 + Normal + + + 01 + Flash + + + 02 + Reverse + + + + Text Color: + + + + 000 + White + + + 001 + Red + + + 010 + Yellow + + + 011 + Green + + + 100 + Cyan + + + 101 + Magenta + + + + + + <command>Set Duck Level [MD]</command> + + + + Module + rdairplay1 + + + Mnemonic + MD + + + + + Set duck level for an RDAirPlay log machine. + + + MD + mach + level + fade + [mport]! + + + Set the duck level of mach, or + 0 for all log machines. If playing, the audio + fades to level (in dbFS) in + fade msecs. If specified, only affect carts + playing on machine port mport. + Loading or clearing a log will set the duck level back to 0. + + + + + <command>Set Label [LB]</command> + + + + Module + rdairplay1 + + + Mnemonic + LB + + + + + Display a message in the label widget on RDAirPlay. + + + LB + string! + + + Display string> in the message widget. + + + + + <command>Set Mode [PM]</command> + + + + Module + rdairplay1 + + + Mnemonic + PM + + + + + Set the mode of an RDAirPlay log machine. + + + PM + mode + [mach]! + + + Set log machine mach to mode + mode. If mode is not given or the Mode + Control Style is set to 'Unified', then all log machines are set to + mode. Valid values for + mode are: + + + 1 + LiveAssist + + + 2 + Auto + + + 3 + Manual + + + + + + + <command>Sleep [SP]</command> + + + + Module + ripcd8 + + + Mnemonic + SP + + + + + Pause for specified time. + + + SP + msecs! + + + Wait for msecs milliseconds. + + + + + <command>Start [PL]</command> + + + + Module + rdairplay1 + + + Mnemonic + PL + + + + + Start a log at a specified line. + + + PL + mach + line! + + + Start log machine mach at line + line if stopped, otherwise do nothing. + + + + + <command>Start Button [PB]</command> + + + + Module + rdairplay1 + + + Mnemonic + PB + + + + + Push an RDAirPlay Start button. + + + PB + button! + + + Push button button. + + + + + <command>Start Next [PN]</command> + + + + Module + rdairplay1 + + + Mnemonic + PN + + + + + Start the next event in a log. + + + PN + mach + [mport] + [skip]! + + + Start log machine mach> if stopped, or start + next event if already running. If specified, start the playout on + machine port mport>. If + skip is supplied, equal to '1' and the log + machine is in Manual or Live Assist mode, then any intervening + meta-events in log between the current 'next' event and the next cart + will be skipped over. + + + + + <command>Start Record Deck [RS]</command> + + + + Module + rdcatchd8 + + + Mnemonic + RS + + + + + Start an RDCatch Recording + + + RS + decknum + cartnum + cutnum + maxlen! + + + Start recording to cut cutnum of cart + cartnum, using RDCatch record deck + decknum for a maximum time of + maxlen mS. The record parameters used + (format, sample rate, channels, etc) will be those configured for the + selected deck in RDAdmin->ManageHosts->RDCatch. The selected cart and + cut must already exist. Any audio previously residing in the selected + cart and cut will be overwritten. + + + + + <command>Stop [PS]</command> + + + + Module + rdairplay1 + + + Mnemonic + PS + + + + + Stop a log in RDAirPlay. + + + PS + mach|0 + [fade] + [mport]! + + + Stop log machine mach, or + 0 for all log machines. If specified, only stop + carts playing on machine port mport. If + specified, fade out fade msecs. + + + + + <command>Stop Panel [PT]</command> + + + + Module + rdairplay1 + + + Mnemonic + PT + + + + + Stop a SoundPanel button in RDAirPlay. + + + PT + panel + col + row + [mport] + [0|1] + fade! + + + Stop the button at col, + row of panel panel. + Panel: S1...S50 or + U1...U50; + C for panel means + currently selected panel. + If col and/or row + is 0: stop all playing buttons in + col or row. + If specified, start the playout on panel port + mport. The stopped panel will stay active when + finished, if the 5th argument is 1. + + + + + <command>Stop Record Deck [RR]</command> + + + + Module + rdcatchd8 + + + Mnemonic + RR + + + + + Stop an RDCatch Recording + + + RR + decknum! + + + Stop any active recording on RDCatch deck decknum. + + + + + <command>Stop Slot [DS]</command> + + + + Module + rdcartslots1 + + + Mnemonic + DS + + + + + Stop an RDCartSlots slot. + + + DS + slot! + + + Stop the cart currently loaded in the slot + slot. The slot must be in Cart Deck mode. This command will be + ignored if the slot is unloaded or already playing. + + + + + <command>Switch Add [SA]</command> + + + + Module + ripcd8 + + + Mnemonic + SA + + + + + Add an input to an output. + + + SA + matrix + input + output! + + + Command switch matrix number matrix to add + input number input to output number + output. Unlike SWITCH TAKE, + this command leaves any other previously assigned inputs unchanged. + + + + + <command>Switch Add With Gain [SG]</command> + + + + Module + ripcd8 + + + Mnemonic + SG + + + + + Add an input to an output while specifyng the crosspoint gain. + + + SG + matrix + input + output + gain! + + + Command switch matrix number matrix to add + input number input to output number + output at gain gain. + The gain is specified in 1/10 of a dB, with 0 = unity gain. + Unlike SWITCH TAKE, this command leaves any other + previously assigned inputs unchanged. + + + + + <command>Switch Crosspoint Gain [SX]</command> + + + + Module + ripcd8 + + + Mnemonic + SX + + + + + Set crosspoint gain. + + + SX + matrix + input + output + level! + + + Command switch matrix number matrix to adjust + the gain of the crosspoint connecting input + input to output + output to level dB. + + + + + <command>Switch Level [SL]</command> + + + + Module + ripcd8 + + + Mnemonic + SL + + + + + Set input gain. + + + SL + matrix + input + level! + + + Command switch matrix number matrix to adjust + the gain of input number input to + level dB. + + + + + <command>Switch Reload [SZ]</command> + + + + Module + ripcd8 + + + Mnemonic + SZ + + + + + Reload the configuration for a switch matrix. + + + SZ + matrix! + + + Reload the configuration for switch matrix + matrix. Normally, this should only be + issued by RDAdmin following a configuration change. + + + + + <command>Switch Remove [SR]</command> + + + + Module + ripcd8 + + + Mnemonic + SR + + + + + Remove an input from an output. + + + SR + matrix + input + output! + + + Command switch matrix number matrix to remove + input number input from output number + output. Unlike SWITCH TAKE, + this command leaves any other previously assigned inputs unchanged. + + + + + <command>Switch Take [ST]</command> + + + + Module + ripcd8 + + + Mnemonic + ST + + + + + Exclusively route an input to an output. + + + ST + matrix + input + output! + + + Command switch matrix number matrix to take + input number input to output number + output. "Take" in this context implies + removing any previously assigned inputs from the referenced output. + + + + + <command>Toggle On Air Flag [TA]</command> + + + + Module + ripcd8 + + + Mnemonic + TA + + + + + Set the state of the On Air flag. + + + TA 0|1! + + + Set the On-Air flag to ON [1] or OFF + [0]. + + + + + <command>UDP Out [UO]</command> + + + + Module + ripcd8 + + + Mnemonic + UO + + + + + Send data to a UDP port. + + + UO + ipaddr + udpport + data! + + + Send data in a UDP packet to port + udpport at ipaddr. + data can consist of arbitrary binary data as + well as textual characters (see Binary Data above). + + + + + + + Interfacing with the Linux Ecosystem: RMLSend and RDImport + + RMLSend + + RMLSend is a small utility that can be used to send RML commands to a + local or remote Rivendell host. It can operate in two modes: GUI or + a command line interface (CLI). + + + If started with no arguments, RMLSend will come up in GUI mode (see + Illustration 65). + + + The Sent To: should have the name or IP address of the system to which + to send the RML. Dest: controls the method by which the command will + be sent. 'RML' is standard RML transmission that returns an echo code + to indicate success/failure. 'RML (No echo)' does not return an echo + code, while 'Set Port' allows the destination UDP port to be set + (useful for controlling Rivendell from outside firewalls). Command: + is the RML command to be sent, and Response: will show any echo code + returned from the remote system (or 'No response' if no reply is + received). Touching the Send Command button actually sends the command. + + + RMLSend also has a full-featured command-line facility that allows + Rivendell commands to be sent using the standard Linux CLI utilities. + Consult the rmlsend1 man + page for details. + + + + RDImport + + RDImport is a command-line interface (CLI) program that can be used to + import audio material into the Rivendell Library. It is particularly + useful in situations where a large number of audio files need to be + imported in an automated fashion, and is capable of importing + thousands of files with a single command-line invocation. Consult + the rdimport1 man page for + details. + + + + + + The GNU General Public License, Version Two + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple + Place, Suite 330, Boston, MA 02111-1307 USA. + + + Everyone is permitted to copy and distribute verbatim copies of + this license document, but changing it is not allowed. + + + Preamble + + The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General Public + License is intended to guarantee your freedom to share and change + free software--to make sure the software is free for all its users. + This General Public License applies to most of the Free Software + Foundation's software and to any other program whose authors commit + to using it. (Some other Free Software Foundation software is + covered by the GNU Library General Public License instead.) + You can apply it to your programs, too. + + + When we speak of free software, we are referring to freedom, not + price. Our General Public Licenses are designed to make sure that + you have the freedom to distribute copies of free software (and + charge for this service if you wish), that you receive source code + or can get it if you want it, that you can change the software or + use pieces of it in new free programs; and that you know you can do + these things. + + + To protect your rights, we need to make restrictions that forbid + anyone to deny you these rights or to ask you to surrender the + rights. These restrictions translate to certain responsibilities + for you if you distribute copies of the software, or if you modify + it. + + + For example, if you distribute copies of such a program, whether + gratis or for a fee, you must give the recipients all the rights + that you have. You must make sure that they, too, receive or can + get the source code. And you must show them these terms so they + know their rights. + + + We protect your rights with two steps: (1) copyright the software, + and (2) offer you this license which gives you legal permission to + copy, distribute and/or modify the software. + + + Also, for each author's protection and ours, we want to make certain + that everyone understands that there is no warranty for this free + software. If the software is modified by someone else and passed + on, we want its recipients to know that what they have is not the + original, so that any problems introduced by others will not reflect + on the original authors' reputations. + + + Finally, any free program is threatened constantly by software + patents. We wish to avoid the danger that redistributors of a free + program will individually obtain patent licenses, in effect making + the program proprietary. To prevent this, we have made it clear + that any patent must be licensed for everyone's free use or not + licensed at all. + + + The precise terms and conditions for copying, distribution and + modification follow. + + + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND + MODIFICATION + + + + This License applies to any program or other work which contains + a notice placed by the copyright holder saying it may be + distributed under the terms of this General Public License. The + "Program", below, refers to any such program or work, + and a "work based on the Program" means either the + Program or any derivative work under copyright law: that is to + say, a work containing the Program or a portion of it, either + verbatim or with modifications and/or translated into another + language. (Hereinafter, translation is included without + limitation in the term "modification".) Each licensee + is addressed as "you". + + + Activities other than copying, distribution and modification are + not covered by this License; they are outside its scope. The act + of running the Program is not restricted, and the output from + the Program is covered only if its contents constitute a work + based on the Program (independent of having been made by running + the Program). Whether that is true depends on what the Program + does. + + + + + You may copy and distribute verbatim copies of the Program's + source code as you receive it, in any medium, provided that you + conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep + intact all the notices that refer to this License and to the + absence of any warranty; and give any other recipients of the + Program a copy of this License along with the Program. + + + You may charge a fee for the physical act of transferring a copy, + and you may at your option offer warranty protection in exchange + for a fee. + + + + + You may modify your copy or copies of the Program or any portion + of it, thus forming a work based on the Program, and copy and + distribute such modifications or work under the terms of Section + 1 above, provided that you also meet all of these conditions: + + + + + You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + + + + You must cause any work that you distribute or publish, that + in whole or in part contains or is derived from the Program + or any part thereof, to be licensed as a whole at no charge + to all third parties under the terms of this License. + + + + + If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display + an announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you + provide a warranty) and that users may redistribute the + program under these conditions, and telling the user how to + view a copy of this License. (Exception: if the Program + itself is interactive but does not normally print such an + announcement, your work based on the Program is not required + to print an announcement.) + + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the + Program, and can be reasonably considered independent and + separate works in themselves, then this License, and its + terms, do not apply to those sections when you distribute + them as separate works. But when you distribute the same + sections as part of a whole which is a work based on the + Program, the distribution of the whole must be on the terms + of this License, whose permissions for other licensees extend + to the entire whole, and thus to each and every part + regardless of who wrote it. + + + Thus, it is not the intent of this section to claim rights + or contest your rights to work written entirely by you; + rather, the intent is to exercise the right to control the + distribution of derivative or collective works based on the + Program. + + + In addition, mere aggregation of another work not based on + the Program with the Program (or with a work based on the + Program) on a volume of a storage or distribution medium + does not bring the other work under the scope of this License. + + + + + + + You may copy and distribute the Program (or a work based on it, + under Section 2) in object code or executable form under the + terms of Sections 1 and 2 above provided that you also do one + of the following: + + + + + Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Sections 1 and 2 above on a medium customarily used for + software interchange; or, + + + + + Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a + medium customarily used for software interchange; or, + + + + + Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + + + + + The source code for a work means the preferred form of the work + for making modifications to it. For an executable work, complete + source code means all the source code for all modules it + contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. + However, as a special exception, the source code distributed + need not include anything that is normally distributed (in + either source or binary form) with the major components + (compiler, kernel, and so on) of the operating system on which + the executable runs, unless that component itself accompanies + the executable. + + + If distribution of executable or object code is made by offering + access to copy from a designated place, then offering equivalent + access to copy the source code from the same place counts as + distribution of the source code, even though third parties are not + compelled to copy the source along with the object code. + + + + + You may not copy, modify, sublicense, or distribute the Program + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense or distribute the Program + is void, and will automatically terminate your rights under this + License. However, parties who have received copies, or rights, + from you under this License will not have their licenses + terminated so long as such parties remain in full compliance. + + + + + You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to + modify or distribute the Program or its derivative works. These + actions are prohibited by law if you do not accept this License. + Therefore, by modifying or distributing the Program (or any work + based on the Program), you indicate your acceptance of this + License to do so, and all its terms and conditions for copying, + distributing or modifying the Program or works based on it. + + + + + Each time you redistribute the Program (or any work based on the + Program), the recipient automatically receives a license from + the original licensor to copy, distribute or modify the Program + subject to these terms and conditions. You may not impose any + further restrictions on the recipients' exercise of the rights + granted herein. You are not responsible for enforcing compliance + by third parties to this License. + + + + + If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent + issues), conditions are imposed on you (whether by court order, + agreement or otherwise) that contradict the conditions of this + License, they do not excuse you from the conditions of this + License. If you cannot distribute so as to satisfy + simultaneously your obligations under this License and any other + pertinent obligations, then as a consequence you may not + distribute the Program at all. For example, if a patent license + would not permit royalty-free redistribution of the Program by + all those who receive copies directly or indirectly through you, + then the only way you could satisfy both it and this License + would be to refrain entirely from distribution of the Program. + + + If any portion of this section is held invalid or unenforceable + under any particular circumstance, the balance of the section is + intended to apply and the section as a whole is intended to + apply in other circumstances. + + + It is not the purpose of this section to induce you to infringe + any patents or other property right claims or to contest + validity of any such claims; this section has the sole purpose + of protecting the integrity of the free software distribution + system, which is implemented by public license practices. Many + people have made generous contributions to the wide range of + software distributed through that system in reliance on + consistent application of that system; it is up to the + author/donor to decide if he or she is willing to distribute + software through any other system and a licensee cannot impose + that choice. + + + This section is intended to make thoroughly clear what is + believed to be a consequence of the rest of this License. + + + + + If the distribution and/or use of the Program is restricted in + certain countries either by patents or by copyrighted interfaces, + the original copyright holder who places the Program under this + License may add an explicit geographical distribution limitation + excluding those countries, so that distribution is permitted only + in or among countries not thus excluded. In such case, this + License incorporates the limitation as if written in the body of + this License. + + + + + The Free Software Foundation may publish revised and/or new + versions of the General Public License from time to time. + Such new versions will be similar in spirit to the present + version, but may differ in detail to address new problems or + concerns. + + + Each version is given a distinguishing version number. If the + Program specifies a version number of this License which applies + to it and "any later version", you have the option of following + the terms and conditions either of that version or of any later + version published by the Free Software Foundation. If the + Program does not specify a version number of this License, you + may choose any version ever published by the Free Software + Foundation. + + + + + If you wish to incorporate parts of the Program into other free + programs whose distribution conditions are different, write to + the author to ask for permission. For software which is + copyrighted by the Free Software Foundation, write to the Free + Software Foundation; we sometimes make exceptions for this. Our + decision will be guided by the two goals of preserving the free + status of all derivatives of our free software and of promoting + the sharing and reuse of software generally. + + + + + + NO WARRANTY + + + + BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE + LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE + RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. + SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL + NECESSARY SERVICING, REPAIR OR CORRECTION. + + + + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY + MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE + LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, + INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR + INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS + OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY + YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH + ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + + + + + END OF TERMS AND CONDITIONS + + + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest + possible use to the public, the best way to achieve this is to make + it free software which everyone can redistribute and change under + these terms. + + + To do so, attach the following notices to the program. It is safest + to attach them to the start of each source file to most effectively + convey the exclusion of warranty; and each file should have at least + the "copyright" line and a pointer to where the full notice is found. + + + + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 + USA + + + + Also add information on how to contact you by electronic and paper mail. + + + If the program is interactive, make it output a short notice like this + when it starts in an interactive mode: + + + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it +under certain conditions; type `show c' for details. + + + + The hypothetical commands `show w' and `show c' should show the + appropriate parts of the General Public License. Of course, the + commands you use may be called something other than `show w' and + `show c'; they could even be mouse-clicks or menu items --whatever + suits your program. + + + You should also get your employer (if you work as a programmer) or + your school, if any, to sign a "copyright disclaimer" for the program, + if necessary. Here is a sample; alter the names: + + + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + + + + This General Public License does not permit incorporating your + program into proprietary programs. If your program is a subroutine + library, you may consider it more useful to permit linking proprietary + applications with the library. If this is what you want to do, use + the GNU Library General Public License instead of this License. + + +