Clutter::Media Class Reference

#include <media.h>

Inheritance diagram for Clutter::Media:

[legend]

List of all members.

Public Member Functions
virtual	~Media ()
ClutterMedia *	gobj ()
	Provides access to the underlying C GObject.
const ClutterMedia *	gobj () const
	Provides access to the underlying C GObject.
void	set_uri (const Glib::ustring &uri)
	Sets the URI of media to uri.
Glib::ustring	get_uri () const
	Retrieves the URI from media.
void	set_playing (bool playing=true)
	Starts or stops media playing.
bool	get_playing () const
	Retrieves the playing status of media.
void	set_position (int position)
	Sets the playback position of media to position.
int	get_position () const
	Retrieves the position of media.
void	set_volume (double volume)
	Sets the playback volume of media to volume.
double	get_volume () const
	Retrieves the playback volume of media.
int	get_buffer_percent () const
	Retrieves the amount of the stream that is buffered.
void	set_filename (const Glib::ustring &filename)
	Sets the filename of the media source.
bool	get_can_seek () const
	Retrieves whether media is seekable or not.
int	get_duration () const
	Retrieves the duration of the media stream that media represents.
Glib::SignalProxy0< void >	signal_eos ()
Glib::PropertyProxy_ReadOnly< int >	property_buffer_percent () const
	The percentage the current stream buffer is filled.
Glib::PropertyProxy_ReadOnly < bool >	property_can_seek () const
	TRUE if the current stream is seekable.
Glib::PropertyProxy_ReadOnly< int >	property_duration () const
	The duration of the current stream in seconds.
Glib::PropertyProxy< bool >	property_playing ()
	TRUE if playing.
Glib::PropertyProxy_ReadOnly < bool >	property_playing () const
	TRUE if playing.
Glib::PropertyProxy< int >	property_position ()
	The position in the current stream in seconds.
Glib::PropertyProxy_ReadOnly< int >	property_position () const
	The position in the current stream in seconds.
Glib::PropertyProxy < Glib::ustring >	property_uri ()
	The loaded URI.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_uri () const
	The loaded URI.
Glib::PropertyProxy< double >	property_volume ()
	The audio volume.
Glib::PropertyProxy_ReadOnly < double >	property_volume () const
	The audio volume.
Static Public Member Functions
static void	add_interface (GType gtype_implementer)
Protected Member Functions
virtual void	set_uri_vfunc (const Glib::ustring &uri)
virtual const char *	get_uri_vfunc () const
virtual void	set_playing_vfunc (bool playing)
virtual bool	get_playing_vfunc () const
virtual void	set_position_vfunc (int position)
virtual int	get_position_vfunc () const
virtual void	set_volume_vfunc (double volume)
virtual double	get_volume_vfunc () const
virtual bool	can_seek_vfunc () const
virtual int	get_buffer_percent_vfunc () const
virtual int	get_duration_vfunc () const
virtual void	on_eos ()
Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::Media >	wrap (ClutterMedia *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Constructor & Destructor Documentation

virtual Clutter::Media::~Media

(

)

[virtual]

---

Member Function Documentation

static void Clutter::Media::add_interface

(

GType

gtype_implementer

)

[static]

ClutterMedia* Clutter::Media::gobj

(

)

[inline]

Provides access to the underlying C GObject.

const ClutterMedia* Clutter::Media::gobj

(

)

const [inline]

Provides access to the underlying C GObject.

void Clutter::Media::set_uri

(

const Glib::ustring &

uri

)

Sets the URI of media to uri.

Parameters:

uri

URI.

Glib::ustring Clutter::Media::get_uri

(

)

const

Retrieves the URI from media.

Returns:

The URI as a string.

void Clutter::Media::set_playing

(

bool

playing = true

)

Starts or stops media playing.

Parameters:

playing

true to start playing, false to stop.

bool Clutter::Media::get_playing

(

)

const

Retrieves the playing status of media.

Returns:

true if playing, false if stopped.

void Clutter::Media::set_position

(

int

position

)

Sets the playback position of media to position.

Parameters:

position

The desired position.

int Clutter::Media::get_position

(

)

const

Retrieves the position of media.

Returns:

The playback position.

void Clutter::Media::set_volume

(

double

volume

)

Sets the playback volume of media to volume.

Parameters:

volume

The volume as a double between 0.0 and 1.0.

double Clutter::Media::get_volume

(

)

const

Retrieves the playback volume of media.

Returns:

The playback volume between 0.0 and 1.0.

int Clutter::Media::get_buffer_percent

(

)

const

Retrieves the amount of the stream that is buffered.

Returns:

Percentage value.

void Clutter::Media::set_filename

(

const Glib::ustring &

filename

)

Sets the filename of the media source.

Parameters:

filename

A filename to media file.

bool Clutter::Media::get_can_seek

(

)

const

Retrieves whether media is seekable or not.

Returns:

true if media can seek, false otherwise.

int Clutter::Media::get_duration

(

)

const

Retrieves the duration of the media stream that media represents.

Returns:

The length of the media stream.

Glib::SignalProxy0< void > Clutter::Media::signal_eos

(

)

Prototype:

void on_my_eos()

Glib::PropertyProxy_ReadOnly<int> Clutter::Media::property_buffer_percent

(

)

const

The percentage the current stream buffer is filled.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Clutter::Media::property_can_seek

(

)

const

TRUE if the current stream is seekable.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<int> Clutter::Media::property_duration

(

)

const

The duration of the current stream in seconds.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Clutter::Media::property_playing

(

)

TRUE if playing.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Clutter::Media::property_playing

(

)

const

TRUE if playing.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<int> Clutter::Media::property_position

(

)

The position in the current stream in seconds.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<int> Clutter::Media::property_position

(

)

const

The position in the current stream in seconds.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Clutter::Media::property_uri

(

)

The loaded URI.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Clutter::Media::property_uri

(

)

const

The loaded URI.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<double> Clutter::Media::property_volume

(

)

The audio volume.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<double> Clutter::Media::property_volume

(

)

const

The audio volume.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

virtual void Clutter::Media::set_uri_vfunc

(

const Glib::ustring &

uri

)

[protected, virtual]

virtual const char* Clutter::Media::get_uri_vfunc

(

)

const [protected, virtual]

virtual void Clutter::Media::set_playing_vfunc

(

bool

playing

)

[protected, virtual]

virtual bool Clutter::Media::get_playing_vfunc

(

)

const [protected, virtual]

virtual void Clutter::Media::set_position_vfunc

(

int

position

)

[protected, virtual]

virtual int Clutter::Media::get_position_vfunc

(

)

const [protected, virtual]

virtual void Clutter::Media::set_volume_vfunc

(

double

volume

)

[protected, virtual]

virtual double Clutter::Media::get_volume_vfunc

(

)

const [protected, virtual]

virtual bool Clutter::Media::can_seek_vfunc

(

)

const [protected, virtual]

virtual int Clutter::Media::get_buffer_percent_vfunc

(

)

const [protected, virtual]

virtual int Clutter::Media::get_duration_vfunc

(

)

const [protected, virtual]

virtual void Clutter::Media::on_eos

(

)

[protected, virtual]

---

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Media > wrap	(	ClutterMedia *	object,
		bool	take_copy = false
	)			[related]

A Glib::wrap() method for this object.

Parameters:

	object	The C instance.
	take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:

A C++ instance that wraps this C instance.

---

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

• media.h