API Wrappers
[flixpub_main.js]

API Wrappers for abstracting away differences between the Mac and Windows plug-ins. More...

Functions
function	fp_fms_enabled (pub)
	FMS broadcast enabled?
function	fp_input_file_selected (pub)
	Input file selected? [for playback].
function	fp_output_file_selected (pub)
	Output file selected? [for playback].
function	fp_set_play_position (pub, pos)
	Set the play position (seek).
function	fp_show_file_chooser (pub)
	Show open file dialog.

---

Detailed Description

This section includes documentation on javascript functions used in the reference application to abstract away the differences between the Mac and Windows plug-in APIs.

---

Function Documentation

function fp_fms_enabled

(

pub

)

The behavior of this function is determined by the platform on which it is called.

Arguments

• pub - Flix Publisher plug-in Object

Mac plug-in

Always returns false. FMS streaming is not available on the Mac.

Windows plug-ins

Returns the value of the FmsEnable attribute.

function fp_input_file_selected

(

pub

)

The behavior of this function is determined by the platform on which it is called.

Arguments

• pub - Flix Publisher plug-in Object

Mac plug-in

Always returns true. Output file playback is not supported on the Mac.

Windows plug-ins

Returns the value of the InputFileSelected attribute.

function fp_output_file_selected

(

pub

)

The behavior of this function is determined by the platform on which it is called.

Arguments

• pub - Flix Publisher plug-in Object

Mac plug-in

Always returns false. Output file playback is not supported on the Mac.

Windows plug-ins

Returns the value of the OutputFileSelected attribute.

function fp_set_play_position	(	pub	,
		pos
	)

This function behaves the same on Windows and Mac. It's purpose is to ensure that the value assigned the the PlayPosition attribute is of type number.

Note:

The Publisher plug-in for Mac Safari ignores writes to PlayPosition when the value written is not of type number.

Arguments

• pub - Flix Publisher plug-in Object
• pos - Position to seek to, in milliseconds

function fp_show_file_chooser

(

pub

)

This function wraps addFile() in order to abstract subtle differences in behavior between the Mac and Windows implementations of the method. See the implementation of the function in flixpub_main.js for more detail.

Arguments

• pub - Flix Publisher plug-in Object

Return values:

	\c	true - User selected a file, you should call checkInputFile() to validate the file.
	\c	false - User did not select a file, do nothing.

---