Deprecated
[Audio Encoding Options]


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.

Enumeration Type Documentation

Sample rates for use with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter.

Deprecated:
With the addition of new Muxers the allowed sample rates will change. For this reason the desired value should be entered directly in Flix2_FilterSetParam().
Enumerator:
Hertz11025 
Hertz22050 
Hertz44100 

Definition at line 70 of file audio_options.h.

Valid output audio formats for use in calls to audio_options_GetFlvAudioFormat() and audio_options_SetFlvAudioFormat().

Deprecated:
Use the Codec Interface. This enumeration will be removed in a future release. See also: Audio Codecs.
Enumerator:
FlvAudioUncompressed 
FlvAudioMp3 

Definition at line 59 of file audio_options.h.


Function Documentation

on2sc audio_options_GetBitrate ( const FLIX2HANDLE  flix,
FE2_AudioBitrates pBitrate 
)

Retrieve the current mp3 bitrate.

Only has meaning when outputting FlvAudioMp3

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
Note:
Default: Bitrate64kbps
Deprecated:
Use the Codec Interface along with the FE2_CODECPARAM_BITRATE parameter. This function will be removed in a future release. See also: Audio Codecs.

on2sc audio_options_GetFlvAudioFormat ( const FLIX2HANDLE  flix,
FE2_FlvAudioFormat pFormat 
)

Retrieve the current output audio format.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pFormat 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
pFormat is not NULL
Deprecated:
Use the Codec Interface. This function will be removed in a future release. See also: Audio Codecs.

on2sc audio_options_GetSamplingrate ( const FLIX2HANDLE  flix,
FE2_AudioSamplingrates pSamplingrate 
)

Retrieve the current output sample rate.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pSamplingrate 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
pSamplingrate is not NULL
Note:
How the default output sample rate is determined is described by audio_options_SetSamplingrate()
Deprecated:
Use the Filter Interface along with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter.

on2sc audio_options_GetStereo ( const FLIX2HANDLE  flix,
on2bool pStereo 
)

Retrieve the current number of output audio channels.

Value indicates stereo (on2true) or mono (on2false)

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pStereo 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
pStereo is not NULL
Deprecated:
Use the Codec Interface along with the FE2_LAME_CHANNELS parameter. This function will be removed in a future release. See also: Audio Codecs.

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()

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should the precondition fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
Deprecated:
Use the Codec and Filter interfaces.

on2sc audio_options_SetBitrate ( FLIX2HANDLE  flix,
const FE2_AudioBitrates  bitrate 
)

Set the bitrate to use in mp3 encoding.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] bitrate Bitrate to use encoding mp3 audio
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
bitrate is a valid member of FE2_AudioBitrates
Note:
Default: Bitrate64kbps
Deprecated:
Use the Codec Interface along with the FE2_CODECPARAM_BITRATE parameter. This function will be removed in a future release. See also: Audio Codecs.

on2sc audio_options_SetFlvAudioFormat ( FLIX2HANDLE  flix,
const FE2_FlvAudioFormat  format 
)

Set the output audio format.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] format Output audio format
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
format is a valid member of FE2_FlvAudioFormat
Note:
Default: FlvAudioMp3
Deprecated:
Use the Codec Interface. This function will be removed in a future release. See also: Audio Codecs.

on2sc audio_options_SetSamplingrate ( FLIX2HANDLE  flix,
const FE2_AudioSamplingrates  samplingrate 
)

Set the output audio sample rate.

Parameters:
[in] flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx()
[in] samplingrate Output audio sample rate
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
samplingrate is a valid member of FE2_AudioSamplingrates
Remarks:
Flash video files are limited by what sample rate audio they can store. The default output sample rate is determined using the source file attributes in the following manner:
  • source sample rate < 16000Hz, set default to Hertz11025
  • source sample rate >= 16000Hz and < 32000Hz, set default to Hertz22050
  • source sample rate >= 32000Hz, set default to Hertz44100
Deprecated:
Use the Filter Interface along with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter.

on2sc audio_options_SetStereo ( FLIX2HANDLE  flix,
const on2bool  stereo 
)

Set the number of output audio channels.

Parameters:
[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)
Return values:
ON2_OK on success
ON2_INVALID_PARAMS should the precondition fail
ON2_NET_ERROR the underlying communication layer failed
Precondition:
flix is not NULL
Remarks:
Flash video files are limited by the number of output audio channels they can store. The default output number of channels is determined using the source file attributes in the following manner:
  • input number of channels == 2, set default to: stereo (on2true)
  • otherwise, set default to: mono (on2false)
Deprecated:
Use the Codec Interface along with the FE2_LAME_CHANNELS parameter. This function will be removed in a future release. See also: Audio Codecs.

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:


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