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