flixengine2/flixengine2.h File Reference

Reference module(s): Main Engine Interface, Filter Manipulation, Codec Manipulation, Muxer Manipulation. More...

#include "on2types.h"
#include "filter_constants.h"
#include "codec_constants.h"
#include "muxer_constants.h"
#include "video_options.h"
#include "audio_options.h"
#include "swf_options.h"
#include "encoding_status.h"
#include "media_editor_options.h"
#include "overlay_options.h"

Go to the source code of this file.

Defines
#define	FLIXENGINE_API
#define	FLIXENGINE_VERSION_CHIEF
#define	FLIXENGINE_VERSION_MAJOR
#define	FLIXENGINE_VERSION_MINOR
#define	FLIXENGINE_VERSION_PATCH
#define	FLIXENGINE_VERSION_EXTRA
#define	FLIXENGINE_VERSION_STR
Typedefs
typedef void *	FLIX2HANDLE
typedef void *	FLIX2PLGNHANDLE
Enumerations
enum	FE2_ExportedVideoType { ExportSWF3To6Video, ExportSWF7PlusVideo, ExportSWFVectorVideo, ExportFLVVideo }
	Output file types for use in calls to Flix2_SetExportVideoType() and Flix2_GetExportVideoType(). More...
enum	FE2_EncState { EncStateIdle, EncStateRunning, EncStateQueued }
	Encoder state returned by Flix2_GetEncoderState(). More...
enum	FE2_errno { ErrNone, ErrSys, ErrFileIO, ErrFileOpen, ErrFileDecode, ErrFileDecodeA, ErrFileDecodeV, ErrEncodeA, ErrEncodeV }
	Flix engine error state returned by Flix2_Errno(). More...
Functions
on2sc	Flix2_Create (FLIX2HANDLE *pFlix)
	Create a handle to the flix engine.
on2sc	Flix2_Destroy (FLIX2HANDLE flix)
	Frees resources associated with a `FLIX2HANDLE`.
const char *	Flix2_Version ()
	Returns the library version as a string.
const on2tc *	Flix2_Copyright ()
	Returns copyright information for this library as a string.
on2sc	Flix2_SetOutputFile (FLIX2HANDLE flix, const on2tc *outputFile)
	Set the destination file for the encode session.
on2sc	Flix2_GetOutputFile (const FLIX2HANDLE flix, on2tc pOutputFile, int32_t len)
	Get the destination file for the encode session.
on2sc	Flix2_SetOverwriteExistingFiles (FLIX2HANDLE flix, const on2bool bOverwriteExistingFiles)
	Enable/disable overwriting of existing output files.
on2sc	Flix2_GetOverwriteExistingFiles (const FLIX2HANDLE flix, on2bool *bpOverwriteExistingFiles)
	Retrieve the engine's current behavior regarding existing output files.
on2sc	Flix2_SetExportAudio (FLIX2HANDLE flix, const on2bool bExportAudio)
	Enable/disable audio output in the current encoding session.
on2sc	Flix2_GetExportAudio (const FLIX2HANDLE flix, on2bool *bpExportAudio)
	Retrieve the engine's current behavior regarding audio output.
on2sc	Flix2_SetExportVideo (FLIX2HANDLE flix, const on2bool bExportVideo)
	Enable/disable video output in the current encoding session.
on2sc	Flix2_GetExportVideo (const FLIX2HANDLE flix, on2bool *bpExportVideo)
	Retrieve the engine's current behavior regarding video output.
on2sc	Flix2_SetExportVideoType (FLIX2HANDLE flix, const FE2_ExportedVideoType exportVideoType)
	Set the output file type.
on2sc	Flix2_GetExportVideoType (const FLIX2HANDLE flix, FE2_ExportedVideoType *pExportVideoType)
	Retrieve the current output file type.
on2sc	Flix2_SetInputFile (FLIX2HANDLE flix, const on2tc *inputFile)
	Set the source file for the encode session.
on2sc	Flix2_GetInputFile (const FLIX2HANDLE flix, on2tc pInputFile, int32_t len)
	Get the source file for the encode session.
on2sc	Flix2_GetSourceDuration (const FLIX2HANDLE flix, int32_t *duration)
	Get the duration, in milliseconds, of the source file.
