Class: FMOD::Dsp::DspInfo

Inherits:
Struct
  • Object
show all
Defined in:
lib/fmod/dsp.rb

Overview

Contains information about the current DSP unit, including name, version, default channels and width and height of configuration dialog box if it exists.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channels ⇒ Integer

The number of channels the unit was initialized with. 0 means the plugin will process whatever number of channels is currently in the network. >0 would be mostly used if the unit is a unit that only generates sound, or is not flexible enough to take any number of input channels.

Returns:

  • (Integer) —

    the current value of channels



79
80
81
 
# File 'lib/fmod/dsp.rb', line 79

def channels
  @channels
end

#height ⇒ Integer

The height of an optional configuration dialog box that can be displayed with FMOD::Dsp#show_dialog. 0 means the dialog is not present.

Returns:

  • (Integer) —

    the current value of height



79
80
81
 
# File 'lib/fmod/dsp.rb', line 79

def height
  @height
end

#name ⇒ String

The name of the unit.

Returns:

  • (String) —

    the current value of name



79
80
81
 
# File 'lib/fmod/dsp.rb', line 79

def name
  @name
end

#version ⇒ String

The version number of the DSP unit.

Returns:

  • (String) —

    the current value of version



79
80
81
 
# File 'lib/fmod/dsp.rb', line 79

def version
  @version
end

#width ⇒ Integer

The width of an optional configuration dialog box that can be displayed with FMOD::Dsp#show_dialog. 0 means the dialog is not present.

Returns:

  • (Integer) —

    the current value of width



79
80
81
 
# File 'lib/fmod/dsp.rb', line 79

def width
  @width
end

Instance Method Details

#config? ⇒ Boolean

Note:

None of the built-in DSP units contain a dialog.

Returns a flag indicating if DSP unit has an optional configuration dialog that can be displayed.

Returns:

  • (Boolean) —

    a flag indicating if DSP unit has an optional configuration dialog that can be displayed.



85
86
87
 
# File 'lib/fmod/dsp.rb', line 85

def config?
  width > 0 && height > 0
end