Efl.Canvas.Video (class)

Description

Efl canvas video class

Inheritance

Efl.Canvas.Group (class)Efl.Canvas.Object (class)Efl.Object (class)

Full hierarchy

Members

constructor [Overridden from Efl.Object]

Call the object's constructor.
Efl_Object *efl_constructor(Eo *obj);


engine (set)

Initializes an emotion object with the specified module.
Eina_Bool efl_canvas_video_engine_set(Eo *obj, const char *module_filename);


file (get, set) [Overridden from Efl.File]

void efl_file_get(const Eo *obj, const char **file, const char **key);
Eina_Bool efl_file_set(Eo *obj, const char *file, const char *key);


length (get) [Overridden from Efl.Player]

Get the length of play for the media file.
double efl_player_length_get(const Eo *obj);


load_size (get, set) [Overridden from Efl.Image.Load]

The load size of an image.
Eina_Size2D efl_image_load_size_get(const Eo *obj);
void efl_image_load_size_set(Eo *obj, Eina_Size2D size);


mute (get, set) [Overridden from Efl.Player]

This property controls the audio mute state.
Eina_Bool efl_player_mute_get(const Eo *obj);
void efl_player_mute_set(Eo *obj, Eina_Bool mute);


option (set)

Set the specified option for the current module.
void efl_canvas_video_option_set(Eo *obj, const char *opt, const char *val);


play (get, set) [Overridden from Efl.Player]

Eina_Bool efl_player_play_get(const Eo *obj);
void efl_player_play_set(Eo *obj, Eina_Bool play);


position (get, set) [Overridden from Efl.Player]

double efl_player_position_get(const Eo *obj);
void efl_player_position_set(Eo *obj, double sec);


position (get, set) [Overridden from Efl.Gfx]

The 2D position of a canvas object.
Eina_Position2D efl_gfx_position_get(const Eo *obj);
void efl_gfx_position_set(Eo *obj, Eina_Position2D pos);


progress (get) [Overridden from Efl.Player]

Get how much of the file has been played.
double efl_player_progress_get(const Eo *obj);


ratio (get) [Overridden from Efl.Image]

The native width/height ratio of the image.
double efl_image_ratio_get(const Eo *obj);


seekable (get) [Overridden from Efl.Player]

Get whether the media file is seekable.
Eina_Bool efl_player_seekable_get(const Eo *obj);


size (get, set) [Overridden from Efl.Gfx]

The 2D size of a canvas object.
Eina_Size2D efl_gfx_size_get(const Eo *obj);
void efl_gfx_size_set(Eo *obj, Eina_Size2D size);


smooth_scale (get, set) [Overridden from Efl.Image]

Whether to use high-quality image scaling algorithm for this image.
Eina_Bool efl_image_smooth_scale_get(const Eo *obj);
void efl_image_smooth_scale_set(Eo *obj, Eina_Bool smooth_scale);


volume (get, set) [Overridden from Efl.Player]

Control the audio volume.
double efl_player_volume_get(const Eo *obj);
void efl_player_volume_set(Eo *obj, double volume);


Inherited

