Totem

typedef struct TotemObject Totem;

The Totem object is a handy synonym for TotemObject, and the two can be used interchangably.

TotemObject

typedef struct TotemObject TotemObject;

All the fields in the TotemObject structure are private and should never be accessed directly.

TotemObjectClass

typedef struct {
	GObjectClass parent_class;

	void (*file_opened)			(Totem *totem, const char *mrl);
	void (*file_closed)			(Totem *totem);
	void (*metadata_updated)		(Totem *totem,
						 const char *artist,
						 const char *title,
						 const char *album,
						 guint track_num);
} TotemObjectClass;

The class structure for the TotemPlParser type.

enum TotemRemoteCommand

typedef enum {
	TOTEM_REMOTE_COMMAND_UNKNOWN = 0,
	TOTEM_REMOTE_COMMAND_PLAY,
	TOTEM_REMOTE_COMMAND_PAUSE,
	TOTEM_REMOTE_COMMAND_STOP,
	TOTEM_REMOTE_COMMAND_PLAYPAUSE,
	TOTEM_REMOTE_COMMAND_NEXT,
	TOTEM_REMOTE_COMMAND_PREVIOUS,
	TOTEM_REMOTE_COMMAND_SEEK_FORWARD,
	TOTEM_REMOTE_COMMAND_SEEK_BACKWARD,
	TOTEM_REMOTE_COMMAND_VOLUME_UP,
	TOTEM_REMOTE_COMMAND_VOLUME_DOWN,
	TOTEM_REMOTE_COMMAND_FULLSCREEN,
	TOTEM_REMOTE_COMMAND_QUIT,
	TOTEM_REMOTE_COMMAND_ENQUEUE,
	TOTEM_REMOTE_COMMAND_REPLACE,
	TOTEM_REMOTE_COMMAND_SHOW,
	TOTEM_REMOTE_COMMAND_TOGGLE_CONTROLS,
	TOTEM_REMOTE_COMMAND_UP,
	TOTEM_REMOTE_COMMAND_DOWN,
	TOTEM_REMOTE_COMMAND_LEFT,
	TOTEM_REMOTE_COMMAND_RIGHT,
	TOTEM_REMOTE_COMMAND_SELECT,
	TOTEM_REMOTE_COMMAND_DVD_MENU,
	TOTEM_REMOTE_COMMAND_ZOOM_UP,
	TOTEM_REMOTE_COMMAND_ZOOM_DOWN,
	TOTEM_REMOTE_COMMAND_EJECT,
	TOTEM_REMOTE_COMMAND_PLAY_DVD,
	TOTEM_REMOTE_COMMAND_MUTE,
	TOTEM_REMOTE_COMMAND_TOGGLE_ASPECT
} TotemRemoteCommand;

Represents a command which can be sent to a running Totem instance remotely.

enum TotemRemoteSetting

typedef enum {
	TOTEM_REMOTE_SETTING_SHUFFLE,
	TOTEM_REMOTE_SETTING_REPEAT
} TotemRemoteSetting;

Represents a boolean setting or preference on a remote Totem instance.

TOTEM_GCONF_PREFIX

#define TOTEM_GCONF_PREFIX "/apps/totem"

The GConf prefix under which all Totem GConf keys are stored.

totem_object_plugins_init ()

void                totem_object_plugins_init           (TotemObject *totem);

Initialises the plugin engine and activates all the enabled plugins.

totem_object_plugins_shutdown ()

void                totem_object_plugins_shutdown       (void);

Shuts down the plugin engine and deactivates all the plugins.

totem_file_opened ()

void                totem_file_opened                   (TotemObject *totem,
                                                         const char *mrl);

Emits the "file-opened" signal on totem, with the specified mrl.

totem_file_closed ()

void                totem_file_closed                   (TotemObject *totem);

Emits the "file-closed" signal on totem.

totem_metadata_updated ()

void                totem_metadata_updated              (TotemObject *totem,
                                                         const char *artist,
                                                         const char *title,
                                                         const char *album,
                                                         guint track_num);

Emits the "metadata-updated" signal on totem, with the specified stream data.

totem_action_error ()

void                totem_action_error                  (const char *title,
                                                         const char *reason,
                                                         Totem *totem);

Displays a non-blocking error dialog with the given title and reason.

totem_action_exit ()

void                totem_action_exit                   (Totem *totem);

Closes Totem.

totem_add_to_playlist_and_play ()

void                totem_add_to_playlist_and_play      (Totem *totem,
                                                         const char *uri,
                                                         const char *display_name,
                                                         gboolean add_to_recent);

Add uri to the playlist and play it immediately.

totem_action_play ()

void                totem_action_play                   (Totem *totem);

