CamzorFlash - CamzorFlash XML

From BloatedCowSoftware Wiki

Jump to: navigation, search
This page outlines all of the different settings elements that can exist in the CamzorFlash.xml file.

Contents


File Structure

The CamzorFlash.xml file should start with: 

<?xml version="1.0" ?>
<data>

and end with: 

</data>

In between the data tags are setting tags. setting tags tell CamzorFlash how to run. They look like this (notice how it ends with />): 

<setting name="image" value="http://yourdomain.com/webcam_image.jpg"/>

Settings

Webcam

image
The image setting should be set to the FULL URL path of your webcam image. This path must be in the same domain/subdomain of your website as the CamzorFlash.swf file.
type: String
expects: FULL URL path to a graphic (png, jpg, gif)
default: null
example: <setting name="image" value="http://yourdomain.com/webcam_image.jpg"/> <!--display the image located at http://yourdomain.com/webcam_image.jpg -->


image_height
The image_height setting should be set to the height of your webcam image. You can set this larger or smaller to have Camzor automatically expand or shrink your image.
type: Integer


expects: Any Integer between -1 and 2415919103.
default: -1 (setting this value to -1 will cause Camzor to use the swf's height as default)
example: <setting name="image_height" value="240"/> <!--image is 240px tall-->


image_width
The image_width setting should be set to the width of your webcam image. You can set this larger or smaller to have Camzor automatically expand or shrink your image.
type: Integer


expects: Any Integer between -1 and 2415919103.
default: -1 (setting this value to -1 will cause Camzor to use the swf's width as default)
example: <setting name="image_width" value="320"/> <!--image is 320px wide-->


refresh
The refresh setting is how long Camzor will wait between image downloads. This setting is in milliseconds.
type: Integer (milliseconds)
expects: Any Integer between 100 and 2415919103.
default: 5000


example: <setting name="refresh" value="1000"/> <!--refresh every second-->


Progress bar

progressbar
The progressbar setting specifies whether or not a progress bar will be shown for download progress as well as refresh countdown.
type: Boolean (true/false)
expects: true or false


default: true
example: <setting name="progressbar" value="false"/> <!--do not display a progress bar-->


progressbar_y_offset
The progressbar_y_offset setting specifies how far from the top of the swf the progress bar should appear. Note: the progress bar is 4px tall.
type: Integer


expects: Any Integer between 0 and 2415919103
default: -1 (setting this value to -1 will use the default which is image_height - 4)
example: <setting name="progressbar_y_offset" value="236"/> <!--display the progress bar 236px below the top of the image-->


Text Overlay

text_overlay
The text_overlay setting tells Camzor whether or not to display the text overlay
type: Boolean (true/false)
expects: true or false


default: false
example: <setting name="text_overlay" value="true"/> <!--display the text overlay-->


text_bgcolor
The text_bgcolor setting tells Camzor what color to use as the background of the text overlay.
type: HTML Hex color what is a hex color code?
expects: # followed by a hexadecimal number
default: #000000 (black)
example: <setting name="text_bgcolor" value="#00FF00"/> <!--set the text overlay to have a green background-->


text_forecolor
The text_forecolor setting tells Camzor what color the text in the text overlay should be.
type:


expects: # followed by a hexadecimal number
default: #FFFFFF
example: <setting name="text_forecolor" value="#FF0000"/> <!--set the font color to red-->


text_y_offset
The text_y_offset setting specifies how far from the top of the swf the text overlay should appear. Note: the text overlay is 18px tall.
type: Integer


expects: Any Integer between 0 and 2415919103
default: -1 (setting this value to -1 will cause Camzor to use (image_height - 18) as default)
example: <setting name="text_y_offset" value="0"/> <!--display the text overlay at the top of the swf-->


text_string
The text_string setting tells Camzor
type: String


expects: Any string
default: text_string is not set
example: <setting name="text_string" value="Hello World!"/> <!--display 'Hello World! in the text overlay-->


Double Click Link

link
The link setting tells Camzor what document to open when the user double clicks. Note: If you leave this blank, nothing will happen on a double click.
type: String


expects: The FULL URL to the document/image/etc... you'd like to open on double click
default: (default is a blank string)
example: <setting name="link" value="http://google.com/"/> <!--Open Google on double click-->


Image Fading

fade
Tells Camzor whether or not to use fade transitions between images.
type: Boolean (true/false)
expects: true or false


default: true
example: <setting name="fade" value="false"/> <!--Do not fade between images-->
Registered version only


fade_duration
If fade is enabled, this specifies how long the fade time should be. This setting is in milliseconds
type: Integer (milliseconds)
expects: Any integer between 100 and 2415919103
default: 1000


example: <setting name="fade" value="500"/> <!--Fade for a half second-->
Registered version only


Zoom Settings

zoom_max
How far in to allow zooming
type: Float


expects: any float between 1.0 and 8.0
default: 5
example: <setting name="fade" value="4"/> <!--Only allow 4x zoom-->
Registered version only


zoom_step
How much to zoom with each zoom event (right click menu, mouse wheel, etc...)
type: Float


expects: any float between 0.05 and 1.0
default: 0.1
example: <setting name="fade" value="1.0"/> <!--Zoom 1x per zoom event-->
Registered version only


zoom_mousewheel
Tells Camzor whether or not the mousewheel will be allowed to zoom the image.
type: Boolean (true/false)
expects: true or false


default: true
example: <setting name="fade" value="false"/> <!--Do not allow zoom on the mousewheel-->
Registered version only


zoom_menu
Tells Camzor whether or not the menu will contain zoom commands
type: Boolean (true/false)
expects: true or false


default: true
example: <setting name="fade" value="false"/> <!--Do not allow zoom commands in the menu-->
Registered version only


toolbar_zoom_and_pan_toggle
Tells Camzor whether or not the toolbar will contain the mouse zoom toggle
type: Boolean (true/false)
expects: true or false


default: true
example: <setting name="fade" value="false"/> <!--Do not allow zoom mouse button on the toolbar-->
Registered version only


Miscellaneous

collect_errors
If you wish to hide the red error box (should it pop up), you can set this to false. Note: the error collector will start dismissing the oldest errors when the count is higher than 10.
type: Boolean (true/false)
expects: true or false


default: true
example: <setting name="collect_errors" value="false"/> <!--do not collect errors-->


regcode
If you have purchased Camzor, enter your registration code here.
type: String


expects: A string in the form of a registration code.
default: (default is a blank string)
example: <setting name="regcode" value="Cz90-Sazsadf-qwIOW3"/> <!--Register to work on this website-->


splash_duration
If you have purchased Camzor, you can change the amount of time the Bloated Cow logo appears. This setting is in milliseconds
type: Integer (milliseconds)
expects: Any integer between 100 and 2415919103
default: 3000


example: <setting name="splash_duration" value="500"/> <!--Show the Bloated Cow logo for half a second-->
Registered version only


Example

The following code is an example CamzorFlash.xml document. Highlighted areas represent areas you'll need to change in order for the example to work for you. 

   <?xml version="1.0" ?>
   <data>
       <setting name="bgcolor" value="#FFFFFF"/>
       <setting name="image" value="http://yourdomain.com/webcam_image.jpg"/>
       <setting name="image_height" value="240"/>
       <setting name="image_width" value="320"/>
       <setting name="refresh" value="5000"/>
       <setting name="progressbar" value="true"/>
       <setting name="progressbar_y_offset" value="218"/>
       <setting name="text_overlay" value="true"/>
       <setting name="text_bgcolor" value="#000000"/>
       <setting name="text_forecolor" value="#FFFFFF"/>
       <setting name="text_y_offset" value="222"/>
       <setting name="text_string" value="this is my webcam"/>
   </data>
Retrieved from "http://wiki.bloatedcowsoftware.com/CamzorFlash_-_CamzorFlash_XML"
Personal tools
Bloated Cow Software