HTTP POST settings
[Section 4: Upload Settings]

These variables control HTTP POSTing. More...

Variables

var upload_path_http
 Path for HTTP uploads [string].
var upload_form_var_names
 Form Variable Names [Array].
var upload_form_var_values
 Form Variable Values [Array].
var upload_req_hdr_names
 Request Header Names [Array].
var upload_req_hdr_values
 Request Header Values [Array].
var upload_md5_enable
 Enable MD5 checksum [bool].
var upload_md5_form_var
 MD5 checksum upload method [bool].
var upload_md5_name
 MD5 checksum parameter name [string].
var upload_http_target_is_file
 Target of POST is file being uploaded [bool].
var upload_http_success_200
 HTTP 200 response means upload success [bool].
var upload_http_success_message
 HTTP upload success message [string].

Detailed Description


Variable Documentation

var upload_path_http

Path and arguments for use of upload.php on your webserver.

The Publisher sample implementation includes an example PHP script that can be used as the target for HTTP uploads, called `upload.php`. Publisher assumes that this script is in the same directory as the sample HTML page. If for some reason you've moved `upload.php` to a subdirectory, you will need to add a path specification to the following value. No leading slash.

Example

    var upload_path_http = "php/upload/upload.php?action=upload";

var upload_form_var_names

Use the upload_form_var_names array to store your form variable names.

Precondition:
upload_mode must be kUploadModeHttpFormPost

Example

    upload_form_var_names[0]  = "varName";
    upload_form_var_values[0] = "varValue";

var upload_form_var_values

Use the upload_form_var_values array to store your form variable values.

Precondition:
upload_mode must be kUploadModeHttpFormPost

Example

    upload_form_var_names[0]  = "varName";
    upload_form_var_values[0] = "varValue";

var upload_req_hdr_names

Use the upload_req_hdr_names array to to store request header names. Request headers are sent with all HTTP POST's.

Example

    upload_req_hdr_names[0]  = "Example-Header-Name";
    upload_req_hdr_values[0] = "Example-Header-Value";

var upload_req_hdr_values

Use the upload_req_hdr_values array to to store request header values. Request headers are sent with all HTTP POST's.

Example

    upload_req_hdr_names[0]  = "Example-Header-Name";
    upload_req_hdr_values[0] = "Example-Header-Value";

var upload_md5_enable

If enabled, the MD5 checksum of the file being uploaded will be sent to the web server. The MD5 checksum is in Hex form.

Precondition:
upload_mode must be kUploadModeHttpFormPost or kUploadModeHttpBinPost for MD5 sum to be included with upload.

var upload_md5_form_var

Controls method of uploading MD5 string. If upload_md5_form_var is set to true, the MD5 checksum will be uploaded as a form variable.

Precondition:
upload_mode must be set to a HTTP mode
upload_md5_enable must be set to true.
See also:
upload_form_var_names
upload_form_var_values
upload_md5_name
upload_req_hdr_names
upload_req_hdr_values

var upload_md5_name

Controls the name of the MD5 checksum parameter in the HTTP POST.

Precondition:
upload_md5_enable must be set to true.

var upload_http_target_is_file

Controls target of POST. If set to true, post target will be a FLV file name generated using the current date and time.

Remarks:
Generally speaking, upload_http_target_is_file should only be set to true if upload_mode == kUploadModeHttpBinPost.

var upload_http_success_200

200's enough. In other words, if the HTTP server returns HTTP 200 OK, and that's how your web server is setup to respond to an upload that was successful, set upload_http_success_is_200 = true.

Remarks:
Generally speaking, upload_http_success_200 should only be set to true if upload_mode == kUploadModeHttpBinPost.

var upload_http_success_message

Only set this variable if your web server returns content data that should be scanned for the presence of a string or particular code that denotes file upload success. If you leave the value as it is currently set, it will work with the upload.php file included with the SDK. Please note that the upload.php file included with the SDK requires that upload_mode == kUploadModeHttpFormPost.


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