Video Encoding Options
[Flix Engine API]


Modules

 Deprecated

Functions

on2sc video_options_Reset (FLIX2HANDLE flix)
 Reset the video options to their defaults.
on2sc video_options_Validate (const FLIX2HANDLE flix)
 Ensure the current video settings are valid.
on2sc video_options_GetSwfHeight (const FLIX2HANDLE flix, int32_t *lpSwfHeight)
 Gets the SWF height.
on2sc video_options_SetSwfHeight (FLIX2HANDLE flix, const int32_t lSwfHeight)
 Sets the SWF height.
on2sc video_options_GetSwfWidth (const FLIX2HANDLE flix, int32_t *lpSwfWidth)
 Gets the SWF width.
on2sc video_options_SetSwfWidth (FLIX2HANDLE flix, const int32_t lSwfWidth)
 Sets the SWF width.
on2sc video_options_GetUseCustomSwfDimensions (const FLIX2HANDLE flix, on2bool *bpUseCustomSwfDimensions)
 Determine if the engine is using the SWF width and height for the SWF.
on2sc video_options_SetUseCustomSwfDimensions (FLIX2HANDLE flix, const on2bool bUseCustomSwfDimensions)
 Tells the engine to use the SWF width and SWF height for the SWF.
on2sc video_options_GetSourceHeight (const FLIX2HANDLE flix, int32_t *height)
 Get the height of the source video.
on2sc video_options_GetSourceWidth (const FLIX2HANDLE flix, int32_t *width)
 Get the width of the source video.

Function Documentation

on2sc video_options_GetSourceHeight ( const FLIX2HANDLE  flix,
int32_t *  height 
)

Get the height of the source video.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] height Source video height, in pixels
Return values:
ON2_OK The source video size was successfully retrieved from the engine.
ON2_NET_ERROR The underlying communication layer failed.

on2sc video_options_GetSourceWidth ( const FLIX2HANDLE  flix,
int32_t *  width 
)

Get the width of the source video.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] width Source video width, in pixels
Return values:
ON2_OK The source video size was successfully retrieved from the engine.
ON2_NET_ERROR The underlying communication layer failed.

on2sc video_options_GetSwfHeight ( const FLIX2HANDLE  flix,
int32_t *  lpSwfHeight 
)

Gets the SWF height.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] lpSwfHeight SWF height.
Return values:
ON2_OK Success.
ON2_NET_ERROR The underlying communication layer failed.
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_HEIGHT parameter. This function will be removed in a future release.

on2sc video_options_GetSwfWidth ( const FLIX2HANDLE  flix,
int32_t *  lpSwfWidth 
)

Gets the SWF width.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] lpSwfWidth SWF width.
Return values:
ON2_OK Success.
ON2_NET_ERROR The underlying communication layer failed.
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_WIDTH parameter. This function will be removed in a future release.

on2sc video_options_GetUseCustomSwfDimensions ( const FLIX2HANDLE  flix,
on2bool *  bpUseCustomSwfDimensions 
)

Determine if the engine is using the SWF width and height for the SWF.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] bpUseCustomSwfDimensions Variable to update with the current custom SWF dimensions enable status
Return values:
ON2_OK Success.
ON2_NET_ERROR The underlying communication layer failed.
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_WIDTH/FE2_SWF_HEIGHT parameters. This function will be removed in a future release.

on2sc video_options_Reset ( FLIX2HANDLE  flix  ) 

Reset the video options to their defaults.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
Return values:
ON2_OK The video options were reset successfully.
ON2_NET_ERROR The underlying communication layer failed.

on2sc video_options_SetSwfHeight ( FLIX2HANDLE  flix,
const int32_t  lSwfHeight 
)

Sets the SWF height.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] lSwfHeight SWF height.
Return values:
ON2_OK Success.
ON2_NET_ERROR The underlying communication layer failed.
Note:
By default, the SWF height will be the video height.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_HEIGHT parameter. This function will be removed in a future release.

on2sc video_options_SetSwfWidth ( FLIX2HANDLE  flix,
const int32_t  lSwfWidth 
)

Sets the SWF width.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] lSwfWidth SWF width.
Return values:
ON2_OK Success.
ON2_NET_ERROR The underlying communication layer failed.
Note:
By default, the SWF width will be the video width.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_WIDTH parameter. This function will be removed in a future release.

on2sc video_options_SetUseCustomSwfDimensions ( FLIX2HANDLE  flix,
const on2bool  bUseCustomSwfDimensions 
)

Tells the engine to use the SWF width and SWF height for the SWF.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] bUseCustomSwfDimensions on2true to enable, on2false to disable.
Return values:
ON2_OK Success.
ON2_NET_ERROR The underlying communication layer failed.
Note:
By default, this is disabled.
This will automatically be set to enabled if video_options_SetSwfWidth() or video_options_SetSwfHeight() is called.
Deprecated:
Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_WIDTH/FE2_SWF_HEIGHT parameters. This function will be removed in a future release.

on2sc video_options_Validate ( const FLIX2HANDLE  flix  ) 

Ensure the current video settings are valid.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
Return values:
ON2_OK The video options are valid and encoding may proceed.
ON2_INVALID_PARAMS One or more options are invalid. Proceeding with encoding may cause encoding to fail or a file that does not match the specified options will be created.
ON2_NET_ERROR The underlying communication layer failed.

On2 Technologies, Inc Flix Engine Linux documentation, generated on Tue Nov 2 16:53:01 2010 by doxygen 1.5.5