OGMRipAudio

OGMRipAudio — Base class for audio codecs

Synopsis


#include <ogmrip-audio.h>


                    OGMRipAudio;
OGMDvdAudioStream*  ogmrip_audio_get_dvd_audio_stream   (OGMRipAudio *audio);
void                ogmrip_audio_set_dvd_audio_stream   (OGMRipAudio *audio,
                                                         OGMDvdAudioStream *stream);
gint                ogmrip_audio_get_channels           (OGMRipAudio *audio);
void                ogmrip_audio_set_channels           (OGMRipAudio *audio,
                                                         OGMDvdAudioChannels channels);
gboolean            ogmrip_audio_get_fast               (OGMRipAudio *audio);
void                ogmrip_audio_set_fast               (OGMRipAudio *audio,
                                                         gboolean fast);
gboolean            ogmrip_audio_get_normalize          (OGMRipAudio *audio);
void                ogmrip_audio_set_normalize          (OGMRipAudio *audio,
                                                         gboolean normalize);
gint                ogmrip_audio_get_quality            (OGMRipAudio *audio);
void                ogmrip_audio_set_quality            (OGMRipAudio *audio,
                                                         guint quality);
gint                ogmrip_audio_get_sample_rate        (OGMRipAudio *audio);
void                ogmrip_audio_set_sample_rate        (OGMRipAudio *audio,
                                                         guint srate);
gint                ogmrip_audio_get_samples_per_frame  (OGMRipAudio *audio);

Object Hierarchy


  GObject
   +----OGMJobSpawn
         +----OGMJobContainer
               +----OGMJobBin
                     +----OGMRipCodec
                           +----OGMRipAudio

Properties


  "channels"                 guint                 : Read / Write
  "fast"                     gboolean              : Read / Write
  "normalize"                gboolean              : Read / Write
  "quality"                  guint                 : Read / Write
  "samples-per-frame"        guint                 : Read
  "stream"                   gpointer              : Read / Write

Description

Details

OGMRipAudio

typedef struct _OGMRipAudio OGMRipAudio;


ogmrip_audio_get_dvd_audio_stream ()

OGMDvdAudioStream*  ogmrip_audio_get_dvd_audio_stream   (OGMRipAudio *audio);

Gets the audio stream to encode.

audio : an OGMRipAudio
Returns : an OGMDvdAudioStream, or NULL

ogmrip_audio_set_dvd_audio_stream ()

void                ogmrip_audio_set_dvd_audio_stream   (OGMRipAudio *audio,
                                                         OGMDvdAudioStream *stream);

Sets the audio stream to encode.

audio : an OGMRipAudio
stream : an OGMDvdAudioStream

ogmrip_audio_get_channels ()

gint                ogmrip_audio_get_channels           (OGMRipAudio *audio);

Gets the number of channels of the output file.

audio : an OGMRipAudio
Returns : an OGMDvdAudioChannels, or -1

ogmrip_audio_set_channels ()

void                ogmrip_audio_set_channels           (OGMRipAudio *audio,
                                                         OGMDvdAudioChannels channels);

Sets the number of channels of the output file.

audio : an OGMRipAudio
channels : an OGMDvdAudioChannels

ogmrip_audio_get_fast ()

gboolean            ogmrip_audio_get_fast               (OGMRipAudio *audio);

Returns whether to encode faster than realtime.

audio : an OGMRipAudio
Returns : TRUE if fast encoding is enabled

ogmrip_audio_set_fast ()

void                ogmrip_audio_set_fast               (OGMRipAudio *audio,
                                                         gboolean fast);

Sets whether to encode faster than realtime.

audio : an OGMRipAudio
fast : TRUE to enable fast encoding

ogmrip_audio_get_normalize ()

gboolean            ogmrip_audio_get_normalize          (OGMRipAudio *audio);

Returns whether the volume of the audio stream should be normalized.

audio : an OGMRipAudio
Returns : TRUE if normalization is enabled

ogmrip_audio_set_normalize ()

void                ogmrip_audio_set_normalize          (OGMRipAudio *audio,
                                                         gboolean normalize);

Sets whether to normalize the volume of the audio stream.

audio : an OGMRipAudio
normalize : TRUE to enable normalization

ogmrip_audio_get_quality ()

gint                ogmrip_audio_get_quality            (OGMRipAudio *audio);

Gets the quality of the encoding, 0 for lowest, 10 for best.

audio : an OGMRipAudio
Returns : the quality, or -1

ogmrip_audio_set_quality ()

void                ogmrip_audio_set_quality            (OGMRipAudio *audio,
                                                         guint quality);

Sets the quality of the encoding, 0 for lowest, 10 for best.

audio : an OGMRipAudio
quality : the quality of the encoding

ogmrip_audio_get_sample_rate ()

gint                ogmrip_audio_get_sample_rate        (OGMRipAudio *audio);

Gets the output sample rate.

audio : an OGMRipAudio
Returns : the sample rate

ogmrip_audio_set_sample_rate ()

void                ogmrip_audio_set_sample_rate        (OGMRipAudio *audio,
                                                         guint srate);

Sets the output sample rate to be used.

audio : an OGMRipAudio
srate : the sample rate

ogmrip_audio_get_samples_per_frame ()

gint                ogmrip_audio_get_samples_per_frame  (OGMRipAudio *audio);

Gets the number of samples per frame.

audio : an OGMRipAudio
Returns : the number of samples per frame, or -1

Property Details

The "channels" property

  "channels"                 guint                 : Read / Write

Set channels.

Allowed values: <= 10

Default value: 1


The "fast" property

  "fast"                     gboolean              : Read / Write

Set fast.

Default value: FALSE


The "normalize" property

  "normalize"                gboolean              : Read / Write

Set normalize.

Default value: FALSE


The "quality" property

  "quality"                  guint                 : Read / Write

Set quality.

Allowed values: <= 10

Default value: 3


The "samples-per-frame" property

  "samples-per-frame"        guint                 : Read

Set samples per frame.

Default value: 512


The "stream" property

  "stream"                   gpointer              : Read / Write

Set audio stream.