Swf_options_setembeddedurl, Also, Swf_options_setembeddedurl() – Google Flix Engine Linux Reference Manual User Manual

Page 237

Advertising
background image

5.52 SWF

231

5.52.5.20

on2sc swf_options_SetAdaptivePreloaderBufferFactor (FLIX2HANDLE flix, const
double preloaderBufferFactor)

Sets the adaptive preload buffer factor.

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

← preloaderBufferFactor The adaptive preloader buffer factor.

Return values:

ON2_OK

Success

ON2_INVALID_PARAMS

should one or more of the preconditions fail

ON2_NET_ERROR

the underlying communication layer failed

Precondition:

flix

is not NULL

Note:

The preloader has to be enabled.
The default value is 1.1.
The range is 0-2 in increments of 0.1.
The preloader type must be

SwfAdaptivePreloader

.

Works with any Flash player version 5 and higher.

See also:

swf_options_GetAdaptivePreloaderBufferFactor()

Remarks:

An adaptive preloader is an "intelligent" preloader that will preload a variable amount of video based
on the size of the video and the viewer’s internet connection speed so that the viewer can watch the
video without stops and starts - no matter what speed they are connected to the internet at. The adaptive
preloader determines the user’s connection speed and based on that figure and the size of the video file
preloading, it preloads precisely the amount of the video required to enable the video to begin playing
as soon as it possibly can and still not stop at any point until it is done. In this way, the preload process
is optimized so the amount of time taken for a video to preload is minimized as much as possible. If
the adaptive preloader is selected, a buffer factor must also be selected. The buffer factor will cause the
preloader to preload more (or less) of the video than the initial calculations determine is the minimum
amount of time required. This is useful because a viewer’s connection speed often varies, even during
the course of watching a single video. The time required to load the file up to the end is multiplied by
this factor. If a buffer is not needed, set the factor to 1.0 (a factor of 1.0 means no buffer - loadingTime
∗ 1.0 = loadingTime). To be on the safe side, the recommendation is to use a factor larger than 1.0.
If the viewer’s connection should get faster during the visit (e.g., perhaps a download ends) then the
buffer factor can be changed to a number smaller than 1.0. If the viewer’s connection will likely get
slower during the visit (e.g., because the viewer starts a new download) the buffer factor should be
changed to a number greater than 1.0. As a general rule, it is a good idea to make the buffer factor
larger than 1.0 to be on the safe side.

Deprecated

Use the

Muxer Interface

along with

FE2_MUXER_SWF

and the

FE2_SWF_ADAPTIVE_-

PRELOAD_BUFFER_FACTOR

parameter. This function will be removed in a future release.

Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen

Advertising