/usr/include/gstreamermm-0.10/gstreamermm/query.h is in libgstreamermm-0.10-dev 0.10.11-0ubuntu2.
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 | // -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GSTREAMERMM_QUERY_H
#define _GSTREAMERMM_QUERY_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* gstreamermm - a C++ wrapper for gstreamer
*
* Copyright 2008 The gstreamermm Development Team
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gst/gstquery.h>
#include <gstreamermm/miniobject.h>
#include <gstreamermm/structure.h>
#include <gstreamermm/wrap.h>
#include <gstreamermm/format.h>
#include <glibmm/arrayhandle.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GstQuery GstQuery;
typedef struct _GstQueryClass GstQueryClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{ class Query_Class; } // namespace Gst
namespace Gst
{
//Gst::IteratorBasic<> forward declaration.
template <class CppType>
class IteratorBasic;
/** @addtogroup gstreamermmEnums gstreamermm Enums and Flags */
/**
* @ingroup gstreamermmEnums
*/
enum QueryType
{
QUERY_NONE,
QUERY_POSITION,
QUERY_DURATION,
QUERY_LATENCY,
QUERY_JITTER,
QUERY_RATE,
QUERY_SEEKING,
QUERY_SEGMENT,
QUERY_CONVERT,
QUERY_FORMATS,
QUERY_BUFFERING,
QUERY_CUSTOM,
QUERY_URI
};
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::QueryType> : public Glib::Value_Enum<Gst::QueryType>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/**
* @ingroup gstreamermmEnums
*/
enum BufferingMode
{
BUFFERING_STREAM,
BUFFERING_DOWNLOAD,
BUFFERING_TIMESHIFT,
BUFFERING_LIVE
};
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::BufferingMode> : public Glib::Value_Enum<Gst::BufferingMode>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/** A class to store the details of a Gst::Query retrieved by
* Gst::Query::get_details().
*/
class QueryTypeDefinition
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef QueryTypeDefinition CppObjectType;
typedef GstQueryTypeDefinition BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
private:
public:
/// Default constructor.
QueryTypeDefinition();
/** Constructs a Gst::QueryTypeDefinition from a C GstQueryTypeDefinition
* type. The @a castitem is left unaffected; its contents are simply copied.
* @param castitem The GstQueryTypeDefinition to copy contents from.
*/
explicit QueryTypeDefinition(const GstQueryTypeDefinition* castitem);
/// The unique id of the Query type.
QueryType value;
/// A short nickname for the query type.
Glib::ustring nick;
/// A longer description of the query type.
Glib::ustring description;
/// The quark for the nick.
Glib::QueryQuark quark;
};
namespace Enums
{
/** Gets a printable name for the given query type.
*
* @param query The query type.
* @return The name of the query.
*/
Glib::ustring get_name(QueryType query);
/** Gets the unique quark for the given query type.
*
* @param query The query type.
* @return The quark associated with the query type.
*/
Glib::QueryQuark get_quark(QueryType query);
} //namespace Enums
/** A class used to perform queries on pads and elements.
*
* Queries can be created using the derived Gst::Query classes create()
* methods. Query values can be set using derived classes set() methods, and
* parsed using derived classes parse() methods.
*
* New query types may also be registered to the GStreamer core using
* register_query_type().
*
* The following example shows how to query the duration of a pipeline:
*
* @code
* Glib::RefPtr<Gst::Query> query = Gst::QueryDuration::create(Gst::FORMAT_TIME);
* bool res = pipeline->query(query);
* if(res)
* {
* gint64 duration = Glib::RefPtr<Gst::QueryDuration>::cast_dynamic(query)->parse();
* ...
* }
* @endcode
*/
class Query : public MiniObject
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Query CppObjectType;
typedef Query_Class CppClassType;
typedef GstQuery BaseObjectType;
typedef GstQueryClass BaseClassType;
private:
friend class Query_Class;
static CppClassType query_class_;
private:
// noncopyable
Query(const Query&);
Query& operator=(const Query&);
protected:
explicit Query(GstQuery* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Query();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GstMiniObject.
GstQuery* gobj() { return reinterpret_cast<GstQuery*>(gobject_); }
///Provides access to the underlying C GstMiniObject.
const GstQuery* gobj() const { return reinterpret_cast<GstQuery*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GstQuery* gobj_copy();
private:
public:
/** Wrap a GstQuery in a C++ instance, creating an instance of a derived
* Gst::Query. Gst::wrap() would just create a Gst::Query (rather than a
* derived one) because the derived Gst::Query classes do not correspond
* to GType types in the GStreamer API.
*/
static Glib::RefPtr<Gst::Query> wrap(GstQuery* query, bool take_copy = false);
/** Makes a writable query from the given query. Does exactly what
* Gst::MiniObject::create_writable() does for the Gst::Query.
* @return A Gst::Query (possibly the same pointer) that is writable.
*/
Glib::RefPtr<Gst::Query> create_writable();
// A copy is taken so that the original is not freed by the wrapper.
/** Get the structure of a query.
* @return The Gst::Structure of the query. The structure is
* still owned by the query and will therefore be freed when the query
* is unreffed.
*/
Gst::Structure get_structure() const;
/** Get the Gst::QueryType of the query.
*/
QueryType get_query_type() const;
/** Create a new GstQueryType based on the nick or return an
* already registered query with that nick
* @param nick The nick of the new query.
* @param description The description of the new query.
* @return A new GstQueryType or an already registered query
* with the same nick.
*/
static QueryType register_query_type(const Glib::ustring& nick, const Glib::ustring& description);
/** Get the query type registered with @a nick.
* @param nick The nick of the query.
* @return The query registered with @a nick or Gst::QUERY_NONE
* if the query was not registered.
*/
static QueryType get_query_type(const Glib::ustring& nick);
/** See if the given Gst::QueryType is inside the @a types query types array.
* @param type The Gst::QueryType to find.
* @return <tt>true</tt> if the type is found inside the array.
*/
static bool query_types_contain(const Glib::ArrayHandle<const QueryType>& types, QueryType type);
/** Get details about the given Gst::QueryType.
*
* @param type A Gst::QueryType.
* @param def A Gst::QueryTypeDefinition in which to store the details.
* @return true if successful, false otherwise.
*/
bool get_details(QueryType type, QueryTypeDefinition& def) const;
/** Get a Gst::IteratorBasic of all the registered query types. The definitions
* iterated over are read only.
* @return A Gst::IteratorBasic of Gst::QueryTypeDefinition.
*/
static Gst::IteratorBasic<const Gst::QueryTypeDefinition> iterate_definitions();
/** Virtual function called when the Gst::Query needs to be copied.
*/
virtual Glib::RefPtr<Gst::MiniObject> copy_vfunc() const;
/** Virtual function called when the Gst::Query is about to be finalized.
*/
virtual void finalize_vfunc();
protected:
protected:
// This method is used in the create() methods to convert a wrapped GstQuery
// to one of the more specific Gst::Query types.
template <class QueryType>
static inline Glib::RefPtr<QueryType> wrap(GstQuery* query,
bool take_copy = false);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
//TODO: Modify create methods of derived Query classes to return
//Glib::RefPtr<...> to the derived class and not just Gst::Query. Must deal
//with GstStructure immutability problem (bug #510301) first because casting
//Glib::RefPtrs references the objects which causes problems when GStreamer API
//tries to modify the GstStructures of the objects.
/** A custom application query object. See create() for more details.
*/
class QueryApplication : public Query
{
public:
explicit QueryApplication(GstQuery* query);
/** Constructs a new custom application query object. The Gst::Query may be
* used by applications in their own way. Please note that a custom
* Gst::QueryType must be used in order for the returned Gst::Query to
* actually be a Gst::QueryApplication type.
* @param type The query type.
* @param structure A structure for the query.
* @return The new Gst::QueryApplication.
*/
static Glib::RefPtr<Gst::QueryApplication>
create(QueryType type, Gst::Structure& structure);
};
/** A convert query object. See create() for more details.
*/
class QueryConvert : public Query
{
public:
explicit QueryConvert(GstQuery* query);
/** Constructs a new convert query object. A convert query is used to ask
* for a conversion between one format and another.
* @param src_format The source Gst::Format for the new query.
* @param value The value to convert.
* @param dest_format The target Gst::Format.
* @return The new Gst::QueryConvert.
*/
static Glib::RefPtr<Gst::QueryConvert>
create(Format src_format, gint64 value, Format dest_format);
/** Answer a convert query by setting the requested values.
* @param src_format The source Gst::Format.
* @param src_value The source value.
* @param dest_format The destination Gst::Format.
* @param dest_value The destination value.
*/
void set(Format src_format, gint64 src_value, Format dest_format, gint64 dest_value);
/** Parse a convert query answer. Use the other parse() methods for parsing
* individual values.
* @param src_format The storage for the Gst::Format of the source value.
* @param src_value The storage for the source value.
* @param dest_format The storage for the Gst::Format of the destination.
* value.
* @param dest_value The storage for the destination value.
*/
void parse(Format& src_format, gint64& src_value, Format& dest_format, gint64& dest_value) const;
/** Parse the destination format and value of a convert query answer.
* @param dest_format The storage for the Gst::Format of the destination
* value.
* @param dest_value The storage for the destination value.
*/
void parse(Format& dest_format, gint64& dest_value) const;
/** Parse the source format of a convert query answer, returning the format.
* @return The Gst::Format of the source value.
*/
Format parse_src_format() const;
/** Parse the source value of a convert query answer returning, the value.
* @return The source value.
*/
gint64 parse_src_value() const;
/** Parse the destination format of a convert query answer, returning the
* format.
* @return The Gst::Format of the destination value.
*/
Format parse_dest_format() const;
/** Parse the destination value of a convert query answer, returning the
* value.
* @return The destination value.
*/
gint64 parse_dest_value() const;
};
/** A stream position query object. See create() for more details.
*/
class QueryPosition : public Query
{
public:
explicit QueryPosition(GstQuery* query);
/** Constructs a new query stream position query object. A position query is
* used to query the current position of playback in the streams, in some
* format.
* @param format The default Gst::Format for the new query.
* @return The new Gst::QueryPosition.
*/
static Glib::RefPtr<Gst::QueryPosition> create(Format format);
/** Answer a position query by setting the requested value in the given
* format.
* @param format The requested Gst::Format.
* @param position The position to set.
*/
void set(Format format, gint64 position);
/** Parse a position query, writing the format into format, and the position
* into @a position. Use the other parse() methods for parsing individual
* values.
* @param format The storage for the Gst::Format of the position values.
* @param position The storage for the current position.
*/
void parse(Format& format, gint64& position) const;
/** Parse the position of a position query, returning the position.
* @return The current position of the position query.
*/
gint64 parse() const;
/** Parse the format of a position query, returning the format.
* @return The the Gst::Format of the position values.
*/
Format parse_format() const;
};
/** A stream duration query object. See create() for more details.
*/
class QueryDuration : public Query
{
public:
explicit QueryDuration(GstQuery* query);
/** Constructs a new stream duration query object to query in the given
* format. A duration query will give the total length of the stream.
* @param format The Gst::Format for this duration query.
* @return The new Gst::QueryDuration.
*/
static Glib::RefPtr<Gst::QueryDuration> create(Format format);
/** Answer a duration query by setting the requested value in the given
* format.
* @param format The Gst::Format for the duration.
* @param duration The duration of the stream.
*/
void set(Format format, gint64 duration);
/** Parse a duration query answer. Write the format of the duration into
* @a format, and the value into @a duration. Use the other parse() methods
* for parsing individual values.
* @param format The storage for the Gst::Format of the duration value.
* @param duration The storage for the total duration.
*/
void parse(Format& format, gint64& duration) const;
/** Parse a duration query answer, returning the duration.
* @return The total duration.
*/
gint64 parse() const;
/** Parse a duration query answer, returning the format of the duration.
* @return The Gst::Format of the duration value.
*/
Format parse_format() const;
};
/** A latency query object. See create() for more details.
*/
class QueryLatency : public Query
{
public:
explicit QueryLatency(GstQuery* query);
/** Constructs a new latency query object. A latency query is usually
* performed by sinks to compensate for additional latency introduced by
* elements in the pipeline.
* @return The new Gst::QueryLatency.
*/
static Glib::RefPtr<Gst::QueryLatency> create();
/** Answer a latency query by setting the requested values in the given
* format.
* @param live If there is a live element upstream.
* @param min_latency The minimal latency of the live element.
* @param max_latency The maximal latency of the live element.
*/
void set(bool live, ClockTime min_latency, ClockTime max_latency);
/** Parse a latency query answer. Use the other parse() methods for parsing
* individual values.
* @param live Storage for live.
* @param min_latency The storage for the min latency.
* @param max_latency The storage for the max latency.
*/
void parse(bool& live, ClockTime& min_latency, ClockTime& max_latency) const;
/** Parse a latency query answer, returning the live status.
* @return the live satus.
*/
bool parse_live() const;
/** Parse a latency query answer, returning the minimum latency.
* @return The minimum latency.
*/
ClockTime parse_min() const;
/** Parse a latency query answer, returning the maximum latency.
* @return The maximum latency.
*/
ClockTime parse_max() const;
};
/** A seeking query object. See create() for more details.
*/
class QuerySeeking : public Query
{
public:
explicit QuerySeeking(GstQuery* query);
/** Constructs a new query object for querying seeking properties of the
* stream.
* @param format The default Gst::Format for the new query.
* @return The new Gst::QuerySeeking.
*/
static Glib::RefPtr<Gst::QuerySeeking> create(Format format);
/** Set the seeking query result fields in query.
* @param format The format to set for @a the segment_start and
* @a segment_end values.
* @param seekable The seekable flag to set.
* @param segment_start The segment_start to set.
* @param segment_end The segment_end to set.
*/
void set(Format format, bool seeakable, gint64 segment_start, gint64 segment_end);
/** Parse a seeking query, writing the format into format, and other results
* into the passed parameters. Use the other parse() methods for parsing
* individual values.
* @param format The storage location for the foramt.
* @param seekable The storage location for the seekable flag.
* @param segment_start The storage location for the segment start value.
* @param segment_end The storage location for the segment end.
*/
void parse(Format& format, bool& seekable, gint64& segment_start, gint64& segment_end) const;
/** Parse a seeking query, returning the format.
* @return The format.
*/
Format parse_format() const;
/** Parse a seeking query, returning the seekable status.
* @return The seekable flag.
*/
bool parse_seekable() const;
/** Parse a seeking query, returning the segment start value.
* @return The segment start.
*/
gint64 parse_start() const;
/** Parse a seeking query, returning the segment end value.
* @return The segment end.
*/
gint64 parse_end() const;
};
/** A formats query object. See create() for more details.
*/
class QueryFormats : public Query
{
public:
explicit QueryFormats(GstQuery* query);
/** Constructs a new query object for querying formats of the stream.
* @return The new Gst::QueryFormats.
*/
static Glib::RefPtr<Gst::QueryFormats> create();
/** Set the formats query result fields. All the formats in the array are
* used.
* @param formats An array containing Gst::Format values.
*/
void set(const Glib::ArrayHandle<Format>& formats);
/** Set the formats query result fields using only @a n_formats from @a
* formats. The number of formats passed in the formats array must be
* greater than or equal to @a n_formats.
* @param n_formats The number of formats to set.
* @param formats An array containing at least @a n_formats Gst::Format
* values.
*/
void set(int n_formats, const Glib::ArrayHandle<Format>& formats);
/** Parse and return the number of formats in the formats query.
* @return The number of formats in this query.
*/
guint parse_length() const;
/** Parse the format query and return the @a nth format from it. If the list
* contains less elements than @a nth, Gst::FORMAT_UNDEFINED will be
* returned.
* @param nth The index of the format to return.
* @return the @a nth format or Gst::FORMAT_UNDEFINED.
*/
Format parse(guint nth) const;
};
/** A new segment query object. See create() for more details.
*/
class QuerySegment : public Query
{
public:
explicit QuerySegment(GstQuery* query);
/** Constructs a new segment query object. A segment query is used to
* discover information about the currently configured segment for playback.
* @param format The Gst::Format for the new query.
* @return The new Gst::QuerySegment.
*/
static Glib::RefPtr<Gst::QuerySegment> create(Format format);
/** Answer a segment query by setting the requested values. The normal
* playback segment of a pipeline is 0 to duration at the default rate of
* 1.0. If a seek was performed on the pipeline to play a different segment,
* this query will return the range specified in the last seek.
*
* @a start_value and @a stop_value will respectively contain the configured
* playback range start and stop values expressed in @a format. The values
* are always between 0 and the duration of the media and @a start_value <=
* @a stop_value. @a rate will contain the playback rate. For negative
* rates, playback will actually happen from @a stop_value to @a start_value.
*
* @param rate The rate of the segment.
* @param format The Gst::Format of the segment values (@a start_value and
* @a stop_value).
* @param start_value The start value.
* @param stop_value The stop value.
*/
void set(double rate, Format format, gint64 start_value, gint64 stop_value);
/** Parse a segment query answer. See set() for an explanation of the
* function arguments. Use the other parse() methods to parse individual
* values.
*
* @param rate The storage for the rate of the segment.
* @param format The storage for the Gst::Format of the values.
* @param start_value The storage for the start value.
* @param stop_value The storage for the stop value.
*/
void parse(double& rate, Format& format, gint64& start_value, gint64& stop_value) const;
/** Parse a segment query answer, returning the rate. See set() for an
* explanation of the function arguments.
* @return The rate of the segment.
*/
double parse_rate() const;
/** Parse a segment query answer, returning the format. See set() for an
* explanation of the function arguments.
* @return The Gst::Format of the start and stop values.
*/
Format parse_format() const;
/** Parse a segment query answer, returning the start value. See set() for
* an explanation of the function arguments.
* @return The start value.
*/
gint64 parse_start() const;
/** Parse a segment query answer, returning the stop value. See set() for
* an explanation of the function arguments.
* @return The stop value.
*/
gint64 parse_stop() const;
};
/** A new buffering query object. See create() for more details.
*/
class QueryBuffering : public Query
{
public:
explicit QueryBuffering(GstQuery* query);
/** Constructs a new query object for querying the buffering status of a
* stream.
* @param format The default Gst::Format for the new query.
* @return The new Gst::QueryBuffering.
*/
static Glib::RefPtr<Gst::QueryBuffering> create(Format format);
/** Set the percentage of buffered data. This is a value between 0 and 100.
* The @a busy indicator is true when the buffering is in progress.
* @param busy If buffering is busy.
* @param percent A buffering percent.
*/
void set(bool busy, int percent);
/** Get the busy flag and percentage of the buffered data. The percent is a
* value between 0 and 100. The busy indicator is true when the buffering
* is in progress. Use the other parse() methods to parse individual
* values.
* @param busy The location to store the buffering busy flag.
* @param percent The location to store the buffering percent.
*/
void parse(bool& busy, int& percent) const;
/** Get the busy flag of the buffered data. The busy indicator is true when
* the buffering is in progress.
* @return The buffering busy flag.
*/
bool parse_busy() const;
/** Get the percentage of the buffered data. The percent is a value between
* 0 and 100.
* @return The buffering percent.
*/
int parse_percent() const;
/** Configures the buffering stats values in query.
* @param mode A buffering mode.
* @param avg_in The average input rate.
* @param avg_out The average output rate.
* @param buffering_left Amount of buffering time left.
*/
void set(BufferingMode mode, int avg_in, int avg_out, gint64 buffering_left);
/** Extracts the buffering stats values from the query. Use the other
* parse() methods to parse individual values.
* @param mode The location to store the buffering mode.
* @param avg_in The location to store the average input rate.
* @param avg_out The location to store the average output rate.
* @param buffering_left The location to store the amount of buffering time
* left.
*/
void parse(BufferingMode& mode, int& avg_in, int& avg_out, gint64 buffering_left) const;
/** Extracts the buffering mode from the query.
* @return The the buffering mode.
*/
BufferingMode parse_mode() const;
/** Extracts the average input rate from the query.
* @return The average input rate.
*/
int parse_input_rate() const;
/** Extracts the average output rate from the query.
* @return The average output rate.
*/
int parse_output_rate() const;
/** Extracts the buffering time left from the query.
* @return The the amount of buffering time left.
*/
gint64 parse_time_left() const;
/** Set the available query result fields in query.
* @param format The format to set for the start and stop values.
* @param start The start to set.
* @param stop The stop to set.
* @param estimated_total Estimated total amount of download time.
*/
void set(Format format, gint64 start, gint64 stop, gint64 estimated_total);
/** Parse the query, writing the format into format, and other
* results into the passed parameters. Use the other parse() methods to
* parse individual values.
* @param format The location to store the format.
* @param start The location to store the start.
* @param stop The location to store the stop.
* @param estimated_total The location to store the estimated total amount
* of download time.
*/
void parse(Format& format, gint64& start, gint64& stop, gint64& estimated_total) const;
/** Parse the query, returning the format.
* @return The format.
*/
Format parse_format() const;
/** Parse the query, returning the start range value.
* @return The start value.
*/
gint64 parse_start() const;
/** Parse the query, returning the stop range value.
* @return The stop value.
*/
gint64 parse_stop() const;
/** Parse the query, returning the estimated total amount of download time.
* @return The estimated total amount of download time.
*/
gint64 parse_total_time() const;
};
/****************************** Gst::Query **************************/
template <class QueryType>
Glib::RefPtr<QueryType> Query::wrap(GstQuery* query, bool take_copy)
{
Glib::RefPtr<Gst::Query> result = wrap(query, take_copy);
return Glib::RefPtr<QueryType>::cast_dynamic(result);
}
} //namespace Gst
namespace Gst
{
/** @relates Gst::Query
* @param object The C instance
* @param take_copy false if the result should take ownership of the C instance. true if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*/
Glib::RefPtr<Gst::Query> wrap(GstQuery* object, bool take_copy = false);
}
#endif /* _GSTREAMERMM_QUERY_H */
|