Events
[Flix Publisher API Documentation]

Variables
event	captureCompleted
	Capture to FLV Complete.
event	clicked
	Mouse clicked.
event	doubleClicked
	Mouse double clicked.
event	rightClicked
	Mouse right clicked.
event	fileEncoded
	Encode completed.
event	filePaused
	Paused Playback.
event	filePlayed
	Playback complete.
event	filesDropped
	User Drag and Drop.
event	fmsConnectionDown
	FMS Disconnected.
event	fmsConnectionUp
	FMS Connected.
event	uploadStart
	Upload starting.
event	uploadComplete
	Upload complete.
event	uploadFailed
	Upload failed.

---

Detailed Description

Special Considerations for Multiple Browser Support

For All Browsers

The following example HTML should be used as a starting point for writing javascript code intended to receive events from the publisher.

For the purposes of this example, assume flixe was used for the name and id parameters specified within the object tag used to install the Flix Publisher plug-in within the page.

<SCRIPT FOR="flixe" EVENT="captureCompleted">captureCompleted();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="uploadStart">uploadStart();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="uploadComplete">uploadComplete();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="uploadFailed">uploadFailed();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="filePlayed">filePlayed();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="filePaused">filePaused();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="fileEncoded">fileEncoded();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="filesDropped">filesDropped();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="clicked">clicked();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="rightClicked">rightClicked();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="fmsConnectionDown">fmsConnectionDown();</SCRIPT>
<SCRIPT FOR="flixe" EVENT="fmsConnectionUp">fmsConnectionUp();</SCRIPT>

For each event above, follow this example using the captureCompleted event:

function captureCompleted()
{
// add your event handler code here
}

For Mozilla (netscape plugin) Based Browsers

Javascript functions must be created for each event that you wish to receive. Each function must be named exactly as the event is named. For example, for the filesDropped event:

function filesDropped()
{
// add your event handler code here
}

---

Variable Documentation

event captureCompleted

The captureCompleted event is fired when capture stops.

Precondition:

To receive this event, you must define a Javascript function named captureCompleted that takes no arguments.

See also:

• MaximumDuration - captureCompleted will be fired if EncodedDuration exceeds the maximum duration.
• stopCapture() - captureCompleted will be fired when capture stops.

Mac Support: Yes.

event clicked

The clicked event is fired when a user clicks on the publisher.

Precondition:

To receive this event, you must define a Javascript function named clicked that takes no arguments.

Mac Support: Yes.

event doubleClicked

The clicked event is fired when a user double-clicks the publisher.

Precondition:

To receive this event, you must define a Javascript function named doubleClicked that takes no arguments.

Mac Support: Yes.

event rightClicked

The rightClicked event is fired when a user right-clicks the publisher.

Precondition:

To receive this event, you must define a Javascript function named rightClicked that takes no arguments.

Mac Support: Yes.

event fileEncoded

The fileEncoded event is fired when an encode completes.

Precondition:

To receive this event, you must define a Javascript function named fileEncoded that takes no arguments.

See also:

• MaximumDuration - fileEncoded will be fired if EncodedDuration exceeds the maximum duration.
• stopFileEncode() - fileEncoded will be fired when transcode stops.

Mac Support: Yes.

event filePaused

The filePaused event is fired when playback is paused internally by the publisher because PlayPosition is greater than EncodeTimeEnd.

Precondition:

• To receive this event, you must define a Javascript function named filePaused that takes no arguments.
• EncodeTimeEnd must be set to a value less than the InputFileDuration.

Mac Support: Yes.

event filePlayed

The filePlayed event is fired when playback stops.

Precondition:

To receive this event, you must define a Javascript function named filePlayed that takes no arguments.

Remarks:

• stopPlayback() - filePlayed will is fired when playback stops.
• filePlayed is fired when the file being played reaches its end.

Mac Support: Yes.

event filesDropped

The filesDropped event is fired when a user drags and drops a file on the publisher plug-in.

Precondition:

To receive this event, you must define a Javascript function named filesDropped that takes no arguments.

Remarks:

When the filesDropped is recieved, the input file must be validated. Call checkInputFile().

Mac Support: Yes.

event fmsConnectionDown

The fmsConnectionDown event is fired immediately after the connection to FMS goes down.

Precondition:

To receive this event, you must define a Javascript function named fmsConnectionDown that takes no arguments.

Mac Support: No.

event fmsConnectionUp

The fmsConnectionUp event is fired immediately after the connection to FMS connection is established

Precondition:

To receive this event, you must define a Javascript function named fmsConnectionUp that takes no arguments.

Mac Support: No.

event uploadStart

The uploadStart event is fired immediately before the upload starts.

Since:

Mac	Initial Release
Windows	Version 3.0.6.4

Precondition:

To receive this event, you must define a Javascript function named uploadStart that takes no arguments.

Mac Support: Yes.

event uploadComplete

• if PublishMethod is kUploadModeFtp:
  The uploadComplete event is fired when uploading completes. The receipt of this event after an FTP upload denotes successful upload.
• if PublishMethod is kUploadModeHttp:
  The uploadComplete event is fired when the HTTP transaction completes. The method documentation for getHttpVar() contains information with regard to checking the HTTP upload status.

Precondition:

To receive this event, you must define a Javascript function named uploadComplete that takes no arguments.

Mac Support: Yes.

event uploadFailed

• if PublishMethod is kUploadModeFtp:
  The uploadFailed event is fired when the FTP upload operation fails.
• if PublishMethod is kUploadModeHttp:
  The uploadFailed event is fired when the plug-in is unable to communicate with the web server.

Precondition:

To receive this event, you must define a Javascript function named uploadFailed that takes no arguments.

Mac Support: Yes.

---