Commit dbad1d42 authored by Tim-Philipp Müller's avatar Tim-Philipp Müller

docs: update

parent 4701696a
......@@ -1148,6 +1148,16 @@
<DEFAULT>85</DEFAULT>
</ARG>
<ARG>
<NAME>GstJpegEnc::idct-method</NAME>
<TYPE>GstIDCTMethod</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>IDCT Method</NICK>
<BLURB>The IDCT algorithm to use.</BLURB>
<DEFAULT>Faster, less accurate integer method</DEFAULT>
</ARG>
<ARG>
<NAME>GstSmokeEnc::keyframe</NAME>
<TYPE>gint</TYPE>
......@@ -20148,3 +20158,233 @@
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpBin::do-lost</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Do Lost</NICK>
<BLURB>Send an event downstream when a packet is lost.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpBin::latency</NAME>
<TYPE>guint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer latency in ms</NICK>
<BLURB>Default amount of ms to buffer in the jitterbuffers.</BLURB>
<DEFAULT>200</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpBin::sdes</NAME>
<TYPE>GstStructure*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>SDES</NICK>
<BLURB>The SDES items of this session.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpJitterBuffer::do-lost</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Do Lost</NICK>
<BLURB>Send an event downstream when a packet is lost.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpJitterBuffer::drop-on-latency</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Drop buffers when maximum latency is reached</NICK>
<BLURB>Tells the jitterbuffer to never exceed the given latency in size.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpJitterBuffer::latency</NAME>
<TYPE>guint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer latency in ms</NICK>
<BLURB>Amount of ms to buffer.</BLURB>
<DEFAULT>200</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpJitterBuffer::ts-offset</NAME>
<TYPE>gint64</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Timestamp Offset</NICK>
<BLURB>Adjust buffer timestamps with offset in nanoseconds.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::bandwidth</NAME>
<TYPE>gdouble</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Bandwidth</NICK>
<BLURB>The bandwidth of the session.</BLURB>
<DEFAULT>64000</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::internal-session</NAME>
<TYPE>RTPSession*</TYPE>
<RANGE></RANGE>
<FLAGS>r</FLAGS>
<NICK>Internal Session</NICK>
<BLURB>The internal RTPSession object.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::ntp-ns-base</NAME>
<TYPE>guint64</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>NTP base time</NICK>
<BLURB>The NTP base time corresponding to running_time 0.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::num-active-sources</NAME>
<TYPE>guint</TYPE>
<RANGE></RANGE>
<FLAGS>r</FLAGS>
<NICK>Num Active Sources</NICK>
<BLURB>The number of active sources in the session.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::num-sources</NAME>
<TYPE>guint</TYPE>
<RANGE></RANGE>
<FLAGS>r</FLAGS>
<NICK>Num Sources</NICK>
<BLURB>The number of sources in the session.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::rtcp-fraction</NAME>
<TYPE>gdouble</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>RTCP Fraction</NICK>
<BLURB>The fraction of the bandwidth used for RTCP.</BLURB>
<DEFAULT>3000</DEFAULT>
</ARG>
<ARG>
<NAME>GstRtpSession::sdes</NAME>
<TYPE>GstStructure*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>SDES</NICK>
<BLURB>The SDES items of this session.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::device</NAME>
<TYPE>gchar*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Device</NICK>
<BLURB>Device location.</BLURB>
<DEFAULT>"/dev/video1"</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::device-fd</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<FLAGS>r</FLAGS>
<NICK>File descriptor</NICK>
<BLURB>File descriptor of the device.</BLURB>
<DEFAULT>-1</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::device-name</NAME>
<TYPE>gchar*</TYPE>
<RANGE></RANGE>
<FLAGS>r</FLAGS>
<NICK>Device name</NICK>
<BLURB>Name of the device.</BLURB>
<DEFAULT>NULL</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::flags</NAME>
<TYPE>GstV4l2DeviceTypeFlags</TYPE>
<RANGE></RANGE>
<FLAGS>r</FLAGS>
<NICK>Flags</NICK>
<BLURB>Device type flags.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::overlay-height</NAME>
<TYPE>guint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Overlay height</NICK>
<BLURB>The height of the video overlay; default is equal to negotiated image height.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::overlay-left</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Overlay left</NICK>
<BLURB>The leftmost (x) coordinate of the video overlay; top left corner of screen is 0,0.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::overlay-top</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Overlay top</NICK>
<BLURB>The topmost (y) coordinate of the video overlay; top left corner of screen is 0,0.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::overlay-width</NAME>
<TYPE>guint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Overlay width</NICK>
<BLURB>The width of the video overlay; default is equal to negotiated image width.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstV4l2Sink::queue-size</NAME>
<TYPE>guint</TYPE>
<RANGE>[1,16]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Queue size</NICK>
<BLURB>Number of buffers to be enqueud in the driver in streaming mode.</BLURB>
<DEFAULT>8</DEFAULT>
</ARG>
GObject
GstObject
GstPad
GstInterleavePad
GstVideoMixerPad
GstInterleavePad
GstPadTemplate
GstPluginFeature
GstElementFactory
......@@ -11,31 +11,69 @@ GObject
GstElement
GstBin
GstPipeline
GstHalAudioSink
GstHalAudioSrc
GstGConfVideoSink
GstGConfVideoSrc
GstSwitchSink
GstGConfAudioSink
GstGConfAudioSrc
GstRTSPSrc
GstHalAudioSink
GstHalAudioSrc
GstRtpBin
GstAutoVideoSink
GstAutoVideoSrc
GstAutoAudioSink
GstAutoAudioSrc
GstRTSPSrc
GstRgVolume
GstAspectRatioCrop
GstCmmlEnc
GstCmmlDec
GstBaseSink
GstAASink
GstBaseAudioSink
GstPulseSink
GstAudioSink
GstEsdSink
GstOssSink
GstCACASink
GstVideoSink
GstGdkPixbufSink
GstV4l2Sink
GstShout2send
GstTest
GstMultiFileSink
GstMultiUDPSink
GstUDPSink
GstDynUDPSink
GstBaseSrc
GstPushSrc
GstDV1394Src
GstHDV1394Src
GstSoupHTTPSrc
GstBaseAudioSrc
GstAudioSrc
GstPulseSrc
GstOssSrc
GstV4l2Src
GstXImageSrc
GstMultiFileSrc
GstUDPSrc
GstWavpackParse
GstWavpackDec
GstWavpackEnc
GstDVDemux
GstDVDec
GstTagLibMux
GstId3v2Mux
GstApev2Mux
GstFlacEnc
GstFlacDec
GstFlacTag
GstCairoTextOverlay
GstBaseTransform
GstCairoTimeOverlay
GstPixbufScale
GstVideoBox
GstVideoFilter
GstNavigationtest
GstVideoBalance
GstVideoFlip
GstGamma
GstSMPTEAlpha
GstEdgeTV
GstAgingTV
GstDiceTV
......@@ -48,14 +86,24 @@ GObject
GstRadioacTV
GstStreakTV
GstRippleTV
GstNavigationtest
GstVideoFlip
GstVideoBalance
GstGamma
GstSMPTEAlpha
GstVideoBox
GstBreakMyData
GstNavSeek
GstProgressReport
GstTagInject
GstLevel
GstAlpha
GstAlphaColor
GstLevel
GstAudioFilter
GstIirEqualizer
GstIirEqualizerNBands
GstIirEqualizer3Bands
GstIirEqualizer10Bands
GstSpectrum
GstAudioInvert
GstAudioKaraoke
......@@ -70,95 +118,27 @@ GObject
GstAudioWSincBand
GstAudioFIRFilter
GstAudioEcho
GstIirEqualizer
GstIirEqualizerNBands
GstIirEqualizer3Bands
GstIirEqualizer10Bands
GstAudioPanorama
GstRgAnalysis
GstRgLimiter
GstVideoCrop
GstAudioPanorama
GstCairoRender
GstBaseSrc
GstPushSrc
GstSoupHTTPSrc
GstBaseAudioSrc
GstAudioSrc
GstPulseSrc
GstOssSrc
GstDV1394Src
GstHDV1394Src
GstXImageSrc
GstV4l2Src
GstUDPSrc
GstMultiFileSrc
GstBaseSink
GstCACASink
GstBaseAudioSink
GstPulseSink
GstAudioSink
GstEsdSink
GstOssSink
GstAASink
GstVideoSink
GstGdkPixbufSink
GstShout2send
GstTest
GstMultiUDPSink
GstUDPSink
GstDynUDPSink
GstMultiFileSink
GstPulseMixer
GstTagLibMux
GstId3v2Mux
GstApev2Mux
GstSpeexEnc
GstSpeexDec
GstJpegEnc
GstJpegDec
GstSmokeEnc
GstSmokeDec
GstDVDemux
GstDVDec
GstCmmlEnc
GstCmmlDec
GstFlacEnc
GstFlacDec
GstFlacTag
GstPngDec
GstPngEnc
GstGdkPixbuf
GstWavpackParse
GstWavpackDec
GstWavpackEnc
GstSpeexEnc
GstSpeexDec
GstOssMixerElement
GstRTPDec
GstICYDemux
GstWavParse
GstEbmlRead
GstMatroskaDemux
GstMatroskaMux
GstRndBufferSize
GstEFence
GstFlxDec
GstVideoMixer
GstTagDemux
GstApeDemux
GstID3Demux
GstGoom
GstGoom2k1
GstFLVDemux
GstFlvMux
GstMultipartDemux
GstMultipartMux
GstMuLawEnc
GstMuLawDec
GstALawEnc
GstALawDec
GstCutter
GstQTDemux
GstAviDemux
GstAviMux
GstAviSubtitle
GstRTPDepay
GstBaseRTPDepayload
GstRtpXQTDepay
GstRtpAC3Depay
GstRtpCELTDepay
GstRTPDVDepay
......@@ -182,24 +162,14 @@ GObject
GstRtpMP4VDepay
GstRtpMP4ADepay
GstRtpMP4GDepay
GstRtpQDM2Depay
GstRTPSirenDepay
GstRtpSPEEXDepay
GstRtpSV3VDepay
GstRtpTheoraDepay
GstRtpVorbisDepay
GstRtpVRawDepay
GstAviDemux
GstAviMux
GstAviSubtitle
GstSMPTE
GstInterleave
GstDeinterleave
GstY4mEncode
GstMonoscope
GstDeinterlace
GstWavEnc
GstAuParse
GstRTPDepay
GstRtpXQTDepay
GstBaseRTPPayload
GstRtpCELTPay
GstRTPDVPay
......@@ -229,6 +199,42 @@ GObject
GstRtpVorbisPay
GstRtpVRawPay
GstAsteriskh263
GstGoom
GstGoom2k1
GstWavEnc
GstRtpJitterBuffer
GstRtpPtDemux
GstRtpSession
GstRtpSsrcDemux
GstRndBufferSize
GstEFence
GstCutter
GstEbmlRead
GstMatroskaDemux
GstMatroskaMux
GstRTPDec
GstQTDemux
GstSMPTE
GstAuParse
GstMultipartDemux
GstMultipartMux
GstALawEnc
GstALawDec
GstMuLawEnc
GstMuLawDec
GstTagDemux
GstApeDemux
GstID3Demux
GstFlxDec
GstDeinterlace
GstY4mEncode
GstInterleave
GstDeinterleave
GstWavParse
GstFLVDemux
GstFlvMux
GstICYDemux
GstVideoMixer
GstBus
GstTask
GstTaskPool
......@@ -245,18 +251,21 @@ GObject
GstCmmlTagHead
GstCmmlTagClip
GstColorBalanceChannel
RTPSession
GstTunerNorm
GstTunerChannel
GstMixerTrack
GstMixerOptions
GdkPixbuf
GInterface
GTypePlugin
GstChildProxy
GstURIHandler
GstImplementsInterface
GstPropertyProbe
GstMixer
GstTagSetter
GstPreset
GstTagSetter
GstImplementsInterface
GstMixer
GstTuner
GstColorBalance
GstVideoOrientation
GstBin GstChildProxy
GstPipeline GstChildProxy
GstHalAudioSink GstChildProxy
GstHalAudioSrc GstChildProxy
GstGConfVideoSink GstChildProxy
GstGConfVideoSrc GstChildProxy
GstSwitchSink GstChildProxy
GstGConfAudioSink GstChildProxy
GstGConfAudioSrc GstChildProxy
GstRTSPSrc GstURIHandler GstChildProxy
GstHalAudioSink GstChildProxy
GstHalAudioSrc GstChildProxy
GstRtpBin GstChildProxy
GstAutoVideoSink GstChildProxy
GstAutoVideoSrc GstChildProxy
GstAutoAudioSink GstChildProxy
GstAutoAudioSrc GstChildProxy
GstRTSPSrc GstURIHandler GstChildProxy
GstRgVolume GstChildProxy
GstAspectRatioCrop GstChildProxy
GstVideoBalance GstImplementsInterface GstColorBalance
GstIirEqualizer GstChildProxy
GstIirEqualizerNBands GstChildProxy
GstIirEqualizer3Bands GstChildProxy GstPreset
GstIirEqualizer10Bands GstChildProxy GstPreset
GstSoupHTTPSrc GstURIHandler
GstPulseSrc GstImplementsInterface GstPropertyProbe GstMixer
GstOssSrc GstImplementsInterface GstMixer
GstPulseSink GstPropertyProbe GstImplementsInterface
GstV4l2Sink GstPropertyProbe GstImplementsInterface GstColorBalance GstVideoOrientation
GstShout2send GstTagSetter
GstUDPSink GstURIHandler
GstDV1394Src GstURIHandler GstPropertyProbe
GstHDV1394Src GstURIHandler GstPropertyProbe
GstV4l2Src GstImplementsInterface GstPropertyProbe GstTuner GstColorBalance GstVideoOrientation
GstSoupHTTPSrc GstURIHandler
GstPulseSrc GstPropertyProbe GstImplementsInterface GstMixer
GstOssSrc GstImplementsInterface GstMixer
GstV4l2Src GstPropertyProbe GstImplementsInterface GstTuner GstColorBalance GstVideoOrientation
GstUDPSrc GstURIHandler
GstPulseSink GstImplementsInterface GstPropertyProbe
GstShout2send GstTagSetter
GstUDPSink GstURIHandler
GstPulseMixer GstImplementsInterface GstPropertyProbe GstMixer
GstWavpackEnc GstPreset
GstTagLibMux GstTagSetter
GstId3v2Mux GstTagSetter
GstApev2Mux GstTagSetter
GstFlacEnc GstTagSetter GstPreset
GstFlacEnc GstPreset GstTagSetter
GstFlacTag GstTagSetter
GstWavpackEnc GstPreset
GstSpeexEnc GstTagSetter GstPreset
GstVideoBalance GstImplementsInterface GstColorBalance
GstIirEqualizer GstChildProxy
GstIirEqualizerNBands GstChildProxy
GstIirEqualizer3Bands GstChildProxy GstPreset
GstIirEqualizer10Bands GstChildProxy GstPreset
GstPulseMixer GstPropertyProbe GstImplementsInterface GstMixer
GstSpeexEnc GstPreset GstTagSetter
GstOssMixerElement GstImplementsInterface GstMixer
GstMatroskaMux GstTagSetter
GstVideoMixer GstChildProxy
GstFlvMux GstTagSetter
GstAviMux GstTagSetter
GstMatroskaMux GstTagSetter
GstDeinterlace GstChildProxy
GstFlvMux GstTagSetter
GstVideoMixer GstChildProxy
GstChildProxy GstObject
GstTagSetter GstObject GstElement
GstImplementsInterface GstObject GstElement
GstMixer GstObject GstImplementsInterface GstElement
GstTagSetter GstObject GstElement
GstTuner GstObject GstImplementsInterface GstElement
GstColorBalance GstObject GstImplementsInterface GstElement
GstVideoOrientation GstObject GstImplementsInterface GstElement
......@@ -348,3 +348,299 @@ GstAudioIIRFilter *gstaudioiirfilter
gint arg1
</SIGNAL>
<SIGNAL>
<NAME>GstRtpBin::clear-pt-map</NAME>
<RETURNS>void</RETURNS>
<FLAGS>la</FLAGS>
GstRtpBin *gstrtpbin
</SIGNAL>
<SIGNAL>
<NAME>GstRtpBin::get-internal-session</NAME>
<RETURNS>RTPSession*</RETURNS>
<FLAGS>la</FLAGS>
GstRtpBin *gstrtpbin
guint arg1
</SIGNAL>
<SIGNAL>
<NAME>GstRtpBin::on-bye-ssrc</NAME>
<RETURNS>void</RETURNS>