Efl.Canvas.Group
clip (get, set)
color (get, set)
debug_name_override Build a read-only name for this object used for debugging.
destructor Call the object's destructor.
group_calculate Triggers an immediate recalculation of this object's geometry.
group_change Marks the object as dirty.
group_member_add Set a canvas object as a member of a given group (or smart object).
group_member_del Removes a member object from a given smart object.
group_member_is Finds out if a given object is a member of this group.
group_members_iterate Returns an iterator over the children of this object, which are canvas objects.
group_need_recalculate (get, set) Indicates that the group's layout needs to be recalculated.
no_render (get, set)
paragraph_direction (get, set) This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit.
visible (get, set) The visibility of a canvas object.
protected group_clipper (get) The internal clipper object used by this group.
Efl.Canvas.Object
above (get) Get the Evas object stacked right above obj
anti_alias (get, set)
below (get) Get the Evas object stacked right below obj
clipees (get) Return a list of objects currently clipped by obj.
clipees_has Test if any object is clipped by obj.
coords_inside (get) Returns whether the coords are logically inside the object.
del Unrefs the object and reparents it to NULL.
event_animation (get, set) Set the animation which starts when the given event_name happens to the object.
finalize Called at the end of efl_add. Should not be called, just overridden.
freeze_events (get, set)
geometry (get, set) Rectangular geometry that combines both position and size.
hint_align (get, set) Hints for an object's alignment.
hint_aspect (get, set) Defines the aspect ratio to respect when scaling this object.
hint_combined_min (get) Read-only minimum size combining both Efl.Gfx.Size.Hint.hint_restricted_min and Efl.Gfx.Size.Hint.hint_min size hints.
hint_margin (get, set) Hints for an object's margin or padding space.
hint_max (get, set) Hints on the object's maximum size.
hint_min (get, set) Hints on the object's minimum size.
protected set hint_restricted_min (get, set) Internal hints for an object's minimum size.
hint_weight (get, set) Hints for an object's weight.
is_frame_object (get, set) If true the object belongs to the window border decorations.
key_focus (get, set) Indicates that this object is the keyboard event receiver on its canvas.
key_grab Requests keyname key events be directed to obj.
key_ungrab Removes the grab on keyname key events by obj.
layer (get, set)
loop (get) The loop to which this object belongs to.
lower Lower obj to the bottom of its layer.
pass_events (get, set)
pointer_inside (get) Returns whether the mouse pointer is logically inside the canvas.
pointer_mode (get, set) Low-level pointer behaviour.
pointer_mode_by_device (get, set) Low-level pointer behaviour by device. See Efl.Canvas.Object.pointer_mode.get and Efl.Canvas.Object.pointer_mode.set for more explanation.
precise_is_inside (get, set)
propagate_events (get, set)
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise Raise obj to the top of its layer.
render_op (get, set) Render mode to be used for compositing the Evas object.
repeat_events (get, set)
scale (get, set) The scaling factor of an object.
seat_event_filter (get, set)
seat_focus (get) Check if this object is focused.
seat_focus_add Add a seat to the focus list.
seat_focus_check Check if this object is focused by a given seat
seat_focus_del Remove a seat from the focus list.
stack_above Stack obj immediately above
stack_below Stack obj immediately below
protected render_parent (get) Gets the parent smart object of a given Evas object, if it has one.
Efl.File
load_error (get) Gets the (last) file loading error for a given object.
mmap (get, set)
save Save the given image object's contents to an (image) file.
Efl.Gfx.Color
color_class_code (get, set)
color_code (get, set)
Efl.Gfx.Map
lightning_3d Apply a lighting effect on the object.
lightning_3d_absolute Apply a lighting effect to the object.
map_alpha (get, set) Alpha flag for map rendering.
map_clockwise (get) Clockwise state of a map (read-only).
map_color (get, set) Color of a vertex in the map.
map_coord_absolute (get, set) A point's absolute coordinate on the canvas.
map_has Read-only property indicating whether an object is mapped.
map_point_count (get, set) Number of points of a map.
map_reset Resets the map transformation to its default state.
map_smooth (get, set) Smoothing state for map rendering.
map_uv (get, set) Map point's U and V texture source point.
perspective_3d Apply a perspective transform to the map
perspective_3d_absolute Apply a perspective transform to the map
rotate Apply a rotation to the object.
rotate_3d Rotate the object around 3 axes in 3D.
rotate_3d_absolute Rotate the object around 3 axes in 3D, using absolute coordinates.
rotate_absolute Apply a rotation to the object, using absolute coordinates.
rotate_quat Rotate the object in 3D using a unit quaternion.
rotate_quat_absolute Rotate the object in 3D using a unit quaternion, using absolute coordinates.
translate Apply a translation to the object using map.
zoom Apply a zoom to the object.
zoom_absolute Apply a zoom to the object, using absolute coordinates.
Efl.Gfx.Size.Hint
hint_base (get, set) Base size for objects with sizing restrictions.
hint_step (get, set) Step size for objects with sizing restrictions.
Efl.Image
border (get, set) Dimensions of this image's border, a region that does not scale with the center area.
border_center_fill (get, set) Specifies how the center part of the object (not the borders) should be drawn when EFL is rendering it.
border_scale (get, set) Scaling factor applied to the image borders.
content_hint (get, set)
image_size (get) This represents the size of the original image in pixels.
scale_hint (get, set)
scale_type (get, set) Control how the image is scaled.
Efl.Image.Load
load_async_cancel Cancel preloading an image object's image data in the background.
load_async_start Begin preloading an image object's image data in the background.
load_dpi (get, set)
load_orientation (get, set) Defines whether the orientation information in the image file should be honored.
load_region (get, set)
load_region_support (get) Indicates whether the Efl.Image.Load.load_region property is supported for the current file.
load_scale_down (get, set) The scale down factor is a divider on the original image size.
load_skip_header (get, set) Initial load should skip header check and leave it all to data load
Efl.Object
allow_parent_unref (get, set) Allow an object to be deleted by unref even if it has a parent.
children_iterator_new Get an iterator on all childrens
comment (get, set) A human readable comment for the object
composite_attach Make an object a composite object of another.
composite_detach Detach a composite object from another object.
composite_part_is Check if an object is part of a composite object.
event_callback_forwarder_add Add an event callback forwarder for an event and an object.
event_callback_forwarder_del Remove an event callback forwarder for an event and an object.
event_callback_stop Stop the current callback call.
event_freeze Freeze events of object.
event_freeze_count (get) Return freeze events of object.
class event_global_freeze Freeze events of object.
class event_global_freeze_count (get) Return freeze events of object.
class event_global_thaw Thaw events of object.
event_thaw Thaw events of object.
finalized (get) True if the object is already finalized, otherwise false.
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
parent (get, set) The parent of an object.
Efl.Player
play_speed (get, set) Control the play speed of the media file.
playable (get) Whether or not the object data can be played.
Efl.Ui.Base
language (get, set) The (human) language for this object.
mirrored (get, set) Whether this object should be mirrored.
mirrored_automatic (get, set) Whether the property Efl.Ui.Base.mirrored should be set automatically.