Plays the current stream. If Totem is already playing, it continues to play. If the stream cannot be played, and error dialog is displayed.

totem_action_play_media ()

void                totem_action_play_media             (Totem *totem,
                                                         TotemDiscMediaType type,
                                                         const char *device);

Attempts to play the media found on device (for example, a DVD in a drive or a DVB tuner) by first adding it to the playlist, then playing it.

An error dialog will be displayed if Totem cannot support media of type.

totem_action_play_media_device ()

void                totem_action_play_media_device      (Totem *totem,
                                                         const char *device);

Attempts to play the media device (for example, a DVD drive or CD drive) with the given device path by first adding it to the playlist, then playing it.

An error dialog will be displayed if Totem cannot read or play what's on the media device.

totem_action_play_pause ()

void                totem_action_play_pause             (Totem *totem);

Gets the current MRL from the playlist and attempts to play it. If the stream is already playing, playback is paused.

totem_action_pause ()

void                totem_action_pause                  (Totem *totem);

Pauses the current stream. If Totem is already paused, it continues to be paused.

totem_action_stop ()

void                totem_action_stop                   (Totem *totem);

Stops the current stream.

totem_action_fullscreen ()

void                totem_action_fullscreen             (Totem *totem,
                                                         gboolean state);

Sets Totem's fullscreen state according to state.

totem_action_fullscreen_toggle ()

void                totem_action_fullscreen_toggle      (Totem *totem);

Toggles Totem's fullscreen state; if Totem is fullscreened, calling this makes it unfullscreened and vice-versa.

totem_action_next ()

void                totem_action_next                   (Totem *totem);

If a DVD is being played, goes to the next chapter. If a normal stream is being played, plays the next entry in the playlist.

totem_action_previous ()

void                totem_action_previous               (Totem *totem);

If a DVD is being played, goes to the previous chapter. If a normal stream is being played, goes to the start of the stream if possible. If seeking is not possible, plays the previous entry in the playlist.

totem_action_next_angle ()

void                totem_action_next_angle             (Totem *totem);

Switches to the next angle, if watching a DVD. If not watching a DVD, this is a no-op.

totem_action_remote_get_setting ()

gboolean            totem_action_remote_get_setting     (Totem *totem,
                                                         TotemRemoteSetting setting);

Returns the value of setting for this instance of Totem.

totem_action_remote_set_setting ()

void                totem_action_remote_set_setting     (Totem *totem,
                                                         TotemRemoteSetting setting,
                                                         gboolean value);

Sets setting to value on this instance of Totem.

totem_action_seek_time ()

void                totem_action_seek_time              (Totem *totem,
                                                         gint64 sec);

Seeks to an absolute time in the stream, or displays an error dialog if that's not possible.

totem_action_seek_relative ()

void                totem_action_seek_relative          (Totem *totem,
                                                         gint64 offset);

Seeks to an offset from the current position in the stream, or displays an error dialog if that's not possible.

totem_action_volume_relative ()

void                totem_action_volume_relative        (Totem *totem,
                                                         double off_pct);

Sets the volume relative to its current level, with 1.0 being the maximum, and 0.0 being the minimum level.

totem_action_volume_toggle_mute ()

void                totem_action_volume_toggle_mute     (Totem *totem);

Toggles the mute status.

totem_action_toggle_aspect_ratio ()

void                totem_action_toggle_aspect_ratio    (Totem *totem);

Toggles the aspect ratio selected in the menu to the next one in the list.

totem_action_get_aspect_ratio ()

int                 totem_action_get_aspect_ratio       (Totem *totem);

Gets the current aspect ratio as defined in BvwAspectRatio.

totem_action_set_aspect_ratio ()

void                totem_action_set_aspect_ratio       (Totem *totem,
                                                         int ratio);

Sets the aspect ratio selected in the menu to ratio, as defined in BvwAspectRatio.

totem_action_toggle_controls ()

void                totem_action_toggle_controls        (Totem *totem);

If Totem's not fullscreened, this toggles the state of the "Show Controls" menu entry, and consequently shows or hides the controls in the UI.

totem_action_set_scale_ratio ()

void                totem_action_set_scale_ratio        (Totem *totem,
                                                         gfloat ratio);

Sets the video scale ratio, as a float where, for example, 1.0 is 1:1 and 2.0 is 2:1.

totem_action_set_playlist_index ()

void                totem_action_set_playlist_index     (Totem *totem,
                                                         guint index);

Sets the 0-based playlist index to index, causing Totem to load and start playing that playlist entry.

If index is higher than the current length of the playlist, this has the effect of restarting the current playlist entry.

totem_action_remote ()

void                totem_action_remote                 (Totem *totem,
                                                         TotemRemoteCommand cmd,
                                                         const char *url);

