Class: FMOD::Effects::Pan

Inherits:
Dsp
  • Object
show all
Defined in:
lib/fmod/effects/pan.rb

Overview

This unit pans the signal, possibly up-mixing or down-mixing as well.

Constant Summary collapse

EXTENT_AUTO =

Strongly-typed value used with #extent_mode.

0
EXTENT_USER =

Strongly-typed value used with #extent_mode.

1
EXTENT_OFF =

Strongly-typed value used with #extent_mode.

2
ROLLOFF_LINEAR_SQUARED =

Strongly typed 3D rolloff value used with #rolloff.

0
ROLLOFF_LINEAR =

Strongly typed 3D rolloff value used with #rolloff.

1
ROLLOFF_INVERSE =

Strongly typed 3D rolloff value used with #rolloff.

2
ROLLOFF_INVERSE_TAPERED =

Strongly typed 3D rolloff value used with #rolloff.

3
ROLLOFF_CUSTOM =

Strongly typed 3D rolloff value used with #rolloff.

4

Instance Attribute Summary collapse

Attributes inherited from Dsp

#active, #bypass, #channel_format, #input_count, #output_count, #parameter_count, #parent, #type, #wet_dry_mix

Attributes inherited from Handle

#user_data

Method Summary

Methods inherited from Dsp

#[], #[]=, #add_input, bool_param, data_param, #disconnect, #disconnect_from, #enable_metering, float_param, from_handle, #get_bool, #get_data, #get_float, #get_integer, #idle?, #info, #input, #input_connection, #input_metering?, integer_param, #name, #output, #output_connection, #output_format, #output_metering?, #param_info, #play, #reset, #set_bool, #set_data, #set_float, #set_integer, #set_wet_dry_mix, #show_dialog, #to_s, type_map, #version

Methods inherited from Handle

#initialize, #int_ptr, #release, #to_s

Constructor Details

This class inherits a constructor from FMOD::Handle

Instance Attribute Details

#extent_mode ⇒ Integer

3D Extent Mode.

  • Minimum: 0 (auto)

  • Maximum: 2 (off)

  • Default: 0 (auto)

Returns:

  • (Integer) —

    the current value of extent_mode

See Also:



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def extent_mode
  @extent_mode
end

#height_blend ⇒ Float

2D Height blend. When the input or #speaker_mode has height speakers, control the blend between ground and height.

  • Minimum: -1.0 (push top speakers to ground)

  • Maximum: 1.0 (push ground speakers to top)

  • Default: 0.0 (preserve top / ground separation)

Returns:

  • (Float) —

    the current value of height_blend



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def height_blend
  @height_blend
end

#lfe_upmix_enabled ⇒ Integer

LFE Up-mix Enabled. Determines whether non-LFE source channels should mix to the LFE or leave it alone.

  • Minimum: 0 (off)

  • Maximum: 1 (on)

  • Default: 0 (off)

Returns:

  • (Integer) —

    the current value of lfe_upmix_enabled



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def lfe_upmix_enabled
  @lfe_upmix_enabled
end

#max_distance ⇒ Float

3D Max Distance.

  • Minimum: 0.0

  • Default: 20.0

Returns:

  • (Float) —

    the current value of max_distance



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def max_distance
  @max_distance
end

#min_distance ⇒ Float

3D Min Distance.

  • Minimum: 0.0

  • Default: 1.0

Returns:

  • (Float) —

    the current value of min_distance



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def min_distance
  @min_distance
end

#min_extent ⇒ Float

3D Min Extent.

  • Minimum: 0.0 (degrees)

  • Maximum: 360.0 (degrees)

  • Default: 0.0

Returns:

  • (Float) —

    the current value of min_extent



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def min_extent
  @min_extent
end

#overall_gain ⇒ Pointer

Overall gain. For information only, not set by user. Data to provide to FMOD, to allow FMOD to know the DSP is scaling the signal for virtualization purposes.

Returns:

  • (Pointer) —

    the current value of overall_gain



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def overall_gain
  @overall_gain
end

#pan_blend ⇒ Float

