Encoding Statistics
[Flix Engine API]


Functions

on2sc encoding_status_GetAverageBitrate (const FLIX2HANDLE flix, int32_t *pBitrate)
 Retrieve the encoder's average (video) bitrate.
on2sc encoding_status_GetAverageFramesize (const FLIX2HANDLE flix, int32_t *pFramesize)
 Retrieve the encoder's average (video) frame size.
on2sc encoding_status_GetMaximumFramesize (const FLIX2HANDLE flix, int32_t *pMaxFramesize)
 Retrieve the encoder's maximum (video) frame size.
on2sc encoding_status_GetMinimumFramesize (const FLIX2HANDLE flix, int32_t *pMinFramesize)
 Retrieve the encoder's minimum (video) frame size.
on2sc encoding_status_GetTotalFrames (const FLIX2HANDLE flix, int32_t *pTotalFrames)
 Retrieve the total number of (video) frames encoded.
on2sc encoding_status_GetElapsedTime (const FLIX2HANDLE flix, int32_t *pElapsedTime)
 Retrieve the total elapsed encode time.
on2sc encoding_status_GetEndTime (const FLIX2HANDLE flix, int32_t *pEndTime)
 Retrieve the encode completion time.
on2sc encoding_status_GetStartTime (const FLIX2HANDLE flix, int32_t *pStartTime)
 Retrieve the encode start time.
on2sc encoding_status_PercentComplete (const FLIX2HANDLE flix, int32_t *percent)
 Retrieve the percent of the encode complete.

Function Documentation

on2sc encoding_status_GetAverageBitrate ( const FLIX2HANDLE  flix,
int32_t pBitrate 
)

Retrieve the encoder's average (video) bitrate.

Value is in bits per second (bps).

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pBitrate Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pBitrate is not NULL

on2sc encoding_status_GetAverageFramesize ( const FLIX2HANDLE  flix,
int32_t pFramesize 
)

Retrieve the encoder's average (video) frame size.

Value is in bytes.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pFramesize Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pFramesize is not NULL

on2sc encoding_status_GetElapsedTime ( const FLIX2HANDLE  flix,
int32_t pElapsedTime 
)

Retrieve the total elapsed encode time.

Value is in milliseconds.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pElapsedTime Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pElapsedTime is not NULL

on2sc encoding_status_GetEndTime ( const FLIX2HANDLE  flix,
int32_t pEndTime 
)

Retrieve the encode completion time.

Value is in milliseconds.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pEndTime Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pEndTime is not NULL

on2sc encoding_status_GetMaximumFramesize ( const FLIX2HANDLE  flix,
int32_t pMaxFramesize 
)

Retrieve the encoder's maximum (video) frame size.

Value is in bytes.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pMaxFramesize Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pMaxFramesize is not NULL

on2sc encoding_status_GetMinimumFramesize ( const FLIX2HANDLE  flix,
int32_t pMinFramesize 
)

Retrieve the encoder's minimum (video) frame size.

Value is in bytes

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pMinFramesize Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pMinFramesize is not NULL

on2sc encoding_status_GetStartTime ( const FLIX2HANDLE  flix,
int32_t pStartTime 
)

Retrieve the encode start time.

Value is in milliseconds.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pStartTime Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pStartTime is not NULL

on2sc encoding_status_GetTotalFrames ( const FLIX2HANDLE  flix,
int32_t pTotalFrames 
)

Retrieve the total number of (video) frames encoded.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pTotalFrames Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
pTotalFrames is not NULL

on2sc encoding_status_PercentComplete ( const FLIX2HANDLE  flix,
int32_t percent 
)

Retrieve the percent of the encode complete.

Percent is returned as a whole number, e.g. 45.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] percent Storage location to receive the result
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should one or more of the preconditions fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
percent is not NULL
Note:
If Flix2_GetSourceDuration() returns -1, percent complete will remain 0 until the first pass of the encode completes.
This value is only valid after Flix2_Encode() has been called.


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