On2 Flix Publisher: Attributes

long AudioBitrate

Desired bit rate, in kilobits per second, for the output audio stream. The default value of AudioBitrate is 32 kilobits per second.

1 kilobit = 1 thousand bits

if AudioCodecID is set to kAudioCodecMp3
The first ACM MP3 encoder found on the client computer is used through the DirectShow ACM wrapper interface. Available bitrates will be limited by what the installed ACM encoder provides. If a rate specified is unavailable, or unsupported, the plug-ins use the closest matching setting supported by the ACM.

if AudioCodecID is set to kAudioCodecNellyMoser
The built in Nellymoser audio encoder is used to encode audio at the closest matching bitrate setting that it supports.

Mac Support: Yes.

long AudioCaptureBufferTime

Length of audio hardware capture buffer, in milliseconds.

Remarks:

Setting this value below 100ms is not recommended because common audio hardware is not capable of keeping up with such a low latency.
AudioCaptureBufferTime does not have any effect upon DV audio capture. DV capture buffering time is controlled using MaximumCaptureLatency.

Mac Support: No.

string AudioCaptureDevice

Controls the audio capture source. This attribute is read/write.

to retrieve the number of audio capture devices, use numAudioCaptureDevices().
to retrieve the name of an audio capture device, use audioCaptureDeviceName().
to show the audio device settings dialog, call show_audio_capture_settings()

Exceptions:

	FE_CAPTURE_A	- if device fails basic render tests.
	FE_IN_USE	- if written while capture or preview in progress.
	FE_NO_CAPTURE_DEVICE	- if selected device disconnected.

See also:: Exceptions and Errors

Mac Support: Yes.

long AudioCaptureMute

Not implemented. Once implemented, will mute audio capture.

long AudioCaptureVolume

Controls audio capture volume. Range is 0-100, default is 50.

Remarks:

An AudioCaptureVolume of 0 is NOT mute.
AudioCaptureVolume does not have any effect upon DV audio capture. DV capture volume must be controlled using the DV device.

Mac Support: No.

long AudioCodecID

This attribute controls the audio codec used in FLV files encoded by the publisher plug-ins. This attribute supports reading and writing. The default codec is kAudioCodecNellyMoser. The supported AudioCodecID values are:

0 - kAudioCodecMp3
Output FLVs will contain MP3 format audio. Use of MP3 format audio requires the following:
- ACM MP3 driver must be present on user's computer
- ACM MP3 driver must support encoding
1 - kAudioCodecNellyMoser
Output FLVs will contain NellyMoser audio. Nellymoser support is built in to the publisher and does not require the presence of external codecs on the client computer.

Remarks:: If the MP3 requirements are not met, or if an MP3 encoder is not present at all, the plug-ins will use Nellymoser Audio for output files when AudioCodecID is set to kAudioCodecMp3.

Mac Support: No.

string BGImageURL

Holds complete URL for image to be displayed by the plug-in when it is idle. This attribute is read/write.

Precondition:

The image must be a JPEG.
The URL specified must be fully qualified.

Remarks:

Make sure to clear your browser cache during development of your publisher project if frequently changing the URL passed to BGImageURL. BGImageURL is reset to an empty string each time one of the following: methods is called:

Mac Support: Yes.

long EncodedDuration

Duration, in milliseconds, of the portion of the input file already encoded. This attribute is read-only. The value read is invalid if no encode is in progress. Values are in milliseconds.

Precondition:: Encode must be in progress. Ensure that State is equal to FS_CAPTURE, FS_PAUSE_C, or FS_ENCODE.

Mac Support: Yes.

long EncodeTimeStart

Point in the input file at which encoding should be started. This attribute is read/write. Values are in milliseconds. The default EncodeTimeStart is 0.

Precondition:: InputFileCanSeek must be true before attempting to write to EncodeTimeStart

Exceptions:

FE_FILE_CANNOT_SEEK

- the current file does not allow seeking.

See also:: Exceptions and Errors
EncodeTimeEnd
InputFileCanSeek
InputFileDuration

