Add the player to an existing web page.
The easiest way to add the player to an existing web page is to copy the Script Tag (below) and paste it into the HTML of a web page at the location where you would like the player to appear. You can place the Script Tag anywhere within the body of the web page (<body>...</body>). It can be placed within a container (<div> </div>, <td> </td>, etc...) or used as a stand-alone element.
By using the Assignment Parameters and the Load Parameter, you can customize the player display for your web page.
The first parameter must always be preceded by a question mark (?) and all subsequent parameters must be preceded by an ampersand (&).
Assignment Parameters are used to specify the event feed and to set default values and behaviors for the player. Assignment Parameters are used in the SRC attribute of the Script Tag.
EventID, ClientID, and EPC are used to specify the event feed. One of these parameters must be specified to access an event. If more than one of these parameters are specified, the highest priority parameter will be used. They are listed below in priority order (one being highest priority).
- EventID requires a GUID (Globally Unique Identifier). Example: EventID=25E9D359-69CB-4A30-A103-D02E0B986042
- ClientID requires a valid eScription Client ID. Example: ClientID=value
- EPC requires a valid Event PassCode. Example: EPC=value
Height sets the player height and must either be a positive integer value, or be expressed as a percentage value. Examples: Height=160, Height=90%
Width sets the player width and must either be a positive integer value, or be expressed as a percentage value. Example: Width=160, Width=100%
FColor* sets the initial text color and must be one of the following: 00FFFF, 000000, 0000FF, A52A2A, 008000, ADFF2F, 808080, 00FF00, FF00FF, 800000, 808000, FFA500, 800080, 000080, FF0000, E2B48C, 008080, FFFFFF, FFFF00. Example: FColor=FFFFFF
BColor* sets the initial background color and must be one of the following: 00FFFF, 000000, 0000FF, A52A2A, 008000, ADFF2F, 808080, 00FF00, FF00FF, 800000, 808000, FFA500, 800080, 000080, FF0000, E2B48C, 008080, FFFFFF, FFFF00. Example: BColor=000000
Font sets the initial font and must be one of the following: Lucida Console, Courier New, Courier, Monospace, Verdana, Arial, Helvetica, Sans-Serif, Georgia, Times New Roman, Times, Serif. Example: Font=SansSerif
MinFS sets the minimum font size available in the FontSize pull-down menu and must be a positive integer between 1 and 40. Example: MinFS=10
MaxFS sets the maximum font size available in the FontSize pull-down menu and must be a positive integer between 10 and 100. Example: MaxFS=40
FontSize sets the initial font size and must be a positive integer between 10 (or MinFS) and 40 (or MaxFS). Example: FontSize=14
Branding determines whether to display the Speche branding at the bottom of the player. Branding accepts either 0 or 1. Removal of the Speche branding may impact the cost of your event(s). Please contact your Customer Service Representative for details regarding branding and how it relates to cost. Example: Branding=1
Welcome determines whether a welcome message is offered. A welcome message takes the following form: Welcome to <Event Title>. Welcome accepts either 0 or 1. Example: Welcome=0
Cookies determines whether the player will read and store user settings in a cookie, such as Font, Font Size, Font Color, and Background Color. Cookies accepts either 0 or 1. Example: Cookies=1
SaveOption determines whether the To File button will be offered by the player (player Applet only). SaveOption only accepts 0 or 1. Example: SaveOption=0
Encrypt determines whether the data stream between our servers and the player is encrypted. Encrypt only accepts 0 or 1. Example: Encrypt=1
* Colors: 00FFFF=Aqua, 000000=Black, 0000FF=Blue, A52A2A=Brown, 008000=Green, ADFF2F=Green-Yellow, 808080=Grey, 00FF00=Lime, FF00FF=Magenta, 800000=Maroon, 808000=Olive, FFA500=Orange, 800080=Purple, 000080=Navy, FF0000=Red, E2B48C=Tan, 008080=Teal, FFFFFF=White, FFFF00=Yellow
SRC Examples using the Assignment Parameters:
https://www.speche.com/sbload2.aspx?Height=200&Width=200&EventID=25E9D359-69CB-4A30-A103-D02E0B986042
http://www.speche.com/sbload2.aspx?Height=90%&Width=100%&EventID=25E9D359-69CB-4A30-A103-D02E0B986042
https://www.speche.com/sbload2.aspx?Height=340&Width=460&FontSize=16&CleintID=13657
http://www.speche.com/sbload2.aspx?Height=500&Width=700&Font=Monospaced&EPC=XXXXXXXX
Load Parameter
The Load Parameter can be used to specify the Display Components that will be loaded onto the web page. With the Load Parameter you can choose to only load the SpecheBox, or specify any combination of Display Components using a comma-delimited list (SpecheBox,FColor,BColor,...). When using the Load parameter, only the specified Display Components will be loaded. It is not necessary to use the Scripting Components unless you are troubleshooting or implementing a custom display or custom scripting components. The Load Parameter is not required for placement on a web page. Not using the Load Parameter is the equivalent of using Load=All.
All* - This will load all of the Display Components and is the equivalent of SpecheBox,Font,Fontsize,FColor,BColor,Transcript (or not using the Load Parameter). This is most often used when generating links
Help - This will load the Player Usage Guide.
SpecheBox - This will load the SpecheBox. SpecheBox dimensions are assigned through the Height and Width parameters listed among the Assignment Parameters (above).
Font** - This will load the Font... selection pull-down. Approximate Font... selection pull-down dimensions: 22x110 pixels
Fontsize** - This will load the (font) Size... selection pull-down. Approximate Size... selection pull-down dimensions: 22x70 pixels
FColor** - This will load the Text... (color) selection pull-down. Approximate Text... selection pull-down dimensions: 22x110 pixels
BColor** - This will load the Background... (color) selection pull-down. Approximate Background... selection pull-down dimensions: 22x110 pixels
Transcript** - This will load the View Transcript button. Approximate View Transcript button dimensions: 22x140 pixels
Title* - This will load the Title as entered during Event scheduling.
Start* - This will load the Scheduled Start Date and Time as selected during Event scheduling.
* Loading this display component may also load the supporting JavaScript (Script).
* When loaded with the SpecheBox, this display component will appear above the SpecheBox.
* When loaded with the SpecheBox, this display component will appear below, or at the bottom of the SpecheBox.
Script Components (Advanced)
Script - This will load the supporting JavaScript functions. This is an advanced option for those users implementing custom display components.
NoScript - This will explicitly prevent the loading of the supporting JavaScript functions. This is an advanced option for those users implementing custom JavaScript support functions.
Load Parameter Examples:
Load=Help will load the SpecheBox Help information.
Load=All is the equivalent of not using the Load parameter.
Load=All,Help will load all display components and the SpecheBox Help information.
Load=SpecheBox will only load the SpecheBox.
Load=SpecheBox,Transcript will load the SpecheBox and the View Transcript button.
Load=SpecheBox,FColor,BColor will load the Speche Box and both the Text and Background color selection pull-downs.
SRC Examples using the Assignment Parameters and the Load Parameter:
https://www.speche.com/sbload2.aspx?Load=Help
http://www.speche.com/sbload2.aspx?Load=All&Height=200&Width=200&EventID=25E9D359-69CB-4A30-A103-D02E0B986042
https://www.speche.com/sbload2.aspx?Load=SpecheBox&Height=340&Width=460&FontSize=16&CleintID=13657
http://www.speche.com/sbload2.aspx?Load=SpecheBox,FColor,BColor,Transcript&Height=500&Width=700&Font=Monospaced&EPC=XXXXXXXX