Flix Engine Core Library

---

Detailed Description

This library, libflixengine2_core.so, encompasses the Flix Engine API and adds the Frame Server API.

The Flix Engine Core Library consists of a single library, libflixengine2_core.so, that exports the entire Flix Engine API. In addition to this it adds the Frame Server API which allows the user to feed the engine raw audio/video frames as opposed to entire files. This is only available through C/C++. There are no language bindings for the core library.

Modules
	Frame Server API
	Flix Engine Frame Server API.
Functions
on2sc	Flix2_Init ()
	Perform library initialization.
on2sc	Flix2_Deinit ()
	Cleanup resources allocated by Flix2_Init().
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.

---

Function Documentation

on2sc Flix2_Deinit

(

)

Cleanup resources allocated by Flix2_Init().

Call once per program instance

Attention:

Available only in the Flix Engine Core Library

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_Init

(

)

Perform library initialization.

Call once per program instance

Attention:

Available only in the Flix Engine Core Library

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 device, e.g. /dev/stderr

---