SWF
[Muxers]

Defines

#define FE2_MUXER_SWF
 SWF muxer. For use with Flix2_AddMuxer().
#define FE2_SWF_HEIGHT
 Set the SWF height.
#define FE2_SWF_WIDTH
 Set the SWF width.
#define FE2_SWF_FRAMERATE
 Set the SWF framerate.
#define FE2_SWF_EMBEDDED_URL
 Set the SWF's target URL.
#define FE2_SWF_EMBEDDED_URL_TARGET
 Set the target of FE2_SWF_EMBEDDED_URL.
#define FE2_SWF_EMBEDDED_URL_TYPE
 Set how FE2_SWF_EMBEDDED_URL is interpreted.
#define FE2_SWF_LOOP_COUNT
 Sets the number of times the SWF should loop.
#define FE2_SWF_PRELOAD_TYPE
 Sets the type of preloader.
#define FE2_SWF_FIXED_PRELOAD_PCT
 Sets the percent of the SWF movie to preload before playback begins.
#define FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR
 Sets the adaptive preload buffer factor.
#define FE2_SWF_ON_END_OPTION
 Sets the options for the end of the SWF.
#define FE2_SWF_ON_END_URL
 Sets the URL a SWF movie will load after the current movie ends.
#define FE2_SWF_ON_START_OPTION
 Sets the options for the start of the SWF.
#define FE2_SWF_START_BLANK_FRAME
 Control the insertion of a blank first frame in the SWF.
#define FE2_SWF_START_WAIT_SEC
 Sets the number of seconds to wait before playback begins.
#define FE2_SWF_ADD_VARIABLE
 Add or update a variable in the SWF.
#define FE2_SWF_DELETE_VARIABLE
 Delete an existing variable in the SWF.

Enumerations

enum  FE2_EmbeddedUrlType {
  EmbeddedUrlIsGetUrl,
  EmbeddedUrlIsLoadMovie
}
 

Differentiates between the type of file (HTML or SWF) set through FE2_SWF_EMBEDDED_URL.

More...
enum  FE2_SwfOnEndOptions {
  SwfOnMovieEndNothing,
  SwfOnMovieEndSTOP,
  SwfOnMovieEndLoop,
  SwfOnMovieEndUnload,
  SwfOnMovieEndLoadMovie
}
 

Actions that can be added to the last frame of a SWF file.

More...
enum  FE2_SwfOnStartOptions {
  SwfOnMovieStartAutomatically,
  SwfOnMovieStartOnClick,
  SwfOnMovieStartWait,
  SwfOnMovieStartEmbedSTOP
}
 

Actions that can be added to the start frame of the SWF file.

More...
enum  FE2_SwfPreloaderOptions {
  SwfPreloaderNone,
  SwfFixedPreloader,
  SwfAdaptivePreloader
}
 

Determines the type of preloader added to the SWF file.

More...

Deprecated functions



on2sc swf_options_Reset (FLIX2HANDLE flix)
 Resets the swf options.
on2sc swf_options_GetEmbeddedUrl (FLIX2HANDLE flix, char *embeddedUrl, int32_t *len)
 Gets the embedded URL.
on2sc swf_options_GetEmbeddedUrlTarget (FLIX2HANDLE flix, char *embeddedUrlTarget, int32_t *len)
 Gets the target of embedded URL.
on2sc swf_options_SetEmbeddedUrl (FLIX2HANDLE flix, const char *embeddedUrl)
 Sets the embedded URL of the SWF or HTML that will be loaded when the user clicks on the video.
on2sc swf_options_SetEmbeddedUrlTarget (FLIX2HANDLE flix, const char *embeddedUrlTarget)
 Sets the target of the embedded URL.
on2sc swf_options_GetEmbeddedUrlType (FLIX2HANDLE flix, FE2_EmbeddedUrlType *embeddedUrlType)
 Gets the type of embedded URL.
on2sc swf_options_SetEmbeddedUrlType (FLIX2HANDLE flix, const FE2_EmbeddedUrlType embeddedUrlType)
 Sets the type of embedded URL.
on2sc swf_options_GetSwfFramerate (FLIX2HANDLE flix, int32_t *pSwfFramerate)
 Gets the SWF framerate.
on2sc swf_options_SetSwfFramerate (FLIX2HANDLE flix, const int32_t swfFramerate)
 Sets the SWF framerate.
