States
[flixpub_constants.js]

Meanings of State values. More...

Variables

var FS_STOP = 0
 Idle.
var FS_PLAY_I = 1
 Input File Playing.
var FS_PAUSE_I = 2
 Input File Paused.
var FS_PLAY_O = 3
 Output File Playing.
var FS_PAUSE_O = 4
 Output File Paused.
var FS_CAPTURE = 5
 Capture in Progress.
var FS_PAUSE_C = 6
 Capture Paused.
var FS_ENCODE = 7
 File Encode in Progress.
var FS_UPLOAD = 8
 Publish in Progress.
var FS_PREVIEW = 9
 The publisher plug-in is previewing a capture device.
var FS_PAUSE_E = 10
 File Encode Paused.
var FLIXSTATE_STOPPED = FS_STOP
 Deprecated.
var FLIXSTATE_PLAYING_INPUT = FS_PLAY_I
 Deprecated.
var FLIXSTATE_PLAYING_INPUT_PAUSED = FS_PAUSE_I
 Deprecated.
var FLIXSTATE_PLAYING_OUTPUT = FS_PLAY_O
 Deprecated.
var FLIXSTATE_PLAYING_OUTPUT_PAUSED = FS_PAUSE_O
 Deprecated.
var FLIXSTATE_CAPTURING = FS_CAPTURE
 Deprecated.
var FLIXSTATE_CAPTURING_PAUSED = FS_PAUSE_C
 Deprecated.
var FLIXSTATE_ENCODING_FILE = FS_ENCODE
 Deprecated.
var FLIXSTATE_PUBLISHING = FS_UPLOAD
 Deprecated.
var FLIXSTATE_PREVIEWING = FS_PREVIEW
 Deprecated.

Detailed Description

This section documents the Flix Publisher plug-in states and the corresponding named helper variables defined in flixpub_constants.js.

This section contains information about possible values of the Flix Publisher Plug-in API State attribute.

Special Note

Because of Javascript run time implementation differences between Internet Explorer and the Mozilla compatible browsers (Firefox, Netscape, Flock, etc), these "constants" are really var declarations made at global scope.

Instructions for Using The Named Variables

These variables are defined in flixpub_constants.js. You can find flixpub_constants.js in the SDK samples directory.
To use the variables, you must add the file to your site and include it in your page by using a script tag, like this:

<script type="text/javascript" src="flixpub_constants.js"></script>

The script tag for flixpub_constants.js should come before other script tags that reference javascript files that use the publisher plug-in API.

Variable Documentation

var FS_STOP = 0

The publisher is idle.

var FS_PLAY_I = 1

The publisher plug-in is playing the input file.

See also:
selectInputFileForPlayback()
startPlayback()

var FS_PAUSE_I = 2

The publisher plug-in has paused playback the input file.

See also:
pause()
resume()

var FS_PLAY_O = 3

The publisher plug-in is playing the output file.

See also:
selectOutputFileForPlayback()
startPlayback()

var FS_PAUSE_O = 4

The publisher plug-in has paused playback the output file.

See also:
pause()
resume()

var FS_CAPTURE = 5

The publisher is plug-in is capturing.

See also:
startCapture()
stopCapture()

var FS_PAUSE_C = 6

The publisher plug-in has paused capture.

See also:
pause()
resume()

var FS_ENCODE = 7

The publisher plug-in is transcoding an input file.

See also:
startFileEncode()
stopFileEncode()

var FS_UPLOAD = 8

The publisher plug-in is uploading a file.

See also:
publishFile()
publishAbort()

var FS_PREVIEW = 9

See also:
startCapturePreview()
stopCapturePreview()

var FS_PAUSE_E = 10

The publisher plug-in file encode is paused.

See also:
pause()
resume()

var FLIXSTATE_STOPPED = FS_STOP

Deprecated:
Use FS_STOP.

var FLIXSTATE_PLAYING_INPUT = FS_PLAY_I

Deprecated:
Use FS_PLAY_I.

var FLIXSTATE_PLAYING_INPUT_PAUSED = FS_PAUSE_I

Deprecated:
Use FS_PAUSE_I.

var FLIXSTATE_PLAYING_OUTPUT = FS_PLAY_O

Deprecated:
Use FS_PLAY_O.

var FLIXSTATE_PLAYING_OUTPUT_PAUSED = FS_PAUSE_O

Deprecated:
Use FS_PAUSE_O.

var FLIXSTATE_CAPTURING = FS_CAPTURE

Deprecated:
Use FS_CAPTURE.

var FLIXSTATE_CAPTURING_PAUSED = FS_PAUSE_C

Deprecated:
Use FS_PAUSE_C.

var FLIXSTATE_ENCODING_FILE = FS_ENCODE

Deprecated:
Use FS_ENCODE.

var FLIXSTATE_PUBLISHING = FS_UPLOAD

Deprecated:
Use FS_UPLOAD.

var FLIXSTATE_PREVIEWING = FS_PREVIEW

Deprecated:
Use FS_PREVIEW.


On2 Flix Publisher documentation, generated on Mon Jan 7 18:13:01 2008 by doxygen 1.5.4 On2 Technologies, Inc