![]() |
![]() |
![]() |
Parole Plugins Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Signals |
struct ParoleProviderPlayerIface; ParoleProviderPlayer; enum ParolePluginContainer; enum ParoleState; GtkWidget * parole_provider_player_get_main_window (ParoleProviderPlayer *player
); void parole_provider_player_pack (ParoleProviderPlayer *player
,GtkWidget *widget
,const gchar *title
,ParolePluginContainer container
); ParoleState parole_provider_player_get_state (ParoleProviderPlayer *player
); const ParoleStream * parole_provider_player_get_stream (ParoleProviderPlayer *player
); gboolean parole_provider_player_play_uri (ParoleProviderPlayer *player
,const gchar *uri
); gboolean parole_provider_player_pause (ParoleProviderPlayer *player
); gboolean parole_provider_player_resume (ParoleProviderPlayer *player
); gboolean parole_provider_player_stop (ParoleProviderPlayer *player
); gboolean parole_provider_player_seek (ParoleProviderPlayer *player
,gdouble pos
); void parole_provider_player_open_media_chooser (ParoleProviderPlayer *player
);
GInterface +----ParoleProviderPlayerIface
GEnum +----ParolePluginContainer
GEnum +----ParoleState
The player interface that the plugins should use in order to, issue playback commands to the Parole GStreamer backend or to get information about the current playback status.
typedef enum { PAROLE_PLUGIN_CONTAINER_PLAYLIST, PAROLE_PLUGIN_CONTAINER_MAIN_VIEW } ParolePluginContainer;
typedef enum { PAROLE_STATE_STOPPED = 0, PAROLE_STATE_PLAYBACK_FINISHED, PAROLE_STATE_PAUSED, PAROLE_STATE_PLAYING } ParoleState;
GtkWidget * parole_provider_player_get_main_window
(ParoleProviderPlayer *player
);
Ask the Player to get the Parole main window.
|
a ParoleProviderPlayer |
Returns : |
GtkWidget window. |
Since 0.2
void parole_provider_player_pack (ParoleProviderPlayer *player
,GtkWidget *widget
,const gchar *title
,ParolePluginContainer container
);
Ask the player to pack a widget in the playlist notebook if PAROLE_PLUGIN_CONTAINER_PLAYLIST is specified or in the main window notebook if PAROLE_PLUGIN_CONTAINER_MAIN_VIEW is specified.
This function can be called once, the Player is responsible on removing the widget in case the plugin was unloaded.
|
a ParoleProviderPlayer |
|
a GtkWidget. |
|
title |
|
a ParolePluginContainer. |
Since 0.2
ParoleState parole_provider_player_get_state (ParoleProviderPlayer *player
);
Get the current state of the player.
|
a ParoleProviderPlayer |
Returns : |
a ParoleState. |
Since 0.2
const ParoleStream * parole_provider_player_get_stream (ParoleProviderPlayer *player
);
Get the ParoleStream object.
|
a ParoleProviderPlayer |
Returns : |
the ParoleStream object. |
Since 0.2
gboolean parole_provider_player_play_uri (ParoleProviderPlayer *player
,const gchar *uri
);
Issue a play command on the backend for the given uri, note this function can be called only of the Parole current state is PAROLE_STATE_STOPPED.
Returning TRUE doesn't mean that the funtion succeeded to change the state of the player, the state change is indicated asynchronously by "state-changed" signal.
|
a ParoleProviderPlayer |
|
uri |
Returns : |
TRUE if the command is processed, FALSE otherwise. |
Since 0.2
gboolean parole_provider_player_pause (ParoleProviderPlayer *player
);
Issue a pause command to the backend, this function can be called when the state of the player is PAROLE_STATE_PLAYING.
Returning TRUE doesn't mean that the funtion succeeded to change the state of the player, the state change is indicated asynchronously by "state-changed" signal.
|
a ParoleProviderPlayer |
Returns : |
TRUE if the command is processed, FALSE otherwise. |
Since 0.2
gboolean parole_provider_player_resume (ParoleProviderPlayer *player
);
Issue a resume command to the player, this function can be called when the current state of the player is PAROLE_STATE_PAUSED.
Returning TRUE doesn't mean that the funtion succeeded to change the state of the player, the state change is indicated asynchronously by "state-changed" signal.
|
a ParoleProviderPlayer |
Returns : |
TRUE if the command is processed, FALSE otherwise. |
Since 0.2
gboolean parole_provider_player_stop (ParoleProviderPlayer *player
);
Issue a stop command to the player.
Returning TRUE doesn't mean that the funtion succeeded to change the state of the player, the state change is indicated asynchronously by "state-changed" signal.
|
a ParoleProviderPlayer |
Returns : |
TRUE if the command is processed, FALSE otherwise. |
Since 0.2
gboolean parole_provider_player_seek (ParoleProviderPlayer *player
,gdouble pos
);
Issue a seek command.
|
a ParoleProviderPlayer |
|
position to seek. |
Returns : |
TRUE if the seek command succeeded, FALSE otherwise. |
Since 0.2
void parole_provider_player_open_media_chooser
(ParoleProviderPlayer *player
);
Ask Parole to open its media chooser dialog.
|
a ParoleProviderPlayer |
Since 0.2
"state-changed"
signalvoid user_function (ParoleProviderPlayerIface *player,
ParoleStream *stream,
ParoleState state,
gpointer user_data) : Run Last
Issued when the Parole state changed.
|
the object which received the signal. |
|
a ParoleStream. |
|
the new state. |
|
user data set when the signal handler was connected. |
Since 0.2
"tag-message"
signalvoid user_function (ParoleProviderPlayerIface *player,
ParoleStream *stream,
gpointer user_data) : Run Last
Indicated that the stream tags were found and ready to be read.
|
the object which received the signal. |
|
a ParoleStream. |
|
user data set when the signal handler was connected. |
Since 0.2