Class: FMOD::Effects::ObjectPan

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

Overview

This unit sends the signal to a 3d object encoder like Dolby Atmos. Supports a subset of the Core::DspType::PAN parameters.

3D Object panners are meant for hardware 3d object systems like Dolby Atmos or Sony Morpheus. These object panners take input in, and send it to the 7.1 bed, but do not send the signal further down the DSP chain (the output of the dsp is silence).

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:



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def extent_mode
  @extent_mode
end

#max_distance ⇒ Float

3D Max Distance

  • Minimum: 0.0

  • Default: 1.0

Returns:

  • (Float) —

    the current value of max_distance



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

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



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def min_distance
  @min_distance
end

#min_extent ⇒ Float

3D Min Extent (degrees)

  • Minimum: 0.0

  • Maximum: 360.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of min_extent



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def min_extent
  @min_extent
end

#output_gain ⇒ Float

Output gain level, linear scale. For the user to scale the output of the object panner’s signal.

  • Minimum: 0.0

  • Maximum: 1.0

Returns:

  • (Float) —

    the current value of output_gain



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def output_gain
  @output_gain
end

#overall_gain ⇒ Pointer|String

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

Returns:

  • (Pointer|String) —

    the current value of overall_gain



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def overall_gain
  @overall_gain
end

#position ⇒ Pointer|String

3D Position

Returns:

  • (Pointer|String) —

    the current value of position



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

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:



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def rolloff
  @rolloff
end

#sound_size ⇒ Float

3D Sound Size

  • Minimum: 0.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of sound_size



50
51
52
 
# File 'lib/fmod/effects/object_pan.rb', line 50

def sound_size
  @sound_size
end