Roll-up style delivery of captions to the page.
Route
- The prefix for the route will be
u-followed by the event’s URL. -
/u-{event-url}/{lang-code}is available for events with languages enabled. The appropriate language direction will be used for languages that require it. LTR or RTL.
Configurable Parameters
Append configurable parameters, detailed below, to the URL. You can include one or several parameters to the URL.
- https://live.syncwords.com/u-ABCdef?reading_rate=1.5
- https://live.syncwords.com/u-ABCdef?reading_rate=1.5&clear_wait_time=3&lines=2
- https://live.syncwords.com/u-ABCdef?text_color=ffffff&line_color=000000&bg_color=04f404&gap=false&typing_enabled=false
- https://live.syncwords.com/u-ABCdef/fr?text_color=ffffff&line_color=000000&bg_color=04f404&gap=false - add the language code for the translated language you want to display
Configurable Settings
The below settings can be added to the URL as parameters:
| Name | Default | Description |
| reading_rate | 1.2 | Max duration, in seconds, that a line is displayed before the next line appears.
https://live.syncwords.com/u-ABCdef?reading_rate=1.5 Minimum value is 1. Maximum value is 2. We recommend limiting this value to 1.5 to prevent a growing lag between the roll-up display and captions being received. |
| clear_wait_time | 4 |
Time before a line is cleared in the roll-up display. It is a multiple of the reading rate. For example, ‘reading rate’ of 1.5 with a clear wait time’ of 2 will wait 3 seconds before clearing a line in the roll-up display. https://live.syncwords.com/u-ABCdef?clear_wait_time=2 The minimum value is 1. The maximum value is 4. |
| typing_enabled | true |
Remove letter by letter "typing" animation of caption delivery. When set to false captions will be delivered one line at a time. |
| text_color | 000000 |
Color of text shown in the roll-up display. NOTE: Only hex colors are supported. |
| bg_color | ffffff |
Color of the page background behind the caption text and solid lines. NOTE: Only hex colors are supported. |
| line_color | none |
Color of the solid background behind each caption line. NOTE: Only hex colors are supported. |
| font | 1 |
Font options for the caption text. https://live.syncwords.com/u-ABCdef?font=6 Values 1-9 (see fonts table below) |
| lines | 3 |
Maximum number of lines in the roll-up display. https://live.syncwords.com/u-ABCdef?lines=2 Values 2-4 |
| chars | 32 |
Maximum characters per line. https://live.syncwords.com/u-ABCdef?chars=28 Values 16-50 |
| gap | true |
If you want to remove the space between roll up lines. https://live.syncwords.com/u-ABCdef?gap=false Value: false |
| stroke_width | 0 |
Stroke width in pixels. NOTE: Cannot be used in combination with line_color. Line color will take precedence. https://live.syncwords.com/u-ABCdef?stroke_width=3 Values 1 -16 |
| stroke_color | 000000 |
Stroke color on text. Must be used in combination with the stroke_width parameter. NOTE: Only hex colors are supported. Cannot be used in combination with line_color. Line color will take precedence. https://live.syncwords.com/u-ABCdef?stroke_color=0000FF&stroke_width=1 |
| bold | false |
Toggles bold fonts. NOTE: PT Mono (3) does not have a bold option. https://live.syncwords.com/u-ABCdef?bold=true Value: true |
Fonts
The following fonts are available via the font parameter.
| Value | Font | Family |
| 1 | Inconsolata | Monospace |
| 2 | Roboto Mono | Monospace |
| 3 | PT Mono | Monospace |
| 4 | Inter | Sans Serif |
| 5 | Poppins | Sans Serif |
| 6 | Nunito | Sans Serif |
| 7 | Open Sans | Sans Serif |
| 8 | Merriweather | Serif |
| 9 | Noto Serif | Serif |
Reading Rate
The reading_rate includes the render time for the animation sequence which breaks down as follows:
| 10ms | Delay after a new line is inserted |
| 350ms | Rollup animation |
| 20ms | For each character in the line |
Totaling max 1000ms for a full 32 character line to render the animation and 200ms delay before the next caption begins rendering (at a 1.2s reading_rate ).