Filter Manipulation
[Flix Engine API]


Modules

 Deprecated

Functions

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.

Function Documentation

on2sc Flix2_AddFilter ( FLIX2PLGNHANDLE pPlgn,
const FLIX2HANDLE  flix,
const char *  plgn_name 
)

Add a filter to the encoder's filter chain.

Initializes a FLIX2PLGNHANDLE mapped to plgn_name for use in subsequent filter calls.

Parameters:
[out] pPlgn Storage location to receive the value of the created FLIX2PLGNHANDLE
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] plgn_name Name of the filter to add to the chain
Return values:
ON2_OK the engine successfully added the filter and initialized a FLIX2PLGNHANDLE for use in filter related functions.
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NO_MEM memory could not be allocated for the FLIX2PLGNHANDLE
ON2_NET_ERROR the underlying communication layer failed
Precondition:
pPlgn is not NULL
flix is not NULL
plgn_name is not NULL
See also:
Filters

on2sc Flix2_FilterGetParam ( FLIX2PLGNHANDLE  plgn,
const char *  name,
double *  outDblVal 
)

Retrieve the value of a parameter in a filter instance represented as a double.

Parameters:
[in] plgn Handle to the filter returned from Flix2_AddFilter()
[in] name Name of the parameter to retrieve
[out] outDblVal Storage location to receive the value
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should the precondition fail
ON2_NOT_SUPP the filter does not support this parameter/representation
ON2_NET_ERROR the underlying communication layer failed
Precondition:
plgn is not NULL
outDblVal is not NULL
See also:
Filters

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.

Parameters:
[in] plgn Handle to the filter returned from Flix2_AddFilter()
[in] name Name of the parameter to retrieve
[out] value Storage location to receive the value
[in,out] len Pointer to buffer length variable. Should contain the maximum size of the buffer. This call updates this variable with the size of the returned string.
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NOT_SUPP the filter does not support this parameter
ON2_NET_ERROR the underlying communication layer failed
Precondition:
plgn is not NULL
value is not NULL
len is not NULL
Attention:
This function is currently unsupported and will return ON2_NOT_SUPP.
See also:
Filters

on2sc Flix2_FilterSetParam ( FLIX2PLGNHANDLE  plgn,
const char *  name,
double  inDblVal 
)

Set the value of a parameter in a filter instance using a double representation.

Parameters:
[in] plgn Handle to the filter returned from Flix2_AddFilter()
[in] name Name of the parameter to set
[in] inDblVal New value for the parameter
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should the precondition fail
ON2_NOT_SUPP the filter does not support this parameter
ON2_NET_ERROR the underlying communication layer failed
Precondition:
plgn is not NULL
See also:
Filters

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.

Parameters:
[in] plgn Handle to the filter returned from Flix2_AddFilter()
[in] name Name of the parameter to set
[in] value New value for the parameter
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should the precondition fail
ON2_NOT_SUPP the filter does not support this parameter
ON2_NET_ERROR the underlying communication layer failed
Precondition:
plgn is not NULL
See also:
Filters

on2sc Flix2_RemoveFilter ( FLIX2PLGNHANDLE  plgn  ) 

Remove a filter to the encoder's filter chain.

Parameters:
[in] plgn Handle to the filter returned from Flix2_AddFilter()
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should the precondition fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
plgn is not NULL


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