Mac Support: Yes.

long EncodeTimeEnd

Point in the input file at which encoding should stop. This attribute is read/write. Values are in milliseconds. The default EncodeTimeEnd is InputFileDuration.

See also:: Exceptions and Errors
EncodeTimeStart
InputFileDuration

Mac Support: Yes.

long FmsEnable

This attribute enables and disables streaming of FLV output data to a Flash Media Server while encoding is in progress. This attribute supports reading and writing. The default value is 0, disabled. The supported values for FmsEnable are:

0 - disabled (default)
Calls to startCapture() and startFileEncode() will behave normally.
1 - enabled
Calls to startCapture() and startFileEncode() will result in connection to the specified Flash Media Server.

Remarks:

When FMS streaming is enabled, many seconds can elapse after a call to stopCapture() or stopFileEncode() before the corresponding captureCompleted or fileEncoded event is fired.
If capture or transcode is in progress when the value of FmsEnable is changed, the change will not take effect until the next capture or transcode.

See also:: FmsServer
FmsPath
FmsName
fp_fms_enabled()

Mac Support: No.

unsigned long FmsBufferTime

Milliseconds buffered within the FMS streaming support library. The default value is 0, no buffering. No buffering means that the library attempts to send the data to FMS as quickly as possible.

Remarks:: If available bandwidth drops below the stream's combined data rate, latency will increase regardless of the value of FmsBufferTime.

Mac Support: No.

long FmsIgnoreFail

The value of this attribute determines how the plug-in responds to a Flash Media Server connection error. This attribute supports reading and writing. Its possible values are:

0 - disabled (default)
Calls to startCapture() and startFileEncode() will return an error if connection to FMS fails.
1 - enabled
Calls to startCapture() and startFileEncode() will ignore FMS connection failure.

See also:: FmsServer
FmsPath
FmsName

Mac Support: No.

string FmsServer

This attribute controls the Flash Media Server address. This attribute supports reading and writing.

Remarks:: If capture or transcode is in progress when the value of FmsServer is changed, the change will not take effect until the next capture or transcode.

See also:: FmsEnable

Mac Support: No.

string FmsPath

This attribute controls the path portion of URL used to connect to FMS. This attribute supports reading and writing.

For example, in the URL rtmp://fms.on2.com/streams/stream1, the streams/stream1 portion is controlled by this attribute.

Remarks:: If capture or transcode is in progress when the value of FmsPath is changed, the change will not take effect until the next capture or transcode.

See also:: FmsEnable

Mac Support: No.

string FmsName

This attribute controls the stream name used to connect and send data to FMS. FLV streaming from FMS requires a stream name in addition to the URL. This attribute supports reading and writing.

Remarks:: If capture or transcode is in progress when the value of FmsName is changed, the change will not take effect until the next capture or transcode.

See also:: FmsEnable

Mac Support: No.

long FmsAuthenticationMode

FmsAuthenticationMode controls the authentication method used to communicate and authenticate with the destination server for your encoded stream. The only currently supported values are:

0 - no authentication.
3 - custom authentication. Requires use of addFmsAuthArg().

Precondition:: State must be FS_STOP to change authentication modes.

Remarks:: Custom authentication requires that you supply the plug-in with FMS action script functions to call, and the arguments to be passed to those functions. Examples demonstrating this can be found in flixpub_conf.js and flixpub_main.js.

See also:: FmsEnable, addFmsAuthArg()

Mac Support: No.

long FmsAuthWaitForResponse

If FmsAuthWaitForResponse is enabled, the plug-in will wait for a response from each FMS Action Script function call.

Precondition:

State must be FS_STOP to change this flag.
FmsAuthenticationMode must be 3.

See also:: addFmsAuthArg(), FmsAuthenticationMode, FmsAuthWaitTimeout

Mac Support: No.

unsigned long FmsAuthWaitTimeout

Milliseconds the plug-in will wait for a response from a FMS Action Script function call.

Precondition:: State must be FS_STOP to write this value.

See also:: addFmsAuthArg(), FmsAuthenticationMode, FmsAuthWaitForResponse

