ClutterMedia: Clutter Reference Manual

## ClutterMedia ClutterMedia — An interface for controlling playback of media data |

## Functions

void | clutter_media_set_uri ()
gchar * | clutter_media_get_uri ()
void | clutter_media_set_playing ()
gboolean | clutter_media_get_playing ()
void | clutter_media_set_progress ()
gdouble | clutter_media_get_progress ()
void | clutter_media_set_subtitle_uri ()
gchar * | clutter_media_get_subtitle_uri ()
void | clutter_media_set_subtitle_font_name ()
gchar * | clutter_media_get_subtitle_font_name ()
void | clutter_media_set_audio_volume ()
gdouble | clutter_media_get_audio_volume ()
gboolean | clutter_media_get_can_seek ()
gdouble | clutter_media_get_buffer_fill ()
gdouble | clutter_media_get_duration ()
void | clutter_media_set_filename ()

## Properties

gdouble | audio-volume | Read / Write
gdouble | buffer-fill | Read
gboolean | can-seek | Read
gdouble | duration | Read
gboolean | playing | Read / Write
gdouble | progress | Read / Write
gchar * | subtitle-font-name | Read / Write
gchar * | subtitle-uri | Read / Write
gchar * | uri | Read / Write

## Signals

void | eos | Run Last
void | error | Run Last

## Types and Values

| ClutterMedia
struct | ClutterMediaIface

## Object Hierarchy

        GInterface
        ╰── ClutterMedia

## Prerequisites

ClutterMedia requires GObject.

## Description

ClutterMedia is an interface for controlling playback of media sources.

Clutter core does not provide an implementation of this interface, but other integration libraries like Clutter-GStreamer implement it to offer a uniform API for applications.

ClutterMedia is available since Clutter 0.2

ClutterMedia is deprecated since Clutter 1.12. Use the Clutter-GStreamer API directly instead.

## Functions

### clutter_media_set_uri ()

    void
    clutter_media_set_uri (ClutterMedia *media,
                           const gchar *uri);

`clutter_media_set_uri` has been deprecated since version 1.12 and should not be used in newly-written code.

Sets the URI of `media` to `uri` .

#### Parameters

media | a ClutterMedia |
uri | the URI of the media stream |

Since: 0.2

### clutter_media_get_uri ()

    gchar *
    clutter_media_get_uri (ClutterMedia *media);

`clutter_media_get_uri` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the URI from `media` .

#### Parameters

media | a ClutterMedia |

#### Returns

the URI of the media stream. Use `g_free()` to free the returned string

Since: 0.2

### clutter_media_set_playing ()

    void
    clutter_media_set_playing (ClutterMedia *media,
                               gboolean playing);

`clutter_media_set_playing` has been deprecated since version 1.12 and should not be used in newly-written code.

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 “notify” signal on the “playing” property and then retrieve the current state with `clutter_media_get_playing()`. ClutterGstVideoTexture in clutter-gst is an example of such an asynchronous implementation.

#### Parameters

media | a ClutterMedia |
playing | `TRUE` to start playing |

Since: 0.2

### clutter_media_get_playing ()

    gboolean
    clutter_media_get_playing (ClutterMedia *media);

`clutter_media_get_playing` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the playing status of `media` .

#### Parameters

media | A ClutterMedia object |

#### Returns

`TRUE` if playing, `FALSE` if stopped.

Since: 0.2

### clutter_media_set_progress ()

    void
    clutter_media_set_progress (ClutterMedia *media,
                                gdouble progress);

`clutter_media_set_progress` has been deprecated since version 1.12 and should not be used in newly-written code.

Sets the playback progress of `media` . The `progress` is a normalized value between 0.0 (begin) and 1.0 (end).

#### Parameters

media | a ClutterMedia |
progress | the progress of the playback, between 0.0 and 1.0 |

Since: 1.0

### clutter_media_get_progress ()

    gdouble
    clutter_media_get_progress (ClutterMedia *media);

`clutter_media_get_progress` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the playback progress of `media` .

#### Parameters

media | a ClutterMedia |

#### Returns

the playback progress, between 0.0 and 1.0

Since: 1.0

### clutter_media_set_subtitle_uri ()

    void
    clutter_media_set_subtitle_uri (ClutterMedia *media,
                                    const gchar *uri);

`clutter_media_set_subtitle_uri` has been deprecated since version 1.12 and should not be used in newly-written code.

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

#### Parameters

media | a ClutterMedia |
uri | the URI of a subtitle file |

Since: 1.2

### clutter_media_get_subtitle_uri ()

    gchar *
    clutter_media_get_subtitle_uri (ClutterMedia *media);

`clutter_media_get_subtitle_uri` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the URI of the subtitle file in use.

#### Parameters

media | a ClutterMedia |

#### Returns

the URI of the subtitle file. Use `g_free()` to free the returned string

Since: 1.2

### clutter_media_set_subtitle_font_name ()

    void
    clutter_media_set_subtitle_font_name (ClutterMedia *media,
                                          const char *font_name);

`clutter_media_set_subtitle_font_name` has been deprecated since version 1.12 and should not be used in newly-written code.

Sets the font used by the subtitle renderer. The `font_name` string must be either `NULL`, 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:

    1
    clutter_media_set_subtitle_font_name (media, "Sans 24pt");

#### Parameters

media | a ClutterMedia |
font_name | a font name, or `NULL` to set the default font name |

Since: 1.2

### clutter_media_get_subtitle_font_name ()

    gchar *
    clutter_media_get_subtitle_font_name (ClutterMedia *media);

