Enumerations

Enumerations — enumerations used in Swfdec

Synopsis




enum                SwfdecAsContextState;
enum                SwfdecLoaderDataType;
enum                SwfdecLoaderRequest;
const char*         swfdec_loader_data_type_get_extension
                                                        (SwfdecLoaderDataType type);
enum                SwfdecAlignment;
enum                SwfdecMouseCursor;
enum                SwfdecScaleMode;

Description

This file lists all of the enumerations used in various parts of Swfdec.

Details

enum SwfdecAsContextState

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.

SWFDEC_AS_CONTEXT_NEW the context is not yet initialized, swfdec_as_context_startup() needs to be called.
SWFDEC_AS_CONTEXT_RUNNING the context is running normally
SWFDEC_AS_CONTEXT_INTERRUPTED the context has been interrupted by a debugger
SWFDEC_AS_CONTEXT_ABORTED the context has aborted execution due to a fatal error

enum SwfdecLoaderDataType

typedef enum {
  SWFDEC_LOADER_DATA_UNKNOWN,
  SWFDEC_LOADER_DATA_SWF,
  SWFDEC_LOADER_DATA_FLV,
  SWFDEC_LOADER_DATA_XML,
  SWFDEC_LOADER_DATA_TEXT
} 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.

SWFDEC_LOADER_DATA_UNKNOWN Unidentified data or data that cannot be identified.
SWFDEC_LOADER_DATA_SWF Data describing a normal Flash file.
SWFDEC_LOADER_DATA_FLV Data describing a Flash video stream.
SWFDEC_LOADER_DATA_XML Data in XML format.
SWFDEC_LOADER_DATA_TEXT Textual data.

enum SwfdecLoaderRequest

typedef enum {
  SWFDEC_LOADER_REQUEST_DEFAULT = 0,
  SWFDEC_LOADER_REQUEST_GET = 1,
  SWFDEC_LOADER_REQUEST_POST = 2
} SwfdecLoaderRequest;

Describes the moethod to use for requesting a given URL. These methods map naturally to HTTP methods, since HTTP is the common method for requesting Flash content.

SWFDEC_LOADER_REQUEST_DEFAULT Use the default method (this most likely is equal to HTTPget)
SWFDEC_LOADER_REQUEST_GET Use HTTP get
SWFDEC_LOADER_REQUEST_POST Use HTTP post

swfdec_loader_data_type_get_extension ()

const char*         swfdec_loader_data_type_get_extension
                                                        (SwfdecLoaderDataType type);

Queries the extension to be used for data of the given type.

type : a SwfdecLoaderDataType
Returns : the typical extension for this data type or the empty string if the type has no extension

enum SwfdecAlignment

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.

SWFDEC_ALIGNMENT_TOP_LEFT top left
SWFDEC_ALIGNMENT_TOP top
SWFDEC_ALIGNMENT_TOP_RIGHT top right
SWFDEC_ALIGNMENT_LEFT left
SWFDEC_ALIGNMENT_CENTER center
SWFDEC_ALIGNMENT_RIGHT right
SWFDEC_ALIGNMENT_BOTTOM_LEFT left
SWFDEC_ALIGNMENT_BOTTOM bottom
SWFDEC_ALIGNMENT_BOTTOM_RIGHT bottom right

enum SwfdecMouseCursor

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.

SWFDEC_MOUSE_CURSOR_NORMAL a normal mouse cursor
SWFDEC_MOUSE_CURSOR_NONE no mouse image
SWFDEC_MOUSE_CURSOR_TEXT a mouse cursor suitable for text editing
SWFDEC_MOUSE_CURSOR_CLICK a mouse cursor for clicking a hyperlink or a button

enum SwfdecScaleMode

typedef enum {
  SWFDEC_SCALE_SHOW_ALL,
  SWFDEC_SCALE_NO_BORDER,
  SWFDEC_SCALE_EXACT_FIT,
  SWFDEC_SCALE_NONE
} SwfdecScaleMode;

Describes how the movie should be scaled if the given size doesn't equal the movie's size.

SWFDEC_SCALE_SHOW_ALL Show the whole content as large as possible
SWFDEC_SCALE_NO_BORDER Fill the whole area, possibly cropping parts
SWFDEC_SCALE_EXACT_FIT Fill the whole area, don't keep aspect ratio
SWFDEC_SCALE_NONE Do not scale the movie at all