Controlling the streaming text page display
The streaming text page can be visually controlled by passing various query strings to the page in the url. This article discusses what those values are, what their effects are and concludes with some examples.
Query String Parameters
The following querystring parameters can be included when accessing the text streaming page (/player/?event=[your-event-name]).
Use affirmative values to display the chat box on the page and negative values to remove it. Passing any value for this parameter will override whatever setting was chosen when scheduling the event.
controls: (Controls to change the display of the text)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the controls to allow the user to change values such as font size, font family, foreground color and background color. Use negative values to remove all of these controls.
header: (Area of page above the area that the text is being written to)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on", and "hidden". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Query String Parameters
The following querystring parameters can be included when accessing the text streaming page (/player/?event=[your-event-name]).
- delay
- chat
- controls
- header
- title
- scroll
- footer
- fs
- ff
- bgc
- fgc
- spacing
- indicator
- start
- langage
- content-style
- controls-theme
- controls-fs
- controls-ff
- controls-bgc
- controls-fgc
- controls-scroll
- controls-language
- controls-transcript
- controls-audio
- controls-words
delay: (Delays display of text in the browser)
Numeric value. The number of seconds to delay the display of text in the browser. 0 for no delay (this is the default). This value is separate from the delay that can be programmed during scheduling the event and only controls delaying at the browser level. Meaning that if you program a 5 second delay when scheduling the event and then use 5 as the delay value in the URL, then the user will get a total of 10 second delay from when the captions are received. This is a useful control to enforce a delay for some users (e.g. 10 seconds when embedded with video) but allow other users to get the text sooner.
chat: (Chat box)
Use affirmative values to display the chat box on the page and negative values to remove it. Passing any value for this parameter will override whatever setting was chosen when scheduling the event.
controls: (Controls to change the display of the text)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the controls to allow the user to change values such as font size, font family, foreground color and background color. Use negative values to remove all of these controls.
header: (Area of page above the area that the text is being written to)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on", and "hidden". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use "hidden" to keep the header have it start out in a hidden state. If the footer is removed then the user will not have a way to show the header.
Use affirmative values to display the header area in the page. Use negative values to remove the header area. If the header is removed, none of the controls will be visible either.
title: (Name of the event displayed in the upper left hand corner of player)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the title area of the page. Use negative values to remove the title area.
scroll: (Controls the visibility of the scroll bar when text fills up the player)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to show a scroll bar when text fills up the player. Use negative values to hide the scroll bar. When the scroll bar is hidden, the text automatically scrolls to show the latest text and the option to shut off scrolling is now available to the end user.
footer: (Area of page below the area that the text is being written to)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the footer area of the page. Use negative values to remove it. If the footer is removed, the show/hide chat and show/hide header functions will not be visible either.
fs: (font size)
Numeric value. Allowable values are 1 to 100. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the font size to a custom value.
ff: (font family)
String value. Allowable values are any font family names that the browser can display. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the font family to a custom value.
bgc: (background color)
Hexidecimal value. Allowable values are 000000 to ffffff. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the background color to a custom value.
See the following page for a list of colors and their hexidecimal values.
https://en.wikipedia.org/wiki/Web_colors
fgc: (foreground color)
Hexidecimal value. Allowable values are 000000 to ffffff. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the foreground color to a custom value.
https://en.wikipedia.org/wiki/Web_colors
spacing: (amount of space between the lines of text)
Decimal value with a default value of 1.5. Allowable values are 1 to 10.
indicator: (connection status indicator on bottom of page)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the indicator. Use negative values to remove the indicator.
Use affirmative values to display the header area in the page. Use negative values to remove the header area. If the header is removed, none of the controls will be visible either.
title: (Name of the event displayed in the upper left hand corner of player)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the title area of the page. Use negative values to remove the title area.
scroll: (Controls the visibility of the scroll bar when text fills up the player)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to show a scroll bar when text fills up the player. Use negative values to hide the scroll bar. When the scroll bar is hidden, the text automatically scrolls to show the latest text and the option to shut off scrolling is now available to the end user.
footer: (Area of page below the area that the text is being written to)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the footer area of the page. Use negative values to remove it. If the footer is removed, the show/hide chat and show/hide header functions will not be visible either.
fs: (font size)
Numeric value. Allowable values are 1 to 100. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the font size to a custom value.
ff: (font family)
String value. Allowable values are any font family names that the browser can display. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the font family to a custom value.
bgc: (background color)
Hexidecimal value. Allowable values are 000000 to ffffff. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the background color to a custom value.
See the following page for a list of colors and their hexidecimal values.
https://en.wikipedia.org/wiki/Web_colors
fgc: (foreground color)
Hexidecimal value. Allowable values are 000000 to ffffff. All other values are ignored and have no effect on the display.
Passing any value for this parameter will override any user settings that exist. However, if the controls are available to them, they can still change the foreground color to a custom value.
https://en.wikipedia.org/wiki/Web_colors
spacing: (amount of space between the lines of text)
Decimal value with a default value of 1.5. Allowable values are 1 to 10.
indicator: (connection status indicator on bottom of page)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the indicator. Use negative values to remove the indicator.
start: (position to start the stream)
Numeric value with a default value of -1. Allowable values are "-1", "0", or any other number. Omitting the parameters is the same as a value of "-1" and starts the stream at whatever the current position is. A value of "0" starts the stream at the beginning resulting in all of the text from the event being viewable regardless of when the viewer joins the event.
Numeric value with a default value of -1. Allowable values are "-1", "0", or any other number. Omitting the parameters is the same as a value of "-1" and starts the stream at whatever the current position is. A value of "0" starts the stream at the beginning resulting in all of the text from the event being viewable regardless of when the viewer joins the event.
language: (specify language to display transcript in)
This is the ISO-639-1 code of the language you want to be displayed. This needs to match one of the selected languages as the source language or a translated language when the event was scheduled. If the value is not understood or doesn't match a language for the event, it's assumed to be "en" (English). You may find the supported languages at https://cloud.google.com/translate/docs/languages
content-style: (unlimited control over the text display)
We've exposed this value to allow you to control all aspects of the content area of the player. Beware, we are not checking anything you pass in to make sure it doesn't conflict with other values. Any values defined in the content-style will be applied last and overwrite any of the values that control text display above. Here's a reference to setting the style values.
https://developer.mozilla.org/en-US/docs/Web/CSS/Reference
controls-theme: (theme control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the theme control. Use negative values to remove it.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the theme control. Use negative values to remove it.
controls-fs: (font size control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the font size control. Use negative values to remove it.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the font size control. Use negative values to remove it.
controls-ff: (font family control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the font family control. Use negative values to remove it.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the font family control. Use negative values to remove it.
controls-bgc: (background color control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the background color control. Use negative values to remove it.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the background color control. Use negative values to remove it.
controls-fgc: (foreground color control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the foreground color control. Use negative values to remove it.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the foreground color control. Use negative values to remove it.
controls-scroll: (scroll control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the scroll control. Use negative values to remove it.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the scroll control. Use negative values to remove it.
controls-language: (language control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the language control for a multi-language event. Use negative values to remove it. Not that hiding the control for a multi-language event means that the user will not be able to change languages and you'll need to create a URL that gives them the appropriate language by appending the `lanugage=value` query string parameter.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the language control for a multi-language event. Use negative values to remove it. Not that hiding the control for a multi-language event means that the user will not be able to change languages and you'll need to create a URL that gives them the appropriate language by appending the `lanugage=value` query string parameter.
controls-transcript: (view transcript control)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the view transcript control if it has been enabled during scheduling. Use negative values to remove it regardless of the values specified during scheduling.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the view transcript control if it has been enabled during scheduling. Use negative values to remove it regardless of the values specified during scheduling.
controls-audio: (audio controls when integrated audio is enabled)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the audio controls if it has been enabled during scheduling. Use negative values to remove it regardless of the values specified during scheduling.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the audio controls if it has been enabled during scheduling. Use negative values to remove it regardless of the values specified during scheduling.
controls-words: (word by word control when enabled)
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the audio controls if it has been enabled during scheduling. Use negative values to remove it regardless of the values specified during scheduling.
Boolean value with a default value of true. Allowable affirmative values are "true", "1", "yes", "on". Allowable negative values are "false", "0", "no", "off". All other values are ignored and have no effect on the display.
Use affirmative values to display the audio controls if it has been enabled during scheduling. Use negative values to remove it regardless of the values specified during scheduling.
Examples
Show the page with no chat and no user controls but still show the header
http://www.streamtext.net/player/?event=IHaveADream&chat=false&controls=false
Show the page with only the content area
http://www.streamtext.net/player/?event=IHaveADream&chat=false&header=false&footer=false
Show the page with no chat or user controls. Set the font size to 36, background color to black, foreground color to yellow and line spacing to 2.5
http://www.streamtext.net/player/?event=IHaveADream&chat=false&controls=false&fs=36&bgc=000000&fgc=ffff00&spacing=2.5
Show the page with no chat or user controls. Set the overflow of the content area to "hidden" and fix the width to 400 pixels and the height to 500 pixels.
http://www.streamtext.net/player/?event=IHaveADream&chat=false&controls=false&content-style=overflow:hidden;width:400px;height:500px;
Show the page with no chat and no user controls but still show the header
http://www.streamtext.net/player/?event=IHaveADream&chat=false&controls=false
Show the page with only the content area
http://www.streamtext.net/player/?event=IHaveADream&chat=false&header=false&footer=false
Show the page with no chat or user controls. Set the font size to 36, background color to black, foreground color to yellow and line spacing to 2.5
http://www.streamtext.net/player/?event=IHaveADream&chat=false&controls=false&fs=36&bgc=000000&fgc=ffff00&spacing=2.5
Show the page with no chat or user controls. Set the overflow of the content area to "hidden" and fix the width to 400 pixels and the height to 500 pixels.
http://www.streamtext.net/player/?event=IHaveADream&chat=false&controls=false&content-style=overflow:hidden;width:400px;height:500px;
0 Comments