Inheritance diagram for Clutter::Media:

Collaboration diagram for Clutter::Media:

Public Member Functions
virtual	~Media ()
ClutterMedia*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterMedia*	gobj () const
	Provides access to the underlying C GObject. More...
void	set_uri (const Glib::ustring& uri)
	Sets the URI of media to uri. More...
Glib::ustring	get_uri () const
	Retrieves the URI from media. More...
void	set_playing (bool playing=true)
	Starts or stops playing of media. More...
bool	get_playing () const
	Retrieves the playing status of media. More...
void	set_progress (double progress)
	Sets the playback progress of media. More...
double	get_progress () const
	Retrieves the playback progress of media. More...
void	set_subtitle_uri (const gchar* uri)
	Sets the location of a subtitle file to display while playing media. More...
std::string	get_subtitle_uri () const
	Retrieves the URI of the subtitle file in use. More...
void	set_subtitle_font_name (const std::string& font_name)
	Sets the font used by the subtitle renderer. More...
std::string	get_subtitle_font_name () const
	Retrieves the font name currently used. More...
void	set_audio_volume (double volume)
	Sets the playback volume of media to volume. More...
double	get_audio_volume () const
	Retrieves the playback volume of media. More...
double	get_buffer_percent () const
	Retrieves the amount of the stream that is buffered. More...
void	set_filename (const std::string& filename)
	Sets the source of media using a file path. More...
bool	get_can_seek () const
	Retrieves whether media is seekable or not. More...
double	get_duration () const
	Retrieves the duration of the media stream that media represents. More...
Glib::SignalProxy0< void >	signal_eos ()
Glib::PropertyProxy_ReadOnly < double >	property_buffer_fill () const
	The fill level of the buffer. More...
Glib::PropertyProxy_ReadOnly < bool >	property_can_seek () const
	Whether the current stream is seekable. More...
Glib::PropertyProxy_ReadOnly < guint >	property_duration () const
	The duration of the stream, in seconds. More...
Glib::PropertyProxy< bool >	property_playing ()
	Whether the actor is playing. More...
Glib::PropertyProxy_ReadOnly < bool >	property_playing () const
	Whether the actor is playing. More...
Glib::PropertyProxy< double >	property_progress ()
	Current progress of the playback. More...
Glib::PropertyProxy_ReadOnly < double >	property_progress () const
	Current progress of the playback. More...
Glib::PropertyProxy < Glib::ustring >	property_uri ()
	URI of a media file. More...
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_uri () const
	URI of a media file. More...
Glib::PropertyProxy< double >	property_audio_volume ()
	The volume of the audio. More...
Glib::PropertyProxy_ReadOnly < double >	property_audio_volume () const
	The volume of the audio. More...
Glib::PropertyProxy < Glib::ustring >	property_subtitle_font_name ()
	The font used to display subtitles. More...
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_subtitle_font_name () const
	The font used to display subtitles. More...
Glib::PropertyProxy < Glib::ustring >	property_subtitle_uri ()
	URI of a subtitle file. More...
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_subtitle_uri () const
	URI of a subtitle file. More...

Static Public Member Functions
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	Media ()
	You should derive from this class to use it. More...
virtual void	on_eos ()
	This is a default handler for the signal signal_eos(). More...

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. More...

Detailed Description

Deprecated:

Constructor & Destructor Documentation

Clutter::Media::Media ( )

protected

You should derive from this class to use it.

virtual Clutter::Media::~Media ( )

virtual

Member Function Documentation

static void Clutter::Media::add_interface ( GType  gtype_implementer)

static

double Clutter::Media::get_audio_volume

(

)

const

Retrieves the playback volume of media.

Since cluttermm 1.0:

Deprecated: 1.12

Returns

The playback volume between 0.0 and 1.0.

double Clutter::Media::get_buffer_percent

(

)

const

Retrieves the amount of the stream that is buffered.

Since cluttermm 1.0:

Deprecated: 1.12

Returns

The fill level, between 0.0 and 1.0.

bool Clutter::Media::get_can_seek

(

)

const

Retrieves whether media is seekable or not.

Since cluttermm 0.2:

Deprecated: 1.12

Returns

true if media can seek, false otherwise.

double Clutter::Media::get_duration

(

)

const

Retrieves the duration of the media stream that media represents.

Since cluttermm 0.2:

Deprecated: 1.12

Returns

The duration of the media stream, in seconds.

bool Clutter::Media::get_playing

(

)

const

Retrieves the playing status of media.

Since cluttermm 0.2:

