|
|
|
Swfdec Reference Manual | |
|---|---|---|---|---|
#include <swfdec/swfdec.h> #define SWFDEC_TYPE_TIME_VAL enum SwfdecAsContextState; enum SwfdecAsDeleteReturn; enum SwfdecLoaderDataType; const char* swfdec_loader_data_type_get_extension (SwfdecLoaderDataType type); enum SwfdecAlignment; enum SwfdecKey; enum SwfdecMouseCursor; enum SwfdecScaleMode;
#define SWFDEC_TYPE_TIME_VAL swfdec_time_val_get_type()
This type wraps a GTimeVal object as a boxed type and makes it available
for use in object properties.
typedef enum {
SWFDEC_AS_CONTEXT_NEW,
SWFDEC_AS_CONTEXT_RUNNING,
SWFDEC_AS_CONTEXT_INTERRUPTED,
SWFDEC_AS_CONTEXT_ABORTED
} SwfdecAsContextState;
The state of the context describes what operations are possible on the context.
It will be in the state SWFDEC_AS_CONTEXT_STATE_RUNNING almost all the time. If
it is in the state SWFDEC_AS_CONTEXT_STATE_ABORTED, it will not work anymore and
every operation on it will instantly fail.
the context is not yet initialized,
swfdec_as_context_startup() needs to be called.
|
|
| the context is running normally | |
| the context has been interrupted by a debugger | |
| the context has aborted execution due to a fatal error |
typedef enum {
SWFDEC_AS_DELETE_NOT_FOUND = 0,
SWFDEC_AS_DELETE_DELETED,
SWFDEC_AS_DELETE_NOT_DELETED
} SwfdecAsDeleteReturn;
This is the return value used by swfdec_as_object_delete_variable(). It
describes the various outcomes of trying to delete a variable.
typedef enum {
SWFDEC_LOADER_DATA_UNKNOWN,
SWFDEC_LOADER_DATA_SWF,
SWFDEC_LOADER_DATA_FLV,
SWFDEC_LOADER_DATA_XML,
SWFDEC_LOADER_DATA_TEXT,
SWFDEC_LOADER_DATA_JPEG,
SWFDEC_LOADER_DATA_PNG
} SwfdecLoaderDataType;
This type describes the different types of data that can be loaded inside
Swfdec. Swfdec identifies its data streams and you can use the
swfdec_loader_get_data_type() to acquire more information about the data
inside a SwfdecLoader.
| Unidentified data or data that cannot be identified. | |
| Data describing a normal Flash file. | |
| Data describing a Flash video stream. | |
| Data in XML format. | |
| Textual data. | |
| a JPEG image | |
| a PNG image |
const char* swfdec_loader_data_type_get_extension
(SwfdecLoaderDataType type);
Queries the extension to be used for data of the given type.
|
a SwfdecLoaderDataType |
Returns : |
the typical extension for this data type or the empty string if the type has no extension |
typedef enum {
SWFDEC_ALIGNMENT_TOP_LEFT,
SWFDEC_ALIGNMENT_TOP,
SWFDEC_ALIGNMENT_TOP_RIGHT,
SWFDEC_ALIGNMENT_LEFT,
SWFDEC_ALIGNMENT_CENTER,
SWFDEC_ALIGNMENT_RIGHT,
SWFDEC_ALIGNMENT_BOTTOM_LEFT,
SWFDEC_ALIGNMENT_BOTTOM,
SWFDEC_ALIGNMENT_BOTTOM_RIGHT
} SwfdecAlignment;
These are the possible values for the alignment of an unscaled movie.
typedef enum {
SWFDEC_KEY_LEFT_MOUSE = 1,
SWFDEC_KEY_RIGHT_MOUSE = 2,
SWFDEC_KEY_MIDDLE_MOUSE = 4,
SWFDEC_KEY_BACKSPACE = 8,
SWFDEC_KEY_TAB = 9,
SWFDEC_KEY_CLEAR = 12,
SWFDEC_KEY_ENTER = 13,
SWFDEC_KEY_SHIFT = 16,
SWFDEC_KEY_CONTROL = 17,
SWFDEC_KEY_ALT = 18,
SWFDEC_KEY_CAPS_LOCK = 20,
SWFDEC_KEY_ESCAPE = 27,
SWFDEC_KEY_SPACE = 32,
SWFDEC_KEY_PAGE_UP = 33,
SWFDEC_KEY_PAGE_DOWN = 34,
SWFDEC_KEY_END = 35,
SWFDEC_KEY_HOME = 36,
SWFDEC_KEY_LEFT = 37,
SWFDEC_KEY_UP = 38,
SWFDEC_KEY_RIGHT = 39,
SWFDEC_KEY_DOWN = 40,
SWFDEC_KEY_INSERT = 45,
SWFDEC_KEY_DELETE = 46,
SWFDEC_KEY_HELP = 47,
SWFDEC_KEY_0 = 48,
SWFDEC_KEY_1 = 49,
SWFDEC_KEY_2 = 50,
SWFDEC_KEY_3 = 51,
SWFDEC_KEY_4 = 52,
SWFDEC_KEY_5 = 53,
SWFDEC_KEY_6 = 54,
SWFDEC_KEY_7 = 55,
SWFDEC_KEY_8 = 56,
SWFDEC_KEY_9 = 57,
SWFDEC_KEY_A = 65,
SWFDEC_KEY_B = 66,
SWFDEC_KEY_C = 67,
SWFDEC_KEY_D = 68,
SWFDEC_KEY_E = 69,
SWFDEC_KEY_F = 70,
SWFDEC_KEY_G = 71,
SWFDEC_KEY_H = 72,
SWFDEC_KEY_I = 73,
SWFDEC_KEY_J = 74,
SWFDEC_KEY_K = 75,
SWFDEC_KEY_L = 76,
SWFDEC_KEY_M = 77,
SWFDEC_KEY_N = 78,
SWFDEC_KEY_O = 79,
SWFDEC_KEY_P = 80,
SWFDEC_KEY_Q = 81,
SWFDEC_KEY_R = 82,
SWFDEC_KEY_S = 83,
SWFDEC_KEY_T = 84,
SWFDEC_KEY_U = 85,
SWFDEC_KEY_V = 86,
SWFDEC_KEY_W = 87,
SWFDEC_KEY_X = 88,
SWFDEC_KEY_Y = 89,
SWFDEC_KEY_Z = 90,
SWFDEC_KEY_NUMPAD_0 = 96,
SWFDEC_KEY_NUMPAD_1 = 97,
SWFDEC_KEY_NUMPAD_2 = 98,
SWFDEC_KEY_NUMPAD_3 = 99,
SWFDEC_KEY_NUMPAD_4 = 100,
SWFDEC_KEY_NUMPAD_5 = 101,
SWFDEC_KEY_NUMPAD_6 = 102,
SWFDEC_KEY_NUMPAD_7 = 103,
SWFDEC_KEY_NUMPAD_8 = 104,
SWFDEC_KEY_NUMPAD_9 = 105,
SWFDEC_KEY_NUMPAD_MULTIPLY = 106,
SWFDEC_KEY_NUMPAD_ADD = 107,
SWFDEC_KEY_NUMPAD_SUBTRACT = 109,
SWFDEC_KEY_NUMPAD_DECIMAL = 110,
SWFDEC_KEY_NUMPAD_DIVIDE = 111,
SWFDEC_KEY_F1 = 112,
SWFDEC_KEY_F2 = 113,
SWFDEC_KEY_F3 = 114,
SWFDEC_KEY_F4 = 115,
SWFDEC_KEY_F5 = 116,
SWFDEC_KEY_F6 = 117,
SWFDEC_KEY_F7 = 118,
SWFDEC_KEY_F8 = 119,
SWFDEC_KEY_F9 = 120,
SWFDEC_KEY_F10 = 121,
SWFDEC_KEY_F11 = 122,
SWFDEC_KEY_F12 = 123,
SWFDEC_KEY_F13 = 124,
SWFDEC_KEY_F14 = 125,
SWFDEC_KEY_F15 = 126,
SWFDEC_KEY_NUM_LOCK = 144,
SWFDEC_KEY_SCROLL_LOCK = 145,
SWFDEC_KEY_SEMICOLON = 186,
SWFDEC_KEY_EQUAL = 187,
SWFDEC_KEY_COMMA = 188,
SWFDEC_KEY_MINUS = 189,
SWFDEC_KEY_DOT = 190,
SWFDEC_KEY_SLASH = 191,
SWFDEC_KEY_GRAVE = 192,
SWFDEC_KEY_LEFT_BRACKET = 219,
SWFDEC_KEY_BACKSLASH = 220,
SWFDEC_KEY_RIGHT_BRACKET = 221,
SWFDEC_KEY_APOSTROPHE = 222,
} SwfdecKey;
Lists all known key codes in Swfdec and their meanings on an English keyboard. Note that key codes in Flash represent virtual key codes as used in Microsoft Windows.
| the left mouse button | |
| the left mouse button | |
| the middle mouse button | |
| the backspace key | |
| the tab key | |
| the clear key | |
| the enter key | |
| the shift key | |
| the control key | |
| the alt key | |
| the caps lock key | |
| the escape key | |
| the space key | |
| the page up key | |
| the page down key | |
| the end key | |
| the home key | |
| the left key | |
| the up key | |
| the right key | |
| the down key | |
| the insert key | |
| the delete key | |
| the help key | |
| the 0 key | |
| the 1 key | |
| the 2 key | |
| the 3 key | |
| the 4 key | |
| the 5 key | |
| the 6 key | |
| the 7 key | |
| the 8 key | |
| the 9 key | |
| the ! key | |
| the B key | |
| the C key | |
| the D key | |
| the E key | |
| the F key | |
| the G key | |
| the H key | |
| the I key | |
| the J key | |
| the K key | |
| the L key | |
| the M key | |
| the N key | |
| the O key | |
| the P key | |
| the Q key | |
| the R key | |
| the S key | |
| the T key | |
| the U key | |
| the V key | |
| the W key | |
| the X key | |
| the Y key | |
| the Z key | |
| the 0 key on the numeric keypad | |
| the 1 key on the numeric keypad | |
| the 2 key on the numeric keypad | |
| the 3 key on the numeric keypad | |
| the 4 key on the numeric keypad | |
| the 5 key on the numeric keypad | |
| the 6 key on the numeric keypad | |
| the 7 key on the numeric keypad | |
| the 8 key on the numeric keypad | |
| the 9 key on the numeric keypad | |
| the multiply key on the numeric keypad | |
| the add key on the numeric keypad | |
| the subtract key on the numeric keypad | |
| the decimal key on the numeric keypad | |
| the divide key on the numeric keypad | |
| the F1 key | |
| the F2 key | |
| the F3 key | |
| the F4 key | |
| the F5 key | |
| the F6 key | |
| the F7 key | |
| the F8 key | |
| the F9 key | |
| the F10 key | |
| the F11 key | |
| the F12 key | |
| the F13 key | |
| the F14 key | |
| the F15 key | |
| the num lock key | |
| the scroll lock key | |
| the semicolon key (on English keyboards) | |
| the equal key (on English keyboards) | |
| the comma key (on English keyboards) | |
| the minus key (on English keyboards) | |
| the dot key (on English keyboards) | |
| the slash key (on English keyboards) | |
| the grave key (on English keyboards) | |
| the left bracket key (on English keyboards) | |
| the backslash key (on English keyboards) | |
| the right bracket key (on English keyboards) | |
| the apostrophe key (on English keyboards) |
typedef enum {
SWFDEC_MOUSE_CURSOR_NORMAL,
SWFDEC_MOUSE_CURSOR_NONE,
SWFDEC_MOUSE_CURSOR_TEXT,
SWFDEC_MOUSE_CURSOR_CLICK
} SwfdecMouseCursor;
This enumeration describes the possible types for the SwfdecPlayer::mouse-cursor property.