on2sc swf_options_GetInsertBlankFrameOnStart (FLIX2HANDLE flix, on2bool *pInsertBlankFrameOnStart)
 Gets if the engine is to insert a blank frame as the first frame of the SWF or not.
on2sc swf_options_SetInsertBlankFrameOnStart (FLIX2HANDLE flix, const on2bool insertBlankFrameOnStart)
 Tells the engine to insert a blank frame as the first frame of the SWF or not.
on2sc swf_options_GetSwfFramerateAsDouble (FLIX2HANDLE flix, double *pSwfFramerate)
 Gets the SWF framerate as a double.
on2sc swf_options_SetSwfFramerateAsDouble (FLIX2HANDLE flix, const double swfFramerate)
 Sets the SWF framerate as a double.
on2sc swf_options_GetEnablePreloader (FLIX2HANDLE flix, on2bool *pEnablePreloader)
 Gets if a video preloader is enabled or disabled.
on2sc swf_options_SetEnablePreloader (FLIX2HANDLE flix, const on2bool enablePreloader)
 Enables or disables the video preloader.
on2sc swf_options_GetPercentToPreload (FLIX2HANDLE flix, int32_t *pPercentToPreload)
 Gets the percent of the SWF movie to preload before playback begins.
on2sc swf_options_SetPercentToPreload (FLIX2HANDLE flix, const int32_t percentToPreload)
 Sets the percent of the SWF movie to preload before playback begins.
on2sc swf_options_GetPreloaderType (FLIX2HANDLE flix, FE2_SwfPreloaderOptions *pPreloaderType)
 Gets the type of preloader.
on2sc swf_options_SetPreloaderType (FLIX2HANDLE flix, const FE2_SwfPreloaderOptions preloaderType)
 Sets the type of preloader.
on2sc swf_options_GetAdaptivePreloaderBufferFactor (FLIX2HANDLE flix, double *pPreloaderBufferFactor)
 Gets the adaptive preload buffer factor.
on2sc swf_options_SetAdaptivePreloaderBufferFactor (FLIX2HANDLE flix, const double preloaderBufferFactor)
 Sets the adaptive preload buffer factor.
on2sc swf_options_GetMovieOnEndOptions (FLIX2HANDLE flix, FE2_SwfOnEndOptions *pOnEndOptions)
 Gets the options for the end of the SWF.
on2sc swf_options_SetMovieOnEndOptions (FLIX2HANDLE flix, const FE2_SwfOnEndOptions onEndOptions)
 Sets the options for the end of the SWF.
on2sc swf_options_GetLoopCount (FLIX2HANDLE flix, int32_t *pLoopCount)
 Gets the number of times the SWF should loop.
on2sc swf_options_SetLoopCount (FLIX2HANDLE flix, const int32_t loopCount)
 Sets the number of times the SWF should loop.
on2sc swf_options_GetLoadMovieOnEndUrl (FLIX2HANDLE flix, char *pLoadMovieOnEndUrl, int32_t *len)
 Gets the URL of a SWF movie to load after the current movie ends.
on2sc swf_options_SetLoadMovieOnEndUrl (FLIX2HANDLE flix, const char *loadMovieOnEndUrl)
 Sets the URL of a SWF movie to load after the current movie ends.
on2sc swf_options_GetMovieOnStartOptions (FLIX2HANDLE flix, FE2_SwfOnStartOptions *pOnStartOptions)
 Gets the options for the start of the SWF.
on2sc swf_options_SetMovieOnStartOptions (FLIX2HANDLE flix, const FE2_SwfOnStartOptions onStartOptions)
 Sets the options for the start of the SWF.
on2sc swf_options_GetWaitTimeToStart (FLIX2HANDLE flix, int32_t *pWaitTimeToStart)
 Gets the number of seconds to wait before playback begins.
on2sc swf_options_SetWaitTimeToStart (FLIX2HANDLE flix, const int32_t waitTimeToStart)
 Sets the number of seconds to wait before playback begins.
on2sc swf_options_AddVariable (FLIX2HANDLE flix, const char *name, const char *value)
 Adds a custom SWF variable as a name/value pair.
on2sc swf_options_DeleteVariable (FLIX2HANDLE flix, const int32_t index)
 Deletes a custom SWF variable.
on2sc swf_options_GetVariableCount (FLIX2HANDLE flix, int32_t *pVariableCount)
 Gets the number of custom SWF variables already added.
on2sc swf_options_UpdateVariable (FLIX2HANDLE flix, const int32_t index, const char *name, const char *value)
 Updates an already existing SWF variable.

