| GStreamer Bad Plugins 0.10 Plugins Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Prerequisites | Known Implementations | Properties | ||||
GstPhotography; enum GstWhiteBalanceMode; enum GstColourToneMode; enum GstSceneMode; enum GstFlashMode; enum GstFlickerReductionMode; enum GstFocusMode; enum GstFocusStatus; enum GstPhotoCaps; enum GstPhotoShakeRisk; void (*GstPhotoCapturePrepared) (gpointer data,const GstCaps *configured_caps); gboolean gst_photography_get_ev_compensation (GstPhotography *photo,gfloat *ev_comp); gboolean gst_photography_get_iso_speed (GstPhotography *photo,guint *iso_speed); gboolean gst_photography_get_aperture (GstPhotography *photo,guint *aperture); gboolean gst_photography_get_exposure (GstPhotography *photo,guint32 *exposure); gboolean gst_photography_get_white_balance_mode (GstPhotography *photo,GstWhiteBalanceMode *wb_mode); gboolean gst_photography_get_colour_tone_mode (GstPhotography *photo,GstColourToneMode *tone_mode); gboolean gst_photography_get_scene_mode (GstPhotography *photo,GstSceneMode *scene_mode); gboolean gst_photography_get_flash_mode (GstPhotography *photo,GstFlashMode *flash_mode); gboolean gst_photography_get_zoom (GstPhotography *photo,gfloat *zoom); gboolean gst_photography_set_ev_compensation (GstPhotography *photo,gfloat ev_comp); gboolean gst_photography_set_iso_speed (GstPhotography *photo,guint iso_speed); gboolean gst_photography_set_aperture (GstPhotography *photo,guint aperture); gboolean gst_photography_set_exposure (GstPhotography *photo,guint exposure); gboolean gst_photography_set_white_balance_mode (GstPhotography *photo,GstWhiteBalanceMode wb_mode); gboolean gst_photography_set_colour_tone_mode (GstPhotography *photo,GstColourToneMode tone_mode); gboolean gst_photography_set_scene_mode (GstPhotography *photo,GstSceneMode scene_mode); gboolean gst_photography_set_flash_mode (GstPhotography *photo,GstFlashMode flash_mode); gboolean gst_photography_set_zoom (GstPhotography *photo,gfloat zoom); GstPhotoCaps gst_photography_get_capabilities (GstPhotography *photo); gboolean gst_photography_prepare_for_capture (GstPhotography *photo,GstPhotoCapturePrepared func,GstCaps *capture_caps,gpointer user_data); void gst_photography_set_autofocus (GstPhotography *photo,gboolean on); gboolean gst_photography_set_config (GstPhotography *photo,GstPhotoSettings *config); gboolean gst_photography_get_config (GstPhotography *photo,GstPhotoSettings *config);
"aperture" guint : Read / Write "capabilities" gulong : Read "colour-tone-mode" GstColourToneMode : Read / Write "ev-compensation" gfloat : Read / Write "exposure" guint : Read / Write "flash-mode" GstFlashMode : Read / Write "flicker-mode" GstFlickerReductionMode : Read / Write "focus-mode" GstFocusMode : Read / Write "image-capture-supported-caps" GstCaps* : Read "iso-speed" guint : Read / Write "scene-mode" GstSceneMode : Read / Write "white-balance-mode" GstWhiteBalanceMode : Read / Write
The interface allows access to some common digital image capture parameters.
typedef enum
{
GST_PHOTOGRAPHY_WB_MODE_AUTO = 0,
GST_PHOTOGRAPHY_WB_MODE_DAYLIGHT,
GST_PHOTOGRAPHY_WB_MODE_CLOUDY,
GST_PHOTOGRAPHY_WB_MODE_SUNSET,
GST_PHOTOGRAPHY_WB_MODE_TUNGSTEN,
GST_PHOTOGRAPHY_WB_MODE_FLUORESCENT
} GstWhiteBalanceMode;
typedef enum
{
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_NORMAL = 0,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_SEPIA,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_NEGATIVE,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_GRAYSCALE,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_NATURAL,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_VIVID,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_COLORSWAP,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_SOLARIZE,
GST_PHOTOGRAPHY_COLOUR_TONE_MODE_OUT_OF_FOCUS
} GstColourToneMode;
typedef enum
{
GST_PHOTOGRAPHY_SCENE_MODE_MANUAL = 0,
GST_PHOTOGRAPHY_SCENE_MODE_CLOSEUP,
GST_PHOTOGRAPHY_SCENE_MODE_PORTRAIT,
GST_PHOTOGRAPHY_SCENE_MODE_LANDSCAPE,
GST_PHOTOGRAPHY_SCENE_MODE_SPORT,
GST_PHOTOGRAPHY_SCENE_MODE_NIGHT,
GST_PHOTOGRAPHY_SCENE_MODE_AUTO
} GstSceneMode;
typedef enum
{
GST_PHOTOGRAPHY_FLASH_MODE_AUTO = 0,
GST_PHOTOGRAPHY_FLASH_MODE_OFF,
GST_PHOTOGRAPHY_FLASH_MODE_ON,
GST_PHOTOGRAPHY_FLASH_MODE_FILL_IN,
GST_PHOTOGRAPHY_FLASH_MODE_RED_EYE
} GstFlashMode;
typedef enum
{
GST_PHOTOGRAPHY_FLICKER_REDUCTION_OFF = 0,
GST_PHOTOGRAPHY_FLICKER_REDUCTION_50HZ,
GST_PHOTOGRAPHY_FLICKER_REDUCTION_60HZ,
GST_PHOTOGRAPHY_FLICKER_REDUCTION_AUTO,
} GstFlickerReductionMode;
typedef enum {
GST_PHOTOGRAPHY_FOCUS_MODE_AUTO = 0,
GST_PHOTOGRAPHY_FOCUS_MODE_MACRO,
GST_PHOTOGRAPHY_FOCUS_MODE_PORTRAIT,
GST_PHOTOGRAPHY_FOCUS_MODE_INFINITY,
GST_PHOTOGRAPHY_FOCUS_MODE_HYPERFOCAL,
GST_PHOTOGRAPHY_FOCUS_MODE_EXTENDED,
GST_PHOTOGRAPHY_FOCUS_MODE_CONTINUOUS_NORMAL,
GST_PHOTOGRAPHY_FOCUS_MODE_CONTINUOUS_EXTENDED,
} GstFocusMode;
typedef enum
{
GST_PHOTOGRAPHY_FOCUS_STATUS_NONE = 0,
GST_PHOTOGRAPHY_FOCUS_STATUS_RUNNING,
GST_PHOTOGRAPHY_FOCUS_STATUS_FAIL,
GST_PHOTOGRAPHY_FOCUS_STATUS_SUCCESS
} GstFocusStatus;
typedef enum
{
GST_PHOTOGRAPHY_CAPS_NONE = (0 << 0),
GST_PHOTOGRAPHY_CAPS_EV_COMP = (1 << 0),
GST_PHOTOGRAPHY_CAPS_ISO_SPEED = (1 << 1),
GST_PHOTOGRAPHY_CAPS_WB_MODE = (1 << 2),
GST_PHOTOGRAPHY_CAPS_TONE = (1 << 3),
GST_PHOTOGRAPHY_CAPS_SCENE = (1 << 4),
GST_PHOTOGRAPHY_CAPS_FLASH = (1 << 5),
GST_PHOTOGRAPHY_CAPS_ZOOM = (1 << 6),
GST_PHOTOGRAPHY_CAPS_FOCUS = (1 << 7),
GST_PHOTOGRAPHY_CAPS_APERTURE = (1 << 8),
GST_PHOTOGRAPHY_CAPS_EXPOSURE = (1 << 9),
GST_PHOTOGRAPHY_CAPS_SHAKE = (1 << 10)
} GstPhotoCaps;
typedef enum
{
GST_PHOTOGRAPHY_SHAKE_RISK_LOW = 0,
GST_PHOTOGRAPHY_SHAKE_RISK_MEDIUM,
GST_PHOTOGRAPHY_SHAKE_RISK_HIGH,
} GstPhotoShakeRisk;
void (*GstPhotoCapturePrepared) (gpointer data,const GstCaps *configured_caps);
This callback will be called when the element has finished preparations for photo capture.
|
user data that has been given, when registering the callback |
|
GstCaps defining the configured capture format. Ownership of these caps stays in the element. |
gboolean gst_photography_get_ev_compensation (GstPhotography *photo,gfloat *ev_comp);
Get the ev compensation value for the GstElement
|
GstPhotography interface of a GstElement |
|
ev compensation value to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_iso_speed (GstPhotography *photo,guint *iso_speed);
Get the ISO value (light sensivity) for the GstElement
|
GstPhotography interface of a GstElement |
|
ISO speed value to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_aperture (GstPhotography *photo,guint *aperture);
Get the aperture value for the GstElement
|
GstPhotography interface of a GstElement |
|
aperture value to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_exposure (GstPhotography *photo,guint32 *exposure);
Get the fixed exposure time (in us) for the GstElement
|
GstPhotography interface of a GstElement |
|
exposure time to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_white_balance_mode (GstPhotography *photo,GstWhiteBalanceMode *wb_mode);
Get the white balance mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstWhiteBalanceMode to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_colour_tone_mode (GstPhotography *photo,GstColourToneMode *tone_mode);
Get the colour tone mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstColourToneMode to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_scene_mode (GstPhotography *photo,GstSceneMode *scene_mode);
Get the scene mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstSceneMode to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_flash_mode (GstPhotography *photo,GstFlashMode *flash_mode);
Get the flash mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstFlashMode to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_get_zoom (GstPhotography *photo,gfloat *zoom);
Get the zoom value for the GstElement
|
GstPhotography interface of a GstElement |
|
zoom value to get |
Returns : |
TRUE if getting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_ev_compensation (GstPhotography *photo,gfloat ev_comp);
Set the ev compensation value for the GstElement
|
GstPhotography interface of a GstElement |
|
ev compensation value to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_iso_speed (GstPhotography *photo,guint iso_speed);
Set the ISO value (light sensivity) for the GstElement
|
GstPhotography interface of a GstElement |
|
ISO speed value to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_aperture (GstPhotography *photo,guint aperture);
Set the aperture value for the GstElement
|
GstPhotography interface of a GstElement |
|
aperture value to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_exposure (GstPhotography *photo,guint exposure);
Set the fixed exposure time (in us) for the GstElement
|
GstPhotography interface of a GstElement |
|
exposure time to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_white_balance_mode (GstPhotography *photo,GstWhiteBalanceMode wb_mode);
Set the white balance mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstWhiteBalanceMode to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_colour_tone_mode (GstPhotography *photo,GstColourToneMode tone_mode);
Set the colour tone mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstColourToneMode to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_scene_mode (GstPhotography *photo,GstSceneMode scene_mode);
Set the scene mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstSceneMode to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_flash_mode (GstPhotography *photo,GstFlashMode flash_mode);
Set the flash mode for the GstElement
|
GstPhotography interface of a GstElement |
|
GstFlashMode to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
gboolean gst_photography_set_zoom (GstPhotography *photo,gfloat zoom);
Set the zoom value for the GstElement. E.g. 1.0 to get original image and 3.0 for 3x zoom and so on.
|
GstPhotography interface of a GstElement |
|
zoom value to set |
Returns : |
TRUE if setting the value succeeded, FALSE otherwise
|
GstPhotoCaps gst_photography_get_capabilities (GstPhotography *photo);
Get GstPhotoCaps bitmask value that indicates what photography interface features the GstElement supports
|
GstPhotography interface of a GstElement |
Returns : |
GstPhotoCaps value |
gboolean gst_photography_prepare_for_capture (GstPhotography *photo,GstPhotoCapturePrepared func,GstCaps *capture_caps,gpointer user_data);
Start preparations for capture. func callback is called after
preparations are done.
|
GstPhotography interface of a GstElement |
|
callback that is called after capturing has been prepared |
|
|
|
user data that will be passed to the callback func
|
Returns : |
TRUE if preparations were started (caps were OK), otherwise FALSE. |
void gst_photography_set_autofocus (GstPhotography *photo,gboolean on);
Start or stop autofocusing. GST_PHOTOGRAPHY_AUTOFOCUS_DONE
message is posted to bus when autofocusing has finished.
|
GstPhotography interface of a GstElement |
|
TRUE to start autofocusing, FALSE to stop autofocusing
|
gboolean gst_photography_set_config (GstPhotography *photo,GstPhotoSettings *config);
Set all configuration settings at once.
|
GstPhotography interface of a GstElement |
|
GstPhotoSettings containg the configuration |
Returns : |
TRUE if configuration was set successfully, otherwise FALSE. |
gboolean gst_photography_get_config (GstPhotography *photo,GstPhotoSettings *config);
Get all configuration settings at once.
|
GstPhotography interface of a GstElement |
|
GstPhotoSettings containg the configuration |
Returns : |
TRUE if configuration was got successfully, otherwise FALSE. |
"aperture" property"aperture" guint : Read / Write
Aperture defines the size of lens opening (0 = auto).
Allowed values: <= 255
Default value: 0
"capabilities" property"capabilities" gulong : Read
Tells the photo capabilities of the device.
"colour-tone-mode" property"colour-tone-mode" GstColourToneMode : Read / Write
Colour tone setting changes colour shading in the photo.
Default value: GST_PHOTOGRAPHY_COLOUR_TONE_MODE_NORMAL
"ev-compensation" property"ev-compensation" gfloat : Read / Write
EV compensation affects the brightness of the image.
Allowed values: [-2.5,2.5]
Default value: 0
"exposure" property"exposure" guint : Read / Write
Exposure time defines how long the shutter will stay open (0 = auto).
Default value: 0
"flash-mode" property"flash-mode" GstFlashMode : Read / Write
Flash mode defines how the flash light should be used.
Default value: GST_PHOTOGRAPHY_FLASH_MODE_AUTO
"flicker-mode" property"flicker-mode" GstFlickerReductionMode : Read / Write
Flicker reduction mode defines a line frequency for flickering prevention.
Default value: GST_PHOTOGRAPHY_FLICKER_REDUCTION_OFF
"focus-mode" property"focus-mode" GstFocusMode : Read / Write
Focus mode defines the range of focal lengths to use in autofocus search.
Default value: GST_PHOTOGRAPHY_FOCUS_MODE_AUTO
"image-capture-supported-caps" property"image-capture-supported-caps" GstCaps* : Read
Caps describing supported image capture formats.
"iso-speed" property"iso-speed" guint : Read / Write
ISO speed defines the light sensitivity (0 = auto).
Allowed values: <= 6400
Default value: 0
"scene-mode" property"scene-mode" GstSceneMode : Read / Write
Scene mode works as a preset for different photo shooting mode settings.
Default value: GST_PHOTOGRAPHY_SCENE_MODE_AUTO
"white-balance-mode" property"white-balance-mode" GstWhiteBalanceMode : Read / Write
White balance affects the color temperature of the photo.
Default value: GST_PHOTOGRAPHY_WB_MODE_AUTO