Flix2_encode(), Flix2_errno(), Flix2_encode – Google Flix Engine Linux Reference Manual User Manual

Page 164

Advertising
background image

158

Flix Engine Linux Module Documentation

5.38.2.4

on2sc Flix2_Destroy (FLIX2HANDLE flix)

Frees resources associated with a FLIX2HANDLE.

Parameters:

← flix FLIXHANDLE to be destroyed

Return values:

ON2_OK

the engine successfully destroyed the handle

ON2_INVALID_PARAMS

should the precondition fail

ON2_NET_ERROR

the underlying communication layer failed

Precondition:

flix

is not NULL

Remarks:

If an encoding session started with

Flix2_Encode()

is still running when this function is called. It will

be stopped with

Flix2_StopEncoding()

before destroying the handle.

5.38.2.5

on2sc Flix2_Encode (FLIX2HANDLE flix)

Start encoding an output file.

Encode the input file set in

Flix2_SetInputFile()

to the output file set in

Flix2_SetOutputFile()

, using the

options set in the accessor functions or the engine defaults where applicable. Before starting the encode
session, calls

Flix2_Validate()

to ensure the engine is ready to encode the input.

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

Return values:

ON2_OK

the engine successfully started the encode

ON2_INVALID_PARAMS

should the precondition fail

ON2_NET_ERROR

the underlying communication layer failed

<ON2_OK

Flix2_Validate()

failed / there was an error starting the encode session. Call

Flix2_Errno()

for more detail.

Precondition:

flix

is not NULL

Note:

Linux Only:

upon success flixd starts an encode thread on behalf of the FLIX2HANDLE.

Detail about the state of the encoder can be obtained by calling

Flix2_IsEncoderRunning()

,

Flix2_-

GetEncoderState()

or any of the

Encoding Statistics

functions

Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen

Advertising