Executes the specified cmd on this instance of Totem. If cmd is an operation requiring an MRL, url is required; it can be NULL otherwise.

If Totem's fullscreened and the operation is executed correctly, the controls will appear as if the user had moved the mouse.

totem_is_fullscreen ()

gboolean            totem_is_fullscreen                 (Totem *totem);

Returns TRUE if Totem is fullscreened.

totem_is_playing ()

gboolean            totem_is_playing                    (Totem *totem);

Returns TRUE if Totem is playing a stream.

totem_is_paused ()

gboolean            totem_is_paused                     (Totem *totem);

Returns TRUE if playback is paused.

totem_is_seekable ()

gboolean            totem_is_seekable                   (Totem *totem);

Returns TRUE if the current stream is seekable.

totem_get_main_window ()

GtkWindow *         totem_get_main_window               (Totem *totem);

Gets Totem's main window and increments its reference count.

totem_get_ui_manager ()

GtkUIManager *      totem_get_ui_manager                (Totem *totem);

Gets Totem's UI manager, but does not change its reference count.

totem_get_video_widget ()

GtkWidget *         totem_get_video_widget              (Totem *totem);

Gets Totem's video widget and increments its reference count.

totem_get_video_widget_backend_name ()

char *              totem_get_video_widget_backend_name (Totem *totem);

Gets the name string of the backend video widget, typically the video library's version string (e.g. what's returned by gst_version_string()). Free with g_free().

totem_get_current_mrl ()

char *              totem_get_current_mrl               (Totem *totem);

Get the MRL of the current stream, or NULL if nothing's playing. Free with g_free().

totem_get_current_time ()

gint64              totem_get_current_time              (Totem *totem);

Gets the current position's time in the stream as a gint64.

totem_set_current_subtitle ()

void                totem_set_current_subtitle          (Totem *totem,
                                                         const char *subtitle_uri);

Add the subtitle_uri subtitle file to the playlist, setting it as the subtitle for the current playlist entry.

totem_get_playlist_length ()

guint               totem_get_playlist_length           (Totem *totem);

Returns the length of the current playlist.

totem_get_playlist_pos ()

int                 totem_get_playlist_pos              (Totem *totem);

Returns the 0-based index of the current entry in the playlist. If there is no current entry in the playlist, -1 is returned.

totem_get_title_at_playlist_pos ()

char *              totem_get_title_at_playlist_pos     (Totem *totem,
                                                         guint playlist_index);

Gets the title of the playlist entry at index.

totem_get_short_title ()

char *              totem_get_short_title               (Totem *totem);

Gets the title of the current entry in the playlist.

totem_add_sidebar_page ()

void                totem_add_sidebar_page              (Totem *totem,
                                                         const char *page_id,
                                                         const char *title,
                                                         GtkWidget *main_widget);

Adds a sidebar page to Totem's sidebar with the given page_id. main_widget is added into the page and shown automatically, while title is displayed as the page's title in the tab bar.

totem_remove_sidebar_page ()

void                totem_remove_sidebar_page           (Totem *totem,
                                                         const char *page_id);

Removes the page identified by page_id from Totem's sidebar. If page_id doesn't exist in the sidebar, this function does nothing.

The "current-mrl" property

  "current-mrl"              gchar*                : Read

The MRL of the current stream.

Default value: NULL

The "current-time" property

  "current-time"             gint64                : Read

The player's position (time) in the current stream, in milliseconds.

Default value: 0

The "fullscreen" property

  "fullscreen"               gboolean              : Read

If TRUE, Totem is in fullscreen mode.

Default value: FALSE

The "playing" property

  "playing"                  gboolean              : Read

If TRUE, Totem is playing an audio or video file.

Default value: FALSE

The "seekable" property

  "seekable"                 gboolean              : Read

If TRUE, the current stream is seekable.

Default value: FALSE

The "stream-length" property

  "stream-length"            gint64                : Read

The length of the current stream, in milliseconds.

Default value: 0

The "file-closed" signal

void                user_function                      (TotemObject *totem,
                                                        gpointer     user_data)      : Run Last

The "file-closed" signal is emitted when Totem closes a stream.

The "file-opened" signal

void                user_function                      (TotemObject *totem,
                                                        gchar       *mrl,
                                                        gpointer     user_data)      : Run Last

The "file-opened" signal is emitted when a new stream is opened by Totem.

The "metadata-updated" signal

void                user_function                      (TotemObject *totem,
                                                        gchar       *artist,
                                                        gchar       *title,
                                                        gchar       *album,
                                                        guint        track_number,
                                                        gpointer     user_data)         : Run Last

The "metadata-updated" signal is emitted when the metadata of a stream is updated, typically when it's being loaded.