OGMRipSubpCodec

OGMRipSubpCodec — Base class for subtitles codecs

Synopsis


#include <ogmrip-subp-codec.h>

                    OGMRipSubpCodec;
                    OGMRipSubpCodecClass;
void                ogmrip_subp_codec_set_dvd_subp_stream
                                                        (OGMRipSubpCodec *subp,
                                                         OGMDvdSubpStream *stream);
OGMDvdSubpStream*   ogmrip_subp_codec_get_dvd_subp_stream
                                                        (OGMRipSubpCodec *subp);
gint                ogmrip_subp_codec_get_charset       (OGMRipSubpCodec *subp);
void                ogmrip_subp_codec_set_charset       (OGMRipSubpCodec *subp,
                                                         OGMRipCharset charset);
gint                ogmrip_subp_codec_get_newline       (OGMRipSubpCodec *subp);
void                ogmrip_subp_codec_set_newline       (OGMRipSubpCodec *subp,
                                                         OGMRipNewline newline);
gboolean            ogmrip_subp_codec_get_forced_only   (OGMRipSubpCodec *subp);
void                ogmrip_subp_codec_set_forced_only   (OGMRipSubpCodec *subp,
                                                         gboolean forced_only);
gchar*              ogmrip_subp_codec_get_label         (OGMRipSubpCodec *subp);
void                ogmrip_subp_codec_set_label         (OGMRipSubpCodec *subp,
                                                         const gchar *label);

Object Hierarchy

  GObject
   +----OGMJobSpawn
         +----OGMJobContainer
               +----OGMJobBin
                     +----OGMRipCodec
                           +----OGMRipSubpCodec

Properties

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

Description

Details

OGMRipSubpCodec

typedef struct _OGMRipSubpCodec OGMRipSubpCodec;

OGMRipSubpCodecClass

typedef struct {
  OGMRipCodecClass parent_class;
} OGMRipSubpCodecClass;

ogmrip_subp_codec_set_dvd_subp_stream ()

void                ogmrip_subp_codec_set_dvd_subp_stream
                                                        (OGMRipSubpCodec *subp,
                                                         OGMDvdSubpStream *stream);

Sets the subtitle stream to encode.

subp :

 an OGMRipSubpCodec

stream :

 an OGMDvdSubpStream

ogmrip_subp_codec_get_dvd_subp_stream ()

OGMDvdSubpStream*   ogmrip_subp_codec_get_dvd_subp_stream
                                                        (OGMRipSubpCodec *subp);

Gets the subtitle stream to encode.

subp :

 an OGMRipSubpCodec

Returns :

 an OGMDvdSubpStream, or NULL

ogmrip_subp_codec_get_charset ()

gint                ogmrip_subp_codec_get_charset       (OGMRipSubpCodec *subp);

Gets the character set of text subtitles

subp :

 an OGMRipSubpCodec

Returns :

 an OGMRipCharset, or -1

ogmrip_subp_codec_set_charset ()

void                ogmrip_subp_codec_set_charset       (OGMRipSubpCodec *subp,
                                                         OGMRipCharset charset);

Sets the character set of text subtitles

subp :

 an OGMRipSubpCodec

charset :

 the OGMRipCharset

ogmrip_subp_codec_get_newline ()

gint                ogmrip_subp_codec_get_newline       (OGMRipSubpCodec *subp);

Gets the end-of-line characters of text subtitles

subp :

 an OGMRipSubpCodec

Returns :

 the OGMRipNewline, or -1

ogmrip_subp_codec_set_newline ()

void                ogmrip_subp_codec_set_newline       (OGMRipSubpCodec *subp,
                                                         OGMRipNewline newline);

Sets the end-of-line characters of text subtitles

subp :

 an OGMRipSubpCodec

newline :

 the OGMRipNewline

ogmrip_subp_codec_get_forced_only ()

gboolean            ogmrip_subp_codec_get_forced_only   (OGMRipSubpCodec *subp);

Gets whether to extract forced subtitles only.

subp :

 an OGMRipSubpCodec

Returns :

 TRUE to extract forced subtitles only

ogmrip_subp_codec_set_forced_only ()

void                ogmrip_subp_codec_set_forced_only   (OGMRipSubpCodec *subp,
                                                         gboolean forced_only);

Sets whether to extract forced subtitles only.

subp :

 an OGMRipSubpCodec

forced_only :

 TRUE to extract forced subtitles only

ogmrip_subp_codec_get_label ()

gchar*              ogmrip_subp_codec_get_label         (OGMRipSubpCodec *subp);

Gets the name of the track.

subp :

 an OGMRipSubpCodec

Returns :

 the track name

ogmrip_subp_codec_set_label ()

void                ogmrip_subp_codec_set_label         (OGMRipSubpCodec *subp,
                                                         const gchar *label);

Sets the name of the track.

subp :

 an OGMRipSubpCodec

label :

 the track name

Property Details

The "charset" property

  "charset"                  guint                 : Read / Write

Set charset.

Allowed values: <= 2

Default value: 0

The "forced-only" property

  "forced-only"              gboolean              : Read / Write

Set forced only.

Default value: FALSE

The "newline" property

  "newline"                  guint                 : Read / Write

Set newline.

Allowed values: <= 1

Default value: 0

The "stream" property

  "stream"                   gpointer              : Read / Write

Set subp stream.

Generated by GTK-Doc V1.10