on2sc	Flix2_Encode (FLIX2HANDLE flix)
	Start encoding an output file.
on2sc	Flix2_StopEncoding (FLIX2HANDLE flix)
	Cancel a running encoding session.
on2sc	Flix2_Reset (FLIX2HANDLE flix)
	Reset the engine to its defaults.
on2sc	Flix2_Validate (const FLIX2HANDLE flix)
	Validate the current encoder settings.
on2sc	Flix2_IsEncoderRunning (const FLIX2HANDLE flix, on2bool *bpIsEncoderRunning)
	Check the status of an encode.
on2sc	Flix2_GetEncoderState (const FLIX2HANDLE flix, FE2_EncState *pEncState)
	Retrieve the current state of the encoder.
on2sc	Flix2_SetLogLevel (FLIX2HANDLE flix, int32_t level)
	Set the library-wide debug log level.
on2sc	Flix2_GetLogLevel (const FLIX2HANDLE flix, int32_t *level)
	Retrieve current library-wide debug log level.
on2sc	Flix2_SetLogPath (FLIX2HANDLE flix, on2tc *logpath)
	Set the library's log file path.
on2sc	Flix2_GetLogPath (const FLIX2HANDLE flix, on2tc logpath, int32_t len)
	Retrieve the library's current log file path.
on2sc	Flix2_AddFilter (FLIX2PLGNHANDLE pPlgn, const FLIX2HANDLE flix, const char plgn_name)
	Add a filter to the encoder's filter chain.
on2sc	Flix2_RemoveFilter (FLIX2PLGNHANDLE plgn)
	Remove a filter to the encoder's filter chain.
on2sc	Flix2_FilterSetParamAsStr (FLIX2PLGNHANDLE plgn, const char name, const on2tc value)
	Set the value of a parameter in a filter instance using a string representation.
on2sc	Flix2_FilterGetParamAsStr (FLIX2PLGNHANDLE plgn, const char name, on2tc value, int32_t *len)
	Retrieve the value of a parameter in a filter instance represented as a string.
on2sc	Flix2_FilterSetParam (FLIX2PLGNHANDLE plgn, const char *name, double inDblVal)
	Set the value of a parameter in a filter instance using a double representation.
on2sc	Flix2_FilterGetParam (FLIX2PLGNHANDLE plgn, const char name, double outDblVal)
	Retrieve the value of a parameter in a filter instance represented as a double.
on2sc	Flix2_AddCodec (FLIX2PLGNHANDLE pPlgn, const FLIX2HANDLE flix, const char plgn_name)
	Add a codec to the encoder's codec chain.
on2sc	Flix2_RemoveCodec (FLIX2PLGNHANDLE plgn)
	Remove a codec from the encoder's codec chain.
on2sc	Flix2_CodecSetParamAsStr (FLIX2PLGNHANDLE plgn, const char name, const on2tc value)
	Set the value of a parameter in a codec instance using a string representation.
on2sc	Flix2_CodecGetParamAsStr (FLIX2PLGNHANDLE plgn, const char name, on2tc value, int32_t *len)
	Retrieve the value of a parameter in a codec instance represented as a string.
on2sc	Flix2_CodecSetParam (FLIX2PLGNHANDLE plgn, const char *name, double inDblVal)
	Set the value of a parameter in a codec instance using a double representation.
on2sc	Flix2_CodecGetParam (FLIX2PLGNHANDLE plgn, const char name, double outDblVal)
	Retrieve the value of a parameter in a codec instance represented as a double.
on2sc	Flix2_AddMuxer (FLIX2PLGNHANDLE pPlgn, const FLIX2HANDLE flix, const char plgn_name)
	Set the desired muxer.
on2sc	Flix2_RemoveMuxer (FLIX2PLGNHANDLE plgn)
	Remove the specified muxer.
on2sc	Flix2_MuxerSetParamAsStr (FLIX2PLGNHANDLE plgn, const char name, const on2tc value)
	Set the value of a parameter in a muxer instance using a string representation.
on2sc	Flix2_MuxerGetParamAsStr (FLIX2PLGNHANDLE plgn, const char name, on2tc value, int32_t *len)
	Retrieve the value of a parameter in a muxer instance represented as a string.
on2sc	Flix2_MuxerSetParam (FLIX2PLGNHANDLE plgn, const char *name, double inDblVal)
	Set the value of a parameter in a muxer instance using a double representation.