Mac Support: No.

long FmsPollEnable

Enables and disables FMS connection polling. Use FmsPollTimeout to set the polling timeout. Examples demonstrating this can be found in flixpub_conf.js and flixpub_main.js.

Precondition:

State must be FS_STOP to change the timeout.

See also:: addFmsAuthArg(), FmsAuthenticationMode, FmsAuthWaitTimeout

Mac Support: No.

unsigned long FmsPollDelay

Milliseconds between FMS connection poll attempts. The default polling delay is 10000 milliseconds.

Precondition:: State must be FS_STOP to write.

See also:: FmsPollEnable, FmsPollTimeout

Mac Support: No.

unsigned long FmsPollTimeout

Milliseconds plug-in waits for a response from FMS before the connection is timed out. The default time out value is 10000 milliseconds.

Precondition:: State must be FS_STOP to write.

See also:: FmsPollEnable, FmsPollDelay

Mac Support: No.

string FmsUsername

This attribute exists and can be read and written. Unfortunately, using an FMS user name is only supported in specific FMS Authentication schemes. These schemes have not yet been completed. Check back here for futher information in future releases.

Remarks:: If you want to send a username to your application.onConnect function, see addFmsAuthArg() and FmsAuthenticationMode.

Draft documentation for use of this attribute:

FmsUsername holds the user identifier/name that will be used to authenticate the stream on the destination Flash Media Server. FmsUsername is only used when FmsAuthenticationMode is non-zero.

See also:: FmsAuthenticationMode, FmsPassword

Mac Support: No.

string FmsPassword

This attribute exists and can be read and written. Unfortunately, using an FMS password is only supported in specific FMS Authentication schemes. These schemes have not yet been completed. Check back here for futher information in future releases.

Remarks:: If you want to send a password to your application.onConnect function, see addFmsAuthArg() and FmsAuthenticationMode.

Draft documentation for use of this attribute:

FmsPassword holds the password/key that will be used to authenticate the stream on the destination Flash Media Server. FmsPassword is only used when FmsAuthenticationMode is non-zero.

See also:: FmsAuthenticationMode, FmsUsername

Mac Support: No.

string FtpSubDomain

This attribute controls the sub domain portion of the FTP server address. This attribute supports reading and writing.

For example, given the address ftp.example.com, the ftp portion would be controlled by this attribute.

See also:: FtpMode
FtpPort
FtpServer
PublishMethod
publishFile()

Mac Support: Yes.

string FtpServer

Server address for FTP uploading. This attribute is read-only.

Mac Support: Yes.

unsigned short FtpPort

This attribute controls the port used when connecting to FtpServer.

Mac Support: Yes.

string FtpUser

Sets user account name for ftp publishing. This attribute is read/write.

Mac Support: Yes.

string FtpPassword

Sets password for ftp publishing. This attribute is read/write.

Mac Support: Yes.

string FtpDestinationFile

Sets file name for ftp publishing. The file will be stored on the server with the specified name. This attribute is read/write.

Remarks:: This attribute's value defaults to OutputFileName sans path.

Mac Support: Yes.

string FtpMode

Enables or Disables Passive mode. Passive mode FTP uploading is enabled by default, thus the default value of FtpMode is "P". To disable passive mode, set ftpMode to any value other than "P". (not recommended)

Mac Support: Yes.

string HttpSubDomain

The HttpSubDomain contains the portion of the URL that is typically set to 'www'. When the publisher starts an http upload, the url formed will be:

http://HttpSubDomain.HttpServer/HttpPath

See also:

HttpURL

PublishMethod

publishFile()

Mac Support: Yes.

string HttpServer

The Http server address you provided during the publisher licensing process. When the publisher starts an http upload, the url formed will be:

http://HttpSubDomain.HttpServer/HttpPath

See also:

HttpURL

PublishMethod

publishFile()

Mac Support: Yes.

string HttpPath

The HttpPath contains everything that gets appended after the domain/ip in the http url. When the publisher starts an http upload, the url formed will be:

http://HttpSubDomain.HttpServer/HttpPath

This attribute is read-only.

See also:

HttpURL

PublishMethod

publishFile()

Mac Support: Yes.

string HttpFile

This attribute controls the name of the file once uploaded to the server. This attribute is read/write.

Remarks:: This attribute's value defaults to OutputFileName sans path.

Mac Support: No.

string HttpURL

Use this read-only property to determine the url that will be used to create the HTTP post sent to the web server.

http://HttpSubDomain.HttpServer/HttpPath

See also:

HttpPath

HttpServer

HttpSubDomain

Mac Support: Yes.

long InputFileAudioChannels

This attribute holds the number of audio channels detected in the input file when checkInputFile() was called. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

See also:: addFile()
checkInputFile()

Mac Support: No.

long InputFileAudioSampleRate

This attribute holds the audio sampling rate of the input file detected when checkInputFile() was called. The value returned is in hertz. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

See also:: addFile()
checkInputFile()

Mac Support: No.

long InputFileAudioSampleSize

This attribute holds the audio sampling rate of the input file detected when checkInputFile() was called. The value returned is in bits. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

See also:: addFile()
checkInputFile()

Mac Support: No.

long InputFileCanSeek

This attribute must be checked before setting PlayPosition or EncodeTimeStart. Writes to either attribute when InputFileCanSeek is false will result in FE_FILE_CANNOT_SEEK exceptions being thrown. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

Mac Support: Yes.

long InputFileDuration

Duration, in milliseconds, of input file. This attribute is read-only. Values are in milliseconds.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

Mac Support: Yes.

double InputFileFrameRate

Contains input file frame rate. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

Mac Support: Yes.

string InputFileName

The full name and path of the current input file. The attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

Mac Support: Yes.

long InputFileSelected

If non-zero, the input file is currently selected.

See also:: selectInputFileForPlayback()
startPlayback()
stopPlayback()
fp_input_file_selected()

Mac Support: No.

long InputFileWidth

Width, in pixels, of input file. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

Mac Support: Yes.

long InputFileHeight

Height, in pixels, of input file. This attribute is read-only.

Precondition:: checkInputFile() must be called before this attribute holds information related to the most recent input file. This applies to files received via user drag and drop, and files loaded via call to addFile().

Mac Support: Yes.

long LastError

Contains the value of the most recent error. It is best to reset this value prior to eash interaction with the publisher in order to guarantee valid information when reading the value.

See also:: Error Values - for error value documentation.

Mac Support: Yes.

unsigned long MaximumCaptureLatency

MaximumCaptureLatency controls the maximum amount of buffering allowed within the capture data stream. The value is in milliseconds. The default value is 0 milliseconds.

Note:: It is strongly recommended that you avoid modifying this setting. Modifying the setting can have a detrimental effect on audio video synchronization.

Remarks:

With the default value of 0ms system defaults are used
Setting this value below 100ms is not recommended because most audio and video capture hardware is not capable of keeping up with such a low capture latency.
Setting this value above 250ms is not recommended, it can cause loss of audio video synchronization.

Mac Support: No.

long MaximumDuration

Contains the maximum duration, in milliseconds, for files created by the Publisher. This attribute is read/write.

Remarks:

The default value of this attribute is 120000 milliseconds, or 2 minutes.
If MaximumDuration is set to 0, the publisher plug-ins will not limit the duration of output files.
Publisher plug-ins that are watermarked with the On2 logo (demo Plug-ins) will be limited to a 2 minute maximum output file duration, but the MaximumDuration value can be adjusted to be set as low as 1 second.
Publisher plug-ins without the On2 watermark can set the MaximumDuration attribute to 0 for unlimited duration, or adjust the value to their desired duration.

Mac Support: Yes.

long OutputFileDuration

Duration of output file, in milliseconds. This attribute is read-only.

Precondition:: An output file must be created. Output files exist and can be operated upon once the captureCompleted or fileEncoded events have been fired.

Mac Support: Yes.

double OutputFileFrameRate

This attribute controls the video frame rate of the output file. This attribute is read/write.