Detailed Description

Muxer Parameters:

   Name                                   |   Type   | Opt/Reqd |       Range
   ==================================================================================
   FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR |  Number  | Optional | [0.0,2.0] step:0.1
   FE2_SWF_ADD_VARIABLE                   |  String  | Optional | N/A
   FE2_SWF_DELETE_VARIABLE                |  String  | Optional | N/A
   FE2_SWF_EMBEDDED_URL                   |  String  | Optional | N/A
   FE2_SWF_EMBEDDED_URL_TARGET            |  String  | Optional | N/A
   FE2_SWF_EMBEDDED_URL_TYPE              |  String  | Optional | FE2_EmbeddedUrlType
   FE2_SWF_FIXED_PRELOAD_PCT              |  Number  | Optional | [0,100]
   FE2_SWF_FRAMERATE                      |  Number  | Optional | N/A
   FE2_SWF_HEIGHT                         |  Number  | Optional | N/A
   FE2_SWF_LOOP_COUNT                     |  Number  | Optional | [0,)
   FE2_SWF_ON_END_OPTION                  |  String  | Optional | FE2_SwfOnEndOptions
   FE2_SWF_ON_END_URL                     |  String  | Optional | N/A
   FE2_SWF_ON_START_OPTION                |  String  | Optional | FE2_SwfOnStartOptions
   FE2_SWF_PRELOAD_TYPE                   |  Number  | Optional | FE2_SwfPreloaderOptions
   FE2_SWF_START_BLANK_FRAME              |  Number  | Optional | [0,1]
   FE2_SWF_START_WAIT_SEC                 |  Number  | Optional | [0.0,)
   FE2_SWF_WIDTH                          |  Number  | Optional | N/A

Example Usage:

   sc = Flix2_AddMuxer(&muxer, flix, FE2_MUXER_SWF);
   // enable the adaptive preloader
   if(sc == ON2_OK)
       sc = Flix2_MuxerSetParam(muxer, FE2_SWF_PRELOAD_TYPE, SwfAdaptivePreloader);

Supported Codecs


Define Documentation

#define FE2_MUXER_SWF

SWF muxer. For use with Flix2_AddMuxer().

Definition at line 105 of file swf.h.

#define FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR

Sets the adaptive preload buffer factor.

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.

Note:
Default: 1.1
Valid range: [0.0,2.0] step: 0.1
This implicitly sets FE2_SWF_PRELOAD_TYPE to SwfAdaptivePreloader
Works with any Flash player version 5 and higher.

Definition at line 222 of file swf.h.

#define FE2_SWF_ADD_VARIABLE

Add or update a variable in the SWF.

Multiple variables may be specified.

Parameter format:
Format = Variable *[ '&' Variable ]
Variable = varName '=' varValue
e.g. "n0=v0&n1=v1"

Definition at line 262 of file swf.h.

#define FE2_SWF_DELETE_VARIABLE

Delete an existing variable in the SWF.

Multiple variables may be specified.

Parameter format:
Format = varName *[ '&' varName ]
e.g. "var0&var1"

Definition at line 270 of file swf.h.

#define FE2_SWF_EMBEDDED_URL

Set the SWF's target URL.

When a user clicks on the video of the encoded SWF file, the SWF file will immediately try and load the embedded URL.

See also:
FE2_SWF_EMBEDDED_URL_TARGET, FE2_SWF_EMBEDDED_URL_TYPE

Definition at line 138 of file swf.h.

#define FE2_SWF_EMBEDDED_URL_TARGET

Set the target of FE2_SWF_EMBEDDED_URL.

Valid values:

  • "_self"
  • "_blank"
  • "_parent"
  • "_top"
Note:
Default: "_self"
See also:
http://www.w3.org/TR/REC-WebCGM/REC-03-CGM-IC.html#webcgm_3_1_2_2

Definition at line 151 of file swf.h.

#define FE2_SWF_EMBEDDED_URL_TYPE

Set how FE2_SWF_EMBEDDED_URL is interpreted.

Valid values are defined by FE2_EmbeddedUrlType

Note:
Default: EmbeddedUrlIsLoadMovie

Definition at line 158 of file swf.h.

#define FE2_SWF_FIXED_PRELOAD_PCT

Sets the percent of the SWF movie to preload before playback begins.

Note:
Default: 20%
Valid range: [0,100]
This implicitly sets FE2_SWF_PRELOAD_TYPE to SwfFixedPreloader
Works with any Flash player version 4 and higher.