Events

button,change

Called when button changed
EFL_CANVAS_VIDEO_EVENT_BUTTON_CHANGE(void)


button,num,change

Called when button number changed
EFL_CANVAS_VIDEO_EVENT_BUTTON_NUM_CHANGE(void)


channels,change

Called when the channels changed
EFL_CANVAS_VIDEO_EVENT_CHANNELS_CHANGE(void)


frame,decode

Called when the frame was decoded
EFL_CANVAS_VIDEO_EVENT_FRAME_DECODE(void)


frame,resize

Called when the frame was resized
EFL_CANVAS_VIDEO_EVENT_FRAME_RESIZE(void)


length,change

Called when the length changed
EFL_CANVAS_VIDEO_EVENT_LENGTH_CHANGE(void)


open,done

Called when the files was opened
EFL_CANVAS_VIDEO_EVENT_OPEN_DONE(void)


playback,start

Called when playback started
EFL_CANVAS_VIDEO_EVENT_PLAYBACK_START(void)


playback,stop

Called when playback stopped
EFL_CANVAS_VIDEO_EVENT_PLAYBACK_STOP(void)


position,change

Called when the position changed
EFL_CANVAS_VIDEO_EVENT_POSITION_CHANGE(void)


position,load,done

Called when the position loaded
EFL_CANVAS_VIDEO_EVENT_POSITION_LOAD_DONE(void)


position,load,fail

Called when loading the position failed
EFL_CANVAS_VIDEO_EVENT_POSITION_LOAD_FAIL(void)


position,save,done

Called when the position was saved
EFL_CANVAS_VIDEO_EVENT_POSITION_SAVE_DONE(void)


position,save,fail

Called when saving the position failed
EFL_CANVAS_VIDEO_EVENT_POSITION_SAVE_FAIL(void)


progress,change

Called when the progress changed
EFL_CANVAS_VIDEO_EVENT_PROGRESS_CHANGE(void)


ref,change

Called when ref changed
EFL_CANVAS_VIDEO_EVENT_REF_CHANGE(void)


title,change

Called when the title changed
EFL_CANVAS_VIDEO_EVENT_TITLE_CHANGE(void)


volume,change

Called when volume changed
EFL_CANVAS_VIDEO_EVENT_VOLUME_CHANGE(void)


Inherited

Efl.Animator
animator,tick Animator tick synchronized with screen vsync if possible.
Efl.Gfx
hide Object just became invisible.
move Object was moved, its position during the event is the new one.
resize Object was resized, its size during the event is the new one.
show Object just became visible.
Efl.Gfx.Size.Hint
change,size,hints Object size hints changed.
Efl.Gfx.Stack
restack Object stacking was changed.
Efl.Image
preload Image data has been preloaded.
unload Image data has been unloaded (by some mechanism in EFL that threw out the original image data).
Efl.Image.Load
load,cancelled Called when the image loading was cancelled
load,done Called when he image was loaded
load,error Called when an error happened during image loading
Efl.Input.Interface
finger,down Finger pressed (finger id is known).
finger,move Finger moved (current and previous positions are known).
finger,up Finger released (finger id is known).
focus,in A focus in event.
focus,out A focus out event.
hold All input events are on hold or resumed.
key,down Keyboard key press.
key,up Keyboard key release.
pointer,axis Pen or other axis event update.
pointer,cancel Main pointer button press was cancelled (button id is known). This can happen in rare cases when the window manager passes the focus to a more urgent window, for instance. You probably don't need to listen to this event, as it will be accompanied by an up event.
pointer,down Main pointer button pressed (button id is known).
pointer,in Pointer entered a window or a widget.
pointer,move Main pointer move (current and previous positions are known).
pointer,out Pointer left a window or a widget.
pointer,up Main pointer button released (button id is known).
pointer,wheel Mouse wheel event.
Efl.Object
callback,add A callback was added.
callback,del A callback was deleted.
del Object is being deleted.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.