Remarks:

The default value of OutputFileFrameRate varies depending upon input type:

When capturing from a webcam, the default rate is 15 frames per second.
When capturing from a DV camera, the default rate is determined by the DV camera driver.
When transcoding a file, the default rate depends on the input file frame rate. If the file reports a non-zero frame rate, output frame rate defaults to half the input file frame rate. If the file reports a frame rate of 0, the output rate defaults to 15 frames per second.

Mac Support: Yes.

string OutputFileName

Sets output file to the name and path specified. This attribute is read/write.

The full path to the output file name specified must exist. If a directory in the path does not exist, startCapture() will fail. The same is true for startFileEncode().

Remarks:

A call to checkInputFile() will reset the output file name to its default form, which is <InputFileName>.flv, sans path, directory and original extension.
Specifying a name without directory path will cause the output file to be created in the client computers temporary files directory.

See also:: Exceptions and Errors

Mac Support: Yes.

long OutputFileSelected

If non-zero, the output file is currently selected.

See also:: selectOutputFileForPlayback()
startPlayback()
stopPlayback()
fp_output_file_selected()

Mac Support: No.

long OutputFileWidth

Width, in pixels, of output file. This attribute is read/write. The default value for OutputFileWidth is 320 pixels.

Mac Support: Yes.

long OutputFileHeight

Height, in pixels, of output file. This attribute is read/write. The default value for OutputFileHeight is 240 pixels. For input files with aspect ratios not equal to 4:3, the default value of OutputFileHeight will be adjusted to maintain aspect ratio when checkInputFile() is called.

Mac Support: Yes.

long OutputFileWriteEnable

To disable output file writing, set OutputFileWriteEnable to true. Output file writing can only be disabled for capture.

Precondition:: To disable output file writing, FmsEnable must be set to true.

Remarks:: If OutputFileWriteEnable is changed while capture is in progress, the change will not take effect until the next call to startCapture().

Mac Support: No.

long PlayPosition

The current playback time. This attribute is read/write. Values are in milliseconds.
When written, if the file allows seeking, seeks within the file that's currently playing. When read, returns playback position.

Precondition:

State must be FS_PLAY_I, FS_PAUSE_I, FS_PLAY_O, or FS_PAUSE_O
InputFileCanSeek must be true before attempting to write to PlayPosition
(Mac-only behavior) The value assigned to PlayPosition must be of type number

Exceptions:

FE_FILE_CANNOT_SEEK

- file playing does not allow seeking.

See also:: InputFileCanSeek
fp_set_play_position()
Exceptions and Errors

Mac Support: Yes.

long PublishMethod

Determines the upload method used when publishFile() is called. This parameter is read/write. The default publishing method is kUploadModeFtp.

if set to kUploadModeFtp, the file will be uploaded via FTP.
if set to kUploadModeHttpFormPost, the file will be uploaded via HTTP form POST.
if set to kUploadModeHttpBinPost, the file will be uploaded via HTTP binary application/octet-stream POST.

See also:: File Publishing: HTTP Upload Information
FtpMode
getHttpVar()
publishFile()

Mac Support: Yes.

long State

Returns the current publisher state. This parameter is read-only.

See also:: States - for state value documentation.

Mac Support: Yes.

long UploadedBytes

Holds the number of bytes actually uploaded from the publish file. This attribute is read-only.

Precondition:: An upload is in progress.

Mac Support: Yes.

long UploadFileSize

Holds the total size of the file uploading. This attribute is read-only.

Precondition:: An upload is in progress.

Mac Support: Yes.

string Version

Current version of Flix Publisher.

Mac Support: Yes.

long VideoBitrate

Holds the video bitrate of the output file. This attribute it read/write. The default VideoBitrate is 200 kilobits per second. The value must be set before encoding is started.

Note:: VideoBitrate can be adjusted while encoding is in progress when using a plugIn on the Windows platform.

Mac Support: Yes.

string VideoCaptureDevice

Controls the video capture source. This attribute is read/write.

