Class: JSound::Midi::Device

Inherits:

Object

• Object
• JSound::Midi::Device

Includes:

TypeFromClassName

Defined in:

lib/jsound/midi/device.rb

Overview

A device that can transmit and/or receive messages (typically MIDI messages). This default implementation simply passes through all messages.

Direct Known Subclasses

JSound::Midi::Devices::Generator, JSound::Midi::Devices::InputDevice::Bridge, JSound::Midi::Devices::JDevice, JSound::Midi::Devices::Monitor, JSound::Midi::Devices::Recorder, JSound::Midi::Devices::Transformer

Instance Method Summary

• #<=(message) ⇒ Object

  send a message to this device.

• #>>(device) ⇒ Object

  Connect a device as the output for this device.

• #close ⇒ Object

  Close the device and free up any resources used by this device.

• #message(message) ⇒ Object

  Send a message to this device and pass it through to any output(s).

• #open ⇒ Object

  Open the device and allocate the needed resources so that it can send and receive messages.

• #open? ⇒ Boolean

  return true if this device is currently open.

• #output ⇒ Device

  the device connected to this device’s output.

• #output=(device) ⇒ Object

  connect a device as the output for this device.

• #to_s ⇒ Object
• #type ⇒ Object

Methods included from TypeFromClassName

included

Instance Method Details

#<=(message) ⇒ Object

send a message to this device. shortcut for #message

See Also:

• #message

# File 'lib/jsound/midi/device.rb', line 66

def <=(message)
  message(message)
end

#>>(device) ⇒ Object

Connect a device as the output for this device. shortcut for #output=

Parameters:

• the (Device) —

  device to connect, or nil to disconnect the currently connected device

See Also:

• JSound::Midi::Device.{{#output=}

# File 'lib/jsound/midi/device.rb', line 47

def >> device
  self.output= device
end

#close ⇒ Object

Note:

this operation is typically only relevant for Java-based devices such as JSound::Midi::Devices::InputDevice and JSound::Midi::Devices::OutputDevice

Close the device and free up any resources used by this device.

# File 'lib/jsound/midi/device.rb', line 23

def close
end

#message(message) ⇒ Object

Send a message to this device and pass it through to any output(s)

Parameters:

• (Message)

See Also:

• #<=

# File 'lib/jsound/midi/device.rb', line 54

def message(message)
  if @output.respond_to? :each
    for device in @output
      device.message(message)
    end
  elsif @output
    @output.message(message)
  end
end

#open ⇒ Object

Note:

this operation is typically only relevant for Java-based devices such as JSound::Midi::Devices::InputDevice and JSound::Midi::Devices::OutputDevice

Open the device and allocate the needed resources so that it can send and receive messages

See Also:

• JSound::Midi::DeviceList#open

# File 'lib/jsound/midi/device.rb', line 12

def open
end

#open? ⇒ Boolean

return true if this device is currently open

Returns:

• (Boolean)

# File 'lib/jsound/midi/device.rb', line 16

def open?
  # typically, ruby devices are always open, subclasses might not be
  true
end

#output ⇒ Device

the device connected to this device’s output

Returns:

• (Device) —

  the connected device, or nil if nothing is connected

# File 'lib/jsound/midi/device.rb', line 33

def output
  @output
end

#output=(device) ⇒ Object

connect a device as the output for this device

Parameters:

• the (Device) —

  device to connect, or nil to disconnect the currently connected device

See Also:

• JSound::Midi::Device.{{#>>}

# File 'lib/jsound/midi/device.rb', line 40

def output= device
  @output = device
end

#to_s ⇒ Object

# File 'lib/jsound/midi/device.rb', line 70

def to_s
  "MIDI #{type} device"
end

#type ⇒ Object

# File 'lib/jsound/midi/device.rb', line 26

def type
  # The base Device behaves like a 'pass through'
  @type ||= (self.class == Device ? :pass_through : self.class.type)
end