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);
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. | |
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... |
#define FE2_MUXER_SWF |
#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.
#define FE2_SWF_ADD_VARIABLE |
#define FE2_SWF_DELETE_VARIABLE |
#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.
#define FE2_SWF_EMBEDDED_URL_TARGET |
Set the target of FE2_SWF_EMBEDDED_URL.
Valid values:
"_self"
"_blank"
"_parent"
"_top"
#define FE2_SWF_EMBEDDED_URL_TYPE |
Set how FE2_SWF_EMBEDDED_URL is interpreted.
Valid values are defined by FE2_EmbeddedUrlType
#define FE2_SWF_FIXED_PRELOAD_PCT |
Sets the percent of the SWF movie to preload before playback begins.
#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.
#define FE2_SWF_HEIGHT |
#define FE2_SWF_LOOP_COUNT |
Sets the number of times the SWF should loop.
#define FE2_SWF_ON_END_OPTION |
Sets the options for the end of the SWF.
Valid values are defined by FE2_SwfOnEndOptions
#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.
Valid values are defined by FE2_SwfOnStartOptions.
#define FE2_SWF_PRELOAD_TYPE |
Sets the type of preloader.
Valid types are defined by FE2_SwfPreloaderOptions.
#define FE2_SWF_START_BLANK_FRAME |
#define FE2_SWF_START_WAIT_SEC |
#define FE2_SWF_WIDTH |
enum FE2_EmbeddedUrlType |
Differentiates between the type of file (HTML or SWF) set through FE2_SWF_EMBEDDED_URL.
enum FE2_SwfOnEndOptions |
Actions that can be added to the last frame of a SWF file.
For use with FE2_SWF_ON_END_OPTION
Actions that can be added to the start frame of the SWF file.
For use with FE2_SWF_ON_START_OPTION
Determines the type of preloader added to the SWF file.
For use with FE2_SWF_PRELOAD_TYPE
on2sc swf_options_AddVariable | ( | FLIX2HANDLE | flix, | |
const char * | name, | |||
const char * | value | |||
) |
Adds a custom SWF variable as a name/value pair.
[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. |
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 | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
NULL
on2sc swf_options_DeleteVariable | ( | FLIX2HANDLE | flix, | |
const int32_t | index | |||
) |
Deletes a custom SWF variable.
[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. |
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. | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_GetAdaptivePreloaderBufferFactor | ( | FLIX2HANDLE | flix, | |
double * | pPreloaderBufferFactor | |||
) |
Gets the adaptive preload buffer factor.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pPreloaderBufferFactor | The adaptive preloader buffer factor. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetEmbeddedUrl | ( | FLIX2HANDLE | flix, | |
char * | embeddedUrl, | |||
int32_t * | len | |||
) |
Gets the embedded URL.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | embeddedUrl | The embedded URL. |
[in,out] | len |
|
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. | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
NULL
this function will return the size in bytes required to store the current embedded URL in len, not including the null terminator. on2sc swf_options_GetEmbeddedUrlTarget | ( | FLIX2HANDLE | flix, | |
char * | embeddedUrlTarget, | |||
int32_t * | len | |||
) |
Gets the target of embedded URL.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | embeddedUrlTarget | The target of embedded URL. |
[in,out] | len |
|
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. | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
NULL
this function will return the size in bytes required to store the current target in len, not including the null terminator. on2sc swf_options_GetEmbeddedUrlType | ( | FLIX2HANDLE | flix, | |
FE2_EmbeddedUrlType * | embeddedUrlType | |||
) |
Gets the type of embedded URL.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | embeddedUrlType | The type of embedded URL. |
ON2_OK | success. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetEnablePreloader | ( | FLIX2HANDLE | flix, | |
on2bool * | pEnablePreloader | |||
) |
Gets if a video preloader is enabled or disabled.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pEnablePreloader |
ON2_OK | Success. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
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.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pInsertBlankFrameOnStart |
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 | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
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.
[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 |
|
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. | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
NULL
this function will return the size in bytes required to store the current URL in len, not including the null terminator. on2sc swf_options_GetLoopCount | ( | FLIX2HANDLE | flix, | |
int32_t * | pLoopCount | |||
) |
Gets the number of times the SWF should loop.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pLoopCount | The number of times the SWF should loop. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetMovieOnEndOptions | ( | FLIX2HANDLE | flix, | |
FE2_SwfOnEndOptions * | pOnEndOptions | |||
) |
Gets the options for the end of the SWF.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pOnEndOptions | The options for the end of the SWF. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetMovieOnStartOptions | ( | FLIX2HANDLE | flix, | |
FE2_SwfOnStartOptions * | pOnStartOptions | |||
) |
Gets the options for the start of the SWF.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pOnStartOptions | The options for the start of the SWF. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetPercentToPreload | ( | FLIX2HANDLE | flix, | |
int32_t * | pPercentToPreload | |||
) |
Gets the percent of the SWF movie to preload before playback begins.
[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. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetPreloaderType | ( | FLIX2HANDLE | flix, | |
FE2_SwfPreloaderOptions * | pPreloaderType | |||
) |
Gets the type of preloader.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pPreloaderType | The preloader type. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetSwfFramerate | ( | FLIX2HANDLE | flix, | |
int32_t * | pSwfFramerate | |||
) |
Gets the SWF framerate.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | pSwfFramerate | The SWF framerate. |
ON2_OK | The engine successfully returned SWF framerate. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetSwfFramerateAsDouble | ( | FLIX2HANDLE | flix, | |
double * | pSwfFramerate | |||
) |
Gets the SWF framerate as a double.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pSwfFramerate | The SWF framerate. |
ON2_OK | The engine successfully returned SWF framerate. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetVariableCount | ( | FLIX2HANDLE | flix, | |
int32_t * | pVariableCount | |||
) |
Gets the number of custom SWF variables already added.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pVariableCount | The number of custom SWF variables already added |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_GetWaitTimeToStart | ( | FLIX2HANDLE | flix, | |
int32_t * | pWaitTimeToStart | |||
) |
Gets the number of seconds to wait before playback begins.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pWaitTimeToStart | Number of seconds to wait. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
on2sc swf_options_Reset | ( | FLIX2HANDLE | flix | ) |
Resets the swf options.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
ON2_OK | reset of swf options was successful | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetAdaptivePreloaderBufferFactor | ( | FLIX2HANDLE | flix, | |
const double | preloaderBufferFactor | |||
) |
Sets the adaptive preload buffer factor.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | preloaderBufferFactor | The adaptive preloader buffer factor. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
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.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | embeddedUrl | The embedded URL. |
ON2_OK | success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NO_MEM | an error occurred allocating memory for embeddedUrl | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
then the engine will delete the embedded URL. on2sc swf_options_SetEmbeddedUrlTarget | ( | FLIX2HANDLE | flix, | |
const char * | embeddedUrlTarget | |||
) |
Sets the target of the embedded URL.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | embeddedUrlTarget | The target of the embedded URL. |
ON2_OK | success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NO_MEM | an error occurred allocating memory for embeddedUrlTarget | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
then it must be one of the valid values. "_self"
"_blank"
"_parent"
"_top"
"_self"
. NULL
then the engine will delete the target of the embedded URL. on2sc swf_options_SetEmbeddedUrlType | ( | FLIX2HANDLE | flix, | |
const FE2_EmbeddedUrlType | embeddedUrlType | |||
) |
Sets the type of embedded URL.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | embeddedUrlType | The type of embedded URL. |
ON2_OK | success. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetEnablePreloader | ( | FLIX2HANDLE | flix, | |
const on2bool | enablePreloader | |||
) |
Enables or disables the video preloader.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | enablePreloader |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
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.
[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. |
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 | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetLoadMovieOnEndUrl | ( | FLIX2HANDLE | flix, | |
const char * | loadMovieOnEndUrl | |||
) |
Sets the URL of a SWF movie to load after the current movie ends.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | loadMovieOnEndUrl | The URL of a SWF movie. |
ON2_OK | success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NO_MEM | an error occurred allocating memory for loadMovieOnEndUrl | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
then the engine will delete the URL. on2sc swf_options_SetLoopCount | ( | FLIX2HANDLE | flix, | |
const int32_t | loopCount | |||
) |
Sets the number of times the SWF should loop.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | loopCount | The number of times the SWF should loop. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetMovieOnEndOptions | ( | FLIX2HANDLE | flix, | |
const FE2_SwfOnEndOptions | onEndOptions | |||
) |
Sets the options for the end of the SWF.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | onEndOptions | The options for the end of the SWF. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetMovieOnStartOptions | ( | FLIX2HANDLE | flix, | |
const FE2_SwfOnStartOptions | onStartOptions | |||
) |
Sets the options for the start of the SWF.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | onStartOptions | The options for the start of the SWF. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetPercentToPreload | ( | FLIX2HANDLE | flix, | |
const int32_t | percentToPreload | |||
) |
Sets the percent of the SWF movie to preload before playback begins.
[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. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetPreloaderType | ( | FLIX2HANDLE | flix, | |
const FE2_SwfPreloaderOptions | preloaderType | |||
) |
Sets the type of preloader.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | preloaderType | The preloader type. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetSwfFramerate | ( | FLIX2HANDLE | flix, | |
const int32_t | swfFramerate | |||
) |
Sets the SWF framerate.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | swfFramerate | The SWF framerate. |
ON2_OK | The engine successfully set the SWF framerate. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetSwfFramerateAsDouble | ( | FLIX2HANDLE | flix, | |
const double | swfFramerate | |||
) |
Sets the SWF framerate as a double.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | swfFramerate | The SWF framerate. |
ON2_OK | The engine successfully set SWF framerate. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_SetWaitTimeToStart | ( | FLIX2HANDLE | flix, | |
const int32_t | waitTimeToStart | |||
) |
Sets the number of seconds to wait before playback begins.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | waitTimeToStart | Number of seconds to wait. |
ON2_OK | Success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
on2sc swf_options_UpdateVariable | ( | FLIX2HANDLE | flix, | |
const int32_t | index, | |||
const char * | name, | |||
const char * | value | |||
) |
Updates an already existing SWF variable.
[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. |
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. | |
ON2_NET_ERROR | the underlying communication layer failed |
NULL
NULL
NULL