to retrieve the number of video capture devices, use numVideoCaptureDevices().
to retrieve the name of an video capture device, use videoCaptureDeviceName().
to show the video device settings dialog, call show_video_capture_settings()

Exceptions:

	FE_CAPTURE_V	- if device fails basic render tests.
	FE_IN_USE	- if written while capture or preview in progress.
	FE_NO_CAPTURE_DEVICE	- if selected device disconnected.

See also:: Exceptions and Errors

Mac Support: Yes.

long VideoBitrateControlMode

This attribute controls the mode of the of the On2 VP62 (Flash 8) video encoder's bitrate controller. This attribute supports reading and writing.
The default value of the VideoBitrateControlMode attribute is kBitrateModeCBR. The supported VideoBitrateControlMode values are:

0 - kBitrateModeCBR
Default value, creates constant bitrate (CBR) output that is best suited for streaming.
1 - kBitrateModeVBR
Creates variable bitrate (VBR) output that is best for local playback or progressive download.

Remarks:: VideoBitrateControlMode is ignored when FmsEnable is true. All encoding must be done CBR mode when streaming to Flash Media Server.

Mac Support: No.

long VideoCompressMode

This attribute controls the speed of the On2 VP62 (Flash 8) video encoder when the publisher is transcoding a file. This attribute supports reading and writing.
The default value of the VideoCompressMode attribute is kCompressModeRealTime. The supported VideoBitrateControlMode values are:

0 - kCompressModeRealTime
Default value, real-time mode (optimized for real time encoding)
1 - kCompressModeGood
Good quality mode (Higher quality output, slower encoding)
2 - kCompressModeBest
Best quality mode (Best quality output, slowest encoding)

Remarks:: VideoCompressMode is ignored when capturing to FLV. All encoding must be done in kCompressModeRealTime when capturing.

Mac Support: No.

long VideoKeyFrameMode

This attribute controls the mode of the algorithm used to determine keyframe placement in output video. This attribute supports reading and writing.
The default value of the VideoKeyFrameMode attribute is kKeyframeModeAuto. The supported VideoKeyFrameMode values are:

0 - kKeyframeModeAuto
Default value, automatic placement. Let the encoder determine where keyframes should go.
1 - kKeyframeModeConstFrequency
Forces keyframes to be placed at specific intervals.

Remarks:

Given the same input file, output video will typically be of very slightly lower quality when kKeyframeModeConstFrequency is used. This happens because optimal output quality requires optimal keyframe placement. kKeyframeModeConstFrequency overrides the video compressor's keyframe placement algorithm.
Using kKeyframeModeConstFrequency can very rarely result in more keyframes than expected when the source video is difficult to compress.

Mac Support: No.

long VideoKeyFrameFrequency

This attribute controls the frequency of keyframes in the video output. This attribute supports reading and writing. The default value of VideoKeyFrameFrequency is 75.
The bahavior of this attribute varies based on the value of VideoKeyFrameMode:

if VideoKeyFrameMode is set to its default, kKeyframeModeAuto:
VideoKeyFrameFrequency is treated as the maximum distance between keyframes.
if VideoKeyFrameMode is set to kKeyframeModeConstFrequency:
VideoKeyFrameFrequency is used as it is named.

See also:: VideoKeyFrameMode

Mac Support: No.

Attributes
[Flix Publisher API Documentation]

Variables

Detailed Description

Terminology

Exceptions and Errors

Variable Documentation


Variables
long	AudioBitrate
	Audio data rate in kilobits. [RW].
long	AudioCaptureBufferTime
	Audio hardware buffer time. [RW].
string	AudioCaptureDevice
	Audio capture device selection. [RW].
long	AudioCaptureMute
	Not implemented.
long	AudioCaptureVolume
	Audio capture volume level. [RW].
long	AudioCodecID
	Output Audio Format. [RW].
string	BGImageURL
	Background image location. [RW].
long	EncodedDuration
	Duration encoded. [RO].
long	EncodeTimeStart
	Input file start position. [RW].
long	EncodeTimeEnd
	Input file stop position. [RW].
