Module: Seal

Defined in:

src/rubyext.c,
src/rubyext.c

Overview

The top-level namespace of Seal. This module contains interfaces for global Seal operations.

Defined Under Namespace

Modules: Format Classes: Buffer, EffectSlot, Listener, Reverb, SealError, Source, Stream

Constant Summary

VERSION =

A string indicating the version of Seal.

rb_str_new2(seal_get_version())

LISTENER =

The singleton Listener instance.

listener

Class Method Summary

• .cleanup ⇒ nil

  Uninitializes Seal and invalidate all Seal objects.

• .listener ⇒ Object

  Gets the singleton Listener instance.

• .per_source_effect_limit ⇒ Fixnum

  Returns the maximum number of effect slots a source can feed concurrently.

• .startup(*args) ⇒ Object

  Initializes Seal by specifying the device name str.

Class Method Details

.cleanup ⇒ nil

Uninitializes Seal and invalidate all Seal objects. Thread-unsafe.

Returns:

• (nil)

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

static
VALUE
cleanup()
{
    seal_cleanup();

    return Qnil;
}

.listener ⇒ Object

Gets the singleton Listener instance.

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

static
VALUE
get_listener()
{
    return rb_const_get(mSeal, rb_intern("LISTENER"));
}

.per_source_effect_limit ⇒ Fixnum

Returns the maximum number of effect slots a source can feed concurrently.

Returns:

• (Fixnum)

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

static
VALUE
per_source_effect_limit()
{
    return INT2NUM(seal_get_per_src_effect_limit());
}

.startup ⇒ nil .startup(str) ⇒ nil

Initializes Seal by specifying the device name str. This function is not re-entrant nor thread-safe and should be called only once per Seal session. Match a call to seal_startup with a call to seal_cleanup and never call seal_starup twice in a row.

Overloads:

• .startup ⇒ nil

  Returns:

  • (nil)
• .startup(str) ⇒ nil

  Returns:

  • (nil)

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

static
VALUE
startup(int argc, VALUE* argv)
{
    VALUE rstring;

    rb_scan_args(argc, argv, "01", &rstring);
    check_seal_err(seal_startup(NIL_P(rstring)
                   ? 0 : rb_string_value_ptr(&rstring)));

    return Qnil;
}