Google Flix Engine Linux Reference Manual User Manual

Page 196

Advertising
background image

190

Flix Engine Linux Module Documentation

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

← format Raw video format

← width Video width

← height Video height

← pitch Video pitch (stride) in bytes. For YV12 stride is typically equal to width, for BGRA it’s

width ∗ 4

← rate Video rate (rate / scale = framerate)

← scale Video scale (rate / scale = framerate)

Return values:

ON2_OK

on success

ON2_INVALID_PARAMS

should one or more of the preconditions fail

Precondition:

flix

is not NULL

format

is a valid member of

FE2_VideoFormat

width

and height are > 0

pitch

is non-zero

Attention:

Available only in the

Flix Engine Core Library

Remarks:

Taken together with

Flix2_SetAudioProperties()

, can be viewed as the analogue of

Flix2_-

SetInputFile()

Note:

MUST be called before

Flix2_EncodeFrame()

if video output is desired

Calling this function after calling

Flix2_EncodeFrame

(

FrameTypeVideo

) is NOT supported

If the input video is of variable framerate rate and scale may be omitted (i.e. set to 0)

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

Advertising