![]() |
![]() |
![]() |
Parole Plugins Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Signals |
struct ParoleProviderPlayerIface; ParoleProviderPlayer; enum ParolePluginContainer; enum ParoleState; void parole_provider_player_pack (ParoleProviderPlayer *player
,GtkWidget *widget
,const gchar *title
,ParolePluginContainer container
); GSimpleAction * parole_provider_player_get_action (ParoleProviderPlayer *player
,ParolePlayerAction action
); gboolean parole_provider_player_set_fullscreen (ParoleProviderPlayer *player
,gboolean fullscreen
); gboolean parole_provider_player_get_fullscreen (ParoleProviderPlayer *player
); void parole_stream_set_image (GObject *object
,GdkPixbuf *pixbuf
); GdkPixbuf * parole_stream_get_image (GObject *object
); ParoleState parole_provider_player_get_state (ParoleProviderPlayer *player
); gdouble parole_provider_player_get_stream_position (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_play_next (ParoleProviderPlayer *player
); gboolean parole_provider_player_play_previous (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_ABOUT_TO_FINISH, PAROLE_STATE_PAUSED, PAROLE_STATE_PLAYING } ParoleState;
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
GSimpleAction * parole_provider_player_get_action (ParoleProviderPlayer *player
,ParolePlayerAction action
);
Get GSimpleAction from Parole.
|
a ParoleProviderPlayer |
|
the ParolePlayerAction to retrieve |
Returns : |
the requested GSimpleAction. |
Since 0.6
gboolean parole_provider_player_set_fullscreen (ParoleProviderPlayer *player
,gboolean fullscreen
);
Set fullscreen status for Parole.
|
a ParoleProviderPlayer |
|
TRUE for fullscreen, FALSE for unfullscreen |
Returns : |
TRUE if the fullscreen command succeeded, FALSE otherwise. |
Since 0.6
gboolean parole_provider_player_get_fullscreen
(ParoleProviderPlayer *player
);
Get fullscreen status for Parole.
|
a ParoleProviderPlayer |
Returns : |
TRUE if the player window is fullscreen, FALSE otherwise. |
Since 0.6
void parole_stream_set_image (GObject *object
,GdkPixbuf *pixbuf
);
Set the ParoleStream image to a new pixbuf.
|
a ParoleStream object. |
|
a GdkPixbuf to set as the stream image. |
Since 0.6
ParoleState parole_provider_player_get_state (ParoleProviderPlayer *player
);
Get the current state of the player.
|
a ParoleProviderPlayer |
Returns : |
a ParoleState. |
Since 0.2
gdouble parole_provider_player_get_stream_position
(ParoleProviderPlayer *player
);
Get stream position (microseconds) for Parole.
|
a ParoleProviderPlayer |
Returns : |
a gdouble containing the current stream position in microseconds. |
Since 0.6
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_play_next (ParoleProviderPlayer *player
);
Issue a play next command to the player.
|
a ParoleProviderPlayer |
Returns : |
TRUE if the command is processed, FALSE otherwise. |
Since 0.6
gboolean parole_provider_player_play_previous
(ParoleProviderPlayer *player
);
Issue a play previous command to the player.
|
a ParoleProviderPlayer |
Returns : |
TRUE if the command is processed, FALSE otherwise. |
Since 0.6
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
"seeked"
signalvoid user_function (ParoleProviderPlayerIface *player,
gdouble value,
gpointer user_data) : Run Last
Notifies when the stream has been manually advanced.
|
the object which received the signal. |
|
the seeked position. |
|
user data set when the signal handler was connected. |
Since 0.6
"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