mirror of
https://github.com/dyne/FreeJ.git
synced 2026-02-13 16:15:43 +01:00
9b2250fe5e
javascript streaming documentation more fixes to video encoding flash compile fix (Nobuhiro Iwamatsu on debian bugtracker) git-svn-id: svn://dyne.org/rastasoft/freej/trunk@910 383723c8-4afa-0310-b8a8-b1afb83214fc
334 lines
9.1 KiB
JavaScript
334 lines
9.1 KiB
JavaScript
|
|
/** This file is intended solely for being parsed by JSDoc
|
|
to produce documentation for the FreeJ's Javascript API
|
|
it is not a script you can run into FreeJ
|
|
it is not intended to be an example of good JavaScript OO-programming,
|
|
nor is it intended to fulfill any specific purpose apart from generating documentation
|
|
|
|
@author Mr Goil
|
|
@version 0.9
|
|
*/
|
|
|
|
///////////////////////////////////////////////////
|
|
/// Controller VIRTUAL PARENT
|
|
|
|
/**
|
|
Virtual Controller
|
|
@constructor
|
|
@class This class is the parent class of all Controller and should
|
|
not be used directly.
|
|
*/
|
|
function Controller() { };
|
|
|
|
/** get the name of the controller
|
|
(not implemented yet)
|
|
@returns controller name
|
|
@type String
|
|
*/
|
|
Controller.prototype.get_name = function get_name() { };
|
|
|
|
/** The Midi Controller constructor creates a midi controller
|
|
@class The Midi Controller holds callbacks to javascript on midi events.
|
|
Assign functions to the callback to handle events:
|
|
<div class="example">Example:
|
|
|
|
mc = new MidiController();
|
|
register_controller(mc);
|
|
mc.event_ctrl = function (ch, param, value) {
|
|
echo("midi event ctrl called: " + ch + ", " + param + ", " + value);
|
|
// do something
|
|
return true;
|
|
}
|
|
</div>
|
|
You want to use a tool like aconnect/aconnectgui to wire the midi devices.
|
|
You may return true or false in the event handlers to indicate further processing or not. However, this is not implemented properly, yet.
|
|
|
|
@author Mr Goil
|
|
@constructor
|
|
@base Controller
|
|
@returns a new midi controller
|
|
*/
|
|
function MidiController() { };
|
|
MidiController.prototype = new Controller();
|
|
|
|
/** Callback on midi event_ctl.
|
|
Usually this is triggered when moving a sliders or button.
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} ch channel
|
|
@param{int} param parameter number
|
|
@param{int} value value
|
|
*/
|
|
MidiController.prototype.event_ctrl = function (ch, param, value) { }
|
|
|
|
/** Callback on midi event_pitch
|
|
|
|
A pitch slider is like event_ctl but they have '0' zero in the middle.
|
|
in the middle position.
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} ch channel
|
|
@param{int} param parameter number
|
|
@param{int} value range -8192 to 8192, steps of 128
|
|
*/
|
|
MidiController.prototype.event_pitch = function (ch, param, value) { }
|
|
|
|
/** Callback on midi event_noteon
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} ch channel
|
|
@param{int} note note
|
|
@param{int} vel velocity
|
|
*/
|
|
MidiController.prototype.event_noteon = function (ch, note, vel) { }
|
|
|
|
/** Callback on midi event_noteoff
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} ch channel
|
|
@param{int} note note
|
|
@param{int} vel velocity
|
|
*/
|
|
MidiController.prototype.event_noteoff = function (ch, note, vel) { }
|
|
|
|
/** Callback on midi event_pgmchange
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} ch channel
|
|
@param{int} param parameter number
|
|
@param{int} value value
|
|
*/
|
|
MidiController.prototype.event_pgmchange = function (ch, param, value) { }
|
|
|
|
/** connect an midi output port with freej input.
|
|
connect_to() isn't implemented, yet ... ;)
|
|
@type int
|
|
@return status 0 on success, -16 Device or resource busy, -22 Invalid argument
|
|
@param {int} myport freej port number, usually 0
|
|
@param {int} dest_client lookup the input source with "aconnect -li"
|
|
@param {int} dest_port port number of the input client
|
|
*/
|
|
function connect_from(myport, dest_client, dest_port) { };
|
|
MidiController.prototype.connect_from = connect_from;
|
|
|
|
//////////////////////////////
|
|
// Keyboard Controller
|
|
|
|
/** KeyboardController constructor creates a keyboard controller
|
|
@class The KeyboardController holds callbacks to javascript.
|
|
Assign functions to the callback to handle events:
|
|
<div class="example">Example:
|
|
|
|
kbd = new KeyboardController();
|
|
register_controller( kbd );
|
|
|
|
kbd.pressed_ctrl_q = function() { quit(); }
|
|
</div>
|
|
|
|
@author jaromil
|
|
@constructor
|
|
@base Controller
|
|
@returns a new keyboard controller
|
|
*/
|
|
function KeyboardController() { };
|
|
KeyboardController.prototype = new Controller();
|
|
|
|
/** All keyboard events are exported as .pressed_MOD_KEYSYM as in pressed_a pressed_b pressed_c or pressed_shift_a but also as .released_MOD_KEYSYM as in released_a ... see below for a full list of implemented MOD_KEYSYMs (see also the default keyboard.js in share/freej/scripts)
|
|
<div class="example">
|
|
|
|
kbd = new KeyboardController();
|
|
register_controller( kbd );
|
|
|
|
kbd.pressed_1
|
|
kbd.pressed_2
|
|
kbd.pressed_3
|
|
kbd.pressed_4
|
|
kbd.pressed_5
|
|
kbd.pressed_6
|
|
kbd.pressed_7
|
|
kbd.pressed_8
|
|
kbd.pressed_9
|
|
kbd.pressed_0
|
|
|
|
kbd.pressed_a
|
|
kbd.pressed_b
|
|
kbd.pressed_c
|
|
kbd.pressed_d
|
|
kbd.pressed_e
|
|
kbd.pressed_f
|
|
kbd.pressed_g
|
|
kbd.pressed_h
|
|
kbd.pressed_i
|
|
kbd.pressed_j
|
|
kbd.pressed_k
|
|
kbd.pressed_l
|
|
kbd.pressed_m
|
|
kbd.pressed_n
|
|
kbd.pressed_o
|
|
kbd.pressed_p
|
|
kbd.pressed_q
|
|
kbd.pressed_r
|
|
kbd.pressed_s
|
|
kbd.pressed_t
|
|
kbd.pressed_u
|
|
kbd.pressed_v
|
|
kbd.pressed_w
|
|
kbd.pressed_x
|
|
kbd.pressed_y
|
|
kbd.pressed_z
|
|
|
|
// more letter keys are available
|
|
// in combination with control, shift or alt keys
|
|
// define them as:
|
|
kbd.pressed_ctrl_a
|
|
kbd.pressed_shift_b
|
|
kbd.pressed_alt_c
|
|
// .. and so on with other letters
|
|
// you can also combine ctrl+shift+alt for example:
|
|
kbd.pressed_ctrl_shift_alt_a
|
|
|
|
// symbol keys:
|
|
kbd.pressed_up
|
|
kbd.pressed_down
|
|
kbd.pressed_insert
|
|
kbd.pressed_home
|
|
kbd.pressed_end
|
|
kbd.pressed_pageup
|
|
kbd.pressed_pagedown
|
|
|
|
kbd.pressed_backspace
|
|
kbd.pressed_tab
|
|
kbd.pressed_return
|
|
kbd.pressed_space
|
|
kbd.pressed_less
|
|
kbd.pressed_greater
|
|
kbd.pressed_equals
|
|
|
|
// numeric keypad keys:
|
|
kbd.pressed_num_1
|
|
kbd.pressed_num_2
|
|
kbd.pressed_num_3
|
|
kbd.pressed_num_4
|
|
kbd.pressed_num_5
|
|
kbd.pressed_num_6
|
|
kbd.pressed_num_7
|
|
kbd.pressed_num_8
|
|
kbd.pressed_num_9
|
|
kbd.pressed_num_0
|
|
|
|
kbd.pressed_num_period
|
|
kbd.pressed_num_divide
|
|
kbd.pressed_num_multiply
|
|
kbd.pressed_num_minus
|
|
kbd.pressed_num_plus
|
|
kbd.pressed_num_enter
|
|
kbd.pressed_num_equals
|
|
|
|
// to quit we have default keys.
|
|
// never forget to define the quit key! ;^)
|
|
kbd.pressed_ctrl_q
|
|
kbd.pressed_ctrl_c
|
|
kbd.pressed_esc
|
|
</div>
|
|
*/
|
|
KeyboardController.prototype.pressed_MOD_KEYSYM = function () { };
|
|
|
|
|
|
//////////////////////////////
|
|
// Joystick Controller
|
|
|
|
/** The JoystickController constructor creates a joystick controller
|
|
@class The Joystick Controller holds callbacks to javascript.
|
|
Assign functions to the callback to handle events:
|
|
<div class="example">Example:
|
|
|
|
jc = new JoystickController();
|
|
register_controller(jc);
|
|
jc.axismotion = function (which, axis, value) {
|
|
echo("joystick axis event: " + which + ", " + axis + ", " + value);
|
|
// do something
|
|
return true;
|
|
}
|
|
</div>
|
|
You may return true or false in the event handlers to indicate further processing or not. However, this is not implemented properly, yet.
|
|
|
|
@constructor
|
|
@base Controller
|
|
@returns a new JoystickController
|
|
*/
|
|
function JoystickController() { };
|
|
JoystickController.prototype = new Controller();
|
|
|
|
/** Callback on moving a joystick axis
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} which Joystick device index
|
|
@param{int} axis Axis index
|
|
@param{int} value axis position range usually -32767 to 32767
|
|
*/
|
|
JoystickController.prototype.axismotion = function (which, axis, value);
|
|
|
|
/** Callback on trackball motion event
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} which The joystick device index
|
|
@param{int} ball The joystick trackball index
|
|
@param{int} xrel The relative motion in the X direction
|
|
@param{int} yrel The relative motion in the Y direction
|
|
|
|
*/
|
|
JoystickController.prototype.ballmotion = function (which, ball, xrel, yrel);
|
|
|
|
/** Callback on joystick hat position change
|
|
|
|
<div class="example">Positionvalues ('or'ed in the corners):
|
|
|
|
0x01
|
|
0x08 0x00 0x02
|
|
0x04</div>
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} which The joystick device index
|
|
@param{int} hat The joystick hat index
|
|
@param{int} value The hat position value
|
|
|
|
*/
|
|
JoystickController.prototype.hatmotion = function (which, hat, value);
|
|
|
|
/** Callback on button event
|
|
|
|
@return true if event is handled otherwise false
|
|
@type bool
|
|
@param{int} which The joystick device index
|
|
@param{int} button The joystick button index
|
|
@param{int} state 0=up 1=down
|
|
|
|
*/
|
|
JoystickController.prototype.button = function (which, button, state);
|
|
|
|
//////////////////////////////
|
|
// Trigger Controller
|
|
|
|
/** The TriggerController constructor creates a trigger controller
|
|
@class The Trigger Controller holds callbacks to javascript. You can use the frame callback to process various stuff, instead using run().
|
|
|
|
@constructor
|
|
@base Controller
|
|
@returns a new TriggerController
|
|
*/
|
|
function TriggerController() { };
|
|
TriggerController.prototype = new Controller();
|
|
|
|
/** This will be called each frame.
|
|
Don't waste too much time here!
|
|
|
|
@type void
|
|
*/
|
|
TriggerController.prototype.frame = function ();
|