Definition at line 184 of file swf.h.

#define FE2_SWF_FRAMERATE

Set the SWF framerate.

A few things should be considered before setting the SWF framerate. First, SWF framerate should always be equal to or a multiple of the video framerate to prevent problems with encoding such as loss of audio sync and audio distortion. Second, the fractional part of the output SWF framerate has to be rounded to the nearest 1/256th, i.e. 29.97 becomes 29.96875.

Note:
Changing the SWF framerate will NOT change the duration or the audio/video synchronization except as mentioned above.
Default: video framerate
See also:
Frame Rate

Definition at line 130 of file swf.h.

#define FE2_SWF_HEIGHT

Set the SWF height.

Note:
Default: video height

Definition at line 110 of file swf.h.

#define FE2_SWF_LOOP_COUNT

Sets the number of times the SWF should loop.

Note:
Default: 0
Setting this to a value >0 will see the SWF ignore the loop command of the Flash player.
This will implicitly set FE2_SWF_ON_END_OPTION to SwfOnMovieEndLoop

Definition at line 168 of file swf.h.

#define FE2_SWF_ON_END_OPTION

Sets the options for the end of the SWF.

Valid values are defined by FE2_SwfOnEndOptions

Note:
Default: SwfOnMovieEndNothing

Definition at line 228 of file swf.h.

#define FE2_SWF_ON_END_URL

Sets the URL a SWF movie will load after the current movie ends.

Note:
This will implicitly set FE2_SWF_ON_END_OPTION to SwfOnMovieEndLoadMovie

Definition at line 234 of file swf.h.

#define FE2_SWF_ON_START_OPTION

Sets the options for the start of the SWF.

Valid values are defined by FE2_SwfOnStartOptions.

Note:
Default: SwfOnMovieStartAutomatically

Definition at line 241 of file swf.h.

#define FE2_SWF_PRELOAD_TYPE

Sets the type of preloader.

Valid types are defined by FE2_SwfPreloaderOptions.

Note:
Default: SwfPreloaderNone

Definition at line 175 of file swf.h.

#define FE2_SWF_START_BLANK_FRAME

Control the insertion of a blank first frame in the SWF.

Note:
Default: 0

Definition at line 247 of file swf.h.

#define FE2_SWF_START_WAIT_SEC

Sets the number of seconds to wait before playback begins.

Note:
Default: 0

Definition at line 252 of file swf.h.

#define FE2_SWF_WIDTH

Set the SWF width.

Note:
Default: video width

Definition at line 115 of file swf.h.


Enumeration Type Documentation

Differentiates between the type of file (HTML or SWF) set through FE2_SWF_EMBEDDED_URL.

Enumerator:
EmbeddedUrlIsGetUrl 
EmbeddedUrlIsLoadMovie 

Definition at line 68 of file swf.h.

Actions that can be added to the last frame of a SWF file.

For use with FE2_SWF_ON_END_OPTION

Enumerator:
SwfOnMovieEndNothing 
SwfOnMovieEndSTOP 
SwfOnMovieEndLoop 
SwfOnMovieEndUnload 
SwfOnMovieEndLoadMovie 

Definition at line 76 of file swf.h.

Actions that can be added to the start frame of the SWF file.

For use with FE2_SWF_ON_START_OPTION

Enumerator:
SwfOnMovieStartAutomatically 
SwfOnMovieStartOnClick 
SwfOnMovieStartWait 
SwfOnMovieStartEmbedSTOP 

Definition at line 87 of file swf.h.

Determines the type of preloader added to the SWF file.

For use with FE2_SWF_PRELOAD_TYPE

Enumerator:
SwfPreloaderNone 
SwfFixedPreloader 
SwfAdaptivePreloader 

Definition at line 97 of file swf.h.


Function Documentation

on2sc swf_options_AddVariable ( FLIX2HANDLE  flix,
const char *  name,
const char *  value 
)

Adds a custom SWF variable as a name/value pair.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] name The name of the variable.
[in] value The value of the variable.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM an error occurred allocating memory for name or value
Precondition:
flix is not NULL
name is not NULL
value is not NULL
See also:
swf_options_DeleteVariable(), swf_options_GetVariableCount(), swf_options_UpdateVariable()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ADD_VARIABLE parameter. This function will be removed in a future release.
on2sc swf_options_DeleteVariable ( FLIX2HANDLE  flix,
const int32_t  index 
)

