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)
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
Chyron:setDisplayWidth(displayWidth)
Sets the numver of characters of the text to display at once

Parameters:

  • displayWidth number number of characters to show 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

Parameters:

  • updateTime number new updateTime in milliseconds
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

Parameters:

  • message string the text you want to have scroll on the Chyron
Chyron:setDelimiter(delimiter)
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.
generated by LDoc 1.4.6 Last updated 2020-08-25 15:14:20