katetag

katetag — retags kate streams

Synopsis

                    GstKateTag;

Properties

  "category"                 gchar*                : Read / Write
  "language"                 gchar*                : Read / Write
  "original-canvas-height"   gint                  : Read / Write
  "original-canvas-width"    gint                  : Read / Write

Description

Example pipelines

The katetag element can change the tag contained within a raw kate stream. Specifically, it modifies the comments header packet of the kate stream, as well as the language and category of the kate stream.

The element will also process the stream as the kateparse element does so it can be used when remuxing an Ogg Kate stream, without additional elements.

Applications can set the tags to write using the GstTagSetter interface. Tags contained within the kate stream will be picked up automatically (and merged according to the merge mode set via the tag setter interface).

This element is only useful with gst-launch for modifying the language and/or category (which are properties of the stream located in the kate beginning of stream header), because it does not support setting the tags on a GstTagSetter interface. Conceptually, the element will usually be used like:

gst-launch -v filesrc location=foo.ogg ! oggdemux ! katetag ! oggmux ! filesink location=bar.ogg

This pipeline will set the language and category of the stream to the given values:

gst-launch -v filesrc location=foo.ogg ! oggdemux ! katetag language=pt_BR category=subtitles ! oggmux ! filesink location=bar.ogg

Synopsis

Element Information

plugin

kate

author

Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>

class

Formatter/Metadata

Element Pads

name

sink

direction

sink

presence

always

details

subtitle/x-kate

application/x-kate

name

src

direction

source

presence

always

details

subtitle/x-kate

application/x-kate

Details

GstKateTag

typedef struct {
  GstKateParse parse;

  gchar *language;
  gchar *category;
  gint original_canvas_width;
  gint original_canvas_height;
} GstKateTag;

Opaque data structure.

Property Details

The "category" property

  "category"                 gchar*                : Read / Write

Set the category of the stream.

Default value: ""


The "language" property

  "language"                 gchar*                : Read / Write

Set the language of the stream.

Default value: ""


The "original-canvas-height" property

  "original-canvas-height"   gint                  : Read / Write

Set the height of the canvas this stream was authored for (0 is unspecified).

Allowed values: >= 0

Default value: 0


The "original-canvas-width" property

  "original-canvas-width"    gint                  : Read / Write

Set the width of the canvas this stream was authored for (0 is unspecified).

Allowed values: >= 0

Default value: 0

See Also

#oggdemux, oggmux, kateparse, GstTagSetter