/usr/include/d/gtkd-3/gstreamer/Event.d is in libgstreamerd-3-dev 3.7.5-2build1.
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 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 | /*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gstreamer.Event;
private import glib.ConstructionException;
private import glib.ListG;
private import glib.Str;
private import gobject.ObjectG;
private import gstreamer.Buffer;
private import gstreamer.Caps;
private import gstreamer.Message;
private import gstreamer.Segment;
private import gstreamer.Stream;
private import gstreamer.StreamCollection;
private import gstreamer.Structure;
private import gstreamer.TagList;
private import gstreamer.Toc;
private import gstreamer.c.functions;
public import gstreamer.c.types;
public import gstreamerc.gstreamertypes;
/**
* The event class provides factory methods to construct events for sending
* and functions to query (parse) received events.
*
* Events are usually created with gst_event_new_*() which takes event-type
* specific parameters as arguments.
* To send an event application will usually use gst_element_send_event() and
* elements will use gst_pad_send_event() or gst_pad_push_event().
* The event should be unreffed with gst_event_unref() if it has not been sent.
*
* Events that have been received can be parsed with their respective
* gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.
*
* Events are passed between elements in parallel to the data stream. Some events
* are serialized with buffers, others are not. Some events only travel downstream,
* others only upstream. Some events can travel both upstream and downstream.
*
* The events are used to signal special conditions in the datastream such as
* EOS (end of stream) or the start of a new stream-segment.
* Events are also used to flush the pipeline of any pending data.
*
* Most of the event API is used inside plugins. Applications usually only
* construct and use seek events.
* To do that gst_event_new_seek() is used to create a seek event. It takes
* the needed parameters to specify seeking time and mode.
* |[<!-- language="C" -->
* GstEvent *event;
* gboolean result;
* ...
* // construct a seek event to play the media from second 2 to 5, flush
* // the pipeline to decrease latency.
* event = gst_event_new_seek (1.0,
* GST_FORMAT_TIME,
* GST_SEEK_FLAG_FLUSH,
* GST_SEEK_TYPE_SET, 2 * GST_SECOND,
* GST_SEEK_TYPE_SET, 5 * GST_SECOND);
* ...
* result = gst_element_send_event (pipeline, event);
* if (!result)
* g_warning ("seek failed");
* ...
* ]|
*/
public class Event
{
/** the main Gtk struct */
protected GstEvent* gstEvent;
protected bool ownedRef;
/** Get the main Gtk struct */
public GstEvent* getEventStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gstEvent;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gstEvent;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GstEvent* gstEvent, bool ownedRef = false)
{
this.gstEvent = gstEvent;
this.ownedRef = ownedRef;
}
/**
* Create a new EOS event. The eos event can only travel downstream
* synchronized with the buffer flow. Elements that receive the EOS
* event on a pad can return UNEXPECTED as a GstFlowReturn when data
* after the EOS event arrives.
* The EOS event will travel down to the sink elements in the pipeline
* which will then post the GST_MESSAGE_EOS on the bus after they have
* finished playing any buffered data.
* When all sinks have posted an EOS message, the EOS message is
* forwarded to the application.
* Returns:
* The new EOS event.
*/
public static Event newEOS()
{
// GstEvent* gst_event_new_eos (void);
auto p = gst_event_new_eos();
if(p is null)
{
throw new ConstructionException("null returned by gst_event_new_eos");
}
return new Event(cast(GstEvent*)p );
}
/**
* Allocate a new flush start event. The flush start event can be send
* upstream and downstream and travels out-of-bounds with the dataflow.
* It marks pads as being in a WRONG_STATE to process more data.
* Elements unlock and blocking functions and exit their streaming functions
* as fast as possible.
* This event is typically generated after a seek to minimize the latency
* after the seek.
* Returns:
* A new flush start event.
*/
public static Event newFlushStart()
{
// GstEvent* gst_event_new_flush_start (void);
auto p = gst_event_new_flush_start();
if(p is null)
{
throw new ConstructionException("null returned by gst_event_new_flush_start");
}
return new Event(cast(GstEvent*)p );
}
/**
* Generate a TOC select event with the given uid. The purpose of the
* TOC select event is to start playback based on the TOC's entry with
* the given uid.
*/
public static Event newTocSelect(string uid)
{
// GstEvent* gst_event_new_toc_select (const gchar *uid);
auto p = gst_event_new_toc_select(cast(char*)uid.ptr);
if(p is null)
{
throw new ConstructionException("null returned by gst_event_new_toc_select");
}
return new Event(cast(GstEvent*)p );
}
/**
*/
/** */
public static GType getType()
{
return gst_event_get_type();
}
/**
* Create a new buffersize event. The event is sent downstream and notifies
* elements that they should provide a buffer of the specified dimensions.
*
* When the @async flag is set, a thread boundary is preferred.
*
* Params:
* format = buffer format
* minsize = minimum buffer size
* maxsize = maximum buffer size
* async = thread behavior
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstFormat format, long minsize, long maxsize, bool async)
{
auto p = gst_event_new_buffer_size(format, minsize, maxsize, async);
if(p is null)
{
throw new ConstructionException("null returned by new_buffer_size");
}
this(cast(GstEvent*) p);
}
/**
* Create a new CAPS event for @caps. The caps event can only travel downstream
* synchronized with the buffer flow and contains the format of the buffers
* that will follow after the event.
*
* Params:
* caps = a #GstCaps
*
* Returns: the new CAPS event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(Caps caps)
{
auto p = gst_event_new_caps((caps is null) ? null : caps.getCapsStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_caps");
}
this(cast(GstEvent*) p);
}
/**
* Create a new custom-typed event. This can be used for anything not
* handled by other event-specific functions to pass an event to another
* element.
*
* Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
* assigning a free number and filling in the correct direction and
* serialization flags.
*
* New custom events can also be created by subclassing the event type if
* needed.
*
* Params:
* type = The type of the new event
* structure = the structure for the event. The event will
* take ownership of the structure.
*
* Returns: the new custom event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstEventType type, Structure structure)
{
auto p = gst_event_new_custom(type, (structure is null) ? null : structure.getStructureStruct(true));
if(p is null)
{
throw new ConstructionException("null returned by new_custom");
}
this(cast(GstEvent*) p);
}
/**
* Allocate a new flush stop event. The flush stop event can be sent
* upstream and downstream and travels serialized with the dataflow.
* It is typically sent after sending a FLUSH_START event to make the
* pads accept data again.
*
* Elements can process this event synchronized with the dataflow since
* the preceding FLUSH_START event stopped the dataflow.
*
* This event is typically generated to complete a seek and to resume
* dataflow.
*
* Params:
* resetTime = if time should be reset
*
* Returns: a new flush stop event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(bool resetTime)
{
auto p = gst_event_new_flush_stop(resetTime);
if(p is null)
{
throw new ConstructionException("null returned by new_flush_stop");
}
this(cast(GstEvent*) p);
}
/**
* Create a new GAP event. A gap event can be thought of as conceptually
* equivalent to a buffer to signal that there is no data for a certain
* amount of time. This is useful to signal a gap to downstream elements
* which may wait for data, such as muxers or mixers or overlays, especially
* for sparse streams such as subtitle streams.
*
* Params:
* timestamp = the start time (pts) of the gap
* duration = the duration of the gap
*
* Returns: the new GAP event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstClockTime timestamp, GstClockTime duration)
{
auto p = gst_event_new_gap(timestamp, duration);
if(p is null)
{
throw new ConstructionException("null returned by new_gap");
}
this(cast(GstEvent*) p);
}
/**
* Create a new latency event. The event is sent upstream from the sinks and
* notifies elements that they should add an additional @latency to the
* running time before synchronising against the clock.
*
* The latency is mostly used in live sinks and is always expressed in
* the time format.
*
* Params:
* latency = the new latency value
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstClockTime latency)
{
auto p = gst_event_new_latency(latency);
if(p is null)
{
throw new ConstructionException("null returned by new_latency");
}
this(cast(GstEvent*) p);
}
/**
* Create a new navigation event from the given description.
*
* Params:
* structure = description of the event. The event will take
* ownership of the structure.
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(Structure structure)
{
auto p = gst_event_new_navigation((structure is null) ? null : structure.getStructureStruct(true));
if(p is null)
{
throw new ConstructionException("null returned by new_navigation");
}
this(cast(GstEvent*) p);
}
/**
* Creates a new event containing information specific to a particular
* protection system (uniquely identified by @system_id), by which that
* protection system can acquire key(s) to decrypt a protected stream.
*
* In order for a decryption element to decrypt media
* protected using a specific system, it first needs all the
* protection system specific information necessary to acquire the decryption
* key(s) for that stream. The functions defined here enable this information
* to be passed in events from elements that extract it
* (e.g., ISOBMFF demuxers, MPEG DASH demuxers) to protection decrypter
* elements that use it.
*
* Events containing protection system specific information are created using
* #gst_event_new_protection, and they can be parsed by downstream elements
* using #gst_event_parse_protection.
*
* In Common Encryption, protection system specific information may be located
* within ISOBMFF files, both in movie (moov) boxes and movie fragment (moof)
* boxes; it may also be contained in ContentProtection elements within MPEG
* DASH MPDs. The events created by #gst_event_new_protection contain data
* identifying from which of these locations the encapsulated protection system
* specific information originated. This origin information is required as
* some protection systems use different encodings depending upon where the
* information originates.
*
* The events returned by gst_event_new_protection() are implemented
* in such a way as to ensure that the most recently-pushed protection info
* event of a particular @origin and @system_id will
* be stuck to the output pad of the sending element.
*
* Params:
* systemId = a string holding a UUID that uniquely
* identifies a protection system.
* data = a #GstBuffer holding protection system specific
* information. The reference count of the buffer will be incremented by one.
* origin = a string indicating where the protection
* information carried in the event was extracted from. The allowed values
* of this string will depend upon the protection scheme.
*
* Returns: a #GST_EVENT_PROTECTION event, if successful; %NULL
* if unsuccessful.
*
* Since: 1.6
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string systemId, Buffer data, string origin)
{
auto p = gst_event_new_protection(Str.toStringz(systemId), (data is null) ? null : data.getBufferStruct(), Str.toStringz(origin));
if(p is null)
{
throw new ConstructionException("null returned by new_protection");
}
this(cast(GstEvent*) p);
}
/**
* Allocate a new qos event with the given values.
* The QOS event is generated in an element that wants an upstream
* element to either reduce or increase its rate because of
* high/low CPU load or other resource usage such as network performance or
* throttling. Typically sinks generate these events for each buffer
* they receive.
*
* @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
* used when a buffer arrived in time or when the sink cannot keep up with
* the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
* receiving buffers fast enough and thus has to drop late buffers.
* #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
* by the application, for example to reduce power consumption.
*
* @proportion indicates the real-time performance of the streaming in the
* element that generated the QoS event (usually the sink). The value is
* generally computed based on more long term statistics about the streams
* timestamps compared to the clock.
* A value < 1.0 indicates that the upstream element is producing data faster
* than real-time. A value > 1.0 indicates that the upstream element is not
* producing data fast enough. 1.0 is the ideal @proportion value. The
* proportion value can safely be used to lower or increase the quality of
* the element.
*
* @diff is the difference against the clock in running time of the last
* buffer that caused the element to generate the QOS event. A negative value
* means that the buffer with @timestamp arrived in time. A positive value
* indicates how late the buffer with @timestamp was. When throttling is
* enabled, @diff will be set to the requested throttling interval.
*
* @timestamp is the timestamp of the last buffer that cause the element
* to generate the QOS event. It is expressed in running time and thus an ever
* increasing value.
*
* The upstream element can use the @diff and @timestamp values to decide
* whether to process more buffers. For positive @diff, all buffers with
* timestamp <= @timestamp + @diff will certainly arrive late in the sink
* as well. A (negative) @diff value so that @timestamp + @diff would yield a
* result smaller than 0 is not allowed.
*
* The application can use general event probes to intercept the QoS
* event and implement custom application specific QoS handling.
*
* Params:
* type = the QoS type
* proportion = the proportion of the qos message
* diff = The time difference of the last Clock sync
* timestamp = The timestamp of the buffer
*
* Returns: a new QOS event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstQOSType type, double proportion, GstClockTimeDiff diff, GstClockTime timestamp)
{
auto p = gst_event_new_qos(type, proportion, diff, timestamp);
if(p is null)
{
throw new ConstructionException("null returned by new_qos");
}
this(cast(GstEvent*) p);
}
/**
* Create a new reconfigure event. The purpose of the reconfigure event is
* to travel upstream and make elements renegotiate their caps or reconfigure
* their buffer pools. This is useful when changing properties on elements
* or changing the topology of the pipeline.
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this()
{
auto p = gst_event_new_reconfigure();
if(p is null)
{
throw new ConstructionException("null returned by new_reconfigure");
}
this(cast(GstEvent*) p);
}
/**
* Allocate a new seek event with the given parameters.
*
* The seek event configures playback of the pipeline between @start to @stop
* at the speed given in @rate, also called a playback segment.
* The @start and @stop values are expressed in @format.
*
* A @rate of 1.0 means normal playback rate, 2.0 means double speed.
* Negatives values means backwards playback. A value of 0.0 for the
* rate is not allowed and should be accomplished instead by PAUSING the
* pipeline.
*
* A pipeline has a default playback segment configured with a start
* position of 0, a stop position of -1 and a rate of 1.0. The currently
* configured playback segment can be queried with #GST_QUERY_SEGMENT.
*
* @start_type and @stop_type specify how to adjust the currently configured
* start and stop fields in playback segment. Adjustments can be made relative
* or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
* means that the position should not be updated.
*
* When the rate is positive and @start has been updated, playback will start
* from the newly configured start position.
*
* For negative rates, playback will start from the newly configured stop
* position (if any). If the stop position is updated, it must be different from
* -1 (#GST_CLOCK_TIME_NONE) for negative rates.
*
* It is not possible to seek relative to the current playback position, to do
* this, PAUSE the pipeline, query the current playback position with
* #GST_QUERY_POSITION and update the playback segment current position with a
* #GST_SEEK_TYPE_SET to the desired position.
*
* Params:
* rate = The new playback rate
* format = The format of the seek values
* flags = The optional seek flags
* startType = The type and flags for the new start position
* start = The value of the new start position
* stopType = The type and flags for the new stop position
* stop = The value of the new stop position
*
* Returns: a new seek event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(double rate, GstFormat format, GstSeekFlags flags, GstSeekType startType, long start, GstSeekType stopType, long stop)
{
auto p = gst_event_new_seek(rate, format, flags, startType, start, stopType, stop);
if(p is null)
{
throw new ConstructionException("null returned by new_seek");
}
this(cast(GstEvent*) p);
}
/**
* Create a new SEGMENT event for @segment. The segment event can only travel
* downstream synchronized with the buffer flow and contains timing information
* and playback properties for the buffers that will follow.
*
* The segment event marks the range of buffers to be processed. All
* data not within the segment range is not to be processed. This can be
* used intelligently by plugins to apply more efficient methods of skipping
* unneeded data. The valid range is expressed with the @start and @stop
* values.
*
* The time value of the segment is used in conjunction with the start
* value to convert the buffer timestamps into the stream time. This is
* usually done in sinks to report the current stream_time.
* @time represents the stream_time of a buffer carrying a timestamp of
* @start. @time cannot be -1.
*
* @start cannot be -1, @stop can be -1. If there
* is a valid @stop given, it must be greater or equal the @start, including
* when the indicated playback @rate is < 0.
*
* The @applied_rate value provides information about any rate adjustment that
* has already been made to the timestamps and content on the buffers of the
* stream. (@rate * @applied_rate) should always equal the rate that has been
* requested for playback. For example, if an element has an input segment
* with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
* incoming timestamps and buffer content by half and output a segment event
* with @rate of 1.0 and @applied_rate of 2.0
*
* After a segment event, the buffer stream time is calculated with:
*
* time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
*
* Params:
* segment = a #GstSegment
*
* Returns: the new SEGMENT event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(Segment segment)
{
auto p = gst_event_new_segment((segment is null) ? null : segment.getSegmentStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_segment");
}
this(cast(GstEvent*) p);
}
/**
* Create a new segment-done event. This event is sent by elements that
* finish playback of a segment as a result of a segment seek.
*
* Params:
* format = The format of the position being done
* position = The position of the segment being done
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstFormat format, long position)
{
auto p = gst_event_new_segment_done(format, position);
if(p is null)
{
throw new ConstructionException("null returned by new_segment_done");
}
this(cast(GstEvent*) p);
}
/**
* Allocate a new select-streams event.
*
* The select-streams event requests the specified @streams to be activated.
*
* The list of @streams corresponds to the "Stream ID" of each stream to be
* activated. Those ID can be obtained via the #GstStream objects present
* in #GST_EVENT_STREAM_START, #GST_EVENT_STREAM_COLLECTION or
* #GST_MESSSAGE_STREAM_COLLECTION.
*
* Params:
* streams = the list of streams to
* activate
*
* Returns: a new select-streams event.
*
* Since: 1.10
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(ListG streams)
{
auto p = gst_event_new_select_streams((streams is null) ? null : streams.getListGStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_select_streams");
}
this(cast(GstEvent*) p);
}
/**
* Create a new sink-message event. The purpose of the sink-message event is
* to instruct a sink to post the message contained in the event synchronized
* with the stream.
*
* @name is used to store multiple sticky events on one pad.
*
* Params:
* name = a name for the event
* msg = the #GstMessage to be posted
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string name, Message msg)
{
auto p = gst_event_new_sink_message(Str.toStringz(name), (msg is null) ? null : msg.getMessageStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_sink_message");
}
this(cast(GstEvent*) p);
}
/**
* Create a new step event. The purpose of the step event is to instruct a sink
* to skip @amount (expressed in @format) of media. It can be used to implement
* stepping through the video frame by frame or for doing fast trick modes.
*
* A rate of <= 0.0 is not allowed. Pause the pipeline, for the effect of rate
* = 0.0 or first reverse the direction of playback using a seek event to get
* the same effect as rate < 0.0.
*
* The @flush flag will clear any pending data in the pipeline before starting
* the step operation.
*
* The @intermediate flag instructs the pipeline that this step operation is
* part of a larger step operation.
*
* Params:
* format = the format of @amount
* amount = the amount of data to step
* rate = the step rate
* flush = flushing steps
* intermediate = intermediate steps
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GstFormat format, ulong amount, double rate, bool flush, bool intermediate)
{
auto p = gst_event_new_step(format, amount, rate, flush, intermediate);
if(p is null)
{
throw new ConstructionException("null returned by new_step");
}
this(cast(GstEvent*) p);
}
/**
* Create a new STREAM_COLLECTION event. The stream collection event can only
* travel downstream synchronized with the buffer flow.
*
* Source elements, demuxers and other elements that manage collections
* of streams and post #GstStreamCollection messages on the bus also send
* this event downstream on each pad involved in the collection, so that
* activation of a new collection can be tracked through the downstream
* data flow.
*
* Params:
* collection = Active collection for this data flow
*
* Returns: the new STREAM_COLLECTION event.
*
* Since: 1.10
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(StreamCollection collection)
{
auto p = gst_event_new_stream_collection((collection is null) ? null : collection.getStreamCollectionStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_stream_collection");
}
this(cast(GstEvent*) p);
}
/**
* Create a new Stream Group Done event. The stream-group-done event can
* only travel downstream synchronized with the buffer flow. Elements
* that receive the event on a pad should handle it mostly like EOS,
* and emit any data or pending buffers that would depend on more data
* arriving and unblock, since there won't be any more data.
*
* This event is followed by EOS at some point in the future, and is
* generally used when switching pads - to unblock downstream so that
* new pads can be exposed before sending EOS on the existing pads.
*
* Params:
* groupId = the group id of the stream group which is ending
*
* Returns: the new stream-group-done event.
*
* Since: 1.10
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(uint groupId)
{
auto p = gst_event_new_stream_group_done(groupId);
if(p is null)
{
throw new ConstructionException("null returned by new_stream_group_done");
}
this(cast(GstEvent*) p);
}
/**
* Create a new STREAM_START event. The stream start event can only
* travel downstream synchronized with the buffer flow. It is expected
* to be the first event that is sent for a new stream.
*
* Source elements, demuxers and other elements that create new streams
* are supposed to send this event as the first event of a new stream. It
* should not be sent after a flushing seek or in similar situations
* and is used to mark the beginning of a new logical stream. Elements
* combining multiple streams must ensure that this event is only forwarded
* downstream once and not for every single input stream.
*
* The @stream_id should be a unique string that consists of the upstream
* stream-id, / as separator and a unique stream-id for this specific
* stream. A new stream-id should only be created for a stream if the upstream
* stream is split into (potentially) multiple new streams, e.g. in a demuxer,
* but not for every single element in the pipeline.
* gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be
* used to create a stream-id. There are no particular semantics for the
* stream-id, though it should be deterministic (to support stream matching)
* and it might be used to order streams (besides any information conveyed by
* stream flags).
*
* Params:
* streamId = Identifier for this stream
*
* Returns: the new STREAM_START event.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string streamId)
{
auto p = gst_event_new_stream_start(Str.toStringz(streamId));
if(p is null)
{
throw new ConstructionException("null returned by new_stream_start");
}
this(cast(GstEvent*) p);
}
/**
* Generates a metadata tag event from the given @taglist.
*
* The scope of the taglist specifies if the taglist applies to the
* complete medium or only to this specific stream. As the tag event
* is a sticky event, elements should merge tags received from
* upstream with a given scope with their own tags with the same
* scope and create a new tag event from it.
*
* Params:
* taglist = metadata list. The event will take ownership
* of the taglist.
*
* Returns: a new #GstEvent
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(TagList taglist)
{
auto p = gst_event_new_tag((taglist is null) ? null : taglist.getTagListStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_tag");
}
this(cast(GstEvent*) p);
}
/**
* Generate a TOC event from the given @toc. The purpose of the TOC event is to
* inform elements that some kind of the TOC was found.
*
* Params:
* toc = #GstToc structure.
* updated = whether @toc was updated or not.
*
* Returns: a new #GstEvent.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(Toc toc, bool updated)
{
auto p = gst_event_new_toc((toc is null) ? null : toc.getTocStruct(), updated);
if(p is null)
{
throw new ConstructionException("null returned by new_toc");
}
this(cast(GstEvent*) p);
}
/**
* Parses a segment @event and copies the #GstSegment into the location
* given by @segment.
*
* Params:
* segment = a pointer to a #GstSegment
*/
public void copySegment(Segment segment)
{
gst_event_copy_segment(gstEvent, (segment is null) ? null : segment.getSegmentStruct());
}
/**
* Retrieve the accumulated running time offset of the event.
*
* Events passing through #GstPads that have a running time
* offset set via gst_pad_set_offset() will get their offset
* adjusted according to the pad's offset.
*
* If the event contains any information that related to the
* running time, this information will need to be updated
* before usage with this offset.
*
* Returns: The event's running time offset
*
* MT safe.
*
* Since: 1.4
*/
public long getRunningTimeOffset()
{
return gst_event_get_running_time_offset(gstEvent);
}
/**
* Retrieve the sequence number of a event.
*
* Events have ever-incrementing sequence numbers, which may also be set
* explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
* indicate that a event corresponds to some other set of events or messages,
* for example an EOS event corresponding to a SEEK event. It is considered good
* practice to make this correspondence when possible, though it is not
* required.
*
* Note that events and messages share the same sequence number incrementor;
* two events or messages will never have the same sequence number unless
* that correspondence was made explicitly.
*
* Returns: The event's sequence number.
*
* MT safe.
*/
public uint getSeqnum()
{
return gst_event_get_seqnum(gstEvent);
}
/**
* Access the structure of the event.
*
* Returns: The structure of the event. The structure is still
* owned by the event, which means that you should not free it and
* that the pointer becomes invalid when you free the event.
*
* MT safe.
*/
public Structure getStructure()
{
auto p = gst_event_get_structure(gstEvent);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Structure)(cast(GstStructure*) p);
}
/**
* Checks if @event has the given @name. This function is usually used to
* check the name of a custom event.
*
* Params:
* name = name to check
*
* Returns: %TRUE if @name matches the name of the event structure.
*/
public bool hasName(string name)
{
return gst_event_has_name(gstEvent, Str.toStringz(name)) != 0;
}
/**
* Get the format, minsize, maxsize and async-flag in the buffersize event.
*
* Params:
* format = A pointer to store the format in
* minsize = A pointer to store the minsize in
* maxsize = A pointer to store the maxsize in
* async = A pointer to store the async-flag in
*/
public void parseBufferSize(out GstFormat format, out long minsize, out long maxsize, out bool async)
{
int outasync;
gst_event_parse_buffer_size(gstEvent, &format, &minsize, &maxsize, &outasync);
async = (outasync == 1);
}
/**
* Get the caps from @event. The caps remains valid as long as @event remains
* valid.
*
* Params:
* caps = A pointer to the caps
*/
public void parseCaps(out Caps caps)
{
GstCaps* outcaps = null;
gst_event_parse_caps(gstEvent, &outcaps);
caps = ObjectG.getDObject!(Caps)(outcaps);
}
/**
* Parse the FLUSH_STOP event and retrieve the @reset_time member.
*
* Params:
* resetTime = if time should be reset
*/
public void parseFlushStop(out bool resetTime)
{
int outresetTime;
gst_event_parse_flush_stop(gstEvent, &outresetTime);
resetTime = (outresetTime == 1);
}
/**
* Extract timestamp and duration from a new GAP event.
*
* Params:
* timestamp = location where to store the
* start time (pts) of the gap, or %NULL
* duration = location where to store the duration of
* the gap, or %NULL
*/
public void parseGap(out GstClockTime timestamp, out GstClockTime duration)
{
gst_event_parse_gap(gstEvent, ×tamp, &duration);
}
/**
*
* Params:
* groupId = address of variable where to store the group id
* Returns: %TRUE if a group id was set on the event and could be parsed,
* %FALSE otherwise.
*
* Since: 1.2
*/
public bool parseGroupId(out uint groupId)
{
return gst_event_parse_group_id(gstEvent, &groupId) != 0;
}
/**
* Get the latency in the latency event.
*
* Params:
* latency = A pointer to store the latency in.
*/
public void parseLatency(out GstClockTime latency)
{
gst_event_parse_latency(gstEvent, &latency);
}
/**
* Parses an event containing protection system specific information and stores
* the results in @system_id, @data and @origin. The data stored in @system_id,
* @origin and @data are valid until @event is released.
*
* Params:
* systemId = pointer to store the UUID
* string uniquely identifying a content protection system.
* data = pointer to store a #GstBuffer
* holding protection system specific information.
* origin = pointer to store a value that
* indicates where the protection information carried by @event was extracted
* from.
*
* Since: 1.6
*/
public void parseProtection(out string systemId, out Buffer data, string[] origin)
{
char* outsystemId = null;
GstBuffer* outdata = null;
gst_event_parse_protection(gstEvent, &outsystemId, &outdata, Str.toStringzArray(origin));
systemId = Str.toString(outsystemId);
data = ObjectG.getDObject!(Buffer)(outdata);
}
/**
* Get the type, proportion, diff and timestamp in the qos event. See
* gst_event_new_qos() for more information about the different QoS values.
*
* @timestamp will be adjusted for any pad offsets of pads it was passing through.
*
* Params:
* type = A pointer to store the QoS type in
* proportion = A pointer to store the proportion in
* diff = A pointer to store the diff in
* timestamp = A pointer to store the timestamp in
*/
public void parseQos(out GstQOSType type, out double proportion, out GstClockTimeDiff diff, out GstClockTime timestamp)
{
gst_event_parse_qos(gstEvent, &type, &proportion, &diff, ×tamp);
}
/**
* Parses a seek @event and stores the results in the given result locations.
*
* Params:
* rate = result location for the rate
* format = result location for the stream format
* flags = result location for the #GstSeekFlags
* startType = result location for the #GstSeekType of the start position
* start = result location for the start position expressed in @format
* stopType = result location for the #GstSeekType of the stop position
* stop = result location for the stop position expressed in @format
*/
public void parseSeek(out double rate, out GstFormat format, out GstSeekFlags flags, out GstSeekType startType, out long start, out GstSeekType stopType, out long stop)
{
gst_event_parse_seek(gstEvent, &rate, &format, &flags, &startType, &start, &stopType, &stop);
}
/**
* Parses a segment @event and stores the result in the given @segment location.
* @segment remains valid only until the @event is freed. Don't modify the segment
* and make a copy if you want to modify it or store it for later use.
*
* Params:
* segment = a pointer to a #GstSegment
*/
public void parseSegment(out Segment segment)
{
GstSegment* outsegment = null;
gst_event_parse_segment(gstEvent, &outsegment);
segment = ObjectG.getDObject!(Segment)(outsegment);
}
/**
* Extracts the position and format from the segment done message.
*
* Params:
* format = Result location for the format, or %NULL
* position = Result location for the position, or %NULL
*/
public void parseSegmentDone(out GstFormat format, out long position)
{
gst_event_parse_segment_done(gstEvent, &format, &position);
}
/**
* Parse the SELECT_STREAMS event and retrieve the contained streams.
*
* Params:
* streams = the streams
*
* Since: 1.10
*/
public void parseSelectStreams(out ListG streams)
{
GList* outstreams = null;
gst_event_parse_select_streams(gstEvent, &outstreams);
streams = new ListG(outstreams);
}
/**
* Parse the sink-message event. Unref @msg after usage.
*
* Params:
* msg = a pointer to store the #GstMessage in.
*/
public void parseSinkMessage(out Message msg)
{
GstMessage* outmsg = null;
gst_event_parse_sink_message(gstEvent, &outmsg);
msg = ObjectG.getDObject!(Message)(outmsg);
}
/**
* Parse the step event.
*
* Params:
* format = a pointer to store the format in
* amount = a pointer to store the amount in
* rate = a pointer to store the rate in
* flush = a pointer to store the flush boolean in
* intermediate = a pointer to store the intermediate
* boolean in
*/
public void parseStep(out GstFormat format, out ulong amount, out double rate, out bool flush, out bool intermediate)
{
int outflush;
int outintermediate;
gst_event_parse_step(gstEvent, &format, &amount, &rate, &outflush, &outintermediate);
flush = (outflush == 1);
intermediate = (outintermediate == 1);
}
/**
* Parse a stream-start @event and extract the #GstStream from it.
*
* Params:
* stream = adress of variable to store the stream
*
* Since: 1.10
*/
public void parseStream(out Stream stream)
{
GstStream* outstream = null;
gst_event_parse_stream(gstEvent, &outstream);
stream = ObjectG.getDObject!(Stream)(outstream);
}
/**
* Retrieve new #GstStreamCollection from STREAM_COLLECTION event @event.
*
* Params:
* collection = pointer to store the collection
*
* Since: 1.10
*/
public void parseStreamCollection(out StreamCollection collection)
{
GstStreamCollection* outcollection = null;
gst_event_parse_stream_collection(gstEvent, &outcollection);
collection = ObjectG.getDObject!(StreamCollection)(outcollection);
}
/** */
public void parseStreamFlags(out GstStreamFlags flags)
{
gst_event_parse_stream_flags(gstEvent, &flags);
}
/**
* Parse a stream-group-done @event and store the result in the given
* @group_id location.
*
* Params:
* groupId = address of variable to store the group id into
*
* Since: 1.10
*/
public void parseStreamGroupDone(out uint groupId)
{
gst_event_parse_stream_group_done(gstEvent, &groupId);
}
/**
* Parse a stream-id @event and store the result in the given @stream_id
* location. The string stored in @stream_id must not be modified and will
* remain valid only until @event gets freed. Make a copy if you want to
* modify it or store it for later use.
*
* Params:
* streamId = pointer to store the stream-id
*/
public void parseStreamStart(out string streamId)
{
char* outstreamId = null;
gst_event_parse_stream_start(gstEvent, &outstreamId);
streamId = Str.toString(outstreamId);
}
/**
* Parses a tag @event and stores the results in the given @taglist location.
* No reference to the taglist will be returned, it remains valid only until
* the @event is freed. Don't modify or free the taglist, make a copy if you
* want to modify it or store it for later use.
*
* Params:
* taglist = pointer to metadata list
*/
public void parseTag(out TagList taglist)
{
GstTagList* outtaglist = null;
gst_event_parse_tag(gstEvent, &outtaglist);
taglist = ObjectG.getDObject!(TagList)(outtaglist);
}
/**
* Parse a TOC @event and store the results in the given @toc and @updated locations.
*
* Params:
* toc = pointer to #GstToc structure.
* updated = pointer to store TOC updated flag.
*/
public void parseToc(out Toc toc, out bool updated)
{
GstToc* outtoc = null;
int outupdated;
gst_event_parse_toc(gstEvent, &outtoc, &outupdated);
toc = ObjectG.getDObject!(Toc)(outtoc);
updated = (outupdated == 1);
}
/**
* Parse a TOC select @event and store the results in the given @uid location.
*
* Params:
* uid = storage for the selection UID.
*/
public void parseTocSelect(out string uid)
{
char* outuid = null;
gst_event_parse_toc_select(gstEvent, &outuid);
uid = Str.toString(outuid);
}
/**
* All streams that have the same group id are supposed to be played
* together, i.e. all streams inside a container file should have the
* same group id but different stream ids. The group id should change
* each time the stream is started, resulting in different group ids
* each time a file is played for example.
*
* Use gst_util_group_id_next() to get a new group id.
*
* Params:
* groupId = the group id to set
*
* Since: 1.2
*/
public void setGroupId(uint groupId)
{
gst_event_set_group_id(gstEvent, groupId);
}
/**
* Set the running time offset of a event. See
* gst_event_get_running_time_offset() for more information.
*
* MT safe.
*
* Params:
* offset = A the new running time offset
*
* Since: 1.4
*/
public void setRunningTimeOffset(long offset)
{
gst_event_set_running_time_offset(gstEvent, offset);
}
/**
* Set the sequence number of a event.
*
* This function might be called by the creator of a event to indicate that the
* event relates to other events or messages. See gst_event_get_seqnum() for
* more information.
*
* MT safe.
*
* Params:
* seqnum = A sequence number.
*/
public void setSeqnum(uint seqnum)
{
gst_event_set_seqnum(gstEvent, seqnum);
}
/**
* Set the @stream on the stream-start @event
*
* Params:
* stream = the stream object to set
*
* Since: 1.10
*/
public void setStream(Stream stream)
{
gst_event_set_stream(gstEvent, (stream is null) ? null : stream.getStreamStruct());
}
/** */
public void setStreamFlags(GstStreamFlags flags)
{
gst_event_set_stream_flags(gstEvent, flags);
}
/**
* Get a writable version of the structure.
*
* Returns: The structure of the event. The structure
* is still owned by the event, which means that you should not free
* it and that the pointer becomes invalid when you free the event.
* This function checks if @event is writable and will never return
* %NULL.
*
* MT safe.
*/
public Structure writableStructure()
{
auto p = gst_event_writable_structure(gstEvent);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Structure)(cast(GstStructure*) p);
}
/**
* Gets the #GstEventTypeFlags associated with @type.
*
* Params:
* type = a #GstEventType
*
* Returns: a #GstEventTypeFlags.
*/
public static GstEventTypeFlags typeGetFlags(GstEventType type)
{
return gst_event_type_get_flags(type);
}
/**
* Get a printable name for the given event type. Do not modify or free.
*
* Params:
* type = the event type
*
* Returns: a reference to the static name of the event.
*/
public static string typeGetName(GstEventType type)
{
return Str.toString(gst_event_type_get_name(type));
}
/**
* Get the unique quark for the given event type.
*
* Params:
* type = the event type
*
* Returns: the quark associated with the event type
*/
public static GQuark typeToQuark(GstEventType type)
{
return gst_event_type_to_quark(type);
}
}
|