FilterEvent Interface Reference

import <jsf.idl;

Public Member Functions
	FilterEvent (unsigned long type)

Data Fields
attribute unsigned long	type
attribute double	start_range
attribute double	speed
attribute boolean	hw_buffer_reset
attribute boolean	initial_broadcast_play
attribute boolean	timestamp_based
attribute boolean	full_file_only
attribute boolean	forced_dash_segment_switch
attribute unsigned long	from_pck
attribute unsigned long long	start_offset
attribute unsigned long long	end_offset
attribute DOMString	switch_url
attribute boolean	skip_cache_exp
attribute unsigned long	hint_block_size
attribute DOMString	seg_url
attribute boolean	is_init
attribute unsigned long long	media_start_range
attribute unsigned long long	media_end_range
attribute unsigned long long	index_start_range
attribute unsigned long long	index_end_range
attribute boolean	up
attribute unsigned long	dependent_group_index
attribute long	q_idx
attribute unsigned long	set_tile_mode_plus_one
attribute unsigned long	quality_degradation
attribute unsigned long	min_x
attribute unsigned long	min_y
attribute unsigned long	max_x
attribute unsigned long	max_y
attribute boolean	is_gaze
attribute unsigned long	max_buffer_us
attribute unsigned long	max_playout_us
attribute unsigned long	min_playout_us
attribute boolean	pid_only
attribute unsigned long	ui_type
attribute unsigned long	mouse_x
attribute unsigned long	mouse_y
attribute unsigned float	wheel
attribute unsigned long	button
attribute unsigned long	keycode
attribute unsigned long	hwkey
attribute readonly Array	dropfiles
attribute DOMString	clipboard
attribute float	mt_x
attribute float	mt_y
attribute float	mt_rotate
attribute float	mt_pinch
attribute float	mt_fingers
attribute unsigned long	width
attribute unsigned long	height
attribute unsigned long	showtype
attribute unsigned long	move_x
attribute unsigned long	move_y
attribute unsigned long	move_relative
attribute unsigned long	move_alignx
attribute unsigned long	move_aligny

Detailed Description

FilterEvent expose a filter event object, either for processing a received event or triggering a new event. The read access to the members of the structure is cross-checked with the event type and throw an error when attempting to access the wrong field

When a field is marked as read-only, this means the event cannot be fired, it can only be received.

Constructor & Destructor Documentation

FilterEvent()

FilterEvent::FilterEvent

(

unsigned long

type

)

constructor

Parameters

type	the type of event. This type cannot be changed

let evt = new FilterEvent(GF_FEVT_PLAY);

Field Documentation

type

attribute unsigned long FilterEvent::type

event type - see GF_FilterEvent

start_range

attribute double FilterEvent::start_range

play event - see GF_FEVT_Play

speed

attribute double FilterEvent::speed

play event - see GF_FEVT_Play

hw_buffer_reset

attribute boolean FilterEvent::hw_buffer_reset

play event - see GF_FEVT_Play

initial_broadcast_play

attribute boolean FilterEvent::initial_broadcast_play

play event - see GF_FEVT_Play

timestamp_based

attribute boolean FilterEvent::timestamp_based

play event - see GF_FEVT_Play

full_file_only

attribute boolean FilterEvent::full_file_only

play event - see GF_FEVT_Play

forced_dash_segment_switch

attribute boolean FilterEvent::forced_dash_segment_switch

play event - see GF_FEVT_Play

from_pck

attribute unsigned long FilterEvent::from_pck

play event - see GF_FEVT_Play

start_offset

attribute unsigned long long FilterEvent::start_offset

source switch and source seek - see GF_FEVT_SourceSeek

end_offset

attribute unsigned long long FilterEvent::end_offset

source switch and source seek - see GF_FEVT_SourceSeek

switch_url

attribute DOMString FilterEvent::switch_url

source switch and source seek - see GF_FEVT_SourceSeek

skip_cache_exp

attribute boolean FilterEvent::skip_cache_exp

source switch and source seek - see GF_FEVT_SourceSeek

hint_block_size

attribute unsigned long FilterEvent::hint_block_size

source switch and source seek - see GF_FEVT_SourceSeek

seg_url

attribute DOMString FilterEvent::seg_url

segment size - see GF_FEVT_SegmentSize