3D Pan Blend.

  • Minimum: 0.0 (fully 2D)

  • Maximum: 1.0 (fully 3D)

  • Default: 0.0

Returns:

  • (Float) —

    the current value of pan_blend



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def pan_blend
  @pan_blend
end

#panning_mode ⇒ Integer

Panner mode.

  • 0: Mono down-mix

  • 1: Stereo panning

  • 2: Surround panning

Returns:

  • (Integer) —

    the current value of panning_mode



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def panning_mode
  @panning_mode
end

#position ⇒ Pointer|String

3D Position.

Returns:

  • (Pointer|String) —

    the current value of position



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def position
  @position
end

#rolloff ⇒ Integer

3D Rolloff.

  • Minimum: 0

  • Maximum: 4

  • Default: 0 (linear-squared)

Returns:

  • (Integer) —

    the current value of rolloff

See Also:



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def rolloff
  @rolloff
end

#sound_size ⇒ Float

3D Sound Size.

  • Minimum: 0.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of sound_size



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def sound_size
  @sound_size
end

#speaker_mode ⇒ Integer

Surround speaker mode. Target speaker mode for surround panning.

Returns:

  • (Integer) —

    the current value of speaker_mode

See Also:



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def speaker_mode
  @speaker_mode
end

#stereo_position ⇒ Float

2D Stereo pan position.

  • Minimum: -100.0

  • Maximum: 100.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of stereo_position



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def stereo_position
  @stereo_position
end

#stereo_surround ⇒ Integer

Stereo-to-surround mode.

  • 0: Distributed

  • 1: Discrete (default)

Returns:

  • (Integer) —

    the current value of stereo_surround



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def stereo_surround
  @stereo_surround
end

#surround_direction ⇒ Float

2D Surround pan direction. Direction from center point of panning circle, in degrees.

  • Minimum: -180.0 (rear-speakers center point)

  • Maximum: 180.0 (rear-speakers center point)

  • Default: 0.0 (front-center)

Returns:

  • (Float) —

    the current value of surround_direction



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_direction
  @surround_direction
end

#surround_extent ⇒ Float

2D Surround pan extent. Distance from center point of panning circle, in degrees.

  • Minimum: 0.0

  • Maximum: 360.0

  • Default: 360.0

Returns:

  • (Float) —

    the current value of surround_extent



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_extent
  @surround_extent
end

#surround_lfe_level ⇒ Float

2D Surround pan LFE level. 2D LFE level in dB.

  • Minimum: -80.0

  • Maximum: 20.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of surround_lfe_level



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_lfe_level
  @surround_lfe_level
end

#surround_rotation ⇒ Float

2D Surround pan rotation.

  • Minimum: -180.0 (degrees)

  • Maximum: 180.0 (degrees)

  • Default: 0.0

Returns:

  • (Float) —

    the current value of surround_rotation



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_rotation
  @surround_rotation
end

#surround_speakers ⇒ Integer

Speakers Enabled. Bit-mask for each speaker from 0 to 32 to be considered by panner. Use to disable speakers from being panned to.

  • Minimum: 0

  • Maximum: 0xFFF

  • Default: 0xFFF (all on)

Returns:

  • (Integer) —

    the current value of surround_speakers



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_speakers
  @surround_speakers
end

#surround_stereo_axis ⇒ Float

Stereo-To-Surround Stereo (only for #stereo_surround) “discrete” mode). Axis/rotation of L/R parts of stereo sound, in degrees.

  • Minimum: -180.0

  • Maximum: 180.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of surround_stereo_axis



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_stereo_axis
  @surround_stereo_axis
end

#surround_stereo_separation ⇒ Float

Stereo-To-Surround Stereo (only for #stereo_surround) “discrete” mode). Separation/width of L/R parts of stereo sound, in degrees.

  • Minimum: -180.0

  • Maximum: 180.0

  • Default: 60.0

Returns:

  • (Float) —

    the current value of surround_stereo_separation



109
110
111
 
# File 'lib/fmod/effects/pan.rb', line 109

def surround_stereo_separation
  @surround_stereo_separation
end