GstApp-1.0.gir 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511
  1. <?xml version="1.0"?>
  2. <!-- This file was automatically generated from C sources - DO NOT EDIT!
  3. To affect the contents of this file, edit the original C definitions,
  4. and/or use gtk-doc annotations. -->
  5. <repository version="1.2"
  6. xmlns="http://www.gtk.org/introspection/core/1.0"
  7. xmlns:c="http://www.gtk.org/introspection/c/1.0"
  8. xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
  9. <include name="Gst" version="1.0"/>
  10. <include name="GstBase" version="1.0"/>
  11. <package name="gstreamer-app-1.0"/>
  12. <c:include name="gst/app/app.h"/>
  13. <namespace name="GstApp"
  14. version="1.0"
  15. shared-library="libgstapp-1.0.so.0"
  16. c:identifier-prefixes="Gst"
  17. c:symbol-prefixes="gst">
  18. <class name="AppSink"
  19. c:symbol-prefix="app_sink"
  20. c:type="GstAppSink"
  21. parent="GstBase.BaseSink"
  22. glib:type-name="GstAppSink"
  23. glib:get-type="gst_app_sink_get_type"
  24. glib:type-struct="AppSinkClass">
  25. <doc xml:space="preserve">Appsink is a sink plugin that supports many different methods for making
  26. the application get a handle on the GStreamer data in a pipeline. Unlike
  27. most GStreamer elements, Appsink provides external API functions.
  28. appsink can be used by linking to the gstappsink.h header file to access the
  29. methods or by using the appsink action signals and properties.
  30. The normal way of retrieving samples from appsink is by using the
  31. gst_app_sink_pull_sample() and gst_app_sink_pull_preroll() methods.
  32. These methods block until a sample becomes available in the sink or when the
  33. sink is shut down or reaches EOS.
  34. Appsink will internally use a queue to collect buffers from the streaming
  35. thread. If the application is not pulling samples fast enough, this queue
  36. will consume a lot of memory over time. The "max-buffers" property can be
  37. used to limit the queue size. The "drop" property controls whether the
  38. streaming thread blocks or if older buffers are dropped when the maximum
  39. queue size is reached. Note that blocking the streaming thread can negatively
  40. affect real-time performance and should be avoided.
  41. If a blocking behaviour is not desirable, setting the "emit-signals" property
  42. to %TRUE will make appsink emit the "new-sample" and "new-preroll" signals
  43. when a sample can be pulled without blocking.
  44. The "caps" property on appsink can be used to control the formats that
  45. appsink can receive. This property can contain non-fixed caps, the format of
  46. the pulled samples can be obtained by getting the sample caps.
  47. If one of the pull-preroll or pull-sample methods return %NULL, the appsink
  48. is stopped or in the EOS state. You can check for the EOS state with the
  49. "eos" property or with the gst_app_sink_is_eos() method.
  50. The eos signal can also be used to be informed when the EOS state is reached
  51. to avoid polling.</doc>
  52. <implements name="Gst.URIHandler"/>
  53. <virtual-method name="eos">
  54. <return-value transfer-ownership="none">
  55. <type name="none" c:type="void"/>
  56. </return-value>
  57. <parameters>
  58. <instance-parameter name="appsink" transfer-ownership="none">
  59. <type name="AppSink" c:type="GstAppSink*"/>
  60. </instance-parameter>
  61. </parameters>
  62. </virtual-method>
  63. <virtual-method name="new_preroll">
  64. <return-value transfer-ownership="none">
  65. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  66. </return-value>
  67. <parameters>
  68. <instance-parameter name="appsink" transfer-ownership="none">
  69. <type name="AppSink" c:type="GstAppSink*"/>
  70. </instance-parameter>
  71. </parameters>
  72. </virtual-method>
  73. <virtual-method name="new_sample">
  74. <return-value transfer-ownership="none">
  75. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  76. </return-value>
  77. <parameters>
  78. <instance-parameter name="appsink" transfer-ownership="none">
  79. <type name="AppSink" c:type="GstAppSink*"/>
  80. </instance-parameter>
  81. </parameters>
  82. </virtual-method>
  83. <virtual-method name="pull_preroll" invoker="pull_preroll">
  84. <doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
  85. appsink to preroll in the PAUSED state. This sample can be pulled many times
  86. and remains available to the application even after EOS.
  87. This function is typically used when dealing with a pipeline in the PAUSED
  88. state. Calling this function after doing a seek will give the sample right
  89. after the seek position.
  90. Note that the preroll sample will also be returned as the first sample
  91. when calling gst_app_sink_pull_sample().
  92. If an EOS event was received before any buffers, this function returns
  93. %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
  94. This function blocks until a preroll sample or EOS is received or the appsink
  95. element is set to the READY/NULL state.</doc>
  96. <return-value transfer-ownership="full">
  97. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
  98. Call gst_sample_unref() after usage.</doc>
  99. <type name="Gst.Sample" c:type="GstSample*"/>
  100. </return-value>
  101. <parameters>
  102. <instance-parameter name="appsink" transfer-ownership="none">
  103. <doc xml:space="preserve">a #GstAppSink</doc>
  104. <type name="AppSink" c:type="GstAppSink*"/>
  105. </instance-parameter>
  106. </parameters>
  107. </virtual-method>
  108. <virtual-method name="pull_sample" invoker="pull_sample">
  109. <doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
  110. element is set to the READY/NULL state.
  111. This function will only return samples when the appsink is in the PLAYING
  112. state. All rendered buffers will be put in a queue so that the application
  113. can pull samples at its own rate. Note that when the application does not
  114. pull samples fast enough, the queued buffers could consume a lot of memory,
  115. especially when dealing with raw video frames.
  116. If an EOS event was received before any buffers, this function returns
  117. %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
  118. <return-value transfer-ownership="full">
  119. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
  120. Call gst_sample_unref() after usage.</doc>
  121. <type name="Gst.Sample" c:type="GstSample*"/>
  122. </return-value>
  123. <parameters>
  124. <instance-parameter name="appsink" transfer-ownership="none">
  125. <doc xml:space="preserve">a #GstAppSink</doc>
  126. <type name="AppSink" c:type="GstAppSink*"/>
  127. </instance-parameter>
  128. </parameters>
  129. </virtual-method>
  130. <method name="get_caps" c:identifier="gst_app_sink_get_caps">
  131. <doc xml:space="preserve">Get the configured caps on @appsink.</doc>
  132. <return-value transfer-ownership="full">
  133. <doc xml:space="preserve">the #GstCaps accepted by the sink. gst_caps_unref() after usage.</doc>
  134. <type name="Gst.Caps" c:type="GstCaps*"/>
  135. </return-value>
  136. <parameters>
  137. <instance-parameter name="appsink" transfer-ownership="none">
  138. <doc xml:space="preserve">a #GstAppSink</doc>
  139. <type name="AppSink" c:type="GstAppSink*"/>
  140. </instance-parameter>
  141. </parameters>
  142. </method>
  143. <method name="get_drop" c:identifier="gst_app_sink_get_drop">
  144. <doc xml:space="preserve">Check if @appsink will drop old buffers when the maximum amount of queued
  145. buffers is reached.</doc>
  146. <return-value transfer-ownership="none">
  147. <doc xml:space="preserve">%TRUE if @appsink is dropping old buffers when the queue is
  148. filled.</doc>
  149. <type name="gboolean" c:type="gboolean"/>
  150. </return-value>
  151. <parameters>
  152. <instance-parameter name="appsink" transfer-ownership="none">
  153. <doc xml:space="preserve">a #GstAppSink</doc>
  154. <type name="AppSink" c:type="GstAppSink*"/>
  155. </instance-parameter>
  156. </parameters>
  157. </method>
  158. <method name="get_emit_signals"
  159. c:identifier="gst_app_sink_get_emit_signals">
  160. <doc xml:space="preserve">Check if appsink will emit the "new-preroll" and "new-sample" signals.</doc>
  161. <return-value transfer-ownership="none">
  162. <doc xml:space="preserve">%TRUE if @appsink is emiting the "new-preroll" and "new-sample"
  163. signals.</doc>
  164. <type name="gboolean" c:type="gboolean"/>
  165. </return-value>
  166. <parameters>
  167. <instance-parameter name="appsink" transfer-ownership="none">
  168. <doc xml:space="preserve">a #GstAppSink</doc>
  169. <type name="AppSink" c:type="GstAppSink*"/>
  170. </instance-parameter>
  171. </parameters>
  172. </method>
  173. <method name="get_max_buffers"
  174. c:identifier="gst_app_sink_get_max_buffers">
  175. <doc xml:space="preserve">Get the maximum amount of buffers that can be queued in @appsink.</doc>
  176. <return-value transfer-ownership="none">
  177. <doc xml:space="preserve">The maximum amount of buffers that can be queued.</doc>
  178. <type name="guint" c:type="guint"/>
  179. </return-value>
  180. <parameters>
  181. <instance-parameter name="appsink" transfer-ownership="none">
  182. <doc xml:space="preserve">a #GstAppSink</doc>
  183. <type name="AppSink" c:type="GstAppSink*"/>
  184. </instance-parameter>
  185. </parameters>
  186. </method>
  187. <method name="get_wait_on_eos"
  188. c:identifier="gst_app_sink_get_wait_on_eos">
  189. <doc xml:space="preserve">Check if @appsink will wait for all buffers to be consumed when an EOS is
  190. received.</doc>
  191. <return-value transfer-ownership="none">
  192. <doc xml:space="preserve">%TRUE if @appsink will wait for all buffers to be consumed when an
  193. EOS is received.</doc>
  194. <type name="gboolean" c:type="gboolean"/>
  195. </return-value>
  196. <parameters>
  197. <instance-parameter name="appsink" transfer-ownership="none">
  198. <doc xml:space="preserve">a #GstAppSink</doc>
  199. <type name="AppSink" c:type="GstAppSink*"/>
  200. </instance-parameter>
  201. </parameters>
  202. </method>
  203. <method name="is_eos" c:identifier="gst_app_sink_is_eos">
  204. <doc xml:space="preserve">Check if @appsink is EOS, which is when no more samples can be pulled because
  205. an EOS event was received.
  206. This function also returns %TRUE when the appsink is not in the PAUSED or
  207. PLAYING state.</doc>
  208. <return-value transfer-ownership="none">
  209. <doc xml:space="preserve">%TRUE if no more samples can be pulled and the appsink is EOS.</doc>
  210. <type name="gboolean" c:type="gboolean"/>
  211. </return-value>
  212. <parameters>
  213. <instance-parameter name="appsink" transfer-ownership="none">
  214. <doc xml:space="preserve">a #GstAppSink</doc>
  215. <type name="AppSink" c:type="GstAppSink*"/>
  216. </instance-parameter>
  217. </parameters>
  218. </method>
  219. <method name="pull_preroll" c:identifier="gst_app_sink_pull_preroll">
  220. <doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
  221. appsink to preroll in the PAUSED state. This sample can be pulled many times
  222. and remains available to the application even after EOS.
  223. This function is typically used when dealing with a pipeline in the PAUSED
  224. state. Calling this function after doing a seek will give the sample right
  225. after the seek position.
  226. Note that the preroll sample will also be returned as the first sample
  227. when calling gst_app_sink_pull_sample().
  228. If an EOS event was received before any buffers, this function returns
  229. %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
  230. This function blocks until a preroll sample or EOS is received or the appsink
  231. element is set to the READY/NULL state.</doc>
  232. <return-value transfer-ownership="full">
  233. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
  234. Call gst_sample_unref() after usage.</doc>
  235. <type name="Gst.Sample" c:type="GstSample*"/>
  236. </return-value>
  237. <parameters>
  238. <instance-parameter name="appsink" transfer-ownership="none">
  239. <doc xml:space="preserve">a #GstAppSink</doc>
  240. <type name="AppSink" c:type="GstAppSink*"/>
  241. </instance-parameter>
  242. </parameters>
  243. </method>
  244. <method name="pull_sample" c:identifier="gst_app_sink_pull_sample">
  245. <doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
  246. element is set to the READY/NULL state.
  247. This function will only return samples when the appsink is in the PLAYING
  248. state. All rendered buffers will be put in a queue so that the application
  249. can pull samples at its own rate. Note that when the application does not
  250. pull samples fast enough, the queued buffers could consume a lot of memory,
  251. especially when dealing with raw video frames.
  252. If an EOS event was received before any buffers, this function returns
  253. %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
  254. <return-value transfer-ownership="full">
  255. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
  256. Call gst_sample_unref() after usage.</doc>
  257. <type name="Gst.Sample" c:type="GstSample*"/>
  258. </return-value>
  259. <parameters>
  260. <instance-parameter name="appsink" transfer-ownership="none">
  261. <doc xml:space="preserve">a #GstAppSink</doc>
  262. <type name="AppSink" c:type="GstAppSink*"/>
  263. </instance-parameter>
  264. </parameters>
  265. </method>
  266. <method name="set_callbacks"
  267. c:identifier="gst_app_sink_set_callbacks"
  268. introspectable="0">
  269. <doc xml:space="preserve">Set callbacks which will be executed for each new preroll, new sample and eos.
  270. This is an alternative to using the signals, it has lower overhead and is thus
  271. less expensive, but also less flexible.
  272. If callbacks are installed, no signals will be emitted for performance
  273. reasons.</doc>
  274. <return-value transfer-ownership="none">
  275. <type name="none" c:type="void"/>
  276. </return-value>
  277. <parameters>
  278. <instance-parameter name="appsink" transfer-ownership="none">
  279. <doc xml:space="preserve">a #GstAppSink</doc>
  280. <type name="AppSink" c:type="GstAppSink*"/>
  281. </instance-parameter>
  282. <parameter name="callbacks" transfer-ownership="none">
  283. <doc xml:space="preserve">the callbacks</doc>
  284. <type name="AppSinkCallbacks" c:type="GstAppSinkCallbacks*"/>
  285. </parameter>
  286. <parameter name="user_data"
  287. transfer-ownership="none"
  288. nullable="1"
  289. allow-none="1">
  290. <doc xml:space="preserve">a user_data argument for the callbacks</doc>
  291. <type name="gpointer" c:type="gpointer"/>
  292. </parameter>
  293. <parameter name="notify" transfer-ownership="none" scope="async">
  294. <doc xml:space="preserve">a destroy notify function</doc>
  295. <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
  296. </parameter>
  297. </parameters>
  298. </method>
  299. <method name="set_caps" c:identifier="gst_app_sink_set_caps">
  300. <doc xml:space="preserve">Set the capabilities on the appsink element. This function takes
  301. a copy of the caps structure. After calling this method, the sink will only
  302. accept caps that match @caps. If @caps is non-fixed, or incomplete,
  303. you must check the caps on the samples to get the actual used caps.</doc>
  304. <return-value transfer-ownership="none">
  305. <type name="none" c:type="void"/>
  306. </return-value>
  307. <parameters>
  308. <instance-parameter name="appsink" transfer-ownership="none">
  309. <doc xml:space="preserve">a #GstAppSink</doc>
  310. <type name="AppSink" c:type="GstAppSink*"/>
  311. </instance-parameter>
  312. <parameter name="caps" transfer-ownership="none">
  313. <doc xml:space="preserve">caps to set</doc>
  314. <type name="Gst.Caps" c:type="const GstCaps*"/>
  315. </parameter>
  316. </parameters>
  317. </method>
  318. <method name="set_drop" c:identifier="gst_app_sink_set_drop">
  319. <doc xml:space="preserve">Instruct @appsink to drop old buffers when the maximum amount of queued
  320. buffers is reached.</doc>
  321. <return-value transfer-ownership="none">
  322. <type name="none" c:type="void"/>
  323. </return-value>
  324. <parameters>
  325. <instance-parameter name="appsink" transfer-ownership="none">
  326. <doc xml:space="preserve">a #GstAppSink</doc>
  327. <type name="AppSink" c:type="GstAppSink*"/>
  328. </instance-parameter>
  329. <parameter name="drop" transfer-ownership="none">
  330. <doc xml:space="preserve">the new state</doc>
  331. <type name="gboolean" c:type="gboolean"/>
  332. </parameter>
  333. </parameters>
  334. </method>
  335. <method name="set_emit_signals"
  336. c:identifier="gst_app_sink_set_emit_signals">
  337. <doc xml:space="preserve">Make appsink emit the "new-preroll" and "new-sample" signals. This option is
  338. by default disabled because signal emission is expensive and unneeded when
  339. the application prefers to operate in pull mode.</doc>
  340. <return-value transfer-ownership="none">
  341. <type name="none" c:type="void"/>
  342. </return-value>
  343. <parameters>
  344. <instance-parameter name="appsink" transfer-ownership="none">
  345. <doc xml:space="preserve">a #GstAppSink</doc>
  346. <type name="AppSink" c:type="GstAppSink*"/>
  347. </instance-parameter>
  348. <parameter name="emit" transfer-ownership="none">
  349. <doc xml:space="preserve">the new state</doc>
  350. <type name="gboolean" c:type="gboolean"/>
  351. </parameter>
  352. </parameters>
  353. </method>
  354. <method name="set_max_buffers"
  355. c:identifier="gst_app_sink_set_max_buffers">
  356. <doc xml:space="preserve">Set the maximum amount of buffers that can be queued in @appsink. After this
  357. amount of buffers are queued in appsink, any more buffers will block upstream
  358. elements until a sample is pulled from @appsink.</doc>
  359. <return-value transfer-ownership="none">
  360. <type name="none" c:type="void"/>
  361. </return-value>
  362. <parameters>
  363. <instance-parameter name="appsink" transfer-ownership="none">
  364. <doc xml:space="preserve">a #GstAppSink</doc>
  365. <type name="AppSink" c:type="GstAppSink*"/>
  366. </instance-parameter>
  367. <parameter name="max" transfer-ownership="none">
  368. <doc xml:space="preserve">the maximum number of buffers to queue</doc>
  369. <type name="guint" c:type="guint"/>
  370. </parameter>
  371. </parameters>
  372. </method>
  373. <method name="set_wait_on_eos"
  374. c:identifier="gst_app_sink_set_wait_on_eos">
  375. <doc xml:space="preserve">Instruct @appsink to wait for all buffers to be consumed when an EOS is received.</doc>
  376. <return-value transfer-ownership="none">
  377. <type name="none" c:type="void"/>
  378. </return-value>
  379. <parameters>
  380. <instance-parameter name="appsink" transfer-ownership="none">
  381. <doc xml:space="preserve">a #GstAppSink</doc>
  382. <type name="AppSink" c:type="GstAppSink*"/>
  383. </instance-parameter>
  384. <parameter name="wait" transfer-ownership="none">
  385. <doc xml:space="preserve">the new state</doc>
  386. <type name="gboolean" c:type="gboolean"/>
  387. </parameter>
  388. </parameters>
  389. </method>
  390. <property name="caps" writable="1" transfer-ownership="none">
  391. <type name="Gst.Caps"/>
  392. </property>
  393. <property name="drop" writable="1" transfer-ownership="none">
  394. <type name="gboolean" c:type="gboolean"/>
  395. </property>
  396. <property name="emit-signals" writable="1" transfer-ownership="none">
  397. <type name="gboolean" c:type="gboolean"/>
  398. </property>
  399. <property name="eos" transfer-ownership="none">
  400. <type name="gboolean" c:type="gboolean"/>
  401. </property>
  402. <property name="max-buffers" writable="1" transfer-ownership="none">
  403. <type name="guint" c:type="guint"/>
  404. </property>
  405. <property name="wait-on-eos" writable="1" transfer-ownership="none">
  406. <type name="gboolean" c:type="gboolean"/>
  407. </property>
  408. <field name="basesink">
  409. <type name="GstBase.BaseSink" c:type="GstBaseSink"/>
  410. </field>
  411. <field name="priv" readable="0" private="1">
  412. <type name="AppSinkPrivate" c:type="GstAppSinkPrivate*"/>
  413. </field>
  414. <field name="_gst_reserved" readable="0" private="1">
  415. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  416. <type name="gpointer" c:type="gpointer"/>
  417. </array>
  418. </field>
  419. <glib:signal name="eos" when="last">
  420. <doc xml:space="preserve">Signal that the end-of-stream has been reached. This signal is emitted from
  421. the streaming thread.</doc>
  422. <return-value transfer-ownership="none">
  423. <type name="none" c:type="void"/>
  424. </return-value>
  425. </glib:signal>
  426. <glib:signal name="new-preroll" when="last">
  427. <doc xml:space="preserve">Signal that a new preroll sample is available.
  428. This signal is emitted from the streaming thread and only when the
  429. "emit-signals" property is %TRUE.
  430. The new preroll sample can be retrieved with the "pull-preroll" action
  431. signal or gst_app_sink_pull_preroll() either from this signal callback
  432. or from any other thread.
  433. Note that this signal is only emitted when the "emit-signals" property is
  434. set to %TRUE, which it is not by default for performance reasons.</doc>
  435. <return-value transfer-ownership="none">
  436. <type name="Gst.FlowReturn"/>
  437. </return-value>
  438. </glib:signal>
  439. <glib:signal name="new-sample" when="last">
  440. <doc xml:space="preserve">Signal that a new sample is available.
  441. This signal is emitted from the streaming thread and only when the
  442. "emit-signals" property is %TRUE.
  443. The new sample can be retrieved with the "pull-sample" action
  444. signal or gst_app_sink_pull_sample() either from this signal callback
  445. or from any other thread.
  446. Note that this signal is only emitted when the "emit-signals" property is
  447. set to %TRUE, which it is not by default for performance reasons.</doc>
  448. <return-value transfer-ownership="none">
  449. <type name="Gst.FlowReturn"/>
  450. </return-value>
  451. </glib:signal>
  452. <glib:signal name="pull-preroll" when="last" action="1">
  453. <doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
  454. appsink to preroll in the PAUSED state. This sample can be pulled many times
  455. and remains available to the application even after EOS.
  456. This function is typically used when dealing with a pipeline in the PAUSED
  457. state. Calling this function after doing a seek will give the sample right
  458. after the seek position.
  459. Note that the preroll sample will also be returned as the first sample
  460. when calling gst_app_sink_pull_sample() or the "pull-sample" action signal.
  461. If an EOS event was received before any buffers, this function returns
  462. %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
  463. This function blocks until a preroll sample or EOS is received or the appsink
  464. element is set to the READY/NULL state.</doc>
  465. <return-value transfer-ownership="full">
  466. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.</doc>
  467. <type name="Gst.Sample"/>
  468. </return-value>
  469. </glib:signal>
  470. <glib:signal name="pull-sample" when="last" action="1">
  471. <doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
  472. element is set to the READY/NULL state.
  473. This function will only return samples when the appsink is in the PLAYING
  474. state. All rendered samples will be put in a queue so that the application
  475. can pull samples at its own rate.
  476. Note that when the application does not pull samples fast enough, the
  477. queued samples could consume a lot of memory, especially when dealing with
  478. raw video frames. It's possible to control the behaviour of the queue with
  479. the "drop" and "max-buffers" properties.
  480. If an EOS event was received before any buffers, this function returns
  481. %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
  482. <return-value transfer-ownership="full">
  483. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.</doc>
  484. <type name="Gst.Sample"/>
  485. </return-value>
  486. </glib:signal>
  487. </class>
  488. <record name="AppSinkCallbacks"
  489. c:type="GstAppSinkCallbacks"
  490. introspectable="0">
  491. <doc xml:space="preserve">A set of callbacks that can be installed on the appsink with
  492. gst_app_sink_set_callbacks().</doc>
  493. <field name="eos">
  494. <callback name="eos">
  495. <return-value transfer-ownership="none">
  496. <type name="none" c:type="void"/>
  497. </return-value>
  498. <parameters>
  499. <parameter name="appsink" transfer-ownership="none">
  500. <type name="AppSink" c:type="GstAppSink*"/>
  501. </parameter>
  502. <parameter name="user_data"
  503. transfer-ownership="none"
  504. nullable="1"
  505. allow-none="1"
  506. closure="1">
  507. <type name="gpointer" c:type="gpointer"/>
  508. </parameter>
  509. </parameters>
  510. </callback>
  511. </field>
  512. <field name="new_preroll">
  513. <callback name="new_preroll">
  514. <return-value transfer-ownership="none">
  515. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  516. </return-value>
  517. <parameters>
  518. <parameter name="appsink" transfer-ownership="none">
  519. <type name="AppSink" c:type="GstAppSink*"/>
  520. </parameter>
  521. <parameter name="user_data"
  522. transfer-ownership="none"
  523. nullable="1"
  524. allow-none="1"
  525. closure="1">
  526. <type name="gpointer" c:type="gpointer"/>
  527. </parameter>
  528. </parameters>
  529. </callback>
  530. </field>
  531. <field name="new_sample">
  532. <callback name="new_sample">
  533. <return-value transfer-ownership="none">
  534. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  535. </return-value>
  536. <parameters>
  537. <parameter name="appsink" transfer-ownership="none">
  538. <type name="AppSink" c:type="GstAppSink*"/>
  539. </parameter>
  540. <parameter name="user_data"
  541. transfer-ownership="none"
  542. nullable="1"
  543. allow-none="1"
  544. closure="1">
  545. <type name="gpointer" c:type="gpointer"/>
  546. </parameter>
  547. </parameters>
  548. </callback>
  549. </field>
  550. <field name="_gst_reserved" readable="0" private="1">
  551. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  552. <type name="gpointer" c:type="gpointer"/>
  553. </array>
  554. </field>
  555. </record>
  556. <record name="AppSinkClass"
  557. c:type="GstAppSinkClass"
  558. glib:is-gtype-struct-for="AppSink">
  559. <field name="basesink_class">
  560. <type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
  561. </field>
  562. <field name="eos">
  563. <callback name="eos">
  564. <return-value transfer-ownership="none">
  565. <type name="none" c:type="void"/>
  566. </return-value>
  567. <parameters>
  568. <parameter name="appsink" transfer-ownership="none">
  569. <type name="AppSink" c:type="GstAppSink*"/>
  570. </parameter>
  571. </parameters>
  572. </callback>
  573. </field>
  574. <field name="new_preroll">
  575. <callback name="new_preroll">
  576. <return-value transfer-ownership="none">
  577. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  578. </return-value>
  579. <parameters>
  580. <parameter name="appsink" transfer-ownership="none">
  581. <type name="AppSink" c:type="GstAppSink*"/>
  582. </parameter>
  583. </parameters>
  584. </callback>
  585. </field>
  586. <field name="new_sample">
  587. <callback name="new_sample">
  588. <return-value transfer-ownership="none">
  589. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  590. </return-value>
  591. <parameters>
  592. <parameter name="appsink" transfer-ownership="none">
  593. <type name="AppSink" c:type="GstAppSink*"/>
  594. </parameter>
  595. </parameters>
  596. </callback>
  597. </field>
  598. <field name="pull_preroll">
  599. <callback name="pull_preroll">
  600. <return-value transfer-ownership="full">
  601. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
  602. Call gst_sample_unref() after usage.</doc>
  603. <type name="Gst.Sample" c:type="GstSample*"/>
  604. </return-value>
  605. <parameters>
  606. <parameter name="appsink" transfer-ownership="none">
  607. <doc xml:space="preserve">a #GstAppSink</doc>
  608. <type name="AppSink" c:type="GstAppSink*"/>
  609. </parameter>
  610. </parameters>
  611. </callback>
  612. </field>
  613. <field name="pull_sample">
  614. <callback name="pull_sample">
  615. <return-value transfer-ownership="full">
  616. <doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
  617. Call gst_sample_unref() after usage.</doc>
  618. <type name="Gst.Sample" c:type="GstSample*"/>
  619. </return-value>
  620. <parameters>
  621. <parameter name="appsink" transfer-ownership="none">
  622. <doc xml:space="preserve">a #GstAppSink</doc>
  623. <type name="AppSink" c:type="GstAppSink*"/>
  624. </parameter>
  625. </parameters>
  626. </callback>
  627. </field>
  628. <field name="_gst_reserved" readable="0" private="1">
  629. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  630. <type name="gpointer" c:type="gpointer"/>
  631. </array>
  632. </field>
  633. </record>
  634. <record name="AppSinkPrivate" c:type="GstAppSinkPrivate" disguised="1">
  635. </record>
  636. <class name="AppSrc"
  637. c:symbol-prefix="app_src"
  638. c:type="GstAppSrc"
  639. parent="GstBase.BaseSrc"
  640. glib:type-name="GstAppSrc"
  641. glib:get-type="gst_app_src_get_type"
  642. glib:type-struct="AppSrcClass">
  643. <doc xml:space="preserve">The appsrc element can be used by applications to insert data into a
  644. GStreamer pipeline. Unlike most GStreamer elements, appsrc provides
  645. external API functions.
  646. appsrc can be used by linking with the libgstapp library to access the
  647. methods directly or by using the appsrc action signals.
  648. Before operating appsrc, the caps property must be set to fixed caps
  649. describing the format of the data that will be pushed with appsrc. An
  650. exception to this is when pushing buffers with unknown caps, in which case no
  651. caps should be set. This is typically true of file-like sources that push raw
  652. byte buffers. If you don't want to explicitly set the caps, you can use
  653. gst_app_src_push_sample. This method gets the caps associated with the
  654. sample and sets them on the appsrc replacing any previously set caps (if
  655. different from sample's caps).
  656. The main way of handing data to the appsrc element is by calling the
  657. gst_app_src_push_buffer() method or by emitting the push-buffer action signal.
  658. This will put the buffer onto a queue from which appsrc will read from in its
  659. streaming thread. It is important to note that data transport will not happen
  660. from the thread that performed the push-buffer call.
  661. The "max-bytes" property controls how much data can be queued in appsrc
  662. before appsrc considers the queue full. A filled internal queue will always
  663. signal the "enough-data" signal, which signals the application that it should
  664. stop pushing data into appsrc. The "block" property will cause appsrc to
  665. block the push-buffer method until free data becomes available again.
  666. When the internal queue is running out of data, the "need-data" signal is
  667. emitted, which signals the application that it should start pushing more data
  668. into appsrc.
  669. In addition to the "need-data" and "enough-data" signals, appsrc can emit the
  670. "seek-data" signal when the "stream-mode" property is set to "seekable" or
  671. "random-access". The signal argument will contain the new desired position in
  672. the stream expressed in the unit set with the "format" property. After
  673. receiving the seek-data signal, the application should push-buffers from the
  674. new position.
  675. These signals allow the application to operate the appsrc in two different
  676. ways:
  677. The push mode, in which the application repeatedly calls the push-buffer/push-sample
  678. method with a new buffer/sample. Optionally, the queue size in the appsrc
  679. can be controlled with the enough-data and need-data signals by respectively
  680. stopping/starting the push-buffer/push-sample calls. This is a typical
  681. mode of operation for the stream-type "stream" and "seekable". Use this
  682. mode when implementing various network protocols or hardware devices.
  683. The pull mode, in which the need-data signal triggers the next push-buffer call.
  684. This mode is typically used in the "random-access" stream-type. Use this
  685. mode for file access or other randomly accessable sources. In this mode, a
  686. buffer of exactly the amount of bytes given by the need-data signal should be
  687. pushed into appsrc.
  688. In all modes, the size property on appsrc should contain the total stream
  689. size in bytes. Setting this property is mandatory in the random-access mode.
  690. For the stream and seekable modes, setting this property is optional but
  691. recommended.
  692. When the application has finished pushing data into appsrc, it should call
  693. gst_app_src_end_of_stream() or emit the end-of-stream action signal. After
  694. this call, no more buffers can be pushed into appsrc until a flushing seek
  695. occurs or the state of the appsrc has gone through READY.</doc>
  696. <implements name="Gst.URIHandler"/>
  697. <virtual-method name="end_of_stream" invoker="end_of_stream">
  698. <doc xml:space="preserve">Indicates to the appsrc element that the last buffer queued in the
  699. element is the last buffer of the stream.</doc>
  700. <return-value transfer-ownership="none">
  701. <doc xml:space="preserve">#GST_FLOW_OK when the EOS was successfuly queued.
  702. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.</doc>
  703. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  704. </return-value>
  705. <parameters>
  706. <instance-parameter name="appsrc" transfer-ownership="none">
  707. <doc xml:space="preserve">a #GstAppSrc</doc>
  708. <type name="AppSrc" c:type="GstAppSrc*"/>
  709. </instance-parameter>
  710. </parameters>
  711. </virtual-method>
  712. <virtual-method name="enough_data">
  713. <return-value transfer-ownership="none">
  714. <type name="none" c:type="void"/>
  715. </return-value>
  716. <parameters>
  717. <instance-parameter name="appsrc" transfer-ownership="none">
  718. <type name="AppSrc" c:type="GstAppSrc*"/>
  719. </instance-parameter>
  720. </parameters>
  721. </virtual-method>
  722. <virtual-method name="need_data">
  723. <return-value transfer-ownership="none">
  724. <type name="none" c:type="void"/>
  725. </return-value>
  726. <parameters>
  727. <instance-parameter name="appsrc" transfer-ownership="none">
  728. <type name="AppSrc" c:type="GstAppSrc*"/>
  729. </instance-parameter>
  730. <parameter name="length" transfer-ownership="none">
  731. <type name="guint" c:type="guint"/>
  732. </parameter>
  733. </parameters>
  734. </virtual-method>
  735. <virtual-method name="push_buffer" invoker="push_buffer">
  736. <doc xml:space="preserve">Adds a buffer to the queue of buffers that the appsrc element will
  737. push to its source pad. This function takes ownership of the buffer.
  738. When the block property is TRUE, this function can block until free
  739. space becomes available in the queue.</doc>
  740. <return-value transfer-ownership="none">
  741. <doc xml:space="preserve">#GST_FLOW_OK when the buffer was successfuly queued.
  742. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
  743. #GST_FLOW_EOS when EOS occured.</doc>
  744. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  745. </return-value>
  746. <parameters>
  747. <instance-parameter name="appsrc" transfer-ownership="none">
  748. <doc xml:space="preserve">a #GstAppSrc</doc>
  749. <type name="AppSrc" c:type="GstAppSrc*"/>
  750. </instance-parameter>
  751. <parameter name="buffer" transfer-ownership="full">
  752. <doc xml:space="preserve">a #GstBuffer to push</doc>
  753. <type name="Gst.Buffer" c:type="GstBuffer*"/>
  754. </parameter>
  755. </parameters>
  756. </virtual-method>
  757. <virtual-method name="push_sample" invoker="push_sample" version="1.6">
  758. <doc xml:space="preserve">Extract a buffer from the provided sample and adds it to the queue of
  759. buffers that the appsrc element will push to its source pad. Any
  760. previous caps that were set on appsrc will be replaced by the caps
  761. associated with the sample if not equal.
  762. When the block property is TRUE, this function can block until free
  763. space becomes available in the queue.</doc>
  764. <return-value transfer-ownership="none">
  765. <doc xml:space="preserve">#GST_FLOW_OK when the buffer was successfuly queued.
  766. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
  767. #GST_FLOW_EOS when EOS occured.</doc>
  768. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  769. </return-value>
  770. <parameters>
  771. <instance-parameter name="appsrc" transfer-ownership="none">
  772. <doc xml:space="preserve">a #GstAppSrc</doc>
  773. <type name="AppSrc" c:type="GstAppSrc*"/>
  774. </instance-parameter>
  775. <parameter name="sample" transfer-ownership="none">
  776. <doc xml:space="preserve">a #GstSample from which buffer and caps may be
  777. extracted</doc>
  778. <type name="Gst.Sample" c:type="GstSample*"/>
  779. </parameter>
  780. </parameters>
  781. </virtual-method>
  782. <virtual-method name="seek_data">
  783. <return-value transfer-ownership="none">
  784. <type name="gboolean" c:type="gboolean"/>
  785. </return-value>
  786. <parameters>
  787. <instance-parameter name="appsrc" transfer-ownership="none">
  788. <type name="AppSrc" c:type="GstAppSrc*"/>
  789. </instance-parameter>
  790. <parameter name="offset" transfer-ownership="none">
  791. <type name="guint64" c:type="guint64"/>
  792. </parameter>
  793. </parameters>
  794. </virtual-method>
  795. <method name="end_of_stream" c:identifier="gst_app_src_end_of_stream">
  796. <doc xml:space="preserve">Indicates to the appsrc element that the last buffer queued in the
  797. element is the last buffer of the stream.</doc>
  798. <return-value transfer-ownership="none">
  799. <doc xml:space="preserve">#GST_FLOW_OK when the EOS was successfuly queued.
  800. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.</doc>
  801. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  802. </return-value>
  803. <parameters>
  804. <instance-parameter name="appsrc" transfer-ownership="none">
  805. <doc xml:space="preserve">a #GstAppSrc</doc>
  806. <type name="AppSrc" c:type="GstAppSrc*"/>
  807. </instance-parameter>
  808. </parameters>
  809. </method>
  810. <method name="get_caps" c:identifier="gst_app_src_get_caps">
  811. <doc xml:space="preserve">Get the configured caps on @appsrc.</doc>
  812. <return-value transfer-ownership="full">
  813. <doc xml:space="preserve">the #GstCaps produced by the source. gst_caps_unref() after usage.</doc>
  814. <type name="Gst.Caps" c:type="GstCaps*"/>
  815. </return-value>
  816. <parameters>
  817. <instance-parameter name="appsrc" transfer-ownership="none">
  818. <doc xml:space="preserve">a #GstAppSrc</doc>
  819. <type name="AppSrc" c:type="GstAppSrc*"/>
  820. </instance-parameter>
  821. </parameters>
  822. </method>
  823. <method name="get_current_level_bytes"
  824. c:identifier="gst_app_src_get_current_level_bytes"
  825. version="1.2">
  826. <doc xml:space="preserve">Get the number of currently queued bytes inside @appsrc.</doc>
  827. <return-value transfer-ownership="none">
  828. <doc xml:space="preserve">The number of currently queued bytes.</doc>
  829. <type name="guint64" c:type="guint64"/>
  830. </return-value>
  831. <parameters>
  832. <instance-parameter name="appsrc" transfer-ownership="none">
  833. <doc xml:space="preserve">a #GstAppSrc</doc>
  834. <type name="AppSrc" c:type="GstAppSrc*"/>
  835. </instance-parameter>
  836. </parameters>
  837. </method>
  838. <method name="get_emit_signals"
  839. c:identifier="gst_app_src_get_emit_signals">
  840. <doc xml:space="preserve">Check if appsrc will emit the "new-preroll" and "new-buffer" signals.</doc>
  841. <return-value transfer-ownership="none">
  842. <doc xml:space="preserve">%TRUE if @appsrc is emitting the "new-preroll" and "new-buffer"
  843. signals.</doc>
  844. <type name="gboolean" c:type="gboolean"/>
  845. </return-value>
  846. <parameters>
  847. <instance-parameter name="appsrc" transfer-ownership="none">
  848. <doc xml:space="preserve">a #GstAppSrc</doc>
  849. <type name="AppSrc" c:type="GstAppSrc*"/>
  850. </instance-parameter>
  851. </parameters>
  852. </method>
  853. <method name="get_latency" c:identifier="gst_app_src_get_latency">
  854. <doc xml:space="preserve">Retrieve the min and max latencies in @min and @max respectively.</doc>
  855. <return-value transfer-ownership="none">
  856. <type name="none" c:type="void"/>
  857. </return-value>
  858. <parameters>
  859. <instance-parameter name="appsrc" transfer-ownership="none">
  860. <doc xml:space="preserve">a #GstAppSrc</doc>
  861. <type name="AppSrc" c:type="GstAppSrc*"/>
  862. </instance-parameter>
  863. <parameter name="min" transfer-ownership="none">
  864. <doc xml:space="preserve">the min latency</doc>
  865. <type name="guint64" c:type="guint64*"/>
  866. </parameter>
  867. <parameter name="max" transfer-ownership="none">
  868. <doc xml:space="preserve">the min latency</doc>
  869. <type name="guint64" c:type="guint64*"/>
  870. </parameter>
  871. </parameters>
  872. </method>
  873. <method name="get_max_bytes" c:identifier="gst_app_src_get_max_bytes">
  874. <doc xml:space="preserve">Get the maximum amount of bytes that can be queued in @appsrc.</doc>
  875. <return-value transfer-ownership="none">
  876. <doc xml:space="preserve">The maximum amount of bytes that can be queued.</doc>
  877. <type name="guint64" c:type="guint64"/>
  878. </return-value>
  879. <parameters>
  880. <instance-parameter name="appsrc" transfer-ownership="none">
  881. <doc xml:space="preserve">a #GstAppSrc</doc>
  882. <type name="AppSrc" c:type="GstAppSrc*"/>
  883. </instance-parameter>
  884. </parameters>
  885. </method>
  886. <method name="get_size" c:identifier="gst_app_src_get_size">
  887. <doc xml:space="preserve">Get the size of the stream in bytes. A value of -1 means that the size is
  888. not known.</doc>
  889. <return-value transfer-ownership="none">
  890. <doc xml:space="preserve">the size of the stream previously set with gst_app_src_set_size();</doc>
  891. <type name="gint64" c:type="gint64"/>
  892. </return-value>
  893. <parameters>
  894. <instance-parameter name="appsrc" transfer-ownership="none">
  895. <doc xml:space="preserve">a #GstAppSrc</doc>
  896. <type name="AppSrc" c:type="GstAppSrc*"/>
  897. </instance-parameter>
  898. </parameters>
  899. </method>
  900. <method name="get_stream_type"
  901. c:identifier="gst_app_src_get_stream_type">
  902. <doc xml:space="preserve">Get the stream type. Control the stream type of @appsrc
  903. with gst_app_src_set_stream_type().</doc>
  904. <return-value transfer-ownership="none">
  905. <doc xml:space="preserve">the stream type.</doc>
  906. <type name="AppStreamType" c:type="GstAppStreamType"/>
  907. </return-value>
  908. <parameters>
  909. <instance-parameter name="appsrc" transfer-ownership="none">
  910. <doc xml:space="preserve">a #GstAppSrc</doc>
  911. <type name="AppSrc" c:type="GstAppSrc*"/>
  912. </instance-parameter>
  913. </parameters>
  914. </method>
  915. <method name="push_buffer" c:identifier="gst_app_src_push_buffer">
  916. <doc xml:space="preserve">Adds a buffer to the queue of buffers that the appsrc element will
  917. push to its source pad. This function takes ownership of the buffer.
  918. When the block property is TRUE, this function can block until free
  919. space becomes available in the queue.</doc>
  920. <return-value transfer-ownership="none">
  921. <doc xml:space="preserve">#GST_FLOW_OK when the buffer was successfuly queued.
  922. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
  923. #GST_FLOW_EOS when EOS occured.</doc>
  924. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  925. </return-value>
  926. <parameters>
  927. <instance-parameter name="appsrc" transfer-ownership="none">
  928. <doc xml:space="preserve">a #GstAppSrc</doc>
  929. <type name="AppSrc" c:type="GstAppSrc*"/>
  930. </instance-parameter>
  931. <parameter name="buffer" transfer-ownership="full">
  932. <doc xml:space="preserve">a #GstBuffer to push</doc>
  933. <type name="Gst.Buffer" c:type="GstBuffer*"/>
  934. </parameter>
  935. </parameters>
  936. </method>
  937. <method name="push_sample"
  938. c:identifier="gst_app_src_push_sample"
  939. version="1.6">
  940. <doc xml:space="preserve">Extract a buffer from the provided sample and adds it to the queue of
  941. buffers that the appsrc element will push to its source pad. Any
  942. previous caps that were set on appsrc will be replaced by the caps
  943. associated with the sample if not equal.
  944. When the block property is TRUE, this function can block until free
  945. space becomes available in the queue.</doc>
  946. <return-value transfer-ownership="none">
  947. <doc xml:space="preserve">#GST_FLOW_OK when the buffer was successfuly queued.
  948. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
  949. #GST_FLOW_EOS when EOS occured.</doc>
  950. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  951. </return-value>
  952. <parameters>
  953. <instance-parameter name="appsrc" transfer-ownership="none">
  954. <doc xml:space="preserve">a #GstAppSrc</doc>
  955. <type name="AppSrc" c:type="GstAppSrc*"/>
  956. </instance-parameter>
  957. <parameter name="sample" transfer-ownership="none">
  958. <doc xml:space="preserve">a #GstSample from which buffer and caps may be
  959. extracted</doc>
  960. <type name="Gst.Sample" c:type="GstSample*"/>
  961. </parameter>
  962. </parameters>
  963. </method>
  964. <method name="set_callbacks"
  965. c:identifier="gst_app_src_set_callbacks"
  966. introspectable="0">
  967. <doc xml:space="preserve">Set callbacks which will be executed when data is needed, enough data has
  968. been collected or when a seek should be performed.
  969. This is an alternative to using the signals, it has lower overhead and is thus
  970. less expensive, but also less flexible.
  971. If callbacks are installed, no signals will be emitted for performance
  972. reasons.</doc>
  973. <return-value transfer-ownership="none">
  974. <type name="none" c:type="void"/>
  975. </return-value>
  976. <parameters>
  977. <instance-parameter name="appsrc" transfer-ownership="none">
  978. <doc xml:space="preserve">a #GstAppSrc</doc>
  979. <type name="AppSrc" c:type="GstAppSrc*"/>
  980. </instance-parameter>
  981. <parameter name="callbacks" transfer-ownership="none">
  982. <doc xml:space="preserve">the callbacks</doc>
  983. <type name="AppSrcCallbacks" c:type="GstAppSrcCallbacks*"/>
  984. </parameter>
  985. <parameter name="user_data"
  986. transfer-ownership="none"
  987. nullable="1"
  988. allow-none="1">
  989. <doc xml:space="preserve">a user_data argument for the callbacks</doc>
  990. <type name="gpointer" c:type="gpointer"/>
  991. </parameter>
  992. <parameter name="notify" transfer-ownership="none" scope="async">
  993. <doc xml:space="preserve">a destroy notify function</doc>
  994. <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
  995. </parameter>
  996. </parameters>
  997. </method>
  998. <method name="set_caps" c:identifier="gst_app_src_set_caps">
  999. <doc xml:space="preserve">Set the capabilities on the appsrc element. This function takes
  1000. a copy of the caps structure. After calling this method, the source will
  1001. only produce caps that match @caps. @caps must be fixed and the caps on the
  1002. buffers must match the caps or left NULL.</doc>
  1003. <return-value transfer-ownership="none">
  1004. <type name="none" c:type="void"/>
  1005. </return-value>
  1006. <parameters>
  1007. <instance-parameter name="appsrc" transfer-ownership="none">
  1008. <doc xml:space="preserve">a #GstAppSrc</doc>
  1009. <type name="AppSrc" c:type="GstAppSrc*"/>
  1010. </instance-parameter>
  1011. <parameter name="caps" transfer-ownership="none">
  1012. <doc xml:space="preserve">caps to set</doc>
  1013. <type name="Gst.Caps" c:type="const GstCaps*"/>
  1014. </parameter>
  1015. </parameters>
  1016. </method>
  1017. <method name="set_emit_signals"
  1018. c:identifier="gst_app_src_set_emit_signals">
  1019. <doc xml:space="preserve">Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
  1020. by default disabled because signal emission is expensive and unneeded when
  1021. the application prefers to operate in pull mode.</doc>
  1022. <return-value transfer-ownership="none">
  1023. <type name="none" c:type="void"/>
  1024. </return-value>
  1025. <parameters>
  1026. <instance-parameter name="appsrc" transfer-ownership="none">
  1027. <doc xml:space="preserve">a #GstAppSrc</doc>
  1028. <type name="AppSrc" c:type="GstAppSrc*"/>
  1029. </instance-parameter>
  1030. <parameter name="emit" transfer-ownership="none">
  1031. <doc xml:space="preserve">the new state</doc>
  1032. <type name="gboolean" c:type="gboolean"/>
  1033. </parameter>
  1034. </parameters>
  1035. </method>
  1036. <method name="set_latency" c:identifier="gst_app_src_set_latency">
  1037. <doc xml:space="preserve">Configure the @min and @max latency in @src. If @min is set to -1, the
  1038. default latency calculations for pseudo-live sources will be used.</doc>
  1039. <return-value transfer-ownership="none">
  1040. <type name="none" c:type="void"/>
  1041. </return-value>
  1042. <parameters>
  1043. <instance-parameter name="appsrc" transfer-ownership="none">
  1044. <doc xml:space="preserve">a #GstAppSrc</doc>
  1045. <type name="AppSrc" c:type="GstAppSrc*"/>
  1046. </instance-parameter>
  1047. <parameter name="min" transfer-ownership="none">
  1048. <doc xml:space="preserve">the min latency</doc>
  1049. <type name="guint64" c:type="guint64"/>
  1050. </parameter>
  1051. <parameter name="max" transfer-ownership="none">
  1052. <doc xml:space="preserve">the min latency</doc>
  1053. <type name="guint64" c:type="guint64"/>
  1054. </parameter>
  1055. </parameters>
  1056. </method>
  1057. <method name="set_max_bytes" c:identifier="gst_app_src_set_max_bytes">
  1058. <doc xml:space="preserve">Set the maximum amount of bytes that can be queued in @appsrc.
  1059. After the maximum amount of bytes are queued, @appsrc will emit the
  1060. "enough-data" signal.</doc>
  1061. <return-value transfer-ownership="none">
  1062. <type name="none" c:type="void"/>
  1063. </return-value>
  1064. <parameters>
  1065. <instance-parameter name="appsrc" transfer-ownership="none">
  1066. <doc xml:space="preserve">a #GstAppSrc</doc>
  1067. <type name="AppSrc" c:type="GstAppSrc*"/>
  1068. </instance-parameter>
  1069. <parameter name="max" transfer-ownership="none">
  1070. <doc xml:space="preserve">the maximum number of bytes to queue</doc>
  1071. <type name="guint64" c:type="guint64"/>
  1072. </parameter>
  1073. </parameters>
  1074. </method>
  1075. <method name="set_size" c:identifier="gst_app_src_set_size">
  1076. <doc xml:space="preserve">Set the size of the stream in bytes. A value of -1 means that the size is
  1077. not known.</doc>
  1078. <return-value transfer-ownership="none">
  1079. <type name="none" c:type="void"/>
  1080. </return-value>
  1081. <parameters>
  1082. <instance-parameter name="appsrc" transfer-ownership="none">
  1083. <doc xml:space="preserve">a #GstAppSrc</doc>
  1084. <type name="AppSrc" c:type="GstAppSrc*"/>
  1085. </instance-parameter>
  1086. <parameter name="size" transfer-ownership="none">
  1087. <doc xml:space="preserve">the size to set</doc>
  1088. <type name="gint64" c:type="gint64"/>
  1089. </parameter>
  1090. </parameters>
  1091. </method>
  1092. <method name="set_stream_type"
  1093. c:identifier="gst_app_src_set_stream_type">
  1094. <doc xml:space="preserve">Set the stream type on @appsrc. For seekable streams, the "seek" signal must
  1095. be connected to.
  1096. A stream_type stream</doc>
  1097. <return-value transfer-ownership="none">
  1098. <type name="none" c:type="void"/>
  1099. </return-value>
  1100. <parameters>
  1101. <instance-parameter name="appsrc" transfer-ownership="none">
  1102. <doc xml:space="preserve">a #GstAppSrc</doc>
  1103. <type name="AppSrc" c:type="GstAppSrc*"/>
  1104. </instance-parameter>
  1105. <parameter name="type" transfer-ownership="none">
  1106. <doc xml:space="preserve">the new state</doc>
  1107. <type name="AppStreamType" c:type="GstAppStreamType"/>
  1108. </parameter>
  1109. </parameters>
  1110. </method>
  1111. <property name="block" writable="1" transfer-ownership="none">
  1112. <type name="gboolean" c:type="gboolean"/>
  1113. </property>
  1114. <property name="caps" writable="1" transfer-ownership="none">
  1115. <type name="Gst.Caps"/>
  1116. </property>
  1117. <property name="current-level-bytes" transfer-ownership="none">
  1118. <type name="guint64" c:type="guint64"/>
  1119. </property>
  1120. <property name="emit-signals" writable="1" transfer-ownership="none">
  1121. <type name="gboolean" c:type="gboolean"/>
  1122. </property>
  1123. <property name="format" writable="1" transfer-ownership="none">
  1124. <type name="Gst.Format"/>
  1125. </property>
  1126. <property name="is-live" writable="1" transfer-ownership="none">
  1127. <type name="gboolean" c:type="gboolean"/>
  1128. </property>
  1129. <property name="max-bytes" writable="1" transfer-ownership="none">
  1130. <type name="guint64" c:type="guint64"/>
  1131. </property>
  1132. <property name="max-latency" writable="1" transfer-ownership="none">
  1133. <type name="gint64" c:type="gint64"/>
  1134. </property>
  1135. <property name="min-latency" writable="1" transfer-ownership="none">
  1136. <type name="gint64" c:type="gint64"/>
  1137. </property>
  1138. <property name="min-percent" writable="1" transfer-ownership="none">
  1139. <type name="guint" c:type="guint"/>
  1140. </property>
  1141. <property name="size" writable="1" transfer-ownership="none">
  1142. <type name="gint64" c:type="gint64"/>
  1143. </property>
  1144. <property name="stream-type" writable="1" transfer-ownership="none">
  1145. <type name="AppStreamType"/>
  1146. </property>
  1147. <field name="basesrc">
  1148. <type name="GstBase.BaseSrc" c:type="GstBaseSrc"/>
  1149. </field>
  1150. <field name="priv" readable="0" private="1">
  1151. <type name="AppSrcPrivate" c:type="GstAppSrcPrivate*"/>
  1152. </field>
  1153. <field name="_gst_reserved" readable="0" private="1">
  1154. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  1155. <type name="gpointer" c:type="gpointer"/>
  1156. </array>
  1157. </field>
  1158. <glib:signal name="end-of-stream" when="last" action="1">
  1159. <doc xml:space="preserve">Notify @appsrc that no more buffer are available.</doc>
  1160. <return-value transfer-ownership="none">
  1161. <type name="Gst.FlowReturn"/>
  1162. </return-value>
  1163. </glib:signal>
  1164. <glib:signal name="enough-data" when="last">
  1165. <doc xml:space="preserve">Signal that the source has enough data. It is recommended that the
  1166. application stops calling push-buffer until the need-data signal is
  1167. emitted again to avoid excessive buffer queueing.</doc>
  1168. <return-value transfer-ownership="none">
  1169. <type name="none" c:type="void"/>
  1170. </return-value>
  1171. </glib:signal>
  1172. <glib:signal name="need-data" when="last">
  1173. <doc xml:space="preserve">Signal that the source needs more data. In the callback or from another
  1174. thread you should call push-buffer or end-of-stream.
  1175. @length is just a hint and when it is set to -1, any number of bytes can be
  1176. pushed into @appsrc.
  1177. You can call push-buffer multiple times until the enough-data signal is
  1178. fired.</doc>
  1179. <return-value transfer-ownership="none">
  1180. <type name="none" c:type="void"/>
  1181. </return-value>
  1182. <parameters>
  1183. <parameter name="length" transfer-ownership="none">
  1184. <doc xml:space="preserve">the amount of bytes needed.</doc>
  1185. <type name="guint" c:type="guint"/>
  1186. </parameter>
  1187. </parameters>
  1188. </glib:signal>
  1189. <glib:signal name="push-buffer" when="last" action="1">
  1190. <doc xml:space="preserve">Adds a buffer to the queue of buffers that the appsrc element will
  1191. push to its source pad. This function does not take ownership of the
  1192. buffer so the buffer needs to be unreffed after calling this function.
  1193. When the block property is TRUE, this function can block until free space
  1194. becomes available in the queue.</doc>
  1195. <return-value transfer-ownership="none">
  1196. <type name="Gst.FlowReturn"/>
  1197. </return-value>
  1198. <parameters>
  1199. <parameter name="buffer" transfer-ownership="none">
  1200. <doc xml:space="preserve">a buffer to push</doc>
  1201. <type name="Gst.Buffer"/>
  1202. </parameter>
  1203. </parameters>
  1204. </glib:signal>
  1205. <glib:signal name="push-sample" when="last" action="1" version="1.6">
  1206. <doc xml:space="preserve">Extract a buffer from the provided sample and adds the extracted buffer
  1207. to the queue of buffers that the appsrc element will
  1208. push to its source pad. This function set the appsrc caps based on the caps
  1209. in the sample and reset the caps if they change.
  1210. Only the caps and the buffer of the provided sample are used and not
  1211. for example the segment in the sample.
  1212. This function does not take ownership of the
  1213. sample so the sample needs to be unreffed after calling this function.
  1214. When the block property is TRUE, this function can block until free space
  1215. becomes available in the queue.</doc>
  1216. <return-value transfer-ownership="none">
  1217. <type name="Gst.FlowReturn"/>
  1218. </return-value>
  1219. <parameters>
  1220. <parameter name="sample" transfer-ownership="none">
  1221. <doc xml:space="preserve">a sample from which extract buffer to push</doc>
  1222. <type name="Gst.Sample"/>
  1223. </parameter>
  1224. </parameters>
  1225. </glib:signal>
  1226. <glib:signal name="seek-data" when="last">
  1227. <doc xml:space="preserve">Seek to the given offset. The next push-buffer should produce buffers from
  1228. the new @offset.
  1229. This callback is only called for seekable stream types.</doc>
  1230. <return-value transfer-ownership="none">
  1231. <doc xml:space="preserve">%TRUE if the seek succeeded.</doc>
  1232. <type name="gboolean" c:type="gboolean"/>
  1233. </return-value>
  1234. <parameters>
  1235. <parameter name="offset" transfer-ownership="none">
  1236. <doc xml:space="preserve">the offset to seek to</doc>
  1237. <type name="guint64" c:type="guint64"/>
  1238. </parameter>
  1239. </parameters>
  1240. </glib:signal>
  1241. </class>
  1242. <record name="AppSrcCallbacks"
  1243. c:type="GstAppSrcCallbacks"
  1244. introspectable="0">
  1245. <doc xml:space="preserve">A set of callbacks that can be installed on the appsrc with
  1246. gst_app_src_set_callbacks().</doc>
  1247. <field name="need_data">
  1248. <callback name="need_data">
  1249. <return-value transfer-ownership="none">
  1250. <type name="none" c:type="void"/>
  1251. </return-value>
  1252. <parameters>
  1253. <parameter name="src" transfer-ownership="none">
  1254. <type name="AppSrc" c:type="GstAppSrc*"/>
  1255. </parameter>
  1256. <parameter name="length" transfer-ownership="none">
  1257. <type name="guint" c:type="guint"/>
  1258. </parameter>
  1259. <parameter name="user_data"
  1260. transfer-ownership="none"
  1261. nullable="1"
  1262. allow-none="1"
  1263. closure="2">
  1264. <type name="gpointer" c:type="gpointer"/>
  1265. </parameter>
  1266. </parameters>
  1267. </callback>
  1268. </field>
  1269. <field name="enough_data">
  1270. <callback name="enough_data">
  1271. <return-value transfer-ownership="none">
  1272. <type name="none" c:type="void"/>
  1273. </return-value>
  1274. <parameters>
  1275. <parameter name="src" transfer-ownership="none">
  1276. <type name="AppSrc" c:type="GstAppSrc*"/>
  1277. </parameter>
  1278. <parameter name="user_data"
  1279. transfer-ownership="none"
  1280. nullable="1"
  1281. allow-none="1"
  1282. closure="1">
  1283. <type name="gpointer" c:type="gpointer"/>
  1284. </parameter>
  1285. </parameters>
  1286. </callback>
  1287. </field>
  1288. <field name="seek_data">
  1289. <callback name="seek_data">
  1290. <return-value transfer-ownership="none">
  1291. <type name="gboolean" c:type="gboolean"/>
  1292. </return-value>
  1293. <parameters>
  1294. <parameter name="src" transfer-ownership="none">
  1295. <type name="AppSrc" c:type="GstAppSrc*"/>
  1296. </parameter>
  1297. <parameter name="offset" transfer-ownership="none">
  1298. <type name="guint64" c:type="guint64"/>
  1299. </parameter>
  1300. <parameter name="user_data"
  1301. transfer-ownership="none"
  1302. nullable="1"
  1303. allow-none="1"
  1304. closure="2">
  1305. <type name="gpointer" c:type="gpointer"/>
  1306. </parameter>
  1307. </parameters>
  1308. </callback>
  1309. </field>
  1310. <field name="_gst_reserved" readable="0" private="1">
  1311. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  1312. <type name="gpointer" c:type="gpointer"/>
  1313. </array>
  1314. </field>
  1315. </record>
  1316. <record name="AppSrcClass"
  1317. c:type="GstAppSrcClass"
  1318. glib:is-gtype-struct-for="AppSrc">
  1319. <field name="basesrc_class">
  1320. <type name="GstBase.BaseSrcClass" c:type="GstBaseSrcClass"/>
  1321. </field>
  1322. <field name="need_data">
  1323. <callback name="need_data">
  1324. <return-value transfer-ownership="none">
  1325. <type name="none" c:type="void"/>
  1326. </return-value>
  1327. <parameters>
  1328. <parameter name="appsrc" transfer-ownership="none">
  1329. <type name="AppSrc" c:type="GstAppSrc*"/>
  1330. </parameter>
  1331. <parameter name="length" transfer-ownership="none">
  1332. <type name="guint" c:type="guint"/>
  1333. </parameter>
  1334. </parameters>
  1335. </callback>
  1336. </field>
  1337. <field name="enough_data">
  1338. <callback name="enough_data">
  1339. <return-value transfer-ownership="none">
  1340. <type name="none" c:type="void"/>
  1341. </return-value>
  1342. <parameters>
  1343. <parameter name="appsrc" transfer-ownership="none">
  1344. <type name="AppSrc" c:type="GstAppSrc*"/>
  1345. </parameter>
  1346. </parameters>
  1347. </callback>
  1348. </field>
  1349. <field name="seek_data">
  1350. <callback name="seek_data">
  1351. <return-value transfer-ownership="none">
  1352. <type name="gboolean" c:type="gboolean"/>
  1353. </return-value>
  1354. <parameters>
  1355. <parameter name="appsrc" transfer-ownership="none">
  1356. <type name="AppSrc" c:type="GstAppSrc*"/>
  1357. </parameter>
  1358. <parameter name="offset" transfer-ownership="none">
  1359. <type name="guint64" c:type="guint64"/>
  1360. </parameter>
  1361. </parameters>
  1362. </callback>
  1363. </field>
  1364. <field name="push_buffer">
  1365. <callback name="push_buffer">
  1366. <return-value transfer-ownership="none">
  1367. <doc xml:space="preserve">#GST_FLOW_OK when the buffer was successfuly queued.
  1368. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
  1369. #GST_FLOW_EOS when EOS occured.</doc>
  1370. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  1371. </return-value>
  1372. <parameters>
  1373. <parameter name="appsrc" transfer-ownership="none">
  1374. <doc xml:space="preserve">a #GstAppSrc</doc>
  1375. <type name="AppSrc" c:type="GstAppSrc*"/>
  1376. </parameter>
  1377. <parameter name="buffer" transfer-ownership="full">
  1378. <doc xml:space="preserve">a #GstBuffer to push</doc>
  1379. <type name="Gst.Buffer" c:type="GstBuffer*"/>
  1380. </parameter>
  1381. </parameters>
  1382. </callback>
  1383. </field>
  1384. <field name="end_of_stream">
  1385. <callback name="end_of_stream">
  1386. <return-value transfer-ownership="none">
  1387. <doc xml:space="preserve">#GST_FLOW_OK when the EOS was successfuly queued.
  1388. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.</doc>
  1389. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  1390. </return-value>
  1391. <parameters>
  1392. <parameter name="appsrc" transfer-ownership="none">
  1393. <doc xml:space="preserve">a #GstAppSrc</doc>
  1394. <type name="AppSrc" c:type="GstAppSrc*"/>
  1395. </parameter>
  1396. </parameters>
  1397. </callback>
  1398. </field>
  1399. <field name="push_sample">
  1400. <callback name="push_sample">
  1401. <return-value transfer-ownership="none">
  1402. <doc xml:space="preserve">#GST_FLOW_OK when the buffer was successfuly queued.
  1403. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
  1404. #GST_FLOW_EOS when EOS occured.</doc>
  1405. <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
  1406. </return-value>
  1407. <parameters>
  1408. <parameter name="appsrc" transfer-ownership="none">
  1409. <doc xml:space="preserve">a #GstAppSrc</doc>
  1410. <type name="AppSrc" c:type="GstAppSrc*"/>
  1411. </parameter>
  1412. <parameter name="sample" transfer-ownership="none">
  1413. <doc xml:space="preserve">a #GstSample from which buffer and caps may be
  1414. extracted</doc>
  1415. <type name="Gst.Sample" c:type="GstSample*"/>
  1416. </parameter>
  1417. </parameters>
  1418. </callback>
  1419. </field>
  1420. <field name="_gst_reserved" readable="0" private="1">
  1421. <array zero-terminated="0" c:type="gpointer" fixed-size="3">
  1422. <type name="gpointer" c:type="gpointer"/>
  1423. </array>
  1424. </field>
  1425. </record>
  1426. <record name="AppSrcPrivate" c:type="GstAppSrcPrivate" disguised="1">
  1427. </record>
  1428. <enumeration name="AppStreamType"
  1429. glib:type-name="GstAppStreamType"
  1430. glib:get-type="gst_app_stream_type_get_type"
  1431. c:type="GstAppStreamType">
  1432. <doc xml:space="preserve">The stream type.</doc>
  1433. <member name="stream"
  1434. value="0"
  1435. c:identifier="GST_APP_STREAM_TYPE_STREAM"
  1436. glib:nick="stream">
  1437. <doc xml:space="preserve">No seeking is supported in the stream, such as a
  1438. live stream.</doc>
  1439. </member>
  1440. <member name="seekable"
  1441. value="1"
  1442. c:identifier="GST_APP_STREAM_TYPE_SEEKABLE"
  1443. glib:nick="seekable">
  1444. <doc xml:space="preserve">The stream is seekable but seeking might not
  1445. be very fast, such as data from a webserver.</doc>
  1446. </member>
  1447. <member name="random_access"
  1448. value="2"
  1449. c:identifier="GST_APP_STREAM_TYPE_RANDOM_ACCESS"
  1450. glib:nick="random-access">
  1451. <doc xml:space="preserve">The stream is seekable and seeking is fast,
  1452. such as in a local file.</doc>
  1453. </member>
  1454. </enumeration>
  1455. </namespace>
  1456. </repository>