API calls¶

Group/User/Room ID¶

• group.id(value)
• user.id(value)
• room.id(value)

calculates the internal green-go id's to be used in for example channel.

channel.assign[1] = group.id(10)  // assigning group 10 to channel 1

Timers¶

Timers can be usd to create repeating or delayed events or to measure time.

A timer can be accessed as an indexed property (timer[1]), and are based on a 1 millisecond clock

Creating a repeating a timed event¶

the below example will start a timer and 1 second after initialization the event will trigger and execute its code, inside the event the timer is re-triggered with a 500ms time and will trigger the event 500ms later again

event timer[1]
  // do your stuff
  timer[1] = 500 // set repeat time to 500 ms
end

timer[1] = 1000 // start first event after 1 second

Creating a single delayed event¶

the below example will start a timer of 5 seconds, after the 5 seconds the timer event will trigger and execute its code. inside the event the timer is canceled to make it available again

after 5 seconds

event timer[1]
  // do your stuff
  cancel timer[1] // release the timer event
end

timer[1] = 5000 // start event after 5 seconds

Creating 10 times event at 1 second intervals¶

the below example will start a timer of 1 second, after the initial second the event will trigger. the event checks if counter is 0 if not the counter wil be lowered by one and the timer is re-triggered. if 0 the timer will be canceled.

var counter = 9

event timer[1]
  if counter
    counter = counter - 1
    timer [1] = 1000
  else
    cancel timer[1] // release the timer event
  end
  // do your stuff
end

timer[1] = 1000 // start event after 1 seconds

using dynamically assigned timers¶

instead of using timers directly, it is possible to have the VM find a free timer and use that

event timer // get a free timer
  // do event
  timer = 100 // use the timer that generated this event
end
timer = 100 // set the last found timer

Script to Script communication¶

Scripts can communicate between each other (either on the same device or via the green-go network). This function is supported by all devices that can run scripts

communication is send in blocks to destinations. destinations are freely numbered. multiple scripts can receive the same data-block if the same control.receive event is set

Script to script events and api¶

script to script examples¶

talk follower example¶

the following example will trigger an event when the channel talk of channel 1 changes and sends the channel and its talk status to the control destination control.receive.channel.talk (1)

// sending script

define control.receive.channel.talk  1

event channel.talk[1]
  control.destination(control.receive.channel.talk)
  control.write(1) // write the first item, channel number                              
  control.write(channel.talk[1]) // write the second item. channel state
end

the example below will receive the data blok from the previous script, parse it and set the channel accordingly.

// receiving script

define control.receive.channel.talk  1

event control.receive[control.receive.channel.talk]
  local channel = control.read() // read first item, channel number
  channel.talk[channel] = control.read() // read the second item, channel state and set the channel to this value
end

set audio on remote user¶

The snippet below contains a function that will take 3 properties and sends this to the destination user.id(user) this destination is specific to the user id, all devices with this user id will be able to receive this message. two key value pairs, for gain and threshold are set in the message

// sending script

function set.remote.audio(user, gain, threshold)
  control.destination(user.id(user))
  control.write(1, gain)
  control.write(2, threshold)
end

The script below will receive all messages that are send to its user.id. if key 1 is sent it will set its gain to its associated value. for key 2 the threshold is set if present

//receiving script

event control.receive[settings.user.id]
  audio.gain = control.read(1, audio.gain) // if no gain was send, then use the current setting (no change)
  audio.threshold = control.read(2, audio.threshold)
end

Networking commands¶

api¶

Open Sound Control (OSC)¶

OSC commands can be send and received by all devices with a direct network connection.

OSC api and events¶

examples¶

// receiving osc and setting channel 1 talk state accordingly

osc.open(1000) // start listening for osc udp packets on udp-port 1000

event osc.receive["/channel/1/"]
  if osc.receive[1]
    channel.talk[1] = channel.talk.on
  else
    channel.talk[1] = channel.talk.off
  end
end

// sending an osc message to report the talk state of channel 1

osc.open(8000)
osc.destination("192.168.1.255")

event channel.talk[1]
  osc.send("/channel/1/", channel.talk[1])
end

Random Number¶

A random number can be generated by calling random() it will by default return a number between 0 and 100

random(max,min) can be called with 1 or 2 arguments, when only maxis given it will return a number between 0 and max, when both max and min are given it will return a number between min and max

```GSL // random delay on talk on