SwfdecPlayer 3 SWFDEC Library SwfdecPlayer main playback object Functions void swfdec_init () SwfdecPlayer * swfdec_player_new () gboolean swfdec_player_is_initialized () const SwfdecURL * swfdec_player_get_url () void swfdec_player_set_url () const SwfdecURL * swfdec_player_get_base_url () void swfdec_player_set_base_url () const char * swfdec_player_get_variables () void swfdec_player_set_variables () double swfdec_player_get_rate () void swfdec_player_get_default_size () void swfdec_player_get_size () void swfdec_player_set_size () glong swfdec_player_get_next_event () guint swfdec_player_get_background_color () SwfdecScaleMode swfdec_player_get_scale_mode () void swfdec_player_set_scale_mode () SwfdecAlignment swfdec_player_get_alignment () void swfdec_player_set_alignment () SwfdecPlayerScripting * swfdec_player_get_scripting () void swfdec_player_set_scripting () gboolean swfdec_player_get_allow_fullscreen () void swfdec_player_set_allow_fullscreen () gboolean swfdec_player_get_fullscreen () SwfdecRenderer * swfdec_player_get_renderer () void swfdec_player_set_renderer () void swfdec_player_render () void swfdec_player_render_with_renderer () gulong swfdec_player_advance () gboolean swfdec_player_mouse_move () gboolean swfdec_player_mouse_press () gboolean swfdec_player_mouse_release () gboolean swfdec_player_key_press () gboolean swfdec_player_key_release () gboolean swfdec_player_get_focus () void swfdec_player_set_focus () const char * swfdec_player_get_selection () const GList * swfdec_player_get_audio () gulong swfdec_player_get_maximum_runtime () void swfdec_player_set_maximum_runtime () Properties SwfdecAlignmentalignmentRead / Write gbooleanallow-fullscreenRead / Write guintbackground-colorRead SwfdecURL *base-urlRead / Write gulongcache-sizeRead / Write guintdefault-heightRead guintdefault-widthRead gbooleanfocusRead / Write gbooleanfullscreenRead gintheightRead / Write gbooleaninitializedRead GType *loader-typeRead / Write / Construct Only gulongmax-runtimeRead / Write SwfdecMouseCursormouse-cursorRead glongnext-eventRead gdoublerateRead SwfdecRenderer *rendererRead / Write / Construct SwfdecScaleModescale-modeRead / Write SwfdecPlayerScripting *scriptingRead / Write gchar *selectionRead GType *socket-typeRead / Write / Construct Only SwfdecTimeVal *start-timeWrite / Construct Only SwfdecSystem *systemRead / Write SwfdecURL *urlRead gchar *variablesRead / Write gintwidthRead / Write Signals voidadvanceRun Last voidaudio-addedRun Last voidaudio-removedRun Last voidfscommandRun Last gbooleanhandle-keyRun Last gbooleanhandle-mouseRun Last voidinvalidateRun Last voidlaunchRun Last voidmissing-pluginsRun Last gbooleanquery-sizeRun Last Types and Values structSwfdecPlayer Object Hierarchy GObject ╰── SwfdecAsContext ╰── SwfdecPlayer ╰── SwfdecGtkPlayer Includes#include <swfdec/swfdec.h> Description A SwfdecPlayer is the main object used for playing back Flash files through Swfdec. A player interacts with the outside world in a multitude of ways. The most important ones are described below. Input is handled via the SwfdecLoader class. A SwfdecLoader is set on a new player using swfdec_player_set_loader(). When the loader has provided enough data, you can start playing the file. This is done in steps by calling swfdec_player_advance() - preferrably as often as swfdec_player_get_next_event() indicates. Or you can provide user input to the player by calling for example swfdec_player_handle_mouse(). You can use swfdec_player_render() to draw the current state of the player. After that, connect to the SwfdecPlayer:invalidate signal to be notified of changes. Audio output is handled via the SwfdecAudio class. One SwfdecAudio object is created for every output using the SwfdecPlayer::audio-added signal. Functions swfdec_init () swfdec_init void swfdec_init (void); Initializes the Swfdec library. swfdec_player_new () swfdec_player_new SwfdecPlayer * swfdec_player_new (SwfdecAsDebugger *debugger); Creates a new player. This function is supposed to be used for testing. Because of this, the created player will behave as predictable as possible. For example, it will generate the same random number sequence every time. The function calls swfdec_init() for you if it wasn't called before. Parameters debugger NULL or a SwfdecAsDebugger to use for debugging this player. Returns The new player swfdec_player_is_initialized () swfdec_player_is_initialized gboolean swfdec_player_is_initialized (SwfdecPlayer *player); Determines if the player is initalized yet. An initialized player is able to provide basic values like width, height or rate. A player may not be initialized if the loader it was started with does not reference a Flash resources or it did not provide enough data yet. If a player is initialized, it will never be uninitialized again. Parameters player a SwfdecPlayer Returns TRUE if the basic values are known. swfdec_player_get_url () swfdec_player_get_url const SwfdecURL * swfdec_player_get_url (SwfdecPlayer *player); Gets the URL of the resource that is currently played back. If no URL has been set on the player yet, NULL is returned. Parameters player a SwfdecPlayer Returns the SwfdecURL currently played back or NULL swfdec_player_set_url () swfdec_player_set_url void swfdec_player_set_url (SwfdecPlayer *player, const SwfdecURL *url); Sets the url for the main data. This function may only be called once. Parameters player a SwfdecPlayer url the url for the initial reference in this player swfdec_player_get_base_url () swfdec_player_get_base_url const SwfdecURL * swfdec_player_get_base_url (SwfdecPlayer *player); Gets the base URL that this player uses when resolving a relative URL. It is automatically set to the parent directory of the currently played back resource, but can be changed using swfdec_player_set_base_url(). When no resource has been set on the player yet, NULL is returned. Parameters player a SwfdecPlayer Returns the base SwfdecURL for resolving relative links or NULL swfdec_player_set_base_url () swfdec_player_set_base_url void swfdec_player_set_base_url (SwfdecPlayer *player, const SwfdecURL *url); Sets the URL that will be used for resolving realtive links inside the player . Parameters player a SwfdecPlayer url a SwfdecURL or NULL to reset to defaults swfdec_player_get_variables () swfdec_player_get_variables const char * swfdec_player_get_variables (SwfdecPlayer *player); Gets the initial variables for this player. See swfdec_player_set_variables() for details about variables. Parameters player a SwfdecPlayer Returns a string represetation of the current variables or NULL if none are set on the player . swfdec_player_set_variables () swfdec_player_set_variables void swfdec_player_set_variables (SwfdecPlayer *player, const char *variables); Sets the loader for the main data. This function may only be called if swfdec_player_set_url() has not been called yet. If the variables are set and validate, they will be set as properties on the root movie. Parameters player a SwfdecPlayer variables a string that is checked to be in 'application/x-www-form-urlencoded' syntax describing the arguments to set on the new player or NULL for none. swfdec_player_get_rate () swfdec_player_get_rate double swfdec_player_get_rate (SwfdecPlayer *player); Queries the framerate of this movie. This number specifies the number of frames that are supposed to pass per second. It is a multiple of 1/256. Parameters player a SwfdecPlayer Returns The framerate of this movie or 0 if it isn't known yet or the movie doesn't have a framerate. swfdec_player_get_default_size () swfdec_player_get_default_size void swfdec_player_get_default_size (SwfdecPlayer *player, guint *width, guint *height); If the default size of the movie is initialized, fills in width and height with the size. Otherwise width and height are set to 0. Parameters player a SwfdecPlayer width integer to store the width in or NULL height integer to store the height in or NULL swfdec_player_get_size () swfdec_player_get_size void swfdec_player_get_size (SwfdecPlayer *player, int *width, int *height); Gets the currently set image size. If the default width or height should be used, the width or height respectively is set to -1. Parameters player a SwfdecPlayer width integer to store the width in or NULL height integer to store the height in or NULL swfdec_player_set_size () swfdec_player_set_size void swfdec_player_set_size (SwfdecPlayer *player, int width, int height); Sets the image size to the given values. The image size is what the area that the player will render and advocate with scripts. Parameters player a SwfdecPlayer width desired width of the movie or -1 for default height desired height of the movie or -1 for default swfdec_player_get_next_event () swfdec_player_get_next_event glong swfdec_player_get_next_event (SwfdecPlayer *player); Queries how long to the next event. This is the next time when you should call swfdec_player_advance() to forward to. Parameters player ia SwfdecPlayer Returns number of milliseconds until next event or -1 if no outstanding event swfdec_player_get_background_color () swfdec_player_get_background_color guint swfdec_player_get_background_color (SwfdecPlayer *player); Gets the current suggested background color. The color will be an ARGB-color, with the MSB being the alpha value. Note that Swfdec will not render the background color itself, so if you want the background to not be translucent it is your job to clear the background using this color. Parameters player a SwfdecPlayer Returns the background color as an ARGB value swfdec_player_get_scale_mode () swfdec_player_get_scale_mode SwfdecScaleMode swfdec_player_get_scale_mode (SwfdecPlayer *player); Gets the currrent mode used for scaling the movie. See SwfdecScaleMode for the different modes. Parameters player a SwfdecPlayer Returns the current scale mode swfdec_player_set_scale_mode () swfdec_player_set_scale_mode void swfdec_player_set_scale_mode (SwfdecPlayer *player, SwfdecScaleMode mode); Sets the currrent mode used for scaling the movie. See SwfdecScaleMode for the different modes. Parameters player a SwfdecPlayer mode a SwfdecScaleMode swfdec_player_get_alignment () swfdec_player_get_alignment SwfdecAlignment swfdec_player_get_alignment (SwfdecPlayer *player); Gets the alignment of the player. The alignment describes what point is used as the anchor for drawing the contents. See SwfdecAlignment for possible values. Parameters player a SwfdecPlayer Returns the current alignment swfdec_player_set_alignment () swfdec_player_set_alignment void swfdec_player_set_alignment (SwfdecPlayer *player, SwfdecAlignment align); Sets the alignment to align . For details about alignment, see swfdec_player_get_alignment() and SwfdecAlignment. Parameters player a SwfdecPlayer align SwfdecAlignment to set swfdec_player_get_scripting () swfdec_player_get_scripting SwfdecPlayerScripting * swfdec_player_get_scripting (SwfdecPlayer *player); Gets the current scripting implementation in use. If no implementation is in use (the default), NULL is returned. Parameters player a SwfdecPlayer Returns the current scripting implementation used or NULL if none swfdec_player_set_scripting () swfdec_player_set_scripting void swfdec_player_set_scripting (SwfdecPlayer *player, SwfdecPlayerScripting *scripting); Sets the implementation to use for external scripting in the given player . Note that this is different from the internal script engine. See the SwfdecPlayerScripting paragraph for details about external scripting. Parameters player a SwfdecPlayer scripting the scripting implementation to use or NULL to disable scripting swfdec_player_get_allow_fullscreen () swfdec_player_get_allow_fullscreen gboolean swfdec_player_get_allow_fullscreen (SwfdecPlayer *player); Checks if the player is allowed to go fullscreen. See swfdec_player_set_allow_fullscreen() for details. Parameters player the player Returns TRUE if the player is allowed to go fullscreen swfdec_player_set_allow_fullscreen () swfdec_player_set_allow_fullscreen void swfdec_player_set_allow_fullscreen (SwfdecPlayer *player, gboolean allow); Sets if the player is allowed to go fullscreen. If a player is allowed to go fullscreen, it may set the SwfdecPlayer::fullscreen property to TRUE. Players are not allowed to go fullscreen by default. Usually applications only want to allow going fullscreen in response to mouse or keyboard events. Parameters player the player allow if the player should be allowed to go fullscreen swfdec_player_get_fullscreen () swfdec_player_get_fullscreen gboolean swfdec_player_get_fullscreen (SwfdecPlayer *player); CHecks if the player is in fullscreen mode currently. If the player is in fullscreen mode, it assumes it occupies the whole screen. A player will only ever go into fullscreen, if you have allowed it by calling swfdec_player_set_allow_fullscreen(). Parameters player the player Returns TRUE if the player is in fullscreen mode currently swfdec_player_get_renderer () swfdec_player_get_renderer SwfdecRenderer * swfdec_player_get_renderer (SwfdecPlayer *player); Gets the current renderer in use. See swfdec_player_set_renderer() for details. Parameters player a player Returns the current SwfdecRenderer in use. swfdec_player_set_renderer () swfdec_player_set_renderer void swfdec_player_set_renderer (SwfdecPlayer *player, SwfdecRenderer *renderer); Sets the renderer to be used by the player . Setting the correct renderer is mostly relevant for TextField flash objects with native fonts, as the renderer provides those. It can also be very relevant for performance reasons. See the SwfdecRenderer documentation for details. Parameters player a player renderer the renderer to use swfdec_player_render () swfdec_player_render void swfdec_player_render (SwfdecPlayer *player, cairo_t *cr); Renders the given area of the current frame to cr . This function just calls swfdec_player_render_with_renderer() using the player 's renderer. Parameters player a SwfdecPlayer cr cairo_t to render to swfdec_player_render_with_renderer () swfdec_player_render_with_renderer void swfdec_player_render_with_renderer (SwfdecPlayer *player, cairo_t *cr, SwfdecRenderer *renderer); Renders the given area of the current frame to cr . If you only want to redraw parts of the player, like when responding to a SwfdecPlayer:invalidate signal, set a clip on cr using cairo_clip(): cairo_rectangle (cr, x, y, width, height); cairo_clip (cr); swfdec_player_render_with_renderer (player, cr, renderer); Only redrawing parts of the player improves performance considerably. Parameters player a SwfdecPlayer cr cairo_t to render to renderer Renderer to use for rendering swfdec_player_advance () swfdec_player_advance gulong swfdec_player_advance (SwfdecPlayer *player, gulong msecs); Advances player by msecs or at most one event, whatever happens first in the player's timeline. You should make sure to call this function as often as swfdec_player_get_next_event() indicates or your player will not appear smooth. Parameters player the SwfdecPlayer to advance msecs number of milliseconds to advance at maximum Returns actual number of milliseconds advanced. swfdec_player_mouse_move () swfdec_player_mouse_move gboolean swfdec_player_mouse_move (SwfdecPlayer *player, double x, double y); Updates the current mouse position. If the mouse has left the area of player , you should pass values outside the movie size for x and y . You will probably want to call swfdec_player_advance() before to update the player to the correct time when calling this function. Parameters player a SwfdecPlayer x x coordinate of mouse y y coordinate of mouse Returns TRUE if the mouse event was handled. FALSE if the event should be propagated further. A mouse event may not be handled if the user clicked on a translucent area. swfdec_player_mouse_press () swfdec_player_mouse_press gboolean swfdec_player_mouse_press (SwfdecPlayer *player, double x, double y, guint button); Tells the player that the mouse button button was pressed at the given coordinate. Parameters player a SwfdecPlayer x x coordinate of mouse y y coordinate of mouse button number of the button that was pressed. Swfdec supports up to 32 buttons. Returns TRUE if the mouse event was handled. FALSE if the event should be propagated further. A mouse event may not be handled if the user clicked on a translucent area. swfdec_player_mouse_release () swfdec_player_mouse_release gboolean swfdec_player_mouse_release (SwfdecPlayer *player, double x, double y, guint button); Tells the player that the mouse button button was released at the given coordinate. Parameters player a SwfdecPlayer x x coordinate of mouse y y coordinate of mouse button number of the button that was released. Swfdec supports up to 32 buttons. Returns TRUE if the mouse event was handled. FALSE if the event should be propagated further. A mouse event may not be handled if the user clicked on a translucent area. swfdec_player_key_press () swfdec_player_key_press gboolean swfdec_player_key_press (SwfdecPlayer *player, guint keycode, guint character); Call this function to make the player react to a key press. A list of defined key codes is defined by SwfdecKey. You will likely need to translate from your keyboard API to the Flash key codes. Parameters player a SwfdecPlayer keycode the key that was pressed, must be smaller than 256. character UCS4 of the character that was inserted or 0 if none Returns TRUE if the key press was handled by the player , FALSE if it should be propagated further swfdec_player_key_release () swfdec_player_key_release gboolean swfdec_player_key_release (SwfdecPlayer *player, guint keycode, guint character); Call this function to make the player react to a key being released. See swfdec_player_key_press() for details. Parameters player a SwfdecPlayer keycode the key that was released character UCS4 of the character that was inserted or 0 if none Returns TRUE if the key press was handled by the player , FALSE if it should be propagated further swfdec_player_get_focus () swfdec_player_get_focus gboolean swfdec_player_get_focus (SwfdecPlayer *player); Checks if the player has keyboard focus. See swfdec_player_set_focus() for details. Parameters player a SwfdecPlayer Returns TRUE if the player has keyboard focus. swfdec_player_set_focus () swfdec_player_set_focus void swfdec_player_set_focus (SwfdecPlayer *player, gboolean focus); Tells the player whether keyboard focus is inside it. The player will use this information to draw focus indicators around objects. Note that this update will not happen immediately, but only the next time you call swfdec_player_advance(). The player is focussed by default. So if you integrate it into a widget system such, you likely want to unset this upon creation of the player. The player must be focussed to receive keyboard events. Parameters player the player focus if the player is focussed swfdec_player_get_selection () swfdec_player_get_selection const char * swfdec_player_get_selection (SwfdecPlayer *player); Retrieves the currently selected text of the player. If no text is currently selected, NULL is returned. Parameters player the player Returns the currently selected text or NULL swfdec_player_get_audio () swfdec_player_get_audio const GList * swfdec_player_get_audio (SwfdecPlayer *player); Returns a list of all currently active audio streams in player . Parameters player a SwfdecPlayer Returns A GList of SwfdecAudio. You must not modify or free this list. swfdec_player_get_maximum_runtime () swfdec_player_get_maximum_runtime gulong swfdec_player_get_maximum_runtime (SwfdecPlayer *player); Queries the given player for how long scripts may run. see swfdec_player_set_maximum_runtime() for a longer discussion of this value. Parameters player a SwfdecPlayer Returns the maximum time in milliseconds that scripts are allowed to run or 0 for infinite. swfdec_player_set_maximum_runtime () swfdec_player_set_maximum_runtime void swfdec_player_set_maximum_runtime (SwfdecPlayer *player, gulong msecs); Sets the time that the player may use to let internal scripts run. If the Flash file that is currently played back does not manage to complete its scripts in the given time, it is aborted. You cannot continue the scripts at a later point in time. However, your application may become unresponsive and your users annoyed if they cannot interact with it for too long. To give a reference point, the Adobe Flash player usually sets this value to 10 seconds. Note that this time determines the maximum time calling swfdec_player_advance() may take, even if it is called with a large value. Also note that this setting is ignored when running inside a debugger. Parameters player a SwfdecPlayer msecs time in milliseconds that scripts are allowed to run or 0 for infinite Types and Values struct SwfdecPlayer SwfdecPlayer struct SwfdecPlayer; This is the base object used for playing Flash files. Property Details The <literal>“alignment”</literal> property SwfdecPlayer:alignment “alignment” SwfdecAlignment point of the screen to align the output to.Flags: Read / Write Default value: SWFDEC_ALIGNMENT_CENTER The <literal>“allow-fullscreen”</literal> property SwfdecPlayer:allow-fullscreen “allow-fullscreen” gboolean if the player is allowed to change into fullscreen mode.Flags: Read / Write Default value: FALSE The <literal>“background-color”</literal> property SwfdecPlayer:background-color “background-color” guint ARGB color used to draw the background.Flags: Read Default value: 4294967295 The <literal>“base-url”</literal> property SwfdecPlayer:base-url “base-url” SwfdecURL * base URL for creating new resource or NULL if not set yet.Flags: Read / Write The <literal>“cache-size”</literal> property SwfdecPlayer:cache-size “cache-size” gulong maximum cache size in bytes.Flags: Read / Write The <literal>“default-height”</literal> property SwfdecPlayer:default-height “default-height” guint default height of the movie.Flags: Read Default value: 0 The <literal>“default-width”</literal> property SwfdecPlayer:default-width “default-width” guint default width of the movie.Flags: Read Default value: 0 The <literal>“focus”</literal> property SwfdecPlayer:focus “focus” gboolean TRUE if the player has keyboard focus.Flags: Read / Write Default value: TRUE The <literal>“fullscreen”</literal> property SwfdecPlayer:fullscreen “fullscreen” gboolean if the player is in fullscreen mode.Flags: Read Default value: FALSE The <literal>“height”</literal> property SwfdecPlayer:height “height” gint current height of the movie.Flags: Read / Write Allowed values: >= -1 Default value: -1 The <literal>“initialized”</literal> property SwfdecPlayer:initialized “initialized” gboolean TRUE when the player has initialized its basic values.Flags: Read Default value: FALSE The <literal>“loader-type”</literal> property SwfdecPlayer:loader-type “loader-type” GType * type to use for creating loaders.Flags: Read / Write / Construct Only Allowed values: SwfdecLoader The <literal>“max-runtime”</literal> property SwfdecPlayer:max-runtime “max-runtime” gulong maximum time in msecs scripts may run in the player before aborting.Flags: Read / Write The <literal>“mouse-cursor”</literal> property SwfdecPlayer:mouse-cursor “mouse-cursor” SwfdecMouseCursor how the mouse pointer should be presented.Flags: Read Default value: SWFDEC_MOUSE_CURSOR_NONE The <literal>“next-event”</literal> property SwfdecPlayer:next-event “next-event” glong how many milliseconds until the next event or -1 when no event pending.Flags: Read Allowed values: >= -1 Default value: -1 The <literal>“rate”</literal> property SwfdecPlayer:rate “rate” gdouble rate in frames per second.Flags: Read Allowed values: [0,256] Default value: 0 The <literal>“renderer”</literal> property SwfdecPlayer:renderer “renderer” SwfdecRenderer * the renderer used by this player.Flags: Read / Write / Construct The <literal>“scale-mode”</literal> property SwfdecPlayer:scale-mode “scale-mode” SwfdecScaleMode method used to scale the movie.Flags: Read / Write Default value: SWFDEC_SCALE_SHOW_ALL The <literal>“scripting”</literal> property SwfdecPlayer:scripting “scripting” SwfdecPlayerScripting * external scripting implementation.Flags: Read / Write The <literal>“selection”</literal> property SwfdecPlayer:selection “selection” gchar * currently selected text.Flags: Read Default value: NULL The <literal>“socket-type”</literal> property SwfdecPlayer:socket-type “socket-type” GType * type to use for creating sockets.Flags: Read / Write / Construct Only Allowed values: SwfdecSocket The <literal>“start-time”</literal> property SwfdecPlayer:start-time “start-time” SwfdecTimeVal * time to use as the beginning time for this player.Flags: Write / Construct Only The <literal>“system”</literal> property SwfdecPlayer:system “system” SwfdecSystem * object holding system information.Flags: Read / Write The <literal>“url”</literal> property SwfdecPlayer:url “url” SwfdecURL * URL of resource currently played back or NULL if not set.Flags: Read The <literal>“variables”</literal> property SwfdecPlayer:variables “variables” gchar * variables to use when setting the URL.Flags: Read / Write Default value: NULL The <literal>“width”</literal> property SwfdecPlayer:width “width” gint current width of the movie.Flags: Read / Write Allowed values: >= -1 Default value: -1 Signal Details The <literal>“advance”</literal> signal SwfdecPlayer::advance void user_function (SwfdecPlayer *player, gulong msecs, guint audio_samples, gpointer user_data) Emitted whenever the player advances. Parameters player the SwfdecPlayer affected msecs the amount of milliseconds the player will advance audio_samples number of frames the audio is advanced (in 44100Hz steps) user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“audio-added”</literal> signal SwfdecPlayer::audio-added void user_function (SwfdecPlayer *player, SwfdecAudio *audio, gpointer user_data) Emitted whenever a new audio stream was added to player . Parameters player the SwfdecPlayer affected audio the audio stream that was added user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“audio-removed”</literal> signal SwfdecPlayer::audio-removed void user_function (SwfdecPlayer *player, SwfdecAudio *audio, gpointer user_data) Emitted whenever an audio stream was removed from player . The stream will have been added with the SwfdecPlayer::audio-added signal previously. Parameters player the SwfdecPlayer affected audio the audio stream that was removed user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“fscommand”</literal> signal SwfdecPlayer::fscommand void user_function (SwfdecPlayer *player, gchar *command, gchar *parameter, gpointer user_data) This signal is emited whenever a Flash script command (also known as fscommand) is encountered. This method is ued by the Flash file to communicate with the hosting environment. In web browsers it is used to call Javascript functions. Standalone Flash players understand a limited set of functions. They vary from player to player, but the most common are listed here: "quit": quits the player. "fullscreen": A boolean setting (parameter is "true" or "false") that sets the player into fullscreen mode. "allowscale": A boolean setting that tells the player to not scale the Flash application. "showmenu": A boolean setting that tells the Flash player to not show its own entries in the right-click menu. "exec": Run an external executable. The parameter specifies the path. "trapallkeys": A boolean setting that tells the Flash player to pass all key events to the Flash application instead of using it for keyboard shortcuts or similar. Parameters player the SwfdecPlayer affected command the command to execute. This is a lower case string. parameter parameter to pass to the command. The parameter depends on the function. user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“handle-key”</literal> signal SwfdecPlayer::handle-key gboolean user_function (SwfdecPlayer *player, guint key, guint pressed, gboolean Returns, gpointer user_data) This signal is emitted whenever player should respond to a key event. If any of the handlers returns TRUE, swfdec_player_key_press() or swfdec_player_key_release() will return TRUE. Note that unlike many event handlers in gtk, returning TRUE will not stop further event handlers from being invoked. Use g_signal_stop_emission() in that case. Parameters player the SwfdecPlayer affected key SwfdecKey that was pressed or released pressed TRUE if the key was pressed or FALSE if it was released user_data user data set when the signal handler was connected. Returns TRUE if this handler handles the event. Flags: Run Last The <literal>“handle-mouse”</literal> signal SwfdecPlayer::handle-mouse gboolean user_function (SwfdecPlayer *player, gdouble x, gdouble y, gint button, gpointer user_data) This signal is emitted whenever player should respond to a mouse event. If any of the handlers returns TRUE, swfdec_player_handle_mouse() will return TRUE. Note that unlike many event handlers in gtk, returning TRUE will not stop further event handlers from being invoked. Use g_signal_stop_emission() in that case. Parameters player the SwfdecPlayer affected x new x coordinate of the mouse y new y coordinate of the mouse button 0 for a mouse move, a positive number if a button was pressed, a negative number if a button was released user_data user data set when the signal handler was connected. Returns TRUE if this handler handles the event. Flags: Run Last The <literal>“invalidate”</literal> signal SwfdecPlayer::invalidate void user_function (SwfdecPlayer *player, gpointer rectangles, guint n_rectangles, gpointer user_data) This signal is emitted whenever graphical elements inside the player have changed. It provides two ways to look at the changes: By looking at the extents parameter, it provides a simple way to get a single rectangle that encloses all changes. By looking at the rectangles array, you can get finer control over changes which is very useful if your rendering system provides a way to handle regions. Parameters player the SwfdecPlayer affected rectangles a number of smaller rectangles for fine-grained control over changes n_rectangles number of rectangles in rectangles user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“launch”</literal> signal SwfdecPlayer::launch void user_function (SwfdecPlayer *player, gchar *url, gchar *target, SwfdecBuffer *data, guint header_count, GStrv header_names, GStrv header_values, gpointer user_data) Emitted whenever the player encounters an URL that should be loaded into a target the Flash player does not recognize. In most cases this happens when the user clicks a link in an embedded Flash movie that should open a new web page. The effect of calling any swfdec functions on the emitting player is undefined. Parameters player the SwfdecPlayer affected url URL to open target target to load the URL into data optional data to pass on with the request. Can be NULL indicating no data should be passed. header_count number of custom HTTP headers to be sent header_names names of the custom HTTP headers. NULL terminated header_values values of the custom HTTP headers. NULL terminated user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“missing-plugins”</literal> signal SwfdecPlayer::missing-plugins void user_function (SwfdecPlayer *player, GStrv details, gpointer user_data) Emitted whenever a plugin is detected that GStreamer cannot currently handle because it is missing plugins to do so. You should use gst_install_plugins_async() to install those plugins. Parameters player the SwfdecPlayer missing plugins details the details strings for all missing plugins user_data user data set when the signal handler was connected. Flags: Run Last The <literal>“query-size”</literal> signal SwfdecPlayer::query-size gboolean user_function (SwfdecPlayer *player, gboolean fullscreen, gpointer width, gpointer height, gpointer user_data) This signals is emitted whenever the player is (un)fullscreened. In this case it requests the new size the Flash file will be displayed in immediately. If you want to provide values, connect to this signal. The values don't have to be exact, you can still call swfdec_player_set_size() later on. However, it will look visually nicer if your values here are correct. By default, the screen resolution values will be used for fullscreen and the default size will be used otherwise. Parameters player the SwfdecPlayer that resizes fullscreen TRUE if the player queries the fullscreen size, FALSE for the default size width pointer to an integer that takes the width to use height pointer to an integer that takes the height to use user_data user data set when the signal handler was connected. Returns TRUE if this handler properly sets width and height and no other handlers should be invoked. Flags: Run Last