Deletes a custom SWF variable.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] index The zero based index of the variable to delete.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM an error occurred reallocating memory for the variable list.
Precondition:
flix is not NULL
index is inside the range of current variables.
See also:
swf_options_AddVariable(), swf_options_GetVariableCount(), swf_options_UpdateVariable()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_DELETE_VARIABLE parameter. This function will be removed in a future release.
on2sc swf_options_GetAdaptivePreloaderBufferFactor ( FLIX2HANDLE  flix,
double *  pPreloaderBufferFactor 
)

Gets the adaptive preload buffer factor.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pPreloaderBufferFactor The adaptive preloader buffer factor.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pPreloaderBufferFactor is not NULL
See also:
swf_options_SetAdaptivePreloaderBufferFactor()
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.
on2sc swf_options_GetEmbeddedUrl ( FLIX2HANDLE  flix,
char *  embeddedUrl,
int32_t len 
)

Gets the embedded URL.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] embeddedUrl The embedded URL.
[in,out] len 
  • IN: The length of embeddedUrl.
  • OUT: The length of the URL (minus the null terminator).
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM embeddedUrl does not have enough allocated space to return the URL. The size in bytes needed (minus null terminator) will be returned in len.
Precondition:
flix is not NULL
len is not NULL
Note:
If embeddedUrl is NULL this function will return the size in bytes required to store the current embedded URL in len, not including the null terminator.
See also:
swf_options_SetEmbeddedUrl(), swf_options_GetEmbeddedUrlType(), swf_options_SetEmbeddedUrlType()
Attention:
Currently only supported in C/C++
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL parameter. This function will be removed in a future release.
on2sc swf_options_GetEmbeddedUrlTarget ( FLIX2HANDLE  flix,
char *  embeddedUrlTarget,
int32_t len 
)

Gets the target of embedded URL.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] embeddedUrlTarget The target of embedded URL.
[in,out] len 
  • IN: The length of embeddedUrlTarget.
  • OUT: The length of the URL (minus the null terminator).
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM embeddedUrlTarget does not have enough allocated space to return the target. The size in bytes needed (minus null terminator) will be returned in len.
Precondition:
flix is not NULL
len is not NULL
Note:
If embeddedUrlTarget is NULL this function will return the size in bytes required to store the current target in len, not including the null terminator.
See also:
swf_options_GetEmbeddedUrl(), swf_options_SetEmbeddedUrl(), swf_options_SetEmbeddedUrlType()
Attention:
Currently only supported in C/C++
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TARGET parameter. This function will be removed in a future release.
on2sc swf_options_GetEmbeddedUrlType ( FLIX2HANDLE  flix,
FE2_EmbeddedUrlType embeddedUrlType 
)

Gets the type of embedded URL.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] embeddedUrlType The type of embedded URL.
Return values:
ON2_OK success.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
embeddedUrlType is not NULL
See also:
swf_options_SetEmbeddedUrl(), swf_options_SetEmbeddedUrlType()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TYPE parameter. This function will be removed in a future release.
on2sc swf_options_GetEnablePreloader ( FLIX2HANDLE  flix,
on2bool pEnablePreloader 
)

Gets if a video preloader is enabled or disabled.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pEnablePreloader 
Return values:
ON2_OK Success.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pEnablePreloader is not NULL
See also:
swf_options_SetEnablePreloader()
on2sc swf_options_GetInsertBlankFrameOnStart ( FLIX2HANDLE  flix,
on2bool pInsertBlankFrameOnStart 
)

Gets if the engine is to insert a blank frame as the first frame of the SWF or not.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pInsertBlankFrameOnStart 
Return values:
ON2_OK Successfully returned if the engine will insert a blank frame or not.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pInsertBlankFrameOnStart is not NULL
See also:
swf_options_SetInsertBlankFrameOnStart()
on2sc swf_options_GetLoadMovieOnEndUrl ( FLIX2HANDLE  flix,
char *  pLoadMovieOnEndUrl,
int32_t len 
)

