.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "GStreamer::Event 3pm"
.TH GStreamer::Event 3pm "2012-03-01" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
GStreamer::Event \-  Structure describing events that are passed up and down a pipeline
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The various event types are represented as subclasses:
.IP "GStreamer::Event::FlushStart" 4
.IX Item "GStreamer::Event::FlushStart"
.PD 0
.IP "GStreamer::Event::FlushStop" 4
.IX Item "GStreamer::Event::FlushStop"
.IP "GStreamer::Event::EOS" 4
.IX Item "GStreamer::Event::EOS"
.IP "GStreamer::Event::NewSegment" 4
.IX Item "GStreamer::Event::NewSegment"
.IP "GStreamer::Event::Tag" 4
.IX Item "GStreamer::Event::Tag"
.IP "GStreamer::Event::BufferSize" 4
.IX Item "GStreamer::Event::BufferSize"
.IP "GStreamer::Event::QOS" 4
.IX Item "GStreamer::Event::QOS"
.IP "GStreamer::Event::Seek" 4
.IX Item "GStreamer::Event::Seek"
.IP "GStreamer::Event::Navigation" 4
.IX Item "GStreamer::Event::Navigation"
.IP "GStreamer::Event::Custom::UP" 4
.IX Item "GStreamer::Event::Custom::UP"
.IP "GStreamer::Event::Custom::DS" 4
.IX Item "GStreamer::Event::Custom::DS"
.IP "GStreamer::Event::Custom::DS::OOB" 4
.IX Item "GStreamer::Event::Custom::DS::OOB"
.IP "GStreamer::Event::Custom::Both" 4
.IX Item "GStreamer::Event::Custom::Both"
.IP "GStreamer::Event::Custom::Both::OOB" 4
.IX Item "GStreamer::Event::Custom::Both::OOB"
.PD
.PP
To create a new event, you call the constructor of the corresponding class.
.PP
To check if an event is of a certain type, use the \fItype\fR method:
.PP
.Vb 3
\&  if ($event \-> type eq "newsegment") {
\&    # ...
\&  }
\&
\&  elsif ($event \-> type eq "eos") {
\&    # ...
\&  }
.Ve
.PP
To get to the content of an event, call the corresponding accessor:
.PP
.Vb 7
\&  if ($event \-> type eq "newsegment") {
\&    my $update = $event \-> update;
\&    my $rate = $event \-> rate;
\&    my $format = $event \-> format;
\&    my $start_value = $event \-> start_value;
\&    my $stop_value = $event \-> stop_value;
\&    my $stream_time = $event \-> stream_time;
\&
\&    # ...
\&  }
\&
\&  elsif ($event \-> type eq "tag") {
\&    my $tag = $event \-> tag;
\&
\&    # ...
\&  }
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "structure = $event\->\fBget_structure\fP"
.el .SS "structure = \f(CW$event\fP\->\fBget_structure\fP"
.IX Subsection "structure = $event->get_structure"
.ie n .SS "eventtype = $event\->\fBtype\fP"
.el .SS "eventtype = \f(CW$event\fP\->\fBtype\fP"
.IX Subsection "eventtype = $event->type"
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum GStreamer::EventType"
.IX Subsection "enum GStreamer::EventType"
.IP "\(bu" 4
\&'unknown' / '\s-1GST_EVENT_UNKNOWN\s0'
.IP "\(bu" 4
\&'flush\-start' / '\s-1GST_EVENT_FLUSH_START\s0'
.IP "\(bu" 4
\&'flush\-stop' / '\s-1GST_EVENT_FLUSH_STOP\s0'
.IP "\(bu" 4
\&'eos' / '\s-1GST_EVENT_EOS\s0'
.IP "\(bu" 4
\&'newsegment' / '\s-1GST_EVENT_NEWSEGMENT\s0'
.IP "\(bu" 4
\&'tag' / '\s-1GST_EVENT_TAG\s0'
.IP "\(bu" 4
\&'buffersize' / '\s-1GST_EVENT_BUFFERSIZE\s0'
.IP "\(bu" 4
\&'sink\-message' / '\s-1GST_EVENT_SINK_MESSAGE\s0'
.IP "\(bu" 4
\&'qos' / '\s-1GST_EVENT_QOS\s0'
.IP "\(bu" 4
\&'seek' / '\s-1GST_EVENT_SEEK\s0'
.IP "\(bu" 4
\&'navigation' / '\s-1GST_EVENT_NAVIGATION\s0'
.IP "\(bu" 4
\&'latency' / '\s-1GST_EVENT_LATENCY\s0'
.IP "\(bu" 4
\&'step' / '\s-1GST_EVENT_STEP\s0'
.IP "\(bu" 4
\&'custom\-upstream' / '\s-1GST_EVENT_CUSTOM_UPSTREAM\s0'
.IP "\(bu" 4
\&'custom\-downstream' / '\s-1GST_EVENT_CUSTOM_DOWNSTREAM\s0'
.IP "\(bu" 4
\&'custom\-downstream\-oob' / '\s-1GST_EVENT_CUSTOM_DOWNSTREAM_OOB\s0'
.IP "\(bu" 4
\&'custom\-both' / '\s-1GST_EVENT_CUSTOM_BOTH\s0'
.IP "\(bu" 4
\&'custom\-both\-oob' / '\s-1GST_EVENT_CUSTOM_BOTH_OOB\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
GStreamer
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2005\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL\s0.  See GStreamer for a full notice.