Class: Seal::EffectSlot

Inherits:

Object

• Object
• Seal::EffectSlot

Defined in:

src/rubyext.c,
src/rubyext.c

Overview

Interfaces for manipulating effect slots, which are containers for effect objects. Effect slots can attach effect objects (such as reverb objects) and then be fed with a mix of audio from different sources, essentially filtering the rendering of the sound sources and output to the mixer based on the attached effect object. For example, if a reverb object is attached to an effect slot and one source is feeding the slot, the sound of that source will have the reverberation effect defined by the reverb object.

Multiple sources can feed the same effect slot, but conversely there is a limit on the number of effect slots a source can feed concurrently. See the documentation for EffectSlot#feed for more details.

For more infomation about effect slots, check out the OpenAL effect extension guide at: zhang.su/seal/EffectsExtensionGuide.pdf

Instance Method Summary

• #auto ⇒ Boolean (also: #auto?)

  Determines if the effect is automatically adjusted.

• #auto=(true) ⇒ Boolean

  Sets whether the effect should have automatic adjustments based on the physical positions of the sources and the listener.

• #effect ⇒ Object

  Gets the effect object in effect_slot.

• #effect=(effect) ⇒ Object

  Fills effect_slot with effect, then effect_slot will become ready to be fed by sources.

• #gain ⇒ Object

  Gets the output level of effect_slot.

• #gain=(flt) ⇒ Object

  Sets the output level of effect_slot in the interval [0.0, 1.0].

• #initialize(*args) ⇒ Object constructor

  Initializes a new effect slot.

Constructor Details

#new ⇒ Object #new(effect) ⇒ Object

Initializes a new effect slot. If an effect object is specified, initializes the effect slot to have that effect object associated.

There is a limit on the number of allocated effect slots. This method raises an error if it is exceeding the limit.

# File 'src/rubyext.c', line 1613

static
VALUE
init_efs(int argc, VALUE* argv, VALUE rslot)
{
    VALUE reffect;

    rb_scan_args(argc, argv, "01", &reffect);
    check_seal_err(seal_init_efs(DATA_PTR(rslot)));
    if (!NIL_P(reffect))
        set_efs_effect(rslot, reffect);

    return rslot;
}

Instance Method Details

#auto ⇒ Boolean Also known as: auto?

Determines if the effect is automatically adjusted. The default is true (nonzero).

Returns:

• (Boolean)

# File 'src/rubyext.c', line 1688

static
VALUE
is_efs_auto(VALUE refs)
{
    return get_obj_char(refs, seal_is_efs_auto);
}

#auto=(true) ⇒ Boolean

Sets whether the effect should have automatic adjustments based on the physical positions of the sources and the listener.

Returns:

• (Boolean)

# File 'src/rubyext.c', line 1674

static
VALUE
set_efs_auto(VALUE refs, VALUE value)
{
    return set_obj_char(refs, value, seal_set_efs_auto);
}

#effect ⇒ Object

Gets the effect object in effect_slot. The default is nil.

# File 'src/rubyext.c', line 1633

static
VALUE
get_efs_effect(VALUE rslot)
{
    return rb_iv_get(rslot, "@effect");
}

#effect=(effect) ⇒ Object

Fills effect_slot with effect, then effect_slot will become ready to be fed by sources. Pass nil to unfill the slot.

Changing the parameters of effect after it is attached to effect_slot will not change the sound effect provided by effect_slot. To update the sound effect, the updated effect must be re-attached to effect_slot.

# File 'src/rubyext.c', line 1583

static
VALUE
set_efs_effect(VALUE rslot, VALUE reffect)
{
    void* effect;
    seal_err_t err;

    if (NIL_P(reffect)) {
        err = seal_set_efs_effect(DATA_PTR(rslot), 0);
    } else {
        Data_Get_Struct(reffect, void*, effect);
        err = seal_set_efs_effect(DATA_PTR(rslot), effect);
    }
    check_seal_err(err);
    rb_iv_set(rslot, "@effect", reffect);

    return reffect;
}

#gain ⇒ Object

Gets the output level of effect_slot. The default is 1.0.

# File 'src/rubyext.c', line 1660

static
VALUE
get_efs_gain(VALUE refs)
{
    return get_obj_float(refs, seal_get_efs_gain);
}

#gain=(flt) ⇒ Object

Sets the output level of effect_slot in the interval [0.0, 1.0]. A value of 0.0 mutes the output.

# File 'src/rubyext.c', line 1647

static
VALUE
set_efs_gain(VALUE refs, VALUE value)
{
    return set_obj_float(refs, value, seal_set_efs_gain);
}