Deprecated: 1.12

Returns

true if playing, false if stopped.

double Clutter::Media::get_progress

(

)

const

Retrieves the playback progress of media.

Since cluttermm 1.0:

Deprecated: 1.12

Returns

The playback progress, between 0.0 and 1.0.

std::string Clutter::Media::get_subtitle_font_name

(

)

const

Retrieves the font name currently used.

Since cluttermm 1.2:

Deprecated: 1.12

Returns

A string containing the font name. Use Glib::free() to free the returned string.

std::string Clutter::Media::get_subtitle_uri

(

)

const

Retrieves the URI of the subtitle file in use.

Since cluttermm 1.2:

Deprecated: 1.12

Returns

The URI of the subtitle file. Use Glib::free() to free the returned string.

static GType Clutter::Media::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

Glib::ustring Clutter::Media::get_uri

(

)

const

Retrieves the URI from media.

Since cluttermm 0.2:

Deprecated: 1.12

Returns

The URI of the media stream. Use Glib::free() to free the returned string.

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.

virtual void Clutter::Media::on_eos ( )

protectedvirtual

This is a default handler for the signal signal_eos().

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

(

)

The volume of the audio.

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 value of the property, or receive notification when the value of the property changes.

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

(

)

const

The volume of the audio.

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

Returns

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

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

(

)

const

The fill level of the buffer.

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

Returns

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

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

(

)

const

Whether 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_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

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

(

)

const

The duration of the stream, in seconds.

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

Returns

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

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

(

)

Whether the actor is 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 value of the property, or receive notification when the value of the property changes.

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

(

)

const

Whether the actor is playing.

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

Returns

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

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

(

)

Current progress of the playback.

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 value of the property, or receive notification when the value of the property changes.

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

(

)

const

Current progress of the playback.

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

Returns

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

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

(

)

The font used to display subtitles.

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 value of the property, or receive notification when the value of the property changes.

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

(

)

const

The font used to display subtitles.

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

Returns

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

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

(

)

URI of a subtitle file.

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 value of the property, or receive notification when the value of the property changes.

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

(

)

const

URI of a subtitle file.

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

Returns

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

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

(

)

URI of a media file.

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 value of the property, or receive notification when the value of the property changes.

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

(

)

const

URI of a media file.

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

Returns

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

void Clutter::Media::set_audio_volume

(

double

volume)

Sets the playback volume of media to volume.

Since cluttermm 1.0:

Deprecated: 1.12

Parameters

volume

The volume as a double between 0.0 and 1.0.

void Clutter::Media::set_filename

(

const std::string &

filename)

Sets the source of media using a file path.

Since cluttermm 0.2:

Deprecated: 1.12

Parameters

filename

A filename.

void Clutter::Media::set_playing

(

bool

playing = true)

Starts or stops playing of media.

The implementation might be asynchronous, so the way to know whether the actual playing state of the media is to use the Object::signal_notify() signal on the Clutter::Media::property_playing() property and then retrieve the current state with get_playing(). ClutterGstVideoTexture in clutter-gst is an example of such an asynchronous implementation.

Since cluttermm 0.2:

Deprecated: 1.12

Parameters

playing

true to start playing.

void Clutter::Media::set_progress

(

double

progress)

Sets the playback progress of media.

The progress is a normalized value between 0.0 (begin) and 1.0 (end).

Since cluttermm 1.0:

Deprecated: 1.12

Parameters

progress

The progress of the playback, between 0.0 and 1.0.

void Clutter::Media::set_subtitle_font_name

(

const std::string &

font_name)

Sets the font used by the subtitle renderer.

The font_name string must be either 0, which means that the default font name of the underlying implementation will be used; or must follow the grammar recognized by pango_font_description_from_string() like:

[C example ellipted]

Since cluttermm 1.2:

Deprecated: 1.12

Parameters

font_name

A font name, or 0 to set the default font name.

void Clutter::Media::set_subtitle_uri

(

const gchar *

uri)

Sets the location of a subtitle file to display while playing media.

Since cluttermm 1.2:

Deprecated: 1.12

Parameters

uri	The URI of a subtitle file.

void Clutter::Media::set_uri

(

const Glib::ustring &

uri)

Sets the URI of media to uri.

Since cluttermm 0.2:

Deprecated: 1.12

Parameters

uri	The URI of the media stream.

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

(

)

Slot Prototype:

void on_my_eos()

The signal_eos() signal is emitted each time the media stream ends.

Since cluttermm 0.2:

Deprecated: 1.12

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:

• cluttermm/media.h