GNOME Video Arcade Reference Manual: GvaMusicButton

GvaMusicButton

GvaMusicButton — Button for streaming music

Functions

GtkWidget *	gva_music_button_new ()
void	gva_music_button_play ()
void	gva_music_button_pause ()
const gchar *	gva_music_button_get_game ()
void	gva_music_button_set_game ()
const gchar *	gva_music_button_get_status ()

Types and Values

struct

GvaMusicButton

Description

A GvaMusicButton toggles between playing and pausing in-game music clips streamed from http://www.arcade-history.com/.

This requires arcade history information from a 'history.dat' file.

Functions

gva_music_button_new ()

GtkWidget *
gva_music_button_new (void);

Creates a new GvaMusicButton.

Returns

a new GvaMusicButton

gva_music_button_play ()

void
gva_music_button_play (GvaMusicButton *music_button);

Plays a music clip from the game specified by the GvaMusicButton:game property. The clip will repeat indefinitely until paused or a different game is chosen.

Parameters

music_button

a GvaMusicButton

gva_music_button_pause ()

void
gva_music_button_pause (GvaMusicButton *music_button);

Pauses a music clip from the game specified by the GvaMusicButton:game property.

Parameters

music_button

a GvaMusicButton

gva_music_button_get_game ()

const gchar *
gva_music_button_get_game (GvaMusicButton *music_button);

Returns the name of the game for which to play a music clip.

Parameters

music_button

a GvaMusicButton

Returns

the game for which to play a music clip

gva_music_button_set_game ()

void
gva_music_button_set_game (GvaMusicButton *music_button,
                           const gchar *game);

Sets the name of the game for which to play a music clip. Use gva_music_button_play() to play the clip.

Parameters

music_button	a GvaMusicButton
game	the name of a game

gva_music_button_get_status ()

const gchar *
gva_music_button_get_status (GvaMusicButton *music_button);

Returns a status message about the music clip, such as buffering progress or whether a music clip is available for the selected game.

Parameters

music_button

a GvaMusicButton

Returns

a status message about the music clip

Types and Values

struct GvaMusicButton

struct GvaMusicButton {
        GtkButton parent;
        GvaMusicButtonPrivate *priv;
};

Contains only private data that should be read and manipulated using the functions below.