Filter Parameters:
Name | Type | Opt/Reqd | Range ============================================================================ FE2_FRAMERATE_FPS | Numeric | Optional | [0.0,) FE2_FRAMERATE_DECIMATE | Numeric | Optional | [1,)
Example Usage:
sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_FRAMERATE); // decimate by 2. ex. 29.97fps becomes 14.985 if(sc == ON2_OK) sc = Flix2_FilterSetParam(filter, FE2_FRAMERATE_DECIMATE, 2);
Deprecated functions | |
on2sc | video_options_GetVideoFramerate (const FLIX2HANDLE flix, int32_t *lpVideoFramerate) |
Get the current video framerate. | |
on2sc | video_options_SetVideoFramerate (FLIX2HANDLE flix, const int32_t lVideoFramerate) |
Set the video framerate. | |
on2sc | video_options_GetVideoFramerateAsDouble (const FLIX2HANDLE flix, double *p_fps) |
Get the current video framerate. | |
on2sc | video_options_SetVideoFramerateAsDouble (FLIX2HANDLE flix, const double fps) |
Set the video framerate. | |
on2sc | video_options_GetUseSourceFramerate (FLIX2HANDLE flix, on2bool *bpUseSourceFramerate) |
Determine if the source's framerate will be used instead of the modified framerate. | |
on2sc | video_options_SetUseSourceFramerate (FLIX2HANDLE flix, const on2bool bUseSourceFramerate) |
Switch between source and scaled framerate. | |
on2sc | video_options_GetDecimateValue (const FLIX2HANDLE flix, uint32_t *pValue) |
Get the current decimation of the video framerate. | |
on2sc | video_options_SetDecimateValue (FLIX2HANDLE flix, const uint32_t value) |
Set the decimation of the video framerate. | |
Defines | |
#define | FE2_FILTER_FRAMERATE |
Filter name for use with Flix2_AddFilter(). | |
#define | FE2_FRAMERATE_FPS |
Filter parameter name for frames per second value. | |
#define | FE2_FRAMERATE_DECIMATE |
Filter parameter for the decimation interval. |
#define FE2_FILTER_FRAMERATE |
#define FE2_FRAMERATE_DECIMATE |
Filter parameter for the decimation interval.
Decimation removes frames from the source video at regular intervals. This is useful for dropping the rate without introducing jerkiness due to uneven frame rate.
Definition at line 67 of file framerate.h.
#define FE2_FRAMERATE_FPS |
Filter parameter name for frames per second value.
Allows the frame rate to be adjusted to a specific rate.
Definition at line 56 of file framerate.h.
on2sc video_options_GetDecimateValue | ( | const FLIX2HANDLE | flix, | |
uint32_t * | pValue | |||
) |
Get the current decimation of the video framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pValue | Decimate value |
ON2_OK | Success. | |
ON2_INVALID_PARAMS | Should one or more of the preconditions fail. | |
ON2_NET_ERROR | The underlying communication layer failed. |
NULL
NULL
on2sc video_options_GetUseSourceFramerate | ( | FLIX2HANDLE | flix, | |
on2bool * | bpUseSourceFramerate | |||
) |
Determine if the source's framerate will be used instead of the modified framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | bpUseSourceFramerate | Variable to update with the current framerate selection |
ON2_OK | The framerate status was successfully retrieved from the engine. | |
ON2_NET_ERROR | The underlying communication layer failed. |
on2sc video_options_GetVideoFramerate | ( | const FLIX2HANDLE | flix, | |
int32_t * | lpVideoFramerate | |||
) |
Get the current video framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | lpVideoFramerate | Frames per second |
ON2_OK | The framerate was successfully retrieved from the engine. | |
ON2_NET_ERROR | The underlying communication layer failed. |
on2sc video_options_GetVideoFramerateAsDouble | ( | const FLIX2HANDLE | flix, | |
double * | p_fps | |||
) |
Get the current video framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | p_fps | Frames per second |
ON2_OK | The framerate was successfully retrieved from the engine. | |
ON2_NET_ERROR | The underlying communication layer failed. |
on2sc video_options_SetDecimateValue | ( | FLIX2HANDLE | flix, | |
const uint32_t | value | |||
) |
Set the decimation of the video framerate.
This value will be used to drop frames according to the video framerate. For example if the framerate is 30fps and the decimate value is 3 then the encoded framerate will be 10fps.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | value | Decimate value |
ON2_OK | The target framerate was successfully set in the engine. | |
ON2_INVALID_PARAMS | Should one or more of the preconditions fail. | |
ON2_NET_ERROR | The underlying communication layer failed. |
NULL
on2sc video_options_SetUseSourceFramerate | ( | FLIX2HANDLE | flix, | |
const on2bool | bUseSourceFramerate | |||
) |
Switch between source and scaled framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | bUseSourceFramerate | New framerate status. on2true to use source framerate, on2false to use scaled framerate. |
ON2_OK | The framerate status was successfully set in the engine. | |
ON2_NET_ERROR | The underlying communication layer failed. |
on2sc video_options_SetVideoFramerate | ( | FLIX2HANDLE | flix, | |
const int32_t | lVideoFramerate | |||
) |
Set the video framerate.
Sets the framerate to be used when encoding the video. Frames will be duplicated or dropped as necessary to achieve the desired framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | lVideoFramerate | Framerate target (in frames per second) |
ON2_OK | The target framerate was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. | |
ON2_NET_ERROR | The underlying communication layer failed. |
on2sc video_options_SetVideoFramerateAsDouble | ( | FLIX2HANDLE | flix, | |
const double | fps | |||
) |
Set the video framerate.
Sets the framerate to be used when encoding the video. Frames will be duplicated or dropped as necessary to achieve the desired framerate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | fps | Framerate target (in frames per second) |
ON2_OK | The target framerate was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. | |
ON2_NET_ERROR | The underlying communication layer failed. |