Class Rubygame::Mixer::Sample
In: lib/rubygame/deprecated_mixer.rb
Parent: Object

*NOTE:* This class is DEPRECATED and will be removed in Rubygame 3.0. Please use the Rubygame::Sound class instead.

Stores audio data to play with Rubygame::Mixer.play

Methods

load_audio   new  

Public Class methods

*NOTE:* Rubygame::Mixer::Sample is DEPRECATED and will be removed in Rubygame 3.0. Please use the Rubygame::Sound class instead.

Load an audio sample (a “chunk”, to use SDL_mixer’s term) from a file. Only WAV files are supported at this time.

Raises SDLError if the sample could not be loaded.

[Source]

# File lib/rubygame/deprecated_mixer.rb, line 257
  def self.load_audio( filename )
    Rubygame.deprecated( "Rubygame::Mixer::Sample", "3.0" )

    chunk = SDL::Mixer.LoadWAV( filename )

    if( chunk.pointer.null? )
      raise( Rubygame::SDLError,
             "Error loading audio Sample from file `%s': %s"%
             [filename, SDL.GetError()] )
    end

    return new( chunk )
  end

call-seq: new

[Source]

# File lib/rubygame/deprecated_mixer.rb, line 277
  def initialize( struct=nil )
    @struct = struct
  end

[Validate]