Java Script API

Introduction

Every time an event happens in HDFVR (a buttons is pressed, connection succeeds,etc..) a call is made to a java script function with lots of info about the event!

What you can do with it

You can extend these JS functions to:

• show a message in the html page,
• activate a form/button in the html page,
• redirect the user to another page,
• etc... .

Actual JS API

Here is the list of events and associated java script functions:

Event	Java Script function that is called	Parameters passed to the JS function
[Record] button is pressed	btPlayPressed();	no params are sent to this function
[Play] button is pressed	btPlayPressed();	no params are sent to this function
[Stop] button is pressed	btStopPressed(appState);	appState : specifies in what state the recorder is when the STOP button is pressed. Its values are: recording (for when pressing STOP while recording) OR playing (for when pressing STOP wile playing back a recording)
[Save] button is pressed	btSavePressed(streamName, streamDuration, userId);	streamName: a string representing the name of the stream recorded on the video server including the .flv extension streamDuration: the duration of the recorded video/audio file in seconds but accurate to the millisecond (like this: 4.322) userId: the userId sent via flash vars or via the avc_settings.XXX file, the value in the avc_settings.XXX file takes precedence

 

You can find these java script functions defined in the videorecorderi.html and videorecorder-hd.html files that come with the video recorder.

PHP/ASP API

Introduction

Every time an important event happens in HDFVR (the [SAVE] button is pressed) a php/asp file is executed on the web server. Info about the event is sent (via GET variables) to the php/asp file when it is executed .

What you can do with it

You can extend these files to:

• insert the info about the movie/event in the database
• set session variables for later use
• etc...

Actual PHP/ASP API

Here is the list of events and associated php/asp files that are executed when the event happens:

Event	file/script that is executed on the web server	variables sent to the script via GET
HDFVR initializes in the browser	avc_settings.php or avc_settings.asp	No variables are sent when this file is executed. This script returns variable/value pairs in plain text. These vars are used by HDFVR for colors, limits, media server info, etc... . Edit the avc_settings.xxx file with a text eidtor to change the value of the variables.
[Save] button is pressed	save_video_to_db.php or avc_settings.asp	streamName: a string representing the name of the stream recorded on the video server including the .flv extension streamDuration: the duration of the recorded video/audio file in seconds but accurate to the millisecond (like this: 4.322) userId: the userId sent via flash vars or via the avc_settings.XXX file, the value in the avc_settings.XXX file takes precedence

 

Switching between php and asp

By default HDFVR attempts to use the php files (avc_settings.php, save_video_to_db.php). To switch to asp you need to:

1. Edit videorecorder-api.html with a text editor.
2. Replace videorecorder.swf with videorecorder.swf?sscode=asp in both places inside the HTML file.

Cold Fusion, Ruby, aspx etc...

If you manage to port the functionality in the provided asp/php files to other server side scripting languages you can use the sscode flash var to force the video recorder to use the new server side files. For example if sscode=aspx HDFVR will try to execute avc_settings.aspx and so on... .

 

You might also be interetsed in how the video recorder works and the Installation Instructions.