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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT
use crate::ffi;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// 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
/// [`pull_sample()`][Self::pull_sample()] and [`pull_preroll()`][Self::pull_preroll()] methods.
/// These methods block until a sample becomes available in the sink or when the
/// sink is shut down or reaches EOS. There are also timed variants of these
/// methods, [`try_pull_sample()`][Self::try_pull_sample()] and [`try_pull_preroll()`][Self::try_pull_preroll()],
/// which accept a timeout parameter to limit the amount of time to wait.
///
/// 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", "max-time" and "max-bytes"
/// properties 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 [`None`], the appsink
/// is stopped or in the EOS state. You can check for the EOS state with the
/// "eos" property or with the [`is_eos()`][Self::is_eos()] method.
///
/// The eos signal can also be used to be informed when the EOS state is reached
/// to avoid polling.
///
/// ## Properties
///
///
/// #### `buffer-list`
/// Readable | Writeable
///
///
/// #### `caps`
/// Readable | Writeable
///
///
/// #### `drop`
/// Readable | Writeable
///
///
/// #### `emit-signals`
/// Readable | Writeable
///
///
/// #### `eos`
/// Readable
///
///
/// #### `max-buffers`
/// Maximum amount of buffers in the queue (0 = unlimited).
///
/// Readable | Writeable
///
///
/// #### `max-bytes`
/// Maximum amount of bytes in the queue (0 = unlimited)
///
/// Readable | Writeable
///
///
/// #### `max-time`
/// Maximum total duration of data in the queue (0 = unlimited)
///
/// Readable | Writeable
///
///
/// #### `wait-on-eos`
/// Wait for all buffers to be processed after receiving an EOS.
///
/// In cases where it is uncertain if an `appsink` will have a consumer for its buffers
/// when it receives an EOS, set to [`false`] to ensure that the `appsink` will not hang.
///
/// Readable | Writeable
/// <details><summary><h4>BaseSink</h4></summary>
///
///
/// #### `async`
/// If set to [`true`], the basesink will perform asynchronous state changes.
/// When set to [`false`], the sink will not signal the parent when it prerolls.
/// Use this option when dealing with sparse streams or when synchronisation is
/// not required.
///
/// Readable | Writeable
///
///
/// #### `blocksize`
/// The amount of bytes to pull when operating in pull mode.
///
/// Readable | Writeable
///
///
/// #### `enable-last-sample`
/// Enable the last-sample property. If [`false`], basesink doesn't keep a
/// reference to the last buffer arrived and the last-sample property is always
/// set to [`None`]. This can be useful if you need buffers to be released as soon
/// as possible, eg. if you're using a buffer pool.
///
/// Readable | Writeable
///
///
/// #### `last-sample`
/// The last buffer that arrived in the sink and was used for preroll or for
/// rendering. This property can be used to generate thumbnails. This property
/// can be [`None`] when the sink has not yet received a buffer.
///
/// Readable
///
///
/// #### `max-bitrate`
/// Control the maximum amount of bits that will be rendered per second.
/// Setting this property to a value bigger than 0 will make the sink delay
/// rendering of the buffers when it would exceed to max-bitrate.
///
/// Readable | Writeable
///
///
/// #### `max-lateness`
/// Readable | Writeable
///
///
/// #### `processing-deadline`
/// Maximum amount of time (in nanoseconds) that the pipeline can take
/// for processing the buffer. This is added to the latency of live
/// pipelines.
///
/// Readable | Writeable
///
///
/// #### `qos`
/// Readable | Writeable
///
///
/// #### `render-delay`
/// The additional delay between synchronisation and actual rendering of the
/// media. This property will add additional latency to the device in order to
/// make other sinks compensate for the delay.
///
/// Readable | Writeable
///
///
/// #### `stats`
/// Various `GstBaseSink` statistics. This property returns a [`gst::Structure`][crate::gst::Structure]
/// with name `application/x-gst-base-sink-stats` with the following fields:
///
/// - "average-rate" G_TYPE_DOUBLE average frame rate
/// - "dropped" G_TYPE_UINT64 Number of dropped frames
/// - "rendered" G_TYPE_UINT64 Number of rendered frames
///
/// Readable
///
///
/// #### `sync`
/// Readable | Writeable
///
///
/// #### `throttle-time`
/// The time to insert between buffers. This property can be used to control
/// the maximum amount of buffers per second to render. Setting this property
/// to a value bigger than 0 will make the sink create THROTTLE QoS events.
///
/// Readable | Writeable
///
///
/// #### `ts-offset`
/// Controls the final synchronisation, a negative value will render the buffer
/// earlier while a positive value delays playback. This property can be
/// used to fix synchronisation in bad files.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Object</h4></summary>
///
///
/// #### `name`
/// Readable | Writeable | Construct
///
///
/// #### `parent`
/// The parent of the object. Please note, that when changing the 'parent'
/// property, we don't emit [`notify`][struct@crate::glib::Object#notify] and [`deep-notify`][struct@crate::gst::Object#deep-notify]
/// signals due to locking issues. In some cases one can use
/// `GstBin::element-added` or `GstBin::element-removed` signals on the parent to
/// achieve a similar effect.
///
/// Readable | Writeable
/// </details>
///
/// ## Signals
///
///
/// #### `eos`
/// Signal that the end-of-stream has been reached. This signal is emitted from
/// the streaming thread.
///
///
///
///
/// #### `new-preroll`
/// Signal that a new preroll sample is available.
///
/// This signal is emitted from the streaming thread and only when the
/// "emit-signals" property is [`true`].
///
/// The new preroll sample can be retrieved with the "pull-preroll" action
/// signal or [`AppSink::pull_preroll()`][crate::AppSink::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.
///
///
///
///
/// #### `new-sample`
/// Signal that a new sample is available.
///
/// This signal is emitted from the streaming thread and only when the
/// "emit-signals" property is [`true`].
///
/// The new sample can be retrieved with the "pull-sample" action
/// signal or [`AppSink::pull_sample()`][crate::AppSink::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.
///
///
///
///
/// #### `new-serialized-event`
/// Signal that a new downstream serialized event is available.
///
/// This signal is emitted from the streaming thread and only when the
/// "emit-signals" property is [`true`].
///
/// The new event can be retrieved with the "try-pull-object" action
/// signal or [`AppSink::pull_object()`][crate::AppSink::pull_object()] either from this signal callback
/// or from any other thread.
///
/// EOS will not be notified using this signal, use [`eos`][struct@crate::AppSink#eos] instead.
/// EOS cannot be pulled either, use [`AppSink::is_eos()`][crate::AppSink::is_eos()] to check for it.
///
/// 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.
///
/// The callback should return [`true`] if the event has been handled, which will
/// skip basesink handling of the event, [`false`] otherwise.
///
///
///
///
/// #### `propose-allocation`
/// Signal that a new propose_allocation query is available.
///
/// This signal is emitted from the streaming thread and only when the
/// "emit-signals" property is [`true`].
///
///
///
///
/// #### `pull-preroll`
/// Get the last preroll sample in `appsink`. This was the sample that caused the
/// appsink to preroll in the PAUSED state.
///
/// 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.
///
/// Calling this function will clear the internal reference to the preroll
/// buffer.
///
/// Note that the preroll sample will also be returned as the first sample
/// when calling [`AppSink::pull_sample()`][crate::AppSink::pull_sample()] or the "pull-sample" action signal.
///
/// If an EOS event was received before any buffers, this function returns
/// [`None`]. 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.
///
/// Action
///
///
/// #### `pull-sample`
/// 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" / "max-bytes" / "max-time" set of properties.
///
/// If an EOS event was received before any buffers, this function returns
/// [`None`]. Use gst_app_sink_is_eos () to check for the EOS condition.
///
/// Action
///
///
/// #### `try-pull-object`
/// This function blocks until a sample or an event becomes available or the appsink
/// element is set to the READY/NULL state or the timeout expires.
///
/// This function will only return samples when the appsink is in the PLAYING
/// state. All rendered samples and events will be put in a queue so that the application
/// can pull them at its own rate.
/// Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
///
/// 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" / "max-bytes" / "max-time" set of properties.
///
/// This function will only pull serialized events, excluding
/// the EOS event for which this functions returns
/// [`None`]. Use [`AppSink::is_eos()`][crate::AppSink::is_eos()] to check for the EOS condition.
///
/// This signal is a variant of [`try-pull-sample`][struct@crate::AppSink#try-pull-sample]: that can be used
/// to handle incoming events as well as samples.
///
/// Note that future releases may extend this API to return other object types
/// so make sure that your code is checking for the actual type it is handling.
///
/// Action
///
///
/// #### `try-pull-preroll`
/// Get the last preroll sample in `appsink`. This was the sample that caused the
/// appsink to preroll in the PAUSED state.
///
/// 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.
///
/// Calling this function will clear the internal reference to the preroll
/// buffer.
///
/// Note that the preroll sample will also be returned as the first sample
/// when calling [`AppSink::pull_sample()`][crate::AppSink::pull_sample()] or the "pull-sample" action signal.
///
/// If an EOS event was received before any buffers or the timeout expires,
/// this function returns [`None`]. Use gst_app_sink_is_eos () to check for the EOS
/// condition.
///
/// This function blocks until a preroll sample or EOS is received, the appsink
/// element is set to the READY/NULL state, or the timeout expires.
///
/// Action
///
///
/// #### `try-pull-sample`
/// This function blocks until a sample or EOS becomes available or the appsink
/// element is set to the READY/NULL state or the timeout expires.
///
/// 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" / "max-bytes" / "max-time" set of properties.
///
/// If an EOS event was received before any buffers or the timeout expires,
/// this function returns [`None`]. Use gst_app_sink_is_eos () to check
/// for the EOS condition.
///
/// Action
/// <details><summary><h4>Element</h4></summary>
///
///
/// #### `no-more-pads`
/// This signals that the element will not generate more dynamic pads.
/// Note that this signal will usually be emitted from the context of
/// the streaming thread.
///
///
///
///
/// #### `pad-added`
/// a new `GstPad` has been added to the element. Note that this signal will
/// usually be emitted from the context of the streaming thread. Also keep in
/// mind that if you add new elements to the pipeline in the signal handler
/// you will need to set them to the desired target state with
/// [`ElementExtManual::set_state()`][crate::gst::prelude::ElementExtManual::set_state()] or [`ElementExtManual::sync_state_with_parent()`][crate::gst::prelude::ElementExtManual::sync_state_with_parent()].
///
///
///
///
/// #### `pad-removed`
/// a `GstPad` has been removed from the element
///
///
/// </details>
/// <details><summary><h4>Object</h4></summary>
///
///
/// #### `deep-notify`
/// The deep notify signal is used to be notified of property changes. It is
/// typically attached to the toplevel bin to receive notifications from all
/// the elements contained in that bin.
///
/// Detailed
/// </details>
///
/// # Implements
///
/// [`trait@gst::prelude::ElementExt`], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`], [`trait@gst::prelude::URIHandlerExt`]
#[doc(alias = "GstAppSink")]
pub struct AppSink(Object<ffi::GstAppSink, ffi::GstAppSinkClass>) @extends gst::Element, gst::Object, @implements gst::URIHandler;
match fn {
type_ => || ffi::gst_app_sink_get_type(),
}
}
impl AppSink {
/// Check if `self` supports buffer lists.
///
/// # Returns
///
/// [`true`] if `self` supports buffer lists.
#[doc(alias = "gst_app_sink_get_buffer_list_support")]
#[doc(alias = "get_buffer_list_support")]
pub fn is_buffer_list_support(&self) -> bool {
unsafe {
from_glib(ffi::gst_app_sink_get_buffer_list_support(
self.to_glib_none().0,
))
}
}
/// Get the configured caps on `self`.
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] accepted by the sink. `gst_caps_unref()` after usage.
#[doc(alias = "gst_app_sink_get_caps")]
#[doc(alias = "get_caps")]
pub fn caps(&self) -> Option<gst::Caps> {
unsafe { from_glib_full(ffi::gst_app_sink_get_caps(self.to_glib_none().0)) }
}
/// Check if `self` will drop old buffers when the maximum amount of queued
/// data is reached (meaning max buffers, time or bytes limit, whichever is hit first).
///
/// # Returns
///
/// [`true`] if `self` is dropping old buffers when the queue is
/// filled.
#[doc(alias = "gst_app_sink_get_drop")]
#[doc(alias = "get_drop")]
#[doc(alias = "drop")]
pub fn is_drop(&self) -> bool {
unsafe { from_glib(ffi::gst_app_sink_get_drop(self.to_glib_none().0)) }
}
/// Get the maximum amount of buffers that can be queued in `self`.
///
/// # Returns
///
/// The maximum amount of buffers that can be queued.
#[doc(alias = "gst_app_sink_get_max_buffers")]
#[doc(alias = "get_max_buffers")]
#[doc(alias = "max-buffers")]
pub fn max_buffers(&self) -> u32 {
unsafe { ffi::gst_app_sink_get_max_buffers(self.to_glib_none().0) }
}
/// Get the maximum total size, in bytes, that can be queued in `self`.
///
/// # Returns
///
/// The maximum amount of bytes that can be queued
#[cfg(feature = "v1_24")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
#[doc(alias = "gst_app_sink_get_max_bytes")]
#[doc(alias = "get_max_bytes")]
#[doc(alias = "max-bytes")]
pub fn max_bytes(&self) -> u64 {
unsafe { ffi::gst_app_sink_get_max_bytes(self.to_glib_none().0) }
}
/// Get the maximum total duration that can be queued in `self`.
///
/// # Returns
///
/// The maximum total duration that can be queued.
#[cfg(feature = "v1_24")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
#[doc(alias = "gst_app_sink_get_max_time")]
#[doc(alias = "get_max_time")]
#[doc(alias = "max-time")]
pub fn max_time(&self) -> Option<gst::ClockTime> {
unsafe { from_glib(ffi::gst_app_sink_get_max_time(self.to_glib_none().0)) }
}
/// Check if `self` will wait for all buffers to be consumed when an EOS is
/// received.
///
/// # Returns
///
/// [`true`] if `self` will wait for all buffers to be consumed when an
/// EOS is received.
#[doc(alias = "gst_app_sink_get_wait_on_eos")]
#[doc(alias = "get_wait_on_eos")]
#[doc(alias = "wait-on-eos")]
pub fn is_wait_on_eos(&self) -> bool {
unsafe { from_glib(ffi::gst_app_sink_get_wait_on_eos(self.to_glib_none().0)) }
}
/// Check if `self` 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.
///
/// # Returns
///
/// [`true`] if no more samples can be pulled and the appsink is EOS.
#[doc(alias = "gst_app_sink_is_eos")]
pub fn is_eos(&self) -> bool {
unsafe { from_glib(ffi::gst_app_sink_is_eos(self.to_glib_none().0)) }
}
/// This function blocks until a sample or an event 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 and events will be put in a queue so that the application
/// can pull them 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.
/// Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
///
/// This function will only pull serialized events, excluding
/// the EOS event for which this functions returns
/// [`None`]. Use [`is_eos()`][Self::is_eos()] to check for the EOS condition.
///
/// This method is a variant of [`pull_sample()`][Self::pull_sample()] that can be used
/// to handle incoming events events as well as samples.
///
/// Note that future releases may extend this API to return other object types
/// so make sure that your code is checking for the actual type it is handling.
///
/// # Returns
///
/// a [`gst::Sample`][crate::gst::Sample], or a `GstEvent` or NULL when the appsink is stopped or EOS.
/// Call `gst_mini_object_unref()` after usage.
#[cfg(feature = "v1_20")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
#[doc(alias = "gst_app_sink_pull_object")]
pub fn pull_object(&self) -> Result<gst::MiniObject, glib::BoolError> {
unsafe {
Option::<_>::from_glib_full(ffi::gst_app_sink_pull_object(self.to_glib_none().0))
.ok_or_else(|| glib::bool_error!("Failed to pull object"))
}
}
/// Get the last preroll sample in `self`. This was the sample that caused the
/// appsink to preroll in the PAUSED state.
///
/// 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.
///
/// Calling this function will clear the internal reference to the preroll
/// buffer.
///
/// Note that the preroll sample will also be returned as the first sample
/// when calling [`pull_sample()`][Self::pull_sample()].
///
/// If an EOS event was received before any buffers, this function returns
/// [`None`]. 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.
///
/// # Returns
///
/// a [`gst::Sample`][crate::gst::Sample] or NULL when the appsink is stopped or EOS.
/// Call `gst_sample_unref()` after usage.
#[doc(alias = "gst_app_sink_pull_preroll")]
pub fn pull_preroll(&self) -> Result<gst::Sample, glib::BoolError> {
unsafe {
Option::<_>::from_glib_full(ffi::gst_app_sink_pull_preroll(self.to_glib_none().0))
.ok_or_else(|| glib::bool_error!("Failed to pull preroll sample"))
}
}
/// 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
/// [`None`]. Use gst_app_sink_is_eos () to check for the EOS condition.
///
/// # Returns
///
/// a [`gst::Sample`][crate::gst::Sample] or NULL when the appsink is stopped or EOS.
/// Call `gst_sample_unref()` after usage.
#[doc(alias = "gst_app_sink_pull_sample")]
pub fn pull_sample(&self) -> Result<gst::Sample, glib::BoolError> {
unsafe {
Option::<_>::from_glib_full(ffi::gst_app_sink_pull_sample(self.to_glib_none().0))
.ok_or_else(|| glib::bool_error!("Failed to pull sample"))
}
}
/// Instruct `self` to enable or disable buffer list support.
///
/// For backwards-compatibility reasons applications need to opt in
/// to indicate that they will be able to handle buffer lists.
/// ## `enable_lists`
/// enable or disable buffer list support
#[doc(alias = "gst_app_sink_set_buffer_list_support")]
pub fn set_buffer_list_support(&self, enable_lists: bool) {
unsafe {
ffi::gst_app_sink_set_buffer_list_support(
self.to_glib_none().0,
enable_lists.into_glib(),
);
}
}
//#[doc(alias = "gst_app_sink_set_callbacks")]
//pub fn set_callbacks(&self, callbacks: /*Ignored*/&mut AppSinkCallbacks, user_data: /*Unimplemented*/Option<Basic: Pointer>) {
// unsafe { TODO: call ffi:gst_app_sink_set_callbacks() }
//}
/// 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, or incomplete,
/// you must check the caps on the samples to get the actual used caps.
/// ## `caps`
/// caps to set
#[doc(alias = "gst_app_sink_set_caps")]
#[doc(alias = "caps")]
pub fn set_caps(&self, caps: Option<&gst::Caps>) {
unsafe {
ffi::gst_app_sink_set_caps(self.to_glib_none().0, caps.to_glib_none().0);
}
}
/// Instruct `self` to drop old buffers when the maximum amount of queued
/// data is reached, that is, when any configured limit is hit (max-buffers, max-time or max-bytes).
/// ## `drop`
/// the new state
#[doc(alias = "gst_app_sink_set_drop")]
#[doc(alias = "drop")]
pub fn set_drop(&self, drop: bool) {
unsafe {
ffi::gst_app_sink_set_drop(self.to_glib_none().0, drop.into_glib());
}
}
/// Set the maximum amount of buffers that can be queued in `self`. After this
/// amount of buffers are queued in appsink, any more buffers will block upstream
/// elements until a sample is pulled from `self`, unless 'drop' is set, in which
/// case new buffers will be discarded.
/// ## `max`
/// the maximum number of buffers to queue
#[doc(alias = "gst_app_sink_set_max_buffers")]
#[doc(alias = "max-buffers")]
pub fn set_max_buffers(&self, max: u32) {
unsafe {
ffi::gst_app_sink_set_max_buffers(self.to_glib_none().0, max);
}
}
/// Set the maximum total size that can be queued in `self`. After this
/// amount of buffers are queued in appsink, any more buffers will block upstream
/// elements until a sample is pulled from `self`, unless 'drop' is set, in which
/// case new buffers will be discarded.
/// ## `max`
/// the maximum total size of buffers to queue, in bytes
#[cfg(feature = "v1_24")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
#[doc(alias = "gst_app_sink_set_max_bytes")]
#[doc(alias = "max-bytes")]
pub fn set_max_bytes(&self, max: u64) {
unsafe {
ffi::gst_app_sink_set_max_bytes(self.to_glib_none().0, max);
}
}
/// Set the maximum total duration that can be queued in `self`. After this
/// amount of buffers are queued in appsink, any more buffers will block upstream
/// elements until a sample is pulled from `self`, unless 'drop' is set, in which
/// case new buffers will be discarded.
/// ## `max`
/// the maximum total duration to queue
#[cfg(feature = "v1_24")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
#[doc(alias = "gst_app_sink_set_max_time")]
#[doc(alias = "max-time")]
pub fn set_max_time(&self, max: impl Into<Option<gst::ClockTime>>) {
unsafe {
ffi::gst_app_sink_set_max_time(self.to_glib_none().0, max.into().into_glib());
}
}
/// Instruct `self` to wait for all buffers to be consumed when an EOS is received.
/// ## `wait`
/// the new state
#[doc(alias = "gst_app_sink_set_wait_on_eos")]
#[doc(alias = "wait-on-eos")]
pub fn set_wait_on_eos(&self, wait: bool) {
unsafe {
ffi::gst_app_sink_set_wait_on_eos(self.to_glib_none().0, wait.into_glib());
}
}
/// This function blocks until a sample or an event or EOS becomes available or the appsink
/// element is set to the READY/NULL state or the timeout expires.
///
/// This function will only return samples when the appsink is in the PLAYING
/// state. All rendered buffers and events will be put in a queue so that the application
/// can pull them 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.
/// Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
///
/// This function will only pull serialized events, excluding
/// the EOS event for which this functions returns
/// [`None`]. Use [`is_eos()`][Self::is_eos()] to check for the EOS condition.
///
/// This method is a variant of [`try_pull_sample()`][Self::try_pull_sample()] that can be used
/// to handle incoming events events as well as samples.
///
/// Note that future releases may extend this API to return other object types
/// so make sure that your code is checking for the actual type it is handling.
/// ## `timeout`
/// the maximum amount of time to wait for a sample
///
/// # Returns
///
/// a [`gst::Sample`][crate::gst::Sample], or `GstEvent` or NULL when the appsink is stopped or EOS or the timeout expires.
/// Call `gst_mini_object_unref()` after usage.
#[cfg(feature = "v1_20")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
#[doc(alias = "gst_app_sink_try_pull_object")]
pub fn try_pull_object(
&self,
timeout: impl Into<Option<gst::ClockTime>>,
) -> Option<gst::MiniObject> {
unsafe {
from_glib_full(ffi::gst_app_sink_try_pull_object(
self.to_glib_none().0,
timeout.into().into_glib(),
))
}
}
/// Get the last preroll sample in `self`. This was the sample that caused the
/// appsink to preroll in the PAUSED state.
///
/// 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.
///
/// Calling this function will clear the internal reference to the preroll
/// buffer.
///
/// Note that the preroll sample will also be returned as the first sample
/// when calling [`pull_sample()`][Self::pull_sample()].
///
/// If an EOS event was received before any buffers or the timeout expires,
/// this function returns [`None`]. Use gst_app_sink_is_eos () to check for the EOS
/// condition.
///
/// This function blocks until a preroll sample or EOS is received, the appsink
/// element is set to the READY/NULL state, or the timeout expires.
/// ## `timeout`
/// the maximum amount of time to wait for the preroll sample
///
/// # Returns
///
/// a [`gst::Sample`][crate::gst::Sample] or NULL when the appsink is stopped or EOS or the timeout expires.
/// Call `gst_sample_unref()` after usage.
#[doc(alias = "gst_app_sink_try_pull_preroll")]
pub fn try_pull_preroll(
&self,
timeout: impl Into<Option<gst::ClockTime>>,
) -> Option<gst::Sample> {
unsafe {
from_glib_full(ffi::gst_app_sink_try_pull_preroll(
self.to_glib_none().0,
timeout.into().into_glib(),
))
}
}
/// This function blocks until a sample or EOS becomes available or the appsink
/// element is set to the READY/NULL state or the timeout expires.
///
/// 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 or the timeout expires,
/// this function returns [`None`]. Use gst_app_sink_is_eos () to check for the EOS
/// condition.
/// ## `timeout`
/// the maximum amount of time to wait for a sample
///
/// # Returns
///
/// a [`gst::Sample`][crate::gst::Sample] or NULL when the appsink is stopped or EOS or the timeout expires.
/// Call `gst_sample_unref()` after usage.
#[doc(alias = "gst_app_sink_try_pull_sample")]
pub fn try_pull_sample(
&self,
timeout: impl Into<Option<gst::ClockTime>>,
) -> Option<gst::Sample> {
unsafe {
from_glib_full(ffi::gst_app_sink_try_pull_sample(
self.to_glib_none().0,
timeout.into().into_glib(),
))
}
}
#[doc(alias = "buffer-list")]
pub fn is_buffer_list(&self) -> bool {
ObjectExt::property(self, "buffer-list")
}
#[doc(alias = "buffer-list")]
pub fn set_buffer_list(&self, buffer_list: bool) {
ObjectExt::set_property(self, "buffer-list", buffer_list)
}
#[doc(alias = "buffer-list")]
pub fn connect_buffer_list_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_buffer_list_trampoline<
F: Fn(&AppSink) + Send + Sync + 'static,
>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::buffer-list\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_buffer_list_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "caps")]
pub fn connect_caps_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_caps_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::caps\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_caps_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "drop")]
pub fn connect_drop_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_drop_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::drop\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_drop_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "eos")]
pub fn connect_eos_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_eos_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::eos\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_eos_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "max-buffers")]
pub fn connect_max_buffers_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_max_buffers_trampoline<
F: Fn(&AppSink) + Send + Sync + 'static,
>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::max-buffers\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_max_buffers_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_24")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
#[doc(alias = "max-bytes")]
pub fn connect_max_bytes_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_max_bytes_trampoline<
F: Fn(&AppSink) + Send + Sync + 'static,
>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::max-bytes\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_max_bytes_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_24")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
#[doc(alias = "max-time")]
pub fn connect_max_time_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_max_time_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::max-time\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_max_time_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "wait-on-eos")]
pub fn connect_wait_on_eos_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_wait_on_eos_trampoline<
F: Fn(&AppSink) + Send + Sync + 'static,
>(
this: *mut ffi::GstAppSink,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::wait-on-eos\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_wait_on_eos_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
unsafe impl Send for AppSink {}
unsafe impl Sync for AppSink {}