is_init

attribute boolean FilterEvent::is_init

segment size - see GF_FEVT_SegmentSize

media_start_range

attribute unsigned long long FilterEvent::media_start_range

segment size - see GF_FEVT_SegmentSize

media_end_range

attribute unsigned long long FilterEvent::media_end_range

segment size - see GF_FEVT_SegmentSize

index_start_range

attribute unsigned long long FilterEvent::index_start_range

segment size - see GF_FEVT_SegmentSize

index_end_range

attribute unsigned long long FilterEvent::index_end_range

segment size - see GF_FEVT_SegmentSize

up

attribute boolean FilterEvent::up

quality switch - see GF_FEVT_QualitySwitch

dependent_group_index

attribute unsigned long FilterEvent::dependent_group_index

quality switch - see GF_FEVT_QualitySwitch

q_idx

attribute long FilterEvent::q_idx

quality switch - see GF_FEVT_QualitySwitch

set_tile_mode_plus_one

attribute unsigned long FilterEvent::set_tile_mode_plus_one

quality switch - see GF_FEVT_QualitySwitch

quality_degradation

attribute unsigned long FilterEvent::quality_degradation

quality switch - see GF_FEVT_QualitySwitch

min_x

attribute unsigned long FilterEvent::min_x

visibility hint - see GF_FEVT_VisibilityHint

min_y

attribute unsigned long FilterEvent::min_y

visibility hint - see GF_FEVT_VisibilityHint

max_x

attribute unsigned long FilterEvent::max_x

visibility hint - see GF_FEVT_VisibilityHint

max_y

attribute unsigned long FilterEvent::max_y

visibility hint - see GF_FEVT_VisibilityHint

is_gaze

attribute boolean FilterEvent::is_gaze

visibility hint - see GF_FEVT_VisibilityHint

max_buffer_us

attribute unsigned long FilterEvent::max_buffer_us

buffer reqs - see GF_FEVT_BufferRequirement

max_playout_us

attribute unsigned long FilterEvent::max_playout_us

buffer reqs - see GF_FEVT_BufferRequirement

min_playout_us

attribute unsigned long FilterEvent::min_playout_us

buffer reqs - see GF_FEVT_BufferRequirement

pid_only

attribute boolean FilterEvent::pid_only

buffer reqs - see GF_FEVT_BufferRequirement

ui_type

attribute unsigned long FilterEvent::ui_type

ui event type of a GF_Event only mouse and keyboard events are currently exposed

mouse_x

attribute unsigned long FilterEvent::mouse_x

see GF_EventMouse

mouse_y

attribute unsigned long FilterEvent::mouse_y

see GF_EventMouse

wheel

attribute unsigned float FilterEvent::wheel

see GF_EventMouse

button

attribute unsigned long FilterEvent::button

see GF_EventMouse

keycode

attribute unsigned long FilterEvent::keycode

see GF_EventKey

hwkey

attribute unsigned long FilterEvent::hwkey

see GF_EventKey

dropfiles

attribute readonly Array FilterEvent::dropfiles

array of DOMString - see GF_EventOpenFile

clipboard

attribute DOMString FilterEvent::clipboard

see GF_EventClipboard

mt_x

attribute float FilterEvent::mt_x

see GF_EventMultiTouch

mt_y

attribute float FilterEvent::mt_y

see GF_EventMultiTouch

mt_rotate

attribute float FilterEvent::mt_rotate

see GF_EventMultiTouch

mt_pinch

attribute float FilterEvent::mt_pinch

see GF_EventMultiTouch

mt_fingers

attribute float FilterEvent::mt_fingers

see GF_EventMultiTouch

width

attribute unsigned long FilterEvent::width

see GF_EventSize

height

attribute unsigned long FilterEvent::height

see GF_EventSize

showtype

attribute unsigned long FilterEvent::showtype

see GF_EventShow

move_x

attribute unsigned long FilterEvent::move_x

see GF_EventMove

move_y

attribute unsigned long FilterEvent::move_y

see GF_EventMove

move_relative

attribute unsigned long FilterEvent::move_relative

see GF_EventMove

move_alignx

attribute unsigned long FilterEvent::move_alignx

see GF_EventMove

move_aligny

attribute unsigned long FilterEvent::move_aligny

see GF_EventMove