FMS Control Values
[flixpub_constants.js]

Authentication modes. More...

Variables

var kFmsAuthModeOff = 0
 Turn FMS authentication off.
var kFmsAuthModeAkamai = 1
 Akamai FMS Entrypoint Authentication.
var kFmsAuthModeLimelight = 1
 Limelight FMS Authentication.
var kFmsAuthModeCustom = 3
 Turn on custom FMS authentication.

Detailed Description

This section documents named helper variables that are defined in the file flixpub_constants.js, and used in the reference application to control how streams are sent to FMS.

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 kFmsAuthModeOff = 0

Setting FmsAuthenticationMode to kFmsAuthModeOff turns off FMS authentication.

See also:
FmsAuthenticationMode
kFmsAuthModeCustom

var kFmsAuthModeAkamai = 1

Setting FmsAuthenticationMode to kFmsAuthModeAkamai enables Akamai authentication. Requires that FmsUsername and FmsPassword are set.

Precondition:
Access to an Akamai FMS Entrypoint
See also:
FmsUsername, FmsPassword

var kFmsAuthModeLimelight = 1

Setting FmsAuthenticationMode to kFmsAuthModeLimelight enables Limelight authentication. Requires that FmsUsername and FmsPassword are set correctly.

Precondition:
Access to a Limelight FMS server.
See also:
FmsUsername, FmsPassword

var kFmsAuthModeCustom = 3

When FmsAuthenticationMode mode is kFmsAuthModeCustom, you must supply the plug-in with action script function names, and the values of the arguments that must be passed to the server in order to authenticate the stream.

Remarks:
  • You use the method addFmsAuthArg() to add functions and arguments.
  • Authentication takes place while FLV encode is starting.
  • Communication with FMS is currently one way (plug-in to FMS), with the exception being getFmsAuthResponse().
See also:
addFmsAuthArg()
FmsAuthenticationMode
getFmsAuthResponse()
kFmsAuthModeOff


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