Controlling the streaming text page display

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]).  
  • chat
  • controls
  • header
  • title
  • scroll
  • footer
  • fs
  • ff
  • bgc
  • fgc
  • spacing
  • indicator
  • content-style
chat: (Chat box)
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 chat box on the page and negative values to hide 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 hide 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".  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 header area of the page.  Use negative values to hide the header area.  If the header is hidden, 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 hide 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 hide the header area.  If the footer is hidden, 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.
http://www.w3schools.com/Html/html_colors.asp

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.
http://www.w3schools.com/Html/html_colors.asp

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 hide the indicator.

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.
http://www.w3schools.com/css/css_reference.asp

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;
Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk