fmod 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c772ecf5f77aade5c16621fe21270b20abec3078
-  data.tar.gz: f01973742360bb5ac77e442ce6167f2d60f540f3
+  metadata.gz: 7d2902236224e5d663766bcc5b5fb7c48147aa20
+  data.tar.gz: a8b3106722a1da66d22ec30902a24bedaacec0ab
 SHA512:
-  metadata.gz: 8c8ed671237062f1b82ddff1abb2d1b6db181ce908cb7a16c98679b7ac9b74cdf9c91fb245a7aa42592cfbccf278c8850d6dc42be21a6c81e477e4abd6ba4123
-  data.tar.gz: 6546ee0eee3da8627a77500d2bd2ee82287f441830749f44fa4a8ef96e61e08dfd2e604fbf1db23f41d47f5ec071e92fd1fb55d925f462e49c95f6cfa2b2bc16
+  metadata.gz: 1c651d58f0ae40f3c5f615e9bb0a1435b43f07f8d86f0c8dae6441cf8b704a35bdfa3a74a39b08b2ca9ad50000f278a0582ff8a31a5dda0a704be1826fe9651b
+  data.tar.gz: b77425a784f7f48c5687f693f013aab28c48ebd9267664a90b74a43f9c67254534af7ac71479793d135b2a51a70809f7c8cf322e9e35d91dd327c4f6b8d059f3

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+ - FMOD Library Version [e.g. default, 4.01.06]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/HISTORY.txt

@@ -0,0 +1,23 @@
+=== 0.9.1 /  2018-07-10
+
+* Added Features
+    * Expanded methods to FMOD::Core::Structure
+        * names - Gets array of field name symbols
+        * values - Gets all the structure fields as an array
+
+* Bug Fixes
+    * Fixed getting Reverb from System object would cause segmentation fault
+
+* Documentation
+    * Completed for Channel, ChannelGroup, and ChannelControl
+    * Various enum classes
+    * Current documentation completion is 71%
+
+* Misc.
+    * Updated gem description (poor formatting)
+    * Added templates for pull-requests, bugs, etc.
+
+
+=== 0.9.0 / 2018-07-09
+
+* Initial public release

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+### All Submissions:
+
+* [ ] Have you followed the guidelines in our Contributing document?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
+
+<!-- You can erase any parts of this template not applicable to your Pull Request. -->
+
+### New Feature Submissions:
+
+1. [ ] Does your submission pass tests?
+2. [ ] Have you lint your code locally prior to submission?
+
+### Changes to Core Features:
+
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
+* [ ] Have you written new tests for your core changes, as applicable?
+* [ ] Have you successfully ran tests with your changes locally?

data/README.md

@@ -1,31 +1,32 @@
 # FMOD
 
+[![Gem Version](https://badge.fury.io/rb/fmod.svg)](https://badge.fury.io/rb/fmod) ![Documentation](https://img.shields.io/badge/Documentation-71%25-orange.svg)
 
 
 A full-featured (*complete* Ruby wrapper) of the ultra-powerful FMOD Low-Level API. Uses the built-in Fiddle library (Ruby 2.0+), and has no external gem dependencies, all that is needed is the native FMOD platform-specific native FMOD libraries.
 
 Supports a host of audio formats including:
-   * Audio Interchange File Format (.aiff )
-   * Advanced Systems Format (.asf)
-   * Advanced Stream Redirector (.asx)
-   * Downloadable Sound (.dls)
-   * Free Loss-less Audio Codec (.flac)
-   * FMOD Sound Bank (.fsb)
-   * Impulse Tracker (.it)
-   * MPEG Audio Layer 3 URL (.m3u)
-   * Musical Instrument Digital Interface (.mid, .midi)
-   * Module Format (.mod)
-   * MPEG Audio Layer 2 (.mp2)
-   * MPEG Audio Layer 3 (.mp3)
-   * OGG Vorbis (.ogg)
-   * Playlist (.pls)
-   * ScreamTracker 3 Module (.s3m )
-   * PS2/PSP Format (.vag )
-   * Waveform Audio File Forma (.wav )
-   * Windows Media Audio Redirector (.wax )
-   * Windows Media Audio (.wma )
-   * Extended Module (.xm )
-   * Windows Media Audio (Xbox 360) (.xma)
+* Audio Interchange File Format (.aiff )
+* Advanced Systems Format (.asf)
+* Advanced Stream Redirector (.asx)
+* Downloadable Sound (.dls)
+* Free Loss-less Audio Codec (.flac)
+* FMOD Sound Bank (.fsb)
+* Impulse Tracker (.it)
+* MPEG Audio Layer 3 URL (.m3u)
+* Musical Instrument Digital Interface (.mid, .midi)
+* Module Format (.mod)
+* MPEG Audio Layer 2 (.mp2)
+* MPEG Audio Layer 3 (.mp3)
+* OGG Vorbis (.ogg)
+* Playlist (.pls)
+* ScreamTracker 3 Module (.s3m )
+* PS2/PSP Format (.vag )
+* Waveform Audio File Forma (.wav )
+* Windows Media Audio Redirector (.wax )
+* Windows Media Audio (.wma )
+* Extended Module (.xm )
+* Windows Media Audio (Xbox 360) (.xma)
    
 FMOD is most widely known for its application in video games for sound effects, as it fully supports 3D sound, and can be found in all popular video game consoles (Sony, Microsoft, and Nintendo), as well as a large number of popular PC and mobile games. Built-in is a large collection of audio effects that can be applied to a sound, including various equalizers, advanced reverb environments, pitch-shifting, frequency, flange, chorus, and many, many more. 
 
@@ -71,7 +72,7 @@ Each get/set method in the FMOD API has been converted to an "attribute" that ca
 
 ## Future Releases
 
-As of the first release, only slightly better than 50% of documentation is complete. The scripts are highly technical, and good documentation takes time, but it is actively being updated, and will be completed at the highest priority level. If you are using version `1.0.0`, you will have to rely more heavily upon the included FMOD Low-Level API Reference that is included in the `./extras` folder.
+As of the current release, only slightly better than 71% of documentation is complete. The scripts are highly technical, and good documentation takes time, but it is actively being updated, and will be completed at the highest priority level. If you are using version `1.0.0`, you will have to rely more heavily upon the included FMOD Low-Level API Reference that is included in the `./extras` folder.
 
 There is still yet to be a few areas that need completed, and are in active development. Included are the following known issues:
    * FMOD plugin support (including 3rd party codecs)

data/fmod.gemspec

@@ -6,38 +6,10 @@ require 'fmod/version'
 Gem::Specification.new do |spec|
   spec.name          = 'fmod'
   spec.version       = FMOD::VERSION
-  spec.authors       = ['Eric "ForeverZero" Freed']
+  spec.authors       = ['Eric "ForeverZer0" Freed']
   spec.email         = ['efreed09@gmail.com']
   spec.summary       = %q{Ruby wrapper around the high performance, cross-platform FMOD low-level sound library. You get all the benefits of the FMOD library, but in the object-oriented Ruby way!}
-  spec.description   = %q{A full-featured (complete Ruby wrapper) of the ultra-powerful FMOD Low-Level API. Uses the built-in Fiddle library (Ruby 2.0+), and has no external gem dependencies, all that is needed is the native FMOD platform-specific native FMOD libraries (included).
-
-FMOD supports a host of audio formats including:
-
-- Audio Interchange File Format (.aiff )
-- Advanced Systems Format (.asf)
-- Advanced Stream Redirector (.asx)
-- Downloadable Sound (.dls)
-- Free Lossless Audio Codec (.flac)
-- FMOD Sound Bank (.fsb)
-- Impulse Tracker (.it)
-- MPEG Audio Layer 3 URL (.m3u)
-- Musical Instrument Digital Interface (.mid, .midi)
-- Module Format (.mod)
-- MPEG Audio Layer 2 (.mp2)
-- MPEG Audio Layer 3 (.mp3)
-- OGG Vorbis (.ogg)
-- Playlist (.pls)
-- ScreamTracker 3 Module (.s3m )
-- PS2/PSP Format (.vag )
-- Waveform Audio File Forma (.wav )
-- Windows Media Audio Redirector (.wax )
-- Windows Media Audio (.wma )
-- Extended Module (.xm )
-- Windows Media Audio (Xbox 360) (.xma)
-
-FMOD is most widely known for its application in video games for sound effects, as it fully supports 3D sound, and can be found in all popular video game consoles (Sony, Microsoft, and Nintendo), as well as a large number of popular PC and mobile games. Built-in is a large collection of audio effects that can be applied to a sound, including various equalizers, advanced reverb environments, pitch-shifting, frequency, flange, chorus, and many, many more.
-
-The wrapper supports callbacks for various events, such as sync-points in wave files, sound playback ending (either by user or end of data), and various other scenarios. It additionally supports access to raw PCM data directly from the sound card, for creating visualizations or examining the sound in real-time.}
+  spec.description   = %q{A full-featured (complete Ruby wrapper) of the ultra-powerful FMOD Low-Level API. Uses the built-in Fiddle library (Ruby 2.0+), and has no external gem dependencies, all that is needed is the FMOD platform-specific libraries (included). FMOD supports a host of audio formats including .aiff, .asf, .asx, .dls, .flac, .fsb, .it, .m3u, .mid, .midi, .mod, .mp2, .mp3, .ogg .pls, .s3m , vag, .wav, .wax, .wma, .xm, and.xma.}
 
   spec.homepage      = 'https://github.com/ForeverZer0/fmod'
   spec.license       = 'MIT'

data/lib/fmod.rb

@@ -3,6 +3,9 @@ require 'fiddle'
 require 'fiddle/import'
 require 'rbconfig'
 
+##
+# Top-level namespace containing the entirety of the FMOD API.
+# @author Eric "ForeverZer0" Freed
 module FMOD
 
   include Fiddle
@@ -430,7 +433,7 @@ module FMOD
   #
   # @param function [Symbol] Symbol name of an FMOD function, without the the
   #   leading "FMOD_" prefix.
-  # @raise [Error] if the result code returned by FMOD is not {Result::OK}.
+  # @raise [Error] if the result code returned by FMOD is not 0.
   # @return [void]
   # @see invoke_protect
   def self.invoke(function, *args)

data/lib/fmod/channel.rb

@@ -1,5 +1,8 @@
 
 module FMOD
+
+  ##
+  # Represents a sound-card channel and a interface to sound playback.
   class Channel < ChannelControl
 
     ##

data/lib/fmod/channel_control.rb

@@ -1,9 +1,183 @@
 
 module FMOD
+
+  ##
+  # @abstract
+  # The base class for both {Channel} and {ChannelGroup} objects.
   class ChannelControl < Handle
 
+    ##
+    # Emulates an Array-type container of a {ChannelControl}'s DSP chain.
+    class DspChain
+
+      include Enumerable
+
+      ##
+      # Creates a new instance of a {DspChain} for the specified
+      # {ChannelControl}.
+      #
+      # @param channel [ChannelControl] The channel or channel group to create
+      #   the collection wrapper for.
+      def initialize(channel)
+        FMOD.type?(channel, ChannelControl)
+        @channel = channel
+      end
+
+      ##
+      # Retrieves the number of DSPs within the chain. This includes the
+      # built-in {FMOD::Effects::Fader} DSP.
+      # @return [Integer]
+      def count
+        buffer = "\0" * Fiddle::SIZEOF_INT
+        FMOD.invoke(:ChannelGroup_GetNumDSPs, @channel, buffer)
+        buffer.unpack1('l')
+      end
+
+      ##
+      # @overload each(&block)
+      #   If called with a block, passes each DSP in turn before returning self.
+      #   @yield [dsp] Yields a DSP instance to the block.
+      #   @yieldparam dsp [Dsp] The DSP instance.
+      #   @return [self]
+      # @overload each
+      #   Returns an enumerator for the {DspChain} if no block is given.
+      #   @return [Enumerator]
+      def each
+        return to_enum(:each) unless block_given?
+        (0...count).each { |i| yield self[i] }
+        self
+      end
+
+      ##
+      # Element reference. Returns the element at index.
+      # @param index [Integer] The index into the {DspChain} to retrieve.
+      # @return [Dsp|nil] The DSP at the specified index, or +nil+ if index is
+      #   out of range.
+      def [](index)
+        return nil unless index.between?(-2, count)
+        dsp = "\0" * Fiddle::SIZEOF_INTPTR_T
+        FMOD.invoke(:ChannelGroup_GetDSP, @channel, index, dsp)
+        Dsp.from_handle(dsp)
+      end
+
+      ##
+      # Element assignment. Sets the element at the specified index.
+      # @param index [Integer] The index into the {DspChain} to set.
+      # @param dsp [Dsp] A DSP instance.
+      # @return [Dsp] The given DSP instance.
+      def []=(index, dsp)
+        FMOD.type?(dsp, Dsp)
+        FMOD.invoke(:ChannelGroup_AddDSP, @channel, index, dsp)
+        dsp
+      end
+
+      ##
+      # Appends or pushes the given object(s) on to the end of this {DspChain}. This
+      # expression returns +self+, so several appends may be chained together.
+      # @param dsp [Dsp] One or more DSP instance(s).
+      # @return [self]
+      def add(*dsp)
+        dsp.each { |d| self[DspIndex::TAIL] = d }
+        self
+      end
+
+      ##
+      # Prepends objects to the front of +self+, moving other elements upwards.
+      # @param dsp [Dsp] A DSP instance.
+      # @return [self]
+      def unshift(dsp)
+        self[DspIndex::HEAD] = dsp
+        self
+      end
+
+      ##
+      # Removes the last element from +self+ and returns it, or +nil+ if the
+      # {DspChain} is empty.
+      # @return [Dsp|nil]
+      def pop
+        dsp = self[DspIndex::TAIL]
+        remove(dsp)
+        dsp
+      end
+
+      ##
+      # Returns the first element of +self+ and removes it (shifting all other
+      # elements down by one). Returns +nil+ if the array is empty.
+      # @return [Dsp|nil]
+      def shift
+        dsp = self[DspIndex::HEAD]
+        remove(dsp)
+        dsp
+      end
+
+      ##
+      # Deletes the specified DSP from this DSP chain. This does not release ot
+      # dispose the DSP unit, only removes from this {DspChain}, as a DSP unit
+      # can be shared.
+      # @param dsp [Dsp] The DSP to remove.
+      # @return [self]
+      def remove(dsp)
+        return unless dsp.is_a?(Dsp)
+        FMOD.invoke(:ChannelGroup_RemoveDSP, @channel, dsp)
+        self
+      end
+
+      ##
+      # Returns the index of the specified DSP.
+      # @param dsp [Dsp] The DSP to retrieve the index of.
+      # @return [Integer] The index of the DSP.
+      def index(dsp)
+        FMOD.type?(dsp, Dsp)
+        buffer = "\0" * Fiddle::SIZEOF_INT
+        FMOD.invoke(:ChannelGroup_GetDSPIndex, @channel, dsp, buffer)
+        buffer.unpack1('l')
+      end
+
+      ##
+      # Moves a DSP unit that exists in this {DspChain} to a new index.
+      # @param dsp [Dsp] The DSP instance to move, must exist within this
+      #   {DspChain}.
+      # @param index [Integer] The new index to place the specified DSP.
+      # @return [self]
+      def move(dsp, index)
+        FMOD.type?(dsp, Dsp)
+        FMOD.invoke(:ChannelGroup_SetDSPIndex, @channel, dsp, index)
+        self
+      end
+
+      alias_method :size, :count
+      alias_method :length, :count
+      alias_method :length, :count
+      alias_method :delete, :remove
+      alias_method :push, :add
+      alias_method :<<, :add
+
+      private_class_method :new
+    end
+
+    ##
+    # Represents the start (and/or stop) time relative to the parent channel
+    # group DSP clock, with sample accuracy.
+    #
+    # @attr start [Integer] The DSP clock of the parent channel group to audibly
+    #   start playing sound at.
+    # @attr end [Integer] The  DSP clock of the parent channel group to audibly
+    #   stop playing sound at.
+    # @attr stop [Boolean] +true+ to stop according to
+    #   {ChannelControl.playing?}, otherwise +false+ to remain "active" and a
+    #   new start delay could start playback again at a later time.
     ChannelDelay = Struct.new(:start, :end, :stop)
 
+    ##
+    # The settings for the 3D distance filter properties.
+    #
+    # @attr custom [Boolean] The enabled/disabled state of the FMOD distance
+    #   rolloff calculation. Default is +false+.
+    # @attr level [Float] The manual user attenuation, where 1.0 is no
+    #   attenuation and 0.0 is complete attenuation. Default is 1.0.
+    # @attr frequency [Float] The center frequency in Hz for the high-pass
+    #   filter used to simulate distance attenuation, from 10.0 to 22050.0.
+    #   Default is 1500.0.
     DistanceFilter = Struct.new(:custom, :level, :frequency)
 
     include Fiddle
@@ -105,50 +279,52 @@ module FMOD
     #   occlusion.
     float_reader(:audibility, :ChannelGroup_GetAudibility)
 
+    # @!attribute low_pass_gain
+    # The dry signal when low-pass filtering is applied.
+    # * *Minimum:* 0.0 (silent, full filtering)
+    # * *Maximum:* 1.0 (full volume, no filtering)
+    # * *Default:* 1.0
+    # @return [Float] the linear gain level.
     float_reader(:low_pass_gain, :ChannelGroup_GetLowPassGain)
     float_writer(:low_pass_gain=, :ChannelGroup_SetLowPassGain, 0.0, 1.0)
 
+    # @!group 3D Sound
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+    ##
+    # @!attribute level3D
+    # The 3D pan level.
+    # * *Minimum:* 0.0 (attenuation is ignored and panning as set by 2D panning
+    #   functions)
+    # * *Maximum:* 1.0 (pan and attenuate according to 3D position)
+    # * *Default:* 0.0
+    # @return [Float] the 3D pan level.
     float_reader(:level3D, :ChannelGroup_Get3DLevel)
     float_writer(:level3D=, :ChannelGroup_Set3DLevel, 0.0, 1.0)
 
+    ##
+    # @!attribute spread3D
+    # The speaker spread angle.
+    # * *Minimum:* 0.0
+    # * *Maximum:* 360.0
+    # * *Default:* 0.0
+    # @return [Float] the spread of a 3D sound in speaker space.
     float_reader(:spread3D, :ChannelGroup_Get3DSpread)
     float_writer(:spread3D, :ChannelGroup_Set3DSpread, 0.0, 360.0)
 
+    ##
+    # @!attribute doppler3D
+    # The doppler scale.
+    # * *Minimum:* 0.0 (none)
+    # * *Maximum:* 5.0 (exaggerated)
+    # * *Default:* 1.0 (normal)
+    # @return [Float] the amount by which doppler is scaled.
     float_reader(:doppler3D, :ChannelGroup_Get3DDopplerLevel)
     float_writer(:doppler3D=, :ChannelGroup_Set3DDopplerLevel, 0.0, 5.0)
 
+    ##
+    # @!attribute direct_occlusion
+    # @return [Float] the occlusion factor for the direct path.
+
     def direct_occlusion
       direct = "\0" * SIZEOF_FLOAT
       FMOD.invoke(:ChannelGroup_Get3DOcclusion, self, direct, nil)
@@ -162,6 +338,10 @@ module FMOD
       direct
     end
 
+    ##
+    # @!attribute reverb_occlusion
+    # @return [Float] the occlusion factor for the reverb mix.
+
     def reverb_occlusion
       reverb = "\0" * SIZEOF_FLOAT
       FMOD.invoke(:ChannelGroup_Get3DOcclusion, self, nil, reverb)
@@ -176,58 +356,9 @@ module FMOD
     end
 
     ##
-    # Add a volume point to fade from or towards, using a clock offset and 0.0
-    # to 1.0 volume level.
-    # @overload add_fade(fade_point)
-    #   @param fade_point [FadePoint] Fade point structure defining the values.
-    # @overload add_fade(clock, volume)
-    #   @param clock [Integer] DSP clock of the parent channel group to set the
-    #     fade point volume.
-    #   @param volume [Float] Volume level where 0.0 is silent and 1.0 is normal
-    #     volume. Amplification is supported.
-    # @return [self]
-    def add_fade(*args)
-      args = args[0].values if args.size == 1 && args[0].is_a?(FadePoint)
-      FMOD.invoke(:ChannelGroup_AddFadePoint, self, *args)
-      self
-    end
-
-    ##
-    # Retrieves the number of fade points set within the {ChannelControl}.
-    # @return [Integer] The number of fade points.
-    def fade_point_count
-      count = "\0" * SIZEOF_INT
-      FMOD.invoke(:ChannelGroup_GetFadePoints, self, count, nil, nil)
-      count.unpack1('l')
-    end
-
-    ##
-    # Retrieve information about fade points stored within a {ChannelControl}.
-    # @return [Array<FadePoint>] An array of {FadePoint} objects, or an empty
-    #   array if no fade points are present.
-    def fade_points
-      count = fade_point_count
-      return [] if count.zero?
-      clocks = "\0" * (count * SIZEOF_LONG_LONG)
-      volumes = "\0" * (count * SIZEOF_FLOAT)
-      FMOD.invoke(:ChannelGroup_GetFadePoints, self, int_ptr, clocks, volumes)
-      args = clocks.unpack('Q*').zip(volumes.unpack('f*'))
-      args.map { |values| FadePoint.new(*values) }
-    end
-
-    ##
-    # Remove volume fade points on the time-line. This function will remove
-    # multiple fade points with a single call if the points lay between the 2
-    # specified clock values (inclusive).
-    # @param clock_start [Integer] DSP clock of the parent channel group to
-    #   start removing fade points from.
-    # @param clock_end [Integer] DSP clock of the parent channel group to start
-    #   removing fade points to.
-    # @return [self]
-    def remove_fade_points(clock_start, clock_end)
-      FMOD.invoke(:ChannelGroup_RemoveFadePoints, self, clock_start, clock_end)
-      self
-    end
+    # @!attribute position3D
+    # @return [Vector] the position used to apply panning, attenuation and
+    #   doppler.
 
     def position3D
       position = Vector.zero
@@ -241,6 +372,11 @@ module FMOD
       vector
     end
 
+    ##
+    # @!attribute velocity3D
+    # @return [Vector] the velocity used to apply panning, attenuation and
+    #   doppler.
+
     def velocity3D
       velocity = Vector.zero
       FMOD.invoke(:ChannelGroup_Get3DAttributes, self, nil, velocity, nil)
@@ -253,6 +389,10 @@ module FMOD
       vector
     end
 
+    ##
+    # @!attribute distance_filter
+    # @return [DistanceFilter] the behaviour of a 3D distance filter, whether to
+    #   enable or disable it, and frequency characteristics.
     def distance_filter
       args = ["\0" * SIZEOF_INT, "\0" * SIZEOF_FLOAT, "\0" * SIZEOF_FLOAT]
       FMOD.invoke(:ChannelGroup_Get3DDistanceFilter, self, *args)
@@ -297,61 +437,6 @@ module FMOD
       rolloff
     end
 
-    ##
-    # Sets the speaker volume levels for each speaker individually, this is a
-    # helper to avoid having to set the mix matrix.
-    #
-    # Levels can be below 0 to invert a signal and above 1 to amplify the
-    # signal. Note that increasing the signal level too far may cause audible
-    # distortion. Speakers specified that don't exist will simply be ignored.
-    # For more advanced speaker control, including sending the different
-    # channels of a stereo sound to arbitrary speakers, see {#matrix}.
-    #
-    # @note This function overwrites any pan/mix-level by overwriting the
-    # {ChannelControl}'s matrix.
-    #
-    # @param fl [Float] Volume level for the front left speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param fr [Float] Volume level for the front right speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param center [Float] Volume level for the center speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param lfe [Float] Volume level for the sub-woofer speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param sl [Float] Volume level for the surround left speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param sr [Float] Volume level for the surround right speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param bl [Float] Volume level for the back left speaker of a multichannel
-    #   speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @param br [Float] Volume level for the back right speaker of a
-    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
-    # @return [self]
-    def output_mix(fl, fr, center, lfe, sl, sr, bl, br)
-      FMOD.invoke(:ChannelGroup_SetMixLevelsOutput, self, fl,
-        fr, center, lfe, sl, sr, bl, br)
-      self
-    end
-
-    ##
-    # Sets the incoming volume level for each channel of a multi-channel sound.
-    # This is a helper to avoid calling {#matrix}.
-    #
-    # A multi-channel sound is a single sound that contains from 1 to 32
-    # channels of sound data, in an interleaved fashion. If in the extreme case,
-    # a 32 channel wave file was used, an array of 32 floating point numbers
-    # denoting their volume levels would be passed in to the levels parameter.
-    #
-    # @param levels [Array<Float>] Array of volume levels for each incoming
-    #   channel.
-    # @return [self]
-    def input_mix(*levels)
-      count = levels.size
-      binary = levels.pack('f*')
-      FMOD.invoke(:ChannelGroup_SetMixLevelsInput, self, binary, count)
-      self
-    end
-
     ##
     # @!attribute min_distance
     # @return [Float] Minimum volume distance in "units". (Default: 1.0)
@@ -407,18 +492,145 @@ module FMOD
     # dont need to. Some people have the confusion that maximum distance is the
     # point the sound will fade out to zero, this is not the case.
     #
-    # @param min [Float] Minimum volume distance in "units".
-    #   * *Default:* 1.0
-    # @param max [Float] Maximum volume distance in "units".
-    #   * *Default:* 10000.0
+    # @param min [Float] Minimum volume distance in "units".
+    #   * *Default:* 1.0
+    # @param max [Float] Maximum volume distance in "units".
+    #   * *Default:* 10000.0
+    #
+    # @see min_distance
+    # @see max_distance
+    # @return [void]
+    def min_max_distance(min, max)
+      FMOD.invoke(:ChannelGroup_Set3DMinMaxDistance, self, min, max)
+    end
+
+    ##
+    # @!attribute cone_orientation
+    # @return [Vector] the orientation of the sound projection cone.
+
+    def cone_orientation
+      vector = FMOD::Core::Vector.new
+      FMOD.invoke(:ChannelGroup_Get3DConeOrientation, self, vector)
+      vector
+    end
+
+    def cone_orientation=(vector)
+      FMOD.type?(vector, Vector)
+      FMOD.invoke(:ChannelGroup_Set3DConeOrientation, self, vector)
+      vector
+    end
+
+    # @!endgroup
+
+    ##
+    # Add a volume point to fade from or towards, using a clock offset and 0.0
+    # to 1.0 volume level.
+    # @overload add_fade(fade_point)
+    #   @param fade_point [FadePoint] Fade point structure defining the values.
+    # @overload add_fade(clock, volume)
+    #   @param clock [Integer] DSP clock of the parent channel group to set the
+    #     fade point volume.
+    #   @param volume [Float] Volume level where 0.0 is silent and 1.0 is normal
+    #     volume. Amplification is supported.
+    # @return [self]
+    def add_fade(*args)
+      args = args[0].values if args.size == 1 && args[0].is_a?(FadePoint)
+      FMOD.invoke(:ChannelGroup_AddFadePoint, self, *args)
+      self
+    end
+
+    ##
+    # Retrieves the number of fade points set within the {ChannelControl}.
+    # @return [Integer] The number of fade points.
+    def fade_point_count
+      count = "\0" * SIZEOF_INT
+      FMOD.invoke(:ChannelGroup_GetFadePoints, self, count, nil, nil)
+      count.unpack1('l')
+    end
+
+    ##
+    # Retrieve information about fade points stored within a {ChannelControl}.
+    # @return [Array<FadePoint>] An array of {FadePoint} objects, or an empty
+    #   array if no fade points are present.
+    def fade_points
+      count = fade_point_count
+      return [] if count.zero?
+      clocks = "\0" * (count * SIZEOF_LONG_LONG)
+      volumes = "\0" * (count * SIZEOF_FLOAT)
+      FMOD.invoke(:ChannelGroup_GetFadePoints, self, int_ptr, clocks, volumes)
+      args = clocks.unpack('Q*').zip(volumes.unpack('f*'))
+      args.map { |values| FadePoint.new(*values) }
+    end
+
+    ##
+    # Remove volume fade points on the time-line. This function will remove
+    # multiple fade points with a single call if the points lay between the 2
+    # specified clock values (inclusive).
+    # @param clock_start [Integer] DSP clock of the parent channel group to
+    #   start removing fade points from.
+    # @param clock_end [Integer] DSP clock of the parent channel group to start
+    #   removing fade points to.
+    # @return [self]
+    def remove_fade_points(clock_start, clock_end)
+      FMOD.invoke(:ChannelGroup_RemoveFadePoints, self, clock_start, clock_end)
+      self
+    end
+
+    ##
+    # Sets the speaker volume levels for each speaker individually, this is a
+    # helper to avoid having to set the mix matrix.
+    #
+    # Levels can be below 0 to invert a signal and above 1 to amplify the
+    # signal. Note that increasing the signal level too far may cause audible
+    # distortion. Speakers specified that don't exist will simply be ignored.
+    # For more advanced speaker control, including sending the different
+    # channels of a stereo sound to arbitrary speakers, see {#matrix}.
+    #
+    # @note This function overwrites any pan/mix-level by overwriting the
+    # {ChannelControl}'s matrix.
+    #
+    # @param fl [Float] Volume level for the front left speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param fr [Float] Volume level for the front right speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param center [Float] Volume level for the center speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param lfe [Float] Volume level for the sub-woofer speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param sl [Float] Volume level for the surround left speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param sr [Float] Volume level for the surround right speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param bl [Float] Volume level for the back left speaker of a multichannel
+    #   speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @param br [Float] Volume level for the back right speaker of a
+    #   multichannel speaker setup, 0.0 (silent), 1.0 (normal volume).
+    # @return [self]
+    def output_mix(fl, fr, center, lfe, sl, sr, bl, br)
+      FMOD.invoke(:ChannelGroup_SetMixLevelsOutput, self, fl,
+        fr, center, lfe, sl, sr, bl, br)
+      self
+    end
+
+    ##
+    # Sets the incoming volume level for each channel of a multi-channel sound.
+    # This is a helper to avoid calling {#matrix}.
+    #
+    # A multi-channel sound is a single sound that contains from 1 to 32
+    # channels of sound data, in an interleaved fashion. If in the extreme case,
+    # a 32 channel wave file was used, an array of 32 floating point numbers
+    # denoting their volume levels would be passed in to the levels parameter.
     #
-    # @see min_distance
-    # @see max_distance
-    def min_max_distance(min, max)
-      FMOD.invoke(:ChannelGroup_Set3DMinMaxDistance, self, min, max)
+    # @param levels [Array<Float>] Array of volume levels for each incoming
+    #   channel.
+    # @return [self]
+    def input_mix(*levels)
+      count = levels.size
+      binary = levels.pack('f*')
+      FMOD.invoke(:ChannelGroup_SetMixLevelsInput, self, binary, count)
+      self
     end
 
-
     ##
     # @!attribute matrix
     # A 2D pan matrix that maps input channels (columns) to output speakers
@@ -466,72 +678,197 @@ module FMOD
         out_count, in_count, 0)
     end
 
-
+    ##
+    # Sets the pan level, this is a helper to avoid setting the {#matrix}.
+    #
+    # Mono sounds are panned from left to right using constant power panning
+    # (non-linear fade). This means when pan = 0.0, the balance for the sound in
+    # each speaker is 71% left and 71% right, not 50% left and 50% right. This
+    # gives (audibly) smoother pans.
+    #
+    # Stereo sounds heave each left/right value faded up and down according to
+    # the specified pan position. This means when pan is 0.0, the balance for
+    # the sound in each speaker is 100% left and 100% right. When pan is -1.0,
+    # only the left channel of the stereo sound is audible, when pan is 1.0,
+    # only the right channel of the stereo sound is audible.
+    #
+    # @param pan [Float] The desired pan level.
+    #   * *Minimum:* -1.0 (left)
+    #   * *Maximum:* 1.0 (right)
+    #   * *Default:* 0.0 (center)
+    #
+    # @return [self]
     def pan(pan)
       FMOD.invoke(:ChannelGroup_SetPan, self, pan.clamp(-1.0, 1.0))
       self
     end
 
+    ##
+    # Stops the channel (or all channels in the channel group) from playing.
+    #
+    # Makes it available for re-use by the priority system.
+    #
+    # @return [void]
     def stop
       FMOD.invoke(:ChannelGroup_Stop, self)
-      self
     end
 
+    ##
+    # Sets the paused state.
+    #
+    # @return [self]
+    # @see resume
+    # @see paused?
     def pause
       FMOD.invoke(:ChannelGroup_SetPaused, self, 1)
       self
     end
 
+    ##
+    # Resumes playback from a paused state.
+    #
+    # @return [self]
+    # @see pause
+    # @see paused?
     def resume
       FMOD.invoke(:ChannelGroup_SetPaused, self, 0)
       self
     end
 
+    ##
+    # Sets the mute state effectively silencing it or returning it to its normal
+    # volume.
+    #
+    # @return [self]
+    # @see unmute
+    # @see muted?
     def mute
       FMOD.invoke(:ChannelGroup_SetMute, self, 1)
+      self
     end
 
+    ##
+    # Resumes the volume from a muted state.
+    #
+    # @return [self]
+    # @see mute
+    # @see muted?
     def unmute
       FMOD.invoke(:ChannelGroup_SetMute, self, 0)
+      self
     end
 
+    ##
+    # @!attribute dsps
+    # @return [DspChain] the DSP chain of the {ChannelControl}, containing the
+    #   effects currently applied.
     def dsps
       DspChain.send(:new, self)
     end
 
+    ##
+    # @!attribute [r] parent
+    # @return [System] the parent {System} object that was used to create this
+    #   object.
     def parent
       FMOD.invoke(:ChannelGroup_GetSystemObject, self, system = int_ptr)
       System.new(system)
     end
 
+    ##
+    # Add a short 64 sample volume ramp to the specified time in the future
+    # using fade points.
+    #
+    # @param clock [Integer] DSP clock of the parent channel group when the
+    #   volume will be ramped to.
+    # @param volume [Float] Volume level where 0 is silent and 1.0 is normal
+    #   volume. Amplification is supported.
+    #
+    # @return [void]
     def fade_ramp(clock, volume)
       FMOD.invoke(:ChannelGroup_SetFadePointRamp, self, clock, volume)
     end
 
+    ##
+    # Retrieves the DSP clock value which count up by the number of samples per
+    # second in the software mixer, i.e. if the default sample rate is 48KHz,
+    # the DSP clock increments by 48000 per second.
+    #
+    # @return [Integer] the current clock value.
     def dsp_clock
       buffer = "\0" * SIZEOF_LONG_LONG
       FMOD.invoke(:ChannelGroup_GetDSPClock, self, buffer, nil)
       buffer.unpack1('Q')
     end
 
+    ##
+    # Retrieves the DSP clock value which count up by the number of samples per
+    # second in the software mixer, i.e. if the default sample rate is 48KHz,
+    # the DSP clock increments by 48000 per second.
+    #
+    # @return [Integer] the current parent clock value.
     def parent_clock
       buffer = "\0" * SIZEOF_LONG_LONG
       FMOD.invoke(:ChannelGroup_GetDSPClock, self, nil, buffer)
       buffer.unpack1('Q')
     end
 
+    ##
+    # Retrieves the wet level (or send level) for a particular reverb instance.
+    #
+    # @param index [Integer] Index of the particular reverb instance to target.
+    #
+    # @return [Float] the send level for the signal to the reverb, from 0 (none)
+    #   to 1.0 (full).
+    # @see set_reverb_level
     def get_reverb_level(index)
       wet = "\0" * SIZEOF_FLOAT
       FMOD.invoke(:ChannelGroup_GetReverbProperties, self, index, wet)
       wet.unpack1('f')
     end
 
+    ##
+    # Sets the wet level (or send level) of a particular reverb instance.
+    #
+    # A Channel is automatically connected to all existing reverb instances due
+    # to the default wet level of 1.0. A ChannelGroup however will not send to
+    # any reverb by default requiring an explicit call to this function.
+    #
+    # A ChannelGroup reverb is optimal for the case where you want to send 1
+    # mixed signal to the reverb, rather than a lot of individual channel reverb
+    # sends. It is advisable to do this to reduce CPU if you have many Channels
+    # inside a ChannelGroup.
+    #
+    # Keep in mind when setting a wet level for a ChannelGroup, any Channels
+    # under that ChannelGroup will still have their existing sends to the
+    # reverb. To avoid this doubling up you should explicitly set the Channel
+    # wet levels to 0.0.
+    #
+    # @param index [Integer] Index of the particular reverb instance to target.
+    #
+    # @return [void]
+    # @see get_reverb_level
     def set_reverb_level(index, wet_level)
       wet = wet_level.clamp(0.0, 1.0)
       FMOD.invoke(:ChannelGroup_SetReverbProperties, self, index, wet)
-      wet
     end
 
+    ##
+    # @!attribute delay
+    # The start (and/or stop) time relative to the parent channel group DSP
+    # clock, with sample accuracy.
+    #
+    # Every channel and channel group has its own DSP Clock. A channel or
+    # channel group can be delayed relatively against its parent, with sample
+    # accurate positioning. To delay a sound, use the 'parent' channel group DSP
+    # clock to reference against when passing values into this function.
+    #
+    # If a parent channel group changes its pitch, the start and stop times will
+    # still be correct as the parent clock is rate adjusted by that pitch.
+    #
+    # @return [ChannelDelay] the delay.
+    # @see set_delay
+
     def delay
       clock_start = "\0" * SIZEOF_LONG_LONG
       clock_end = "\0" * SIZEOF_LONG_LONG
@@ -547,24 +884,34 @@ module FMOD
       delay
     end
 
+    ##
+    # The start (and/or stop) time relative to the parent channel group DSP
+    # clock, with sample accuracy.
+    #
+    # Every channel and channel group has its own DSP Clock. A channel or
+    # channel group can be delayed relatively against its parent, with sample
+    # accurate positioning. To delay a sound, use the 'parent' channel group DSP
+    # clock to reference against when passing values into this function.
+    #
+    # If a parent channel group changes its pitch, the start and stop times will
+    # still be correct as the parent clock is rate adjusted by that pitch.
+    #
+    # @param clock_start [Integer] DSP clock of the parent channel group to
+    #   audibly start playing sound at, a value of 0 indicates no delay.
+    # @param clock_end [Integer] DSP clock of the parent channel group to
+    #   audibly stop playing sound at, a value of 0 indicates no delay.
+    # @param stop [Boolean] +true+ to stop according to {#playing?}, otherwise
+    #   +false+ to remain "active" and a new start delay could start playback
+    #   again at a later time.
+    #
+    # @return [self]
+    # @see delay
     def set_delay(clock_start, clock_end, stop)
       stop = stop.to_i
       FMOD.invoke(:ChannelGroup_SetDelay, self, clock_start, clock_end, stop)
       self
     end
 
-    def cone_orientation
-      vector = FMOD::Core::Vector.new
-      FMOD.invoke(:ChannelGroup_Get3DConeOrientation, self, vector)
-      vector
-    end
-
-    def cone_orientation=(vector)
-      FMOD.type?(vector, Vector)
-      FMOD.invoke(:ChannelGroup_Set3DConeOrientation, self, vector)
-      vector
-    end
-
     # @!group Callbacks
 
     ##
@@ -633,6 +980,8 @@ module FMOD
 
     # @!endgroup
 
+    ##
+    # @api private
     def initialize(address = nil)
       super
       @callbacks = {}
@@ -666,155 +1015,6 @@ module FMOD
       @callbacks[index] << block
       self
     end
-
-    ##
-    # Emulates an Array-type container of a {ChannelControl}'s DSP chain.
-    class DspChain
-
-      include Enumerable
-
-      ##
-      # Creates a new instance of a {DspChain} for the specified
-      # {ChannelControl}.
-      #
-      # @param channel [ChannelControl] The channel or channel group to create
-      #   the collection wrapper for.
-      def initialize(channel)
-        FMOD.type?(channel, ChannelControl)
-        @channel = channel
-      end
-
-      ##
-      # Retrieves the number of DSPs within the chain. This includes the
-      # built-in {FMOD::Effects::Fader} DSP.
-      # @return [Integer]
-      def count
-        buffer = "\0" * Fiddle::SIZEOF_INT
-        FMOD.invoke(:ChannelGroup_GetNumDSPs, @channel, buffer)
-        buffer.unpack1('l')
-      end
-
-      ##
-      # @overload each(&block)
-      #   If called with a block, passes each DSP in turn before returning self.
-      #   @yield [dsp] Yields a DSP instance to the block.
-      #   @yieldparam dsp [Dsp] The DSP instance.
-      #   @return [self]
-      # @overload each
-      #   Returns an enumerator for the {DspChain} if no block is given.
-      #   @return [Enumerator]
-      def each
-        return to_enum(:each) unless block_given?
-        (0...count).each { |i| yield self[i] }
-        self
-      end
-
-      ##
-      # Element reference. Returns the element at index.
-      # @param index [Integer] The index into the {DspChain} to retrieve.
-      # @return [Dsp|nil] The DSP at the specified index, or +nil+ if index is
-      #   out of range.
-      def [](index)
-        return nil unless index.between?(-2, count)
-        dsp = "\0" * Fiddle::SIZEOF_INTPTR_T
-        FMOD.invoke(:ChannelGroup_GetDSP, @channel, index, dsp)
-        Dsp.from_handle(dsp)
-      end
-
-      ##
-      # Element assignment. Sets the element at the specified index.
-      # @param index [Integer] The index into the {DspChain} to set.
-      # @param dsp [Dsp] A DSP instance.
-      # @return [Dsp] The given DSP instance.
-      def []=(index, dsp)
-        FMOD.type?(dsp, Dsp)
-        FMOD.invoke(:ChannelGroup_AddDSP, @channel, index, dsp)
-        dsp
-      end
-
-      ##
-      # Appends or pushes the given object(s) on to the end of this {DspChain}. This
-      # expression returns +self+, so several appends may be chained together.
-      # @param dsp [Dsp] One or more DSP instance(s).
-      # @return [self]
-      def add(*dsp)
-        dsp.each { |d| self[DspIndex::TAIL] = d }
-        self
-      end
-
-      ##
-      # Prepends objects to the front of +self+, moving other elements upwards.
-      # @param dsp [Dsp] A DSP instance.
-      # @return [self]
-      def unshift(dsp)
-        self[DspIndex::HEAD] = dsp
-        self
-      end
-
-      ##
-      # Removes the last element from +self+ and returns it, or +nil+ if the
-      # {DspChain} is empty.
-      # @return [Dsp|nil]
-      def pop
-        dsp = self[DspIndex::TAIL]
-        remove(dsp)
-        dsp
-      end
-
-      ##
-      # Returns the first element of +self+ and removes it (shifting all other
-      # elements down by one). Returns +nil+ if the array is empty.
-      # @return [Dsp|nil]
-      def shift
-        dsp = self[DspIndex::HEAD]
-        remove(dsp)
-        dsp
-      end
-
-      ##
-      # Deletes the specified DSP from this DSP chain. This does not release ot
-      # dispose the DSP unit, only removes from this {DspChain}, as a DSP unit
-      # can be shared.
-      # @param dsp [Dsp] The DSP to remove.
-      # @return [self]
-      def remove(dsp)
-        return unless dsp.is_a?(Dsp)
-        FMOD.invoke(:ChannelGroup_RemoveDSP, @channel, dsp)
-        self
-      end
-
-      ##
-      # Returns the index of the specified DSP.
-      # @param dsp [Dsp] The DSP to retrieve the index of.
-      # @return [Integer] The index of the DSP.
-      def index(dsp)
-        FMOD.type?(dsp, Dsp)
-        buffer = "\0" * Fiddle::SIZEOF_INT
-        FMOD.invoke(:ChannelGroup_GetDSPIndex, @channel, dsp, buffer)
-        buffer.unpack1('l')
-      end
-
-      ##
-      # Moves a DSP unit that exists in this {DspChain} to a new index.
-      # @param dsp [Dsp] The DSP instance to move, must exist within this
-      #   {DspChain}.
-      # @param index [Integer] The new index to place the specified DSP.
-      # @return [self]
-      def move(dsp, index)
-        FMOD.type?(dsp, Dsp)
-        FMOD.invoke(:ChannelGroup_SetDSPIndex, @channel, dsp, index)
-        self
-      end
-
-      alias_method :size, :count
-      alias_method :length, :count
-      alias_method :length, :count
-      alias_method :delete, :remove
-      alias_method :push, :add
-      alias_method :<<, :add
-
-      private_class_method :new
-    end
   end
 end