`clutter_media_get_subtitle_font_name` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the font name currently used.

#### Parameters

media | a ClutterMedia |

#### Returns

a string containing the font name. Use `g_free()` to free the returned string

Since: 1.2

### clutter_media_set_audio_volume ()

    void
    clutter_media_set_audio_volume (ClutterMedia *media,
                                    gdouble volume);

`clutter_media_set_audio_volume` has been deprecated since version 1.12 and should not be used in newly-written code.

Sets the playback volume of `media` to `volume` .

#### Parameters

media | a ClutterMedia |
volume | the volume as a double between 0.0 and 1.0 |

Since: 1.0

### clutter_media_get_audio_volume ()

    gdouble
    clutter_media_get_audio_volume (ClutterMedia *media);

`clutter_media_get_audio_volume` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the playback volume of `media` .

#### Parameters

media | a ClutterMedia |

#### Returns

The playback volume between 0.0 and 1.0

Since: 1.0

### clutter_media_get_can_seek ()

    gboolean
    clutter_media_get_can_seek (ClutterMedia *media);

`clutter_media_get_can_seek` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves whether `media` is seekable or not.

#### Parameters

media | a ClutterMedia |

#### Returns

`TRUE` if `media` can seek, `FALSE` otherwise.

Since: 0.2

### clutter_media_get_buffer_fill ()

    gdouble
    clutter_media_get_buffer_fill (ClutterMedia *media);

`clutter_media_get_buffer_fill` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the amount of the stream that is buffered.

#### Parameters

media | a ClutterMedia |

#### Returns

the fill level, between 0.0 and 1.0

Since: 1.0

### clutter_media_get_duration ()

    gdouble
    clutter_media_get_duration (ClutterMedia *media);

`clutter_media_get_duration` has been deprecated since version 1.12 and should not be used in newly-written code.

Retrieves the duration of the media stream that `media` represents.

#### Parameters

media | a ClutterMedia |

#### Returns

the duration of the media stream, in seconds

Since: 0.2

### clutter_media_set_filename ()

    void
    clutter_media_set_filename (ClutterMedia *media,
                                const gchar *filename);

`clutter_media_set_filename` has been deprecated since version 1.12 and should not be used in newly-written code.

Sets the source of `media` using a file path.

#### Parameters

media | a ClutterMedia |
filename | A filename |

Since: 0.2

## Types and Values

### ClutterMedia

    typedef struct _ClutterMedia ClutterMedia;

ClutterMedia is an opaque structure whose members cannot be directly accessed

Since: 0.2

### struct ClutterMediaIface

    struct ClutterMediaIface {
      /* signals */
      void (* eos)   (ClutterMedia *media);
      void (* error) (ClutterMedia *media,
    		  const GError *error);
    };

Interface vtable for ClutterMedia implementations

#### Members

`eos` () | handler for the “eos” signal |
`error` () | handler for the “error” signal |

Since: 0.2

## Property Details

### The `“audio-volume”` property

      “audio-volume”             gdouble

The volume of the audio, as a normalized value between 0.0 and 1.0.

`ClutterMedia:audio-volume` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

Since: 1.0

### The `“buffer-fill”` property

      “buffer-fill”              gdouble

The fill level of the buffer for the current stream, as a value between 0.0 and 1.0.

`ClutterMedia:buffer-fill` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read

Allowed values: [0,1]

Default value: 0

Since: 1.0

### The `“can-seek”` property

      “can-seek”                 gboolean

Whether the current stream is seekable.

`ClutterMedia:can-seek` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read

Default value: FALSE

Since: 0.2

### The `“duration”` property

      “duration”                 gdouble

The duration of the current stream, in seconds

`ClutterMedia:duration` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read

Allowed values: >= 0

Default value: 0

Since: 0.2

### The `“playing”` property

      “playing”                  gboolean

Whether the ClutterMedia actor is playing.

`ClutterMedia:playing` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read / Write

Default value: FALSE

Since: 0.2

### The `“progress”` property

      “progress”                 gdouble

The current progress of the playback, as a normalized value between 0.0 and 1.0.

`ClutterMedia:progress` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

Since: 1.0

### The `“subtitle-font-name”` property

      “subtitle-font-name”       gchar *

The font used to display subtitles. The font description has to follow the same grammar as the one recognized by `pango_font_description_from_string()`.

`ClutterMedia:subtitle-font-name` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read / Write

Default value: NULL

Since: 1.2

### The `“subtitle-uri”` property

      “subtitle-uri”             gchar *

The location of a subtitle file, expressed as a valid URI.

`ClutterMedia:subtitle-uri` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read / Write

Default value: NULL

Since: 1.2

### The `“uri”` property

      “uri”                      gchar *

The location of a media file, expressed as a valid URI.

`ClutterMedia:uri` has been deprecated since version 1.12 and should not be used in newly-written code.

Flags: Read / Write

Default value: NULL

Since: 0.2

## Signal Details

### The `“eos”` signal

    void
    user_function (ClutterMedia *media,
                   gpointer      user_data)

The ::eos signal is emitted each time the media stream ends.

`ClutterMedia::eos` has been deprecated since version 1.12 and should not be used in newly-written code.

#### Parameters

media | the ClutterMedia instance that received the signal |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 0.2

### The `“error”` signal

    void
    user_function (ClutterMedia *media,
                   GError       *error,
                   gpointer      user_data)

The ::error signal is emitted each time an error occurred.

`ClutterMedia::error` has been deprecated since version 1.12 and should not be used in newly-written code.

#### Parameters

media | the ClutterMedia instance that received the signal |
error | the GError |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 0.2