on2sc	Flix2_MuxerGetParam (FLIX2PLGNHANDLE plgn, const char name, double outDblVal)
	Retrieve the value of a parameter in a muxer instance represented as a double.
on2sc	Flix2_Errno (const FLIX2HANDLE flix, FE2_errno flixerrno, int32_t syserrno)
	Retrieve the current error state of the engine.

Detailed Description

Reference module(s): Main Engine Interface, Filter Manipulation, Codec Manipulation, Muxer Manipulation.

Definition in file flixengine2.h.

Define Documentation

#define FLIXENGINE_API

Definition at line 24 of file flixengine2.h.

#define FLIXENGINE_VERSION_CHIEF

Definition at line 33 of file flixengine2.h.

#define FLIXENGINE_VERSION_EXTRA

Definition at line 37 of file flixengine2.h.

#define FLIXENGINE_VERSION_MAJOR

Definition at line 34 of file flixengine2.h.

#define FLIXENGINE_VERSION_MINOR

Definition at line 35 of file flixengine2.h.

#define FLIXENGINE_VERSION_PATCH

Definition at line 36 of file flixengine2.h.

#define FLIXENGINE_VERSION_STR

HIDDEN

Definition at line 43 of file flixengine2.h.

Typedef Documentation

typedef void* FLIX2HANDLE

handle type passed to all Flix Engine API functions

Definition at line 50 of file flixengine2.h.

typedef void * FLIX2PLGNHANDLE

filter plgn handle passed to Filter Manipulation functions

Definition at line 50 of file flixengine2.h.

Function Documentation

on2sc Flix2_GetLogLevel	(	const FLIX2HANDLE	flix,
		int32_t *	level
	)

Retrieve current library-wide debug log level.

Parameters:

`[in]`	flix	Handle to the flix engine returned from Flix2_Create()
`[out]`	level	Storage location to receive the result

Return values:

	ON2_OK	on success
	ON2_INVALID_PARAMS	should one or more of the preconditions fail

Precondition:: flix is not NULL
level is not NULL

on2sc Flix2_GetLogPath	(	const FLIX2HANDLE	flix,
		on2tc *	logpath,
		int32_t *	len
	)

Retrieve the library's current log file path.

Parameters:

`[in]`	flix	Handle to the flix engine returned from Flix2_Create()
`[out]`	logpath	Storage location for the log file path
`[in,out]`	len	on input, the max number of bytes available in logpath. On return, the number of bytes used.

Return values:

	ON2_OK	on success
	ON2_INVALID_PARAMS	should one or more of the preconditions fail

Precondition:: flix is not NULL
len is not NULL

on2sc Flix2_SetLogLevel	(	FLIX2HANDLE	flix,
		int32_t	level
	)

Set the library-wide debug log level.

Parameters:

`[in]`	flix	Handle to the flix engine returned from Flix2_Create()
`[in]`	level	The log level to set the library to

Return values:

	ON2_OK	on success
	ON2_INVALID_PARAMS	should one or more of the preconditions fail

Precondition:: flix is not NULL
level is within the range 0-4

Remarks:

Valid values for level are:

0= none (Default)
1= informational
2= errors+asserts
3= debug
4= heavy/program trace logging

on2sc Flix2_SetLogPath	(	FLIX2HANDLE	flix,
		on2tc *	logpath
	)

Set the library's log file path.

The log file is opened for appending whenever a log message needs to be written and closed immediately thereafter.

Parameters:

`[in]`	flix	Handle to the flix engine returned from Flix2_Create()
`[in]`	logpath	Path to the log file

Return values:

	ON2_OK	the engine successfully set the log file
	ON2_INVALID_PARAMS	should one or more of the preconditions fail
	ON2_NO_MEM	an error occurred allocating memory for logpath

Precondition:: flix is not NULL
logpath is not NULL

Note:: No attempt is made to ensure the file can be created by this function, nor will it create any non-existent directories in logpath.

Remarks:: logpath can be the name of a console, e.g. CONOUT$

Attention:: Currently the logpath and log level, set via flixengine_com::IFlix::setLogLevel(), are global properties. Log messages will be prepended with the thread id of origin for disambiguation.

flixengine2/flixengine2.h File Reference

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation