flixengine_com::ISwfOptions Interface Reference
[Flix Engine COM]

import "flixengine_com.idl";

---

Detailed Description

Interface for accessing SWF creation functions.

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with the SWF muxer. This interface will be removed in a future release.

Definition at line 210 of file flixengine_com.idl.

Public Member Functions
HRESULT	reset ()
	Wrapper for swf_options_Reset().
HRESULT	setEmbeddedUrl (const BSTR embeddedUrl)
	Wrapper for swf_options_SetEmbeddedUrl().
HRESULT	setEmbeddedUrlTarget (const BSTR embeddedUrlTarget)
	Wrapper for swf_options_SetEmbeddedUrlTarget().
HRESULT	getEmbeddedUrlType ([out, retval] FE2_EmbeddedUrlType *embeddedUrlType)
	Wrapper for swf_options_GetEmbeddedUrlType().
HRESULT	setEmbeddedUrlType (const FE2_EmbeddedUrlType embeddedUrlType)
	Wrapper for swf_options_SetEmbeddedUrlType().
HRESULT	getInsertBlankFrameOnStart ([out, retval] on2bool *pInsertBlankFrameOnStart)
	Wrapper for swf_options_GetInsertBlankFrameOnStart().
HRESULT	setInsertBlankFrameOnStart (const on2bool insertBlankFrameOnStart)
	Wrapper for swf_options_SetInsertBlankFrameOnStart().
HRESULT	getSwfFramerateAsDouble ([out, retval] double *pSwfFramerate)
	Wrapper for swf_options_GetSwfFramerateAsDouble().
HRESULT	setSwfFramerateAsDouble (const double swfFramerate)
	Wrapper for swf_options_SetSwfFramerateAsDouble().
HRESULT	getEnablePreloader ([out, retval] on2bool *pEnablePreloader)
	Wrapper for swf_options_GetEnablePreloader().
HRESULT	setEnablePreloader (const on2bool enablePreloader)
	Wrapper for swf_options_SetEnablePreloader().
HRESULT	getPercentToPreload ([out, retval] on2s32 *pPercentToPreload)
	Wrapper for swf_options_GetPercentToPreload().
HRESULT	setPercentToPreload (const on2s32 percentToPreload)
	Wrapper for swf_options_SetPercentToPreload().
HRESULT	getPreloaderType ([out, retval] FE2_SwfPreloaderOptions *pPreloaderType)
	Wrapper for swf_options_GetPreloaderType().
HRESULT	setPreloaderType (const FE2_SwfPreloaderOptions preloaderType)
	Wrapper for swf_options_SetPreloaderType().
HRESULT	getAdaptivePreloaderBufferFactor ([out, retval] double *pPreloaderBufferFactor)
	Wrapper for swf_options_GetAdaptivePreloaderBufferFactor().
HRESULT	setAdaptivePreloaderBufferFactor (const double preloaderBufferFactor)
	Wrapper for swf_options_SetAdaptivePreloaderBufferFactor().
HRESULT	getMovieOnEndOptions ([out, retval] FE2_SwfOnEndOptions *pOnEndOptions)
	Wrapper for swf_options_GetMovieOnEndOptions().
HRESULT	setMovieOnEndOptions (const FE2_SwfOnEndOptions onEndOptions)
	Wrapper for swf_options_SetMovieOnEndOptions().
HRESULT	getLoopCount ([out, retval] on2s32 *pLoopCount)
	Wrapper for swf_options_GetLoopCount().
HRESULT	setLoopCount (const on2s32 loopCount)
	Wrapper for swf_options_SetLoopCount().
HRESULT	setLoadMovieOnEndUrl (const BSTR loadMovieOnEndUrl)
	Wrapper for swf_options_SetLoadMovieOnEndUrl().
HRESULT	getMovieOnStartOptions ([out, retval] FE2_SwfOnStartOptions *pOnStartOptions)
	Wrapper for swf_options_GetMovieOnStartOptions().
HRESULT	setMovieOnStartOptions (const FE2_SwfOnStartOptions onStartOptions)
	Wrapper for swf_options_SetMovieOnStartOptions().
HRESULT	getWaitTimeToStart ([out, retval] on2s32 *pWaitTimeToStart)
	Wrapper for swf_options_GetWaitTimeToStart().
HRESULT	setWaitTimeToStart (const on2s32 waitTimeToStart)
	Wrapper for swf_options_SetWaitTimeToStart().
HRESULT	addVariable (const BSTR name, const BSTR value)
	Wrapper for swf_options_AddVariable().
HRESULT	deleteVariable (const on2s32 index)
	Wrapper for swf_options_DeleteVariable().
HRESULT	getVariableCount ([out, retval] on2s32 *pVariableCount)
	Wrapper for swf_options_GetVariableCount().
HRESULT	updateVariable (const on2s32 index, const BSTR name, const BSTR value)
	Wrapper for swf_options_UpdateVariable().
Properties
on2sc *	sc [get]
	on2sc from the last Flix Engine function called within this interface

---

Member Function Documentation

HRESULT flixengine_com::ISwfOptions::reset

(

)

Wrapper for swf_options_Reset().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with the SWF muxer. This interface will be removed in a future release.

HRESULT flixengine_com::ISwfOptions::setEmbeddedUrl

(

const BSTR

embeddedUrl

)

Wrapper for swf_options_SetEmbeddedUrl().

Note:

embeddedUrl is converted to a char*

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL parameter.

HRESULT flixengine_com::ISwfOptions::setEmbeddedUrlTarget

(

const BSTR

embeddedUrlTarget

)

Wrapper for swf_options_SetEmbeddedUrlTarget().

Note:

name is converted to a char*

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL parameter.

HRESULT flixengine_com::ISwfOptions::getEmbeddedUrlType

(

[out, retval] FE2_EmbeddedUrlType *

embeddedUrlType

)

Wrapper for swf_options_GetEmbeddedUrlType().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TYPE parameter.

HRESULT flixengine_com::ISwfOptions::setEmbeddedUrlType

(

const FE2_EmbeddedUrlType

embeddedUrlType

)

Wrapper for swf_options_SetEmbeddedUrlType().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TYPE parameter.

HRESULT flixengine_com::ISwfOptions::getInsertBlankFrameOnStart

(

[out, retval] on2bool *

pInsertBlankFrameOnStart

)

Wrapper for swf_options_GetInsertBlankFrameOnStart().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_START_BLANK_FRAME parameter.

HRESULT flixengine_com::ISwfOptions::setInsertBlankFrameOnStart

(

const on2bool

insertBlankFrameOnStart

)

Wrapper for swf_options_SetInsertBlankFrameOnStart().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_START_BLANK_FRAME parameter.

HRESULT flixengine_com::ISwfOptions::getSwfFramerateAsDouble

(

[out, retval] double *

pSwfFramerate

)

Wrapper for swf_options_GetSwfFramerateAsDouble().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_FRAMERATE parameter.

HRESULT flixengine_com::ISwfOptions::setSwfFramerateAsDouble

(

const double

swfFramerate

)

Wrapper for swf_options_SetSwfFramerateAsDouble().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_FRAMERATE parameter.

HRESULT flixengine_com::ISwfOptions::getEnablePreloader

(

[out, retval] on2bool *

pEnablePreloader

)

Wrapper for swf_options_GetEnablePreloader().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter.

HRESULT flixengine_com::ISwfOptions::setEnablePreloader

(

const on2bool

enablePreloader

)

Wrapper for swf_options_SetEnablePreloader().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter.

HRESULT flixengine_com::ISwfOptions::getPercentToPreload

(

[out, retval] on2s32 *

pPercentToPreload

)

Wrapper for swf_options_GetPercentToPreload().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_FIXED_PRELOAD_PCT parameter.

HRESULT flixengine_com::ISwfOptions::setPercentToPreload

(

const on2s32

percentToPreload

)

Wrapper for swf_options_SetPercentToPreload().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_FIXED_PRELOAD_PCT parameter.

HRESULT flixengine_com::ISwfOptions::getPreloaderType

(

[out, retval] FE2_SwfPreloaderOptions *

pPreloaderType

)

Wrapper for swf_options_GetPreloaderType().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter.

HRESULT flixengine_com::ISwfOptions::setPreloaderType

(

const FE2_SwfPreloaderOptions

preloaderType

)

Wrapper for swf_options_SetPreloaderType().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter.

HRESULT flixengine_com::ISwfOptions::getAdaptivePreloaderBufferFactor

(

[out, retval] double *

pPreloaderBufferFactor

)

Wrapper for swf_options_GetAdaptivePreloaderBufferFactor().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR parameter.

HRESULT flixengine_com::ISwfOptions::setAdaptivePreloaderBufferFactor

(

const double

preloaderBufferFactor

)

Wrapper for swf_options_SetAdaptivePreloaderBufferFactor().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR parameter.

HRESULT flixengine_com::ISwfOptions::getMovieOnEndOptions

(

[out, retval] FE2_SwfOnEndOptions *

pOnEndOptions

)

Wrapper for swf_options_GetMovieOnEndOptions().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_OPTION parameter.

HRESULT flixengine_com::ISwfOptions::setMovieOnEndOptions

(

const FE2_SwfOnEndOptions

onEndOptions

)

Wrapper for swf_options_SetMovieOnEndOptions().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_OPTION parameter.

HRESULT flixengine_com::ISwfOptions::getLoopCount

(

[out, retval] on2s32 *

pLoopCount

)

Wrapper for swf_options_GetLoopCount().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_LOOP_COUNT parameter.

HRESULT flixengine_com::ISwfOptions::setLoopCount

(

const on2s32

loopCount

)

Wrapper for swf_options_SetLoopCount().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_LOOP_COUNT parameter.

HRESULT flixengine_com::ISwfOptions::setLoadMovieOnEndUrl

(

const BSTR

loadMovieOnEndUrl

)

Wrapper for swf_options_SetLoadMovieOnEndUrl().

Note:

name is converted to a char*

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_URL parameter.

HRESULT flixengine_com::ISwfOptions::getMovieOnStartOptions

(

[out, retval] FE2_SwfOnStartOptions *

pOnStartOptions

)

Wrapper for swf_options_GetMovieOnStartOptions().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ON_START_OPTION parameter.

HRESULT flixengine_com::ISwfOptions::setMovieOnStartOptions

(

const FE2_SwfOnStartOptions

onStartOptions

)

Wrapper for swf_options_SetMovieOnStartOptions().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ON_START_OPTION parameter.

HRESULT flixengine_com::ISwfOptions::getWaitTimeToStart

(

[out, retval] on2s32 *

pWaitTimeToStart

)

Wrapper for swf_options_GetWaitTimeToStart().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_START_WAIT_SEC parameter.

HRESULT flixengine_com::ISwfOptions::setWaitTimeToStart

(

const on2s32

waitTimeToStart

)

Wrapper for swf_options_SetWaitTimeToStart().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_START_WAIT_SEC parameter.

HRESULT flixengine_com::ISwfOptions::addVariable	(	const BSTR	name,
		const BSTR	value
	)

Wrapper for swf_options_AddVariable().

Note:

name is converted to a char* value is converted to a char*

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ADD_VARIABLE parameter.

HRESULT flixengine_com::ISwfOptions::deleteVariable

(

const on2s32

index

)

Wrapper for swf_options_DeleteVariable().

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_DELETE_VARIABLE parameter.

HRESULT flixengine_com::ISwfOptions::getVariableCount

(

[out, retval] on2s32 *

pVariableCount

)

Wrapper for swf_options_GetVariableCount().

Deprecated:

Use the SWF muxer.

HRESULT flixengine_com::ISwfOptions::updateVariable	(	const on2s32	index,
		const BSTR	name,
		const BSTR	value
	)

Wrapper for swf_options_UpdateVariable().

Note:

name is converted to a char*

value is converted to a char*

Deprecated:

Use the flixengine_com::IFlixPlgn interface along with FE2_MUXER_SWF and the FE2_SWF_ADD_VARIABLE parameter.

---

Property Documentation

on2sc* flixengine_com::ISwfOptions::sc [get]

on2sc from the last Flix Engine function called within this interface

Deprecated:

Use the flixengine_com::IFlixPlgn interface.

---

The documentation for this interface was generated from the following file:

• flixengine_com.idl