Class Xiron::Event
In: lib/xiron/event.rb
Parent: Object

An instance of this class represents an event. It may be received using Stream#handle, Stream#wait or instanciated to be sent with Stream#send. The attribute Event#id is always valid. The values of the other attributes depend on the type. Here is a list of available events and the semantics of its attributes: FIXME: complete

  id               attributes

  events used by xine for dvd and vcd menu navigation:

  "menu_mouse1"
  "menu_mouse2"
  "menu_mouse3"
  "menu_motion"
  "menu_f1"
  "menu_f2"
  "menu_f3"
  "menu_f4"
  "menu_f5"
  "menu_f6"
  "menu_f7"
  "menu_up"
  "menu_down"
  "menu_left"
  "menu_right"
  "menu_select"
  "menu_next"
  "menu_previous"
  "menu_angle_next"
  "menu_angle_previous"
  "menu_button_force"
  "menu_0"
  "menu_1"
  "menu_2"
  "menu_3"
  "menu_4"
  "menu_5"
  "menu_6"
  "menu_7"
  "menu_8"
  "menu_9"
  "menu_add"

  events generated by Stream#play:

  "playback_started"
  "playback_finished"
  "no_input_plugin"
  "no_demux_plugin"
  "input_failed"
  "demux_failed"
  "malformed_mrl"

  @message and @parameters contain additional information:

  "message"
  "warning"
  "unknown_host"
  "unknown_device"
  "network_unreachable"
  "connection_refused"
  "file_not_found"
  "read_error"
  "library_load_error"
  "encrypted_source"
  "security"
  "audio_out_unavailable"
  "permission_error"

  "channels_changed"
  "set_title"               @message = new title
  "quit"

  FIXME:

  "frame_format_change"
  "audio_level"
  "progress"
  "mrl_reference"
  "num_buttons"
  "spu_button"
  "dropped_frames"

  "set_v4l2"
  "pvr_save"
  "pvr_report_name"
  "pvr_realtime"
  "pvr_pause"
  "set_mpeg_data"

  "vdr_red"
  "vdr_green"
  "vdr_yellow"
  "vdr_blue"
  "vdr_play"
  "vdr_pause"
  "vdr_stop"
  "vdr_record"
  "vdr_fastfwd"
  "vdr_fastrew"
  "vdr_power"
  "vdr_channelplus"
  "vdr_channelminus"
  "vdr_schedule"
  "vdr_channels"
  "vdr_timers"
  "vdr_recordings"
  "vdr_setup"
  "vdr_commands"
  "vdr_back"
  "vdr_user1"
  "vdr_user2"
  "vdr_user3"
  "vdr_user4"
  "vdr_user5"
  "vdr_user6"
  "vdr_user7"
  "vdr_user8"
  "vdr_user9"
  "vdr_volplus"
  "vdr_volminus"
  "vdr_mute"

  these events are generated by video windows or terminals (see Stream#grab_terminal).
  mouse events are passed to the xine engine as "menu_mouseX" or "menu_motion"
  automatically, if it is not explicitely handled:

  "release"     subid = the button released
  "motion"      x, y = cursor position
  "<key>"       key/button pressed as string. FIXME: more here

Methods

new   to_s  

Attributes

aspect  [RW] 
discarded  [RW] 
discarded_threshold  [RW] 
height  [RW] 
id  [RW] 
left  [RW] 
message  [RW] 
mute  [RW] 
num  [RW] 
pan_scan  [RW] 
parameters  [RW] 
percent  [RW] 
right  [RW] 
skipped  [RW] 
skipped_threshold  [RW] 
string  [RW] 
subid  [RW] 
width  [RW] 
x  [RW] 
y  [RW] 

Public Class methods

Public Instance methods

[Validate]