OGMRipSubp

OGMRipSubp — Base class for subtitles codecs

Synopsis


#include <ogmrip-subp.h>


                    OGMRipSubp;
void                ogmrip_subp_set_dvd_subp_stream     (OGMRipSubp *subp,
                                                         OGMDvdSubpStream *stream);
OGMDvdSubpStream*   ogmrip_subp_get_dvd_subp_stream     (OGMRipSubp *subp);
gint                ogmrip_subp_get_charset             (OGMRipSubp *subp);
void                ogmrip_subp_set_charset             (OGMRipSubp *subp,
                                                         OGMRipCharset charset);
gint                ogmrip_subp_get_eol_style           (OGMRipSubp *subp);
void                ogmrip_subp_set_eol_style           (OGMRipSubp *subp,
                                                         OGMRipEolStyle eol);
gboolean            ogmrip_subp_get_forced_only         (OGMRipSubp *subp);
void                ogmrip_subp_set_forced_only         (OGMRipSubp *subp,
                                                         gboolean forced_only);

Object Hierarchy


  GObject
   +----OGMJobSpawn
         +----OGMJobContainer
               +----OGMJobBin
                     +----OGMRipCodec
                           +----OGMRipSubp

Properties


  "charset"                  guint                 : Read / Write
  "eol"                      guint                 : Read / Write
  "forced-only"              gboolean              : Read / Write
  "stream"                   gpointer              : Read / Write

Description

Details

OGMRipSubp

typedef struct _OGMRipSubp OGMRipSubp;


ogmrip_subp_set_dvd_subp_stream ()

void                ogmrip_subp_set_dvd_subp_stream     (OGMRipSubp *subp,
                                                         OGMDvdSubpStream *stream);

Sets the subtitle stream to encode.

subp : an OGMRipSubp
stream : an OGMDvdSubpStream

ogmrip_subp_get_dvd_subp_stream ()

OGMDvdSubpStream*   ogmrip_subp_get_dvd_subp_stream     (OGMRipSubp *subp);

Gets the subtitle stream to encode.

subp : an OGMRipSubp
Returns : an OGMDvdSubpStream, or NULL

ogmrip_subp_get_charset ()

gint                ogmrip_subp_get_charset             (OGMRipSubp *subp);

Gets the character set of text subtitles

subp : an OGMRipSubp
Returns : an OGMRipCharset, or -1

ogmrip_subp_set_charset ()

void                ogmrip_subp_set_charset             (OGMRipSubp *subp,
                                                         OGMRipCharset charset);

Sets the character set of text subtitles

subp : an OGMRipSubp
charset : the OGMRipCharset

ogmrip_subp_get_eol_style ()

gint                ogmrip_subp_get_eol_style           (OGMRipSubp *subp);

Gets the end-of-line characters of text subtitles

subp : an OGMRipSubp
Returns : the OGMRipEolStyle, or -1

ogmrip_subp_set_eol_style ()

void                ogmrip_subp_set_eol_style           (OGMRipSubp *subp,
                                                         OGMRipEolStyle eol);

Sets the end-of-line characters of text subtitles

subp : an OGMRipSubp
eol : the OGMRipEolStyle

ogmrip_subp_get_forced_only ()

gboolean            ogmrip_subp_get_forced_only         (OGMRipSubp *subp);

Gets whether to extract forced subtitles only.

subp : an OGMRipSubp
Returns : TRUE to extract forced subtitles only

ogmrip_subp_set_forced_only ()

void                ogmrip_subp_set_forced_only         (OGMRipSubp *subp,
                                                         gboolean forced_only);

Sets whether to extract forced subtitles only.

subp : an OGMRipSubp
forced_only : TRUE to extract forced subtitles only

Property Details

The "charset" property

  "charset"                  guint                 : Read / Write

Set charset.

Allowed values: <= 2

Default value: 0


The "eol" property

  "eol"                      guint                 : Read / Write

Set end of line style.

Allowed values: <= 1

Default value: 0


The "forced-only" property

  "forced-only"              gboolean              : Read / Write

Set forced only.

Default value: FALSE


The "stream" property

  "stream"                   gpointer              : Read / Write

Set subp stream.