Class Chyron
Creates a label with a scrolling text element.
It is highly recommended you use a monospace font for this label.
Info:
- Copyright: 2019,2020
- Author: Delra,Damian Monogue
Methods
| chyron:new(cons, container) | Creates a new Chyron label |
| chyron:setDisplayWidth(displayWidth) | Sets the numver of characters of the text to display at once |
| chyron:reset() | Sets the Chyron from the first position, without changing enabled status |
| chyron:pause() | Stops the Chyron with its current display |
| chyron:start() | Start the Chyron back up from wherever it currently is |
| chyron:setUpdateTime(updateTime) | Change the update time for the Chyron |
| chyron:enableAutoWidth() | Enable autoWidth adjustment |
| chyron:disableAutoWidth() | Disable autoWidth adjustment |
| chyron:stop() | Stop the Chyron, and reset it to the original position |
| chyron:setMessage(message) | Change the text being scrolled on the Chyron |
| chyron:setDelimiter(delimiter) | Change the delimiter used to show the beginning and end of the message |
Methods
- chyron:new(cons, container) line 80
-
Creates a new Chyron label
Parameters:
- cons
table
table of constraints which configures the EMCO.
option name description default text The text to scroll on the label "" updateTime Milliseconds between movements (one letter shift) 200 displayWidth How many chars wide to display the text 28 delimiter This character will be inserted with a space either side to mark the stop/start of the message "|" enabled Should the chyron scroll? true font What font to use for the Chyron? Available in Geyser.Label but we define a default. "Bitstream Vera Sans Mono" fontSize What font size to use for the Chyron? Available in Geyser.Label but we define a default. 9 autoWidth Should the Chyron resize to just fit the text? true alignment What alignment(left/right/center) to use for the Chyron text? Available in Geyser.Label but we define a default. "center" - container GeyserObject The container to use as the parent for the Chyron
- cons
table
table of constraints which configures the EMCO.
- chyron:setDisplayWidth(displayWidth) line 99
-
Sets the numver of characters of the text to display at once
Parameters:
- displayWidth number number of characters to show at once
- chyron:reset() line 151
- Sets the Chyron from the first position, without changing enabled status
- chyron:pause() line 159
- Stops the Chyron with its current display
- chyron:start() line 167
- Start the Chyron back up from wherever it currently is
- chyron:setUpdateTime(updateTime) line 179
-
Change the update time for the Chyron
Parameters:
- updateTime number new updateTime in milliseconds
- chyron:enableAutoWidth() line 190
- Enable autoWidth adjustment
- chyron:disableAutoWidth() line 196
- Disable autoWidth adjustment
- chyron:stop() line 201
- Stop the Chyron, and reset it to the original position
- chyron:setMessage(message) line 212
-
Change the text being scrolled on the Chyron
Parameters:
- message string message the text you want to have scroll on the Chyron
- chyron:setDelimiter(delimiter) line 228
-
Change the delimiter used to show the beginning and end of the message
Parameters:
- delimiter string the new delimiter to use. I recommend using one character.