API/free chat player

From Webcamwiz
Jump to: navigation, search

Overview

A website can use this page in order to embed free live chat on its pages.

The free live chat page should be embedded inside an iframe.

We also provide an iframe generator tool that can be used as a reference to generate an iframe that demonstrates the custom parameters that can be provided to the player page.

Player Page

The free live player page is provided here - http://pcash.imlive.com/releasese/activepage7139.asp

The embedding site should embed this page in an iframe.

The embedding site should provide some query string parameters to this page in order to customize the player look and behavior.

Iframe Generator Tool

For reference, we provide an iframe generator tool that can be used to demonstrate the possible parameters that can be provided to the player page.

The tool is web-based and is located at - http://pcash.imlive.com/releasese/activepage7139_gen.asp

Player Parameters

The player page supports some query-string parameters for customizing the player look and behavior.

In the following table we provide both the field names of the generator tool and their matching query-string parameter.

Generator Tool Property Label

Query-string Parameter

Description

Comment

Type Page

type_page

The type of the target site

Values are “imlive” or “white_label”

Show Specific Host / Big Host ID

bhid

This is the host ID to start the player with

If omitted then a host is selected randomly. The player always starts with a playing FLC host

In case the host is not available in flc

host_next

What to do if the host specified is not available in FLC

0 = keep the same host

1 = move to the next available host

WID

wid

The WID of the affiliate


Link ID

linkid

Program ID of the affiliate


Query ID

queryid

Query ID of the query to choose host from (randomly)

If specified, and the host ID is not specified then shows a random host from this query ID

General dimensions - width

twidth

Width of the player control


General dimensions – height

theight

height of the player control


Video dimension - width

lfwidth

Value in %

If width = 100% then the chat window will be also 100%.

General Colors - Background

bgcolor

Background color for the window


General Colors – Text

tcolor

Text color


General Colors – Secondary Color

seccolor

Borders color


Chat Button - Label

btntext

Text label to show on mouse over the video window

If left blank then “Chat with me” is used

Chat Button - Text Size

btnt_size

Font size of the chat button label text


Chat Button - Text Color

btnt_clr

Font color of the chat button label text


Chat Button - Background Color

btnbg_clr

Font background color of the chat button label text


Host FLC Status - Offline Message

offtext

Text message to display on the video area if the host is currently offline


Host FLC Status - In Private Show Message

ptext

Text message to display on the video area if the host is currently in a private chat session


Host FLC Status - Time Ended Message

etext

Text message to display on the video area if the user used all the FLC time allocated to him


Host FLC Status Design - Message Text Size

msgt_size

Font size of the host FLC status message


Host FLC Status Design - Message Text Color

msgt_clr

Font color of the host FLC status message


Host FLC Status Design - Message Text background Color

msgbg_clr

Font background color of the host FLC status message


Flash Video Timer

timer

Number of seconds to show FLC video before pausing


Generating iFrame

By clicking the “Update Preview” button, the tool generates a new player object and iframe based on the entered custom properties.

The new player is displayed at the bottom of the page.

The iframe code is displayed in a text box above the player and demonstrates how the player page link should be built.