Gets the URL of a SWF movie to load after the current movie ends.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pLoadMovieOnEndUrl The URL of a SWF movie.
[in,out] len 
  • IN: The length of pLoadMovieOnEndUrl.
  • OUT: The length of the URL (minus the null terminator).
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM pLoadMovieOnEndUrl does not have enough allocated space to return the URL. The size in bytes needed (minus null terminator) will be returned in len.
Precondition:
flix is not NULL
len is not NULL
Note:
If pLoadMovieOnEndUrl is NULL this function will return the size in bytes required to store the current URL in len, not including the null terminator.
See also:
swf_options_SetLoadMovieOnEndUrl()
Attention:
Currently only supported in C/C++
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_URL parameter. This function will be removed in a future release.
on2sc swf_options_GetLoopCount ( FLIX2HANDLE  flix,
int32_t pLoopCount 
)

Gets the number of times the SWF should loop.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pLoopCount The number of times the SWF should loop.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pLoopCount is not NULL
See also:
swf_options_SetLoopCount()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_LOOP_COUNT parameter. This function will be removed in a future release.
on2sc swf_options_GetMovieOnEndOptions ( FLIX2HANDLE  flix,
FE2_SwfOnEndOptions pOnEndOptions 
)

Gets the options for the end of the SWF.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pOnEndOptions The options for the end of the SWF.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pOnEndOptions is not NULL
See also:
swf_options_SetMovieOnEndOptions()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_OPTION parameter. This function will be removed in a future release.
on2sc swf_options_GetMovieOnStartOptions ( FLIX2HANDLE  flix,
FE2_SwfOnStartOptions pOnStartOptions 
)

Gets the options for the start of the SWF.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pOnStartOptions The options for the start of the SWF.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pOnStartOptions is not NULL
See also:
swf_options_SetMovieOnStartOptions()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_START_OPTION parameter. This function will be removed in a future release.
on2sc swf_options_GetPercentToPreload ( FLIX2HANDLE  flix,
int32_t pPercentToPreload 
)

Gets the percent of the SWF movie to preload before playback begins.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pPercentToPreload Percent of the SWF movie to preload before playback begins.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pPercentToPreload is not NULL
See also:
swf_options_SetPercentToPreload()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_FIXED_PRELOAD_PCT parameter. This function will be removed in a future release.
on2sc swf_options_GetPreloaderType ( FLIX2HANDLE  flix,
FE2_SwfPreloaderOptions pPreloaderType 
)

Gets the type of preloader.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pPreloaderType The preloader type.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pPreloaderType is not NULL
See also:
swf_options_SetPreloaderType()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter. This function will be removed in a future release.
on2sc swf_options_GetSwfFramerate ( FLIX2HANDLE  flix,
int32_t pSwfFramerate 
)

Gets the SWF framerate.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] pSwfFramerate The SWF framerate.
Return values:
ON2_OK The engine successfully returned SWF framerate.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pSwfFramerate is not NULL
Deprecated:
This function has been deprecated in favor of swf_options_GetSwfFramerateAsDouble() because this function can only handle integer framerates.
See also:
swf_options_GetSwfFramerateAsDouble()
on2sc swf_options_GetSwfFramerateAsDouble ( FLIX2HANDLE  flix,
double *  pSwfFramerate 
)

Gets the SWF framerate as a double.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pSwfFramerate The SWF framerate.
Return values:
ON2_OK The engine successfully returned SWF framerate.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pSwfFramerate is not NULL
See also:
swf_options_SetSwfFramerateAsDouble()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_FRAMERATE parameter. This function will be removed in a future release.
on2sc swf_options_GetVariableCount ( FLIX2HANDLE  flix,
int32_t pVariableCount 
)

Gets the number of custom SWF variables already added.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pVariableCount The number of custom SWF variables already added
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pVariableCount is not NULL
See also:
swf_options_AddVariable(), swf_options_DeleteVariable(), swf_options_UpdateVariable()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF. This function will be removed in a future release.
on2sc swf_options_GetWaitTimeToStart ( FLIX2HANDLE  flix,
int32_t pWaitTimeToStart 
)

Gets the number of seconds to wait before playback begins.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pWaitTimeToStart Number of seconds to wait.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
pWaitTimeToStart is not NULL
See also:
swf_options_SetWaitTimeToStart()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_START_WAIT_SEC parameter. This function will be removed in a future release.
on2sc swf_options_Reset ( FLIX2HANDLE  flix  ) 

Resets the swf options.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
Return values:
ON2_OK reset of swf options was successful
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
Call this function if you wish to reset all swf options to their default values. This will free any memory that was allocated to the swf object.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF. This function will be removed in a future release.
on2sc swf_options_SetAdaptivePreloaderBufferFactor ( FLIX2HANDLE  flix,
const double  preloaderBufferFactor 
)

