Enumerations | |
enum | FE2_FlvAudioFormat { FlvAudioUncompressed, FlvAudioMp3 } |
Valid output audio formats for use in calls to audio_options_GetFlvAudioFormat() and audio_options_SetFlvAudioFormat(). More... | |
enum | FE2_AudioSamplingrates { Hertz11025, Hertz22050, Hertz44100 } |
Sample rates for use with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter. More... | |
Functions | |
on2sc | audio_options_Reset (FLIX2HANDLE flix) |
Reset the audio encoding options to their default values. | |
on2sc | audio_options_Validate (FLIX2HANDLE flix) |
Validate the current audio encoding options. | |
on2sc | audio_options_SetBitrate (FLIX2HANDLE flix, const FE2_AudioBitrates bitrate) |
Set the bitrate to use in mp3 encoding. | |
on2sc | audio_options_GetBitrate (const FLIX2HANDLE flix, FE2_AudioBitrates *pBitrate) |
Retrieve the current mp3 bitrate. | |
on2sc | audio_options_SetFlvAudioFormat (FLIX2HANDLE flix, const FE2_FlvAudioFormat format) |
Set the output audio format. | |
on2sc | audio_options_GetFlvAudioFormat (const FLIX2HANDLE flix, FE2_FlvAudioFormat *pFormat) |
Retrieve the current output audio format. | |
on2sc | audio_options_SetSamplingrate (FLIX2HANDLE flix, const FE2_AudioSamplingrates samplingrate) |
Set the output audio sample rate. | |
on2sc | audio_options_GetSamplingrate (const FLIX2HANDLE flix, FE2_AudioSamplingrates *pSamplingrate) |
Retrieve the current output sample rate. | |
on2sc | audio_options_SetStereo (FLIX2HANDLE flix, const on2bool stereo) |
Set the number of output audio channels. | |
on2sc | audio_options_GetStereo (const FLIX2HANDLE flix, on2bool *pStereo) |
Retrieve the current number of output audio channels. |
Sample rates for use with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter.
Definition at line 70 of file audio_options.h.
enum FE2_FlvAudioFormat |
Valid output audio formats for use in calls to audio_options_GetFlvAudioFormat() and audio_options_SetFlvAudioFormat().
Definition at line 59 of file audio_options.h.
on2sc audio_options_GetBitrate | ( | const FLIX2HANDLE | flix, | |
FE2_AudioBitrates * | pBitrate | |||
) |
Retrieve the current mp3 bitrate.
Only has meaning when outputting FlvAudioMp3
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pBitrate | Storage location to receive the result |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
NULL
on2sc audio_options_GetFlvAudioFormat | ( | const FLIX2HANDLE | flix, | |
FE2_FlvAudioFormat * | pFormat | |||
) |
Retrieve the current output audio format.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pFormat | Storage location to receive the result |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
NULL
on2sc audio_options_GetSamplingrate | ( | const FLIX2HANDLE | flix, | |
FE2_AudioSamplingrates * | pSamplingrate | |||
) |
Retrieve the current output sample rate.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pSamplingrate | Storage location to receive the result |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
NULL
on2sc audio_options_GetStereo | ( | const FLIX2HANDLE | flix, | |
on2bool * | pStereo | |||
) |
Retrieve the current number of output audio channels.
Value indicates stereo (on2true
) or mono (on2false
)
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[out] | pStereo | Storage location to receive the result |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
NULL
on2sc audio_options_Reset | ( | FLIX2HANDLE | flix | ) |
Reset the audio encoding options to their default values.
Defaults are set as described by: audio_options_SetBitrate(), audio_options_SetFlvAudioFormat(), audio_options_SetSamplingrate() and audio_options_SetStereo()
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should the precondition fail |
NULL
on2sc audio_options_SetBitrate | ( | FLIX2HANDLE | flix, | |
const FE2_AudioBitrates | bitrate | |||
) |
Set the bitrate to use in mp3 encoding.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | bitrate | Bitrate to use encoding mp3 audio |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
on2sc audio_options_SetFlvAudioFormat | ( | FLIX2HANDLE | flix, | |
const FE2_FlvAudioFormat | format | |||
) |
Set the output audio format.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | format | Output audio format |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
on2sc audio_options_SetSamplingrate | ( | FLIX2HANDLE | flix, | |
const FE2_AudioSamplingrates | samplingrate | |||
) |
Set the output audio sample rate.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | samplingrate | Output audio sample rate |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should one or more of the preconditions fail |
NULL
on2sc audio_options_SetStereo | ( | FLIX2HANDLE | flix, | |
const on2bool | stereo | |||
) |
Set the number of output audio channels.
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
[in] | stereo | Indicates whether to encode stereo (on2true ) or mono (on2false ) |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should the precondition fail |
NULL
on2true
) on2false
) on2sc audio_options_Validate | ( | FLIX2HANDLE | flix | ) |
Validate the current audio encoding options.
Ensures the current audio options are sufficient to start encoding. The checks currently performed are:
[in] | flix | Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() |
ON2_OK | on success | |
ON2_INVALID_PARAMS | should the precondition fail |
NULL