Glossary of Terms

API Key

Required for all API requests to identify your account.

Example

    SZ1N63JDVPW87NWSHA7I26OVZAE2FFAY

NOTE: This should be kept private.

Chat text

A component that displays the chat text in an active session. Maximum of one per theme.

Component

Any object in a theme including Host video, Guest video, buttons, user list, etc.

Guest video

A video component that is used by guests to stream video and audio. This is where their video/audio feed is displayed. A theme can include up to 12 guest videos, although a maximum of 6 is recommended.

Host vide

A video component that is used by the primary streaming host. This is where their video/audio feed is displayed. Maximum of one per theme.

layoutPath

The path to the layout configuration file for your theme. A required Flashvar for embedding.

Example

    /themes/126/542/811/1/theme_03d2cdd0-1d8b-11de-a2c3-f7f8349311a2.xml

Private Host ID

A private string used to uniquely identify and authorize a broadcaster.

Example

    C0UC4WO3ATORK259QL1STSIZO7RB1G5I

Public Host ID

Used to reference a particular stream publicly. This is either a numeric ID that is automatically generated or the one you specified as site_user_id when you created the session.

Example

    1745122342

Secret key

Used to generate a checksum (signature) for all of your API requests.

Example

    UAVA72I1PL24PE25G632A2CIS9USAY5A

NOTE: This should be kept private.

Simple Button

A component that is a clickable button. Three different behaviors can be defined when a button is clicked. It can a) run a built-in function. b) run a Javascript function. c) link to a URL. Any number per theme. Built-in function

• cameraPreferencesButton
Opens the Flash settings to the Camera settings tab. Allowing the user to switch between difference camera devices.
• micPreferencesButton
Opens the Flash settings to the Microphone settings tab. Allowing the user to switch between difference microphone devices.
• captionButton (Host only)
Sets the caption overlay for the host video stream.
• chatSendButton
Submits the chat text from text input component. The chat input component will normally send text when the user hits Enter. This is an additional method.
• loginButton
Viewers must login to be able to send chat text and guest video. The login may only require that they set their username or it may require username and password.
• muteAllButton
Mutes the audio for all video components.

Site ID

A unique identifier used in Flash embeds to identify your site.

Example

    1265428111

skinPath

The path to the skin configuration file for your theme. A required Flashvar for embedding.

Example

    /themes/126/542/811/1/skin_03d2cdd0-1d8b-11de-a2c3-f7f8349311a2.xml

Theme

A theme consists of a layout and a skin. You can create as many themes as you wish using the Theme Editor. Usually you will have one for users that are broadcasting and one or more for user's that are viewing.

Theme Editor

The Theme Editor is an interactive WYSIWYG editor that can be used to create a Theme.

User List

A component that displays the list of users in an active session. Maximum of one per theme.