Sets the adaptive preload buffer factor.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] preloaderBufferFactor The adaptive preloader buffer factor.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
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.
on2sc swf_options_SetEmbeddedUrl ( FLIX2HANDLE  flix,
const char *  embeddedUrl 
)

Sets the embedded URL of the SWF or HTML that will be loaded when the user clicks on the video.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] embeddedUrl The embedded URL.
Return values:
ON2_OK success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM an error occurred allocating memory for embeddedUrl
Precondition:
flix is not NULL
Note:
When a user clicks on the video of the encoded SWF file, the SWF file will imediately try and load the embedded URL.
If embeddedUrl is NULL then the engine will delete the embedded URL.
See also:
swf_options_GetEmbeddedUrl(), swf_options_GetEmbeddedUrlType(), swf_options_SetEmbeddedUrlType()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL parameter. This function will be removed in a future release.
on2sc swf_options_SetEmbeddedUrlTarget ( FLIX2HANDLE  flix,
const char *  embeddedUrlTarget 
)

Sets the target of the embedded URL.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] embeddedUrlTarget The target of the embedded URL.
Return values:
ON2_OK success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM an error occurred allocating memory for embeddedUrlTarget
Precondition:
flix is not NULL
If embeddedUrlTarget is not NULL then it must be one of the valid values.
Note:
The embeddedUrlTarget will be ignored if the embedded URL is not set.
Valid values for embeddedUrlTarget are:
The default value is "_self".
If embeddedUrlTarget is NULL then the engine will delete the target of the embedded URL.
See also:
swf_options_GetEmbeddedUrl(), swf_options_SetEmbeddedUrl(), swf_options_GetEmbeddedUrlType()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TARGET parameter. This function will be removed in a future release.
on2sc swf_options_SetEmbeddedUrlType ( FLIX2HANDLE  flix,
const FE2_EmbeddedUrlType  embeddedUrlType 
)

Sets the type of embedded URL.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] embeddedUrlType The type of embedded URL.
Return values:
ON2_OK success.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
embeddedUrlType is a valid member of FE2_EmbeddedUrlType
Note:
The embeddedUrlType will be ignored if the embedded URL is not set.
Remarks:
The default value is EmbeddedUrlIsLoadMovie.
See also:
swf_options_SetEmbeddedUrl(), swf_options_GetEmbeddedUrlType()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TYPE parameter. This function will be removed in a future release.
on2sc swf_options_SetEnablePreloader ( FLIX2HANDLE  flix,
const on2bool  enablePreloader 
)

Enables or disables the video preloader.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] enablePreloader 
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
on2true will enable a preloader.
on2false will disable a preloader.
See also:
swf_options_GetEnablePreloader()
on2sc swf_options_SetInsertBlankFrameOnStart ( FLIX2HANDLE  flix,
const on2bool  insertBlankFrameOnStart 
)

Tells the engine to insert a blank frame as the first frame of the SWF or not.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] insertBlankFrameOnStart on2true will insert a blank frame. on2false will not.
Return values:
ON2_OK The engine set the variable of whether or not to insert a blank frame.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
on2true will insert a blank frame.
on2false will not.
See also:
swf_options_GetInsertBlankFrameOnStart()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_START_BLANK_FRAME parameter. This function will be removed in a future release.
on2sc swf_options_SetLoadMovieOnEndUrl ( FLIX2HANDLE  flix,
const char *  loadMovieOnEndUrl 
)

Sets the URL of a SWF movie to load after the current movie ends.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] loadMovieOnEndUrl The URL of a SWF movie.
Return values:
ON2_OK success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM an error occurred allocating memory for loadMovieOnEndUrl
Precondition:
flix is not NULL
Note:
If loadMovieOnEndUrl is NULL then the engine will delete the URL.
See also:
swf_options_GetLoadMovieOnEndUrl()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_URL parameter. This function will be removed in a future release.
on2sc swf_options_SetLoopCount ( FLIX2HANDLE  flix,
const int32_t  loopCount 
)

Sets the number of times the SWF should loop.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] loopCount The number of times the SWF should loop.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
The default value is 0.
Setting this to a value >0 will have the SWF ignore the loop command of the Flash player.
See also:
swf_options_GetLoopCount()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_LOOP_COUNT parameter. This function will be removed in a future release.
on2sc swf_options_SetMovieOnEndOptions ( FLIX2HANDLE  flix,
const FE2_SwfOnEndOptions  onEndOptions 
)

