gstreamermm  0.10.11
Public Member Functions | Static Public Member Functions
Gst::QueryBuffering Class Reference

A new buffering query object. More...

Inheritance diagram for Gst::QueryBuffering:
Inheritance graph
[legend]
Collaboration diagram for Gst::QueryBuffering:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 QueryBuffering (GstQuery* query)
void set (bool busy, int percent)
 Set the percentage of buffered data.
void parse (bool& busy, int& percent) const
 Get the busy flag and percentage of the buffered data.
bool parse_busy () const
 Get the busy flag of the buffered data.
int parse_percent () const
 Get the percentage of the buffered data.
void set (BufferingMode mode, int avg_in, int avg_out, gint64 buffering_left)
 Configures the buffering stats values in query.
void parse (BufferingMode& mode, int& avg_in, int& avg_out, gint64 buffering_left) const
 Extracts the buffering stats values from the query.
BufferingMode parse_mode () const
 Extracts the buffering mode from the query.
int parse_input_rate () const
 Extracts the average input rate from the query.
int parse_output_rate () const
 Extracts the average output rate from the query.
gint64 parse_time_left () const
 Extracts the buffering time left from the query.
void set (Format format, gint64 start, gint64 stop, gint64 estimated_total)
 Set the available query result fields in query.
void parse (Format& format, gint64&start, gint64& stop, gint64& estimated_total) const
 Parse the query, writing the format into format, and other results into the passed parameters.
Format parse_format () const
 Parse the query, returning the format.
gint64 parse_start () const
 Parse the query, returning the start range value.
gint64 parse_stop () const
 Parse the query, returning the stop range value.
gint64 parse_total_time () const
 Parse the query, returning the estimated total amount of download time.

Static Public Member Functions

static Glib::RefPtr
< Gst::QueryBuffering
create (Format format)
 Constructs a new query object for querying the buffering status of a stream.

Detailed Description

A new buffering query object.

See create() for more details.


Constructor & Destructor Documentation

Gst::QueryBuffering::QueryBuffering ( GstQuery *  query) [explicit]

Member Function Documentation

Constructs a new query object for querying the buffering status of a stream.

Parameters:
formatThe default Gst::Format for the new query.
Returns:
The new Gst::QueryBuffering.
void Gst::QueryBuffering::parse ( bool &  busy,
int &  percent 
) const

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.

Parameters:
busyThe location to store the buffering busy flag.
percentThe location to store the buffering percent.
void Gst::QueryBuffering::parse ( BufferingMode mode,
int &  avg_in,
int &  avg_out,
gint64  buffering_left 
) const

Extracts the buffering stats values from the query.

Use the other parse() methods to parse individual values.

Parameters:
modeThe location to store the buffering mode.
avg_inThe location to store the average input rate.
avg_outThe location to store the average output rate.
buffering_leftThe location to store the amount of buffering time left.
void Gst::QueryBuffering::parse ( Format format,
gint64 &  start,
gint64 &  stop,
gint64 &  estimated_total 
) const

Parse the query, writing the format into format, and other results into the passed parameters.

Use the other parse() methods to parse individual values.

Parameters:
formatThe location to store the format.
startThe location to store the start.
stopThe location to store the stop.
estimated_totalThe location to store the estimated total amount of download time.

Get the busy flag of the buffered data.

The busy indicator is true when the buffering is in progress.

Returns:
The buffering busy flag.

Parse the query, returning the format.

Returns:
The format.

Extracts the average input rate from the query.

Returns:
The average input rate.

Extracts the buffering mode from the query.

Returns:
The the buffering mode.

Extracts the average output rate from the query.

Returns:
The average output rate.

Get the percentage of the buffered data.

The percent is a value between 0 and 100.

Returns:
The buffering percent.

Parse the query, returning the start range value.

Returns:
The start value.

Parse the query, returning the stop range value.

Returns:
The stop value.

Extracts the buffering time left from the query.

Returns:
The the amount of buffering time left.

Parse the query, returning the estimated total amount of download time.

Returns:
The estimated total amount of download time.
void Gst::QueryBuffering::set ( bool  busy,
int  percent 
)

Set the percentage of buffered data.

This is a value between 0 and 100. The busy indicator is true when the buffering is in progress.

Parameters:
busyIf buffering is busy.
percentA buffering percent.
void Gst::QueryBuffering::set ( BufferingMode  mode,
int  avg_in,
int  avg_out,
gint64  buffering_left 
)

Configures the buffering stats values in query.

Parameters:
modeA buffering mode.
avg_inThe average input rate.
avg_outThe average output rate.
buffering_leftAmount of buffering time left.
void Gst::QueryBuffering::set ( Format  format,
gint64  start,
gint64  stop,
gint64  estimated_total 
)

Set the available query result fields in query.

Parameters:
formatThe format to set for the start and stop values.
startThe start to set.
stopThe stop to set.
estimated_totalEstimated total amount of download time.

The documentation for this class was generated from the following file: