Enumerations | |
enum | FE2_VideoCodec { CODEC_NULL, CODEC_H263, CODEC_SCREENVIDEO, CODEC_VP6, CODEC_VP6ALPHA } |
Output video codec types, influences quality/compatibility. More... | |
enum | FE2_CuePointType { CUE_EVENT, CUE_NAVIGATION } |
Cue point type for use with video_options_AddFLVCuePoint(). More... | |
Functions | |
on2sc | video_options_GetImageQuality (const FLIX2HANDLE flix, int32_t *lpImageQuality) |
Get the current image quality factor. | |
on2sc | video_options_SetImageQuality (FLIX2HANDLE flix, const int32_t lImageQuality) |
Set the image quality factor. | |
on2sc | video_options_GetKeyframeInterval (const FLIX2HANDLE flix, int32_t *lpKeyframeInterval) |
Get the current interval between keyfames. | |
on2sc | video_options_SetKeyframeInterval (FLIX2HANDLE flix, const int32_t lKeyframeInterval) |
Set the interval between keyfames. | |
on2sc | video_options_GetKeyframeIntervalType (const FLIX2HANDLE flix, FE2_VideoKeyframeTypes *pKeyframeIntervalType) |
Get the current keyframe interval type. | |
on2sc | video_options_SetKeyframeIntervalType (FLIX2HANDLE flix, const FE2_VideoKeyframeTypes keyframeIntervalType) |
Set the keyframe interval type. | |
on2sc | video_options_GetMaximumBitrate (const FLIX2HANDLE flix, int32_t *lpMaximumBitrate) |
Get the current maximum bitrate target. | |
on2sc | video_options_SetMaximumBitrate (FLIX2HANDLE flix, const int32_t lMaximumBitrate) |
Set the maximum bitrate target. | |
on2sc | video_options_GetRateControlType (const FLIX2HANDLE flix, FE2_VideoBitrateControls *pRateControlType) |
Get the current rate control type. | |
on2sc | video_options_SetRateControlType (FLIX2HANDLE flix, const FE2_VideoBitrateControls rateControlType) |
Set the rate control type. | |
on2sc | video_options_GetUseMaximumBitrate (const FLIX2HANDLE flix, on2bool *bpUseMaximumBitrate) |
Determine if the maximum bitrate target will be used. | |
on2sc | video_options_SetUseMaximumBitrate (FLIX2HANDLE flix, const on2bool bUseMaximumBitrate) |
Enable/disable the maximum bitrate target value. | |
on2sc | video_options_GetSwfFramerate (const FLIX2HANDLE flix, int32_t *pSwfFramerate) |
Gets the SWF framerate. | |
on2sc | video_options_SetSwfFramerate (FLIX2HANDLE flix, const int32_t swfFramerate) |
Sets the SWF framerate. | |
on2sc | video_options_GetVideoCodec (const FLIX2HANDLE flix, FE2_VideoCodec *pVideoCodec) |
Determine which video codec will be used. | |
on2sc | video_options_SetVideoCodec (FLIX2HANDLE flix, const FE2_VideoCodec videoCodec) |
Select the video codec to be used. | |
on2sc | video_options_GetAlphaPercentage (const FLIX2HANDLE flix, int32_t *percentage) |
Gets the percentage of the video bitrate to be used to encode the alpha channel. | |
on2sc | video_options_SetAlphaPercentage (FLIX2HANDLE flix, const int32_t percentage) |
Sets the percentage of the video bitrate to be used to encode the alpha channel. | |
on2sc | video_options_AddFLVCuePoint (FLIX2HANDLE flix, const char *pName, const double time, const FE2_CuePointType type) |
Adds a cue point to the FLV. | |
on2sc | video_options_AddFLVCuePointParameter (FLIX2HANDLE flix, const char *pCuePointName, const char *pName, const char *pValue) |
Adds a name/value parameter to an already added cue point. | |
on2sc | video_options_GetCompressMode (const FLIX2HANDLE flix, FE2_CompressMode *mode) |
Get the current VP6 compression mode. | |
on2sc | video_options_SetCompressMode (FLIX2HANDLE flix, FE2_CompressMode mode) |
Set the VP6 compression mode. |
enum FE2_CuePointType |
Cue point type for use with video_options_AddFLVCuePoint().
CUE_EVENT |
Trigger an event at a specified point |
CUE_NAVIGATION |
Allows the user to seek to a specified point |
Definition at line 52 of file video_options.h.
enum FE2_VideoCodec |
Output video codec types, influences quality/compatibility.
For use in calls to video_options_SetVideoCodec() and video_options_GetVideoCodec()
CODEC_NULL |
place holder, not for external use |
CODEC_H263 |
H263 codec |
CODEC_SCREENVIDEO |
Screen Video codec, NOT supported |
CODEC_VP6 |
VP6 (Flash8) codec |
CODEC_VP6ALPHA |
VP6 + encoded alpha channel |
Definition at line 38 of file video_options.h.
on2sc video_options_AddFLVCuePoint | ( | FLIX2HANDLE | flix, | |
const char * | pName, | |||
const double | time, | |||
const FE2_CuePointType | type | |||
) |
Adds a cue point to the FLV.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | pName | Name of the cue point. |
[in] | time | Time of the cue point in seconds. |
[in] | type | Cue point type. |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NO_MEM | an error occurred allocating memory for the new cue point. |
NULL
NULL
on2sc video_options_AddFLVCuePointParameter | ( | FLIX2HANDLE | flix, | |
const char * | pCuePointName, | |||
const char * | pName, | |||
const char * | pValue | |||
) |
Adds a name/value parameter to an already added cue point.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | pCuePointName | Name of the cue point to add the parameter to. |
[in] | pName | Name of the parameter. |
[in] | pValue | Value of the parameter. |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail | |
ON2_NO_MEM | an error occurred allocating memory for the new cue point. |
NULL
NULL
NULL
NULL
on2sc video_options_GetAlphaPercentage | ( | const FLIX2HANDLE | flix, | |
int32_t * | percentage | |||
) |
Gets the percentage of the video bitrate to be used to encode the alpha channel.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | percentage | Alpha percentage |
ON2_OK | Success. |
on2sc video_options_GetCompressMode | ( | const FLIX2HANDLE | flix, | |
FE2_CompressMode * | mode | |||
) |
Get the current VP6 compression mode.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | mode | Compression mode (one of FE2_CompressMode) |
ON2_OK | The rate control type was successfully retrieved from the engine. |
on2sc video_options_GetImageQuality | ( | const FLIX2HANDLE | flix, | |
int32_t * | lpImageQuality | |||
) |
Get the current image quality factor.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | lpImageQuality | Image quality (0..100) |
ON2_OK | The quality value was successfully retrieved from the engine. |
on2sc video_options_GetKeyframeInterval | ( | const FLIX2HANDLE | flix, | |
int32_t * | lpKeyframeInterval | |||
) |
Get the current interval between keyfames.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | lpKeyframeInterval | Keyframe interval (in frames) |
ON2_OK | The keyframe interval was successfully retrieved from the engine. |
on2sc video_options_GetKeyframeIntervalType | ( | const FLIX2HANDLE | flix, | |
FE2_VideoKeyframeTypes * | pKeyframeIntervalType | |||
) |
Get the current keyframe interval type.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pKeyframeIntervalType | Keyframe interval type (one of FE2_VideoKeyframeTypes) |
ON2_OK | The keyframe interval type was successfully retrieved from the engine. |
on2sc video_options_GetMaximumBitrate | ( | const FLIX2HANDLE | flix, | |
int32_t * | lpMaximumBitrate | |||
) |
Get the current maximum bitrate target.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | lpMaximumBitrate | Target bitrate (in Kbps) |
ON2_OK | The keyframe interval type was successfully retrieved from the engine. |
on2sc video_options_GetRateControlType | ( | const FLIX2HANDLE | flix, | |
FE2_VideoBitrateControls * | pRateControlType | |||
) |
Get the current rate control type.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pRateControlType | Rate control type (one of FE2_VideoBitrateControls) |
ON2_OK | The rate control type was successfully retrieved from the engine. |
on2sc video_options_GetSwfFramerate | ( | const FLIX2HANDLE | flix, | |
int32_t * | pSwfFramerate | |||
) |
Gets the SWF framerate.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | pSwfFramerate | The SWF framerate. |
ON2_OK | The engine successfully returned SWF framerate. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
NULL
on2sc video_options_GetUseMaximumBitrate | ( | const FLIX2HANDLE | flix, | |
on2bool * | bpUseMaximumBitrate | |||
) |
Determine if the maximum bitrate target will be used.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | bpUseMaximumBitrate | Variable to update with the current bitrate enable status |
ON2_OK | The bitrate enable status was successfully retrieved from the engine. |
on2sc video_options_GetVideoCodec | ( | const FLIX2HANDLE | flix, | |
FE2_VideoCodec * | pVideoCodec | |||
) |
Determine which video codec will be used.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pVideoCodec | Current video codec (one of FE2_VideoCodec) |
ON2_OK | The selected video codec was successfully retrieved from the engine. |
on2sc video_options_SetAlphaPercentage | ( | FLIX2HANDLE | flix, | |
const int32_t | percentage | |||
) |
Sets the percentage of the video bitrate to be used to encode the alpha channel.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | percentage | Alpha percentage |
ON2_OK | Success. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetCompressMode | ( | FLIX2HANDLE | flix, | |
FE2_CompressMode | mode | |||
) |
Set the VP6 compression mode.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | mode | Compression mode (one of FE2_CompressMode) |
ON2_OK | The compression mode was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetImageQuality | ( | FLIX2HANDLE | flix, | |
const int32_t | lImageQuality | |||
) |
Set the image quality factor.
Determines the image "quality" level. Higher numbers will generally result in higher quality video, at the cost of higher bitrates and file sizes.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | lImageQuality | Quality Factor (0 to 100) |
ON2_OK | The quality value was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetKeyframeInterval | ( | FLIX2HANDLE | flix, | |
const int32_t | lKeyframeInterval | |||
) |
Set the interval between keyfames.
Determines the interval (in frames) between keyframes. Keyframes "refresh" the player with the best possible quality image, and subsequent images are derived from that image. In addition, the keyframe interval determines the granularity at which seeking can happen (i.e., the player can only seek to a keyframe). Reducing the keyframe interval increases the number of seekable points in the video. However, keyframes take significantly more bits to encode than non-keyframes, which can result in unnecessarily large files if the value is set too low. For most purposes, the default value is preferred.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | lKeyframeInterval | Keyframe interval (in frames) |
ON2_OK | The keyframe interval was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetKeyframeIntervalType | ( | FLIX2HANDLE | flix, | |
const FE2_VideoKeyframeTypes | keyframeIntervalType | |||
) |
Set the keyframe interval type.
Two keyframe modes are supported, MAX_KEYFRAMES (the default) and FIXED_KEYFRAMES. These specify that the keyframe interval set using video_options_SetKeyframeInterval() is either the maximum interval between keyframes or a fixed interval, respectively. In general, the compression codec does the best job of deciding when keyframes should be used, so setting the maximum interval is usually more appropriate.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | keyframeIntervalType | Keyframe interval type (one of FE2_VideoKeyframeTypes) |
ON2_OK | The keyframe interval was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetMaximumBitrate | ( | FLIX2HANDLE | flix, | |
const int32_t | lMaximumBitrate | |||
) |
Set the maximum bitrate target.
Sets the bitrate the compressor will target when encoding the video.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | lMaximumBitrate | Bitrate target (in Kbps) |
ON2_OK | The target bitrate was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetRateControlType | ( | FLIX2HANDLE | flix, | |
const FE2_VideoBitrateControls | rateControlType | |||
) |
Set the rate control type.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | rateControlType | Rate control type (one of FE2_VideoBitrateControls) |
ON2_OK | The rate control type was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |
on2sc video_options_SetSwfFramerate | ( | FLIX2HANDLE | flix, | |
const int32_t | swfFramerate | |||
) |
Sets the SWF framerate.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | swfFramerate | The SWF framerate. |
ON2_OK | The engine successfully set the SWF framerate. | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
on2sc video_options_SetUseMaximumBitrate | ( | FLIX2HANDLE | flix, | |
const on2bool | bUseMaximumBitrate | |||
) |
Enable/disable the maximum bitrate target value.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | bUseMaximumBitrate | New bitrate enable status. on2true to enable, on2false to disable. |
ON2_OK | The bitrate enable status was successfully set in the engine. |
on2sc video_options_SetVideoCodec | ( | FLIX2HANDLE | flix, | |
const FE2_VideoCodec | videoCodec | |||
) |
Select the video codec to be used.
[in] | flix | Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | videoCodec | New video codec (one of FE2_VideoCodec) |
ON2_OK | The video codec was successfully set in the engine. | |
ON2_INVALID_PARAMS | The value is out of range. |