long	FmsEnable
	Controls Streaming to Flash Media Server. [RW].
unsigned long	FmsBufferTime
	Length of FMS stream buffer. [RW].
long	FmsIgnoreFail
	Controls Response to FMS Connection Errors. [RW].
string	FmsServer
	Flash Media Server Address. [RW].
string	FmsPath
	Flash Media Server path. [RW].
string	FmsName
	Flash Media Server stream name. [RW].
long	FmsAuthenticationMode
	Controls FMS authentication mode [RW].
long	FmsAuthWaitForResponse
	Wait for responses from FMS AS function calls. [RW].
unsigned long	FmsAuthWaitTimeout
	FMS AS function call response timeout. [RW].
long	FmsPollEnable
	Enable/disable FMS connection polling. [RW].
unsigned long	FmsPollDelay
	FMS connection poll delay. [RW].
unsigned long	FmsPollTimeout
	FMS connection poll timeout. [RW].
string	FmsUsername
	Controls FMS user name. [RW].
string	FmsPassword
	Controls FMS password. [RW].
string	FtpSubDomain
	FTP server sub domain. [RW].
string	FtpServer
	Server for ftp uploads. [RO].
unsigned short	FtpPort
	FTP port. [RW].
string	FtpUser
	Sets user name for ftp uploads. [RW].
string	FtpPassword
	Sets password for ftp uploads. [RW].
string	FtpDestinationFile
	Sets name of uploaded file. [RW].
string	FtpMode
	FTP transfer mode. [RW].
string	HttpSubDomain
	HTTP sub domain. [RW].
string	HttpServer
	HTTP server address. [RO].
string	HttpPath
	HTTP upload Path. [RW].
string	HttpFile
	File name on server. [RW].
string	HttpURL
	HTTP URL used for publishing. [RO].
long	InputFileAudioChannels
	number of audio channels in input file [RO]
long	InputFileAudioSampleRate
	audio sampling rate of input file [RO]
long	InputFileAudioSampleSize
	audio sample size of input file [RO]
long	InputFileCanSeek
	Input file supports seeking [RO].
long	InputFileDuration
	Input file duration. [RO].
double	InputFileFrameRate
	Input video frames/second [RO].
string	InputFileName
	Input file name. [RO].
long	InputFileSelected
	Input file selected for playback. [RO].
long	InputFileWidth
	Input video width. [RO].
long	InputFileHeight
	Input video height. [RO].
long	LastError
	Error reporting [RW].
unsigned long	MaximumCaptureLatency
	Maximum latency of capture buffers [RW].
long	MaximumDuration
	Maximum File Duration [RW].
long	OutputFileDuration
	Duration of encoded file. [RO].
double	OutputFileFrameRate
	Output Framerate. [RW].
string	OutputFileName
	Sets the output file name. [RW].
long	OutputFileSelected
	Output file selected for playback. [RO].
long	OutputFileWidth
	Encoded Width. [RW].
long	OutputFileHeight
	Encoded Height. [RW].
long	OutputFileWriteEnable
	Enable/Disable output file writing. [RW].
long	PlayPosition
	Playback position. [RW].
long	PublishMethod
	Sets the publishing method. [RW].
long	State
	State tracking [RO].
long	UploadedBytes
	Bytes of publish file uploaded. [RO].
long	UploadFileSize
	Size of publish file. [RO].
string	Version
	Publisher Version [RO].
long	VideoBitrate
	Target VideoBitrate. [RW].
string	VideoCaptureDevice
	Video capture device selection. [RW].
long	VideoBitrateControlMode
	Flash 8 Video Compressor Data Rate Control Mode [RW].
long	VideoCompressMode
	Flash 8 Video Compression Mode [RW].
long	VideoKeyFrameMode
	Flash 8 Video Key Framing Mode [RW].
long	VideoKeyFrameFrequency
	Flash 8 Video Key Frequency [RW].

Attributes [Flix Publisher API Documentation]

Variables

Detailed Description

Terminology

Exceptions and Errors

Variable Documentation

Attributes
[Flix Publisher API Documentation]