Sets the options for the end of the SWF.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] onEndOptions The options for the end of the SWF.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
onEndOptions is a valid member of FE2_SwfOnEndOptions
Note:
The default value is SwfOnMovieEndNothing.
See also:
swf_options_GetMovieOnEndOptions()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_OPTION parameter. This function will be removed in a future release.
on2sc swf_options_SetMovieOnStartOptions ( FLIX2HANDLE  flix,
const FE2_SwfOnStartOptions  onStartOptions 
)

Sets the options for the start of the SWF.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] onStartOptions The options for the start of the SWF.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
onStartOptions is a valid member of FE2_SwfOnStartOptions
Note:
The default value is SwfOnMovieStartAutomatically.
See also:
swf_options_GetMovieOnStartOptions()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_START_OPTION parameter. This function will be removed in a future release.
on2sc swf_options_SetPercentToPreload ( FLIX2HANDLE  flix,
const int32_t  percentToPreload 
)

Sets the percent of the SWF movie to preload before playback begins.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] percentToPreload Percent of the SWF movie to preload before playback begins.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
The preloader has to be enabled.
The default value is 20%.
The range is 1-100.
The preloader type must be SwfFixedPreloader.
Works with any Flash player version 4 and higher.
See also:
swf_options_GetPercentToPreload()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_FIXED_PRELOAD_PCT parameter. This function will be removed in a future release.
on2sc swf_options_SetPreloaderType ( FLIX2HANDLE  flix,
const FE2_SwfPreloaderOptions  preloaderType 
)

Sets the type of preloader.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] preloaderType The preloader type.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
preloaderType is a valid member of FE2_SwfPreloaderOptions
Note:
The preloader has to be enabled.
The default value is SwfFixedPreloader.
See also:
swf_options_GetPreloaderType()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter. This function will be removed in a future release.
on2sc swf_options_SetSwfFramerate ( FLIX2HANDLE  flix,
const int32_t  swfFramerate 
)

Sets the SWF framerate.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] swfFramerate The SWF framerate.
Return values:
ON2_OK The engine successfully set the SWF framerate.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Deprecated:
This function has been deprecated in favor of swf_options_SetSwfFramerateAsDouble() because this function can only handle integer framerates.
See also:
swf_options_SetSwfFramerateAsDouble()
on2sc swf_options_SetSwfFramerateAsDouble ( FLIX2HANDLE  flix,
const double  swfFramerate 
)

Sets the SWF framerate as a double.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] swfFramerate The SWF framerate.
Return values:
ON2_OK The engine successfully set SWF framerate.
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
The default value will be the video framerate.
The SWF framerate may be changed when the encoding process starts because of two conditions. Changing the SWF framerate will NOT change the duration or the audio/video synchronization. The first condition is the SWF framerate should always be equal to or a multiple of the video framerate to prevent problems with encoding such as loss of audio sync and audio distortion. The second condition is the fractional part of the output SWF framerate has to be rounded to the nearest 1/256th. I.E. If the SWF framerate is set to 29.97 then the output SWF framerate will be converted to 29.96875.
See also:
swf_options_GetSwfFramerateAsDouble(), video_options_SetVideoFramerateAsDouble()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_FRAMERATE parameter. This function will be removed in a future release.
on2sc swf_options_SetWaitTimeToStart ( FLIX2HANDLE  flix,
const int32_t  waitTimeToStart 
)

Sets the number of seconds to wait before playback begins.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] waitTimeToStart Number of seconds to wait.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
Precondition:
flix is not NULL
Note:
The default value is 0.
See also:
swf_options_GetWaitTimeToStart()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_START_WAIT_SEC parameter. This function will be removed in a future release.
on2sc swf_options_UpdateVariable ( FLIX2HANDLE  flix,
const int32_t  index,
const char *  name,
const char *  value 
)

Updates an already existing SWF variable.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] index The zero based index of the variable to update.
[in] name The name of the variable.
[in] value The value of the variable.
Return values:
ON2_OK Success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM an error occurred reallocating memory for the variable list.
Precondition:
flix is not NULL
name is not NULL
value is not NULL
index is inside the range of current variables
See also:
swf_options_AddVariable(), swf_options_DeleteVariable(), swf_options_GetVariableCount()
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ADD_VARIABLE parameter. This function will be removed in a future release.

On2 Technologies, Inc Flix Engine Windows documentation, generated on Tue Nov 2 15:38:08 2010 by doxygen 1.6.1