Class: Seal::Source

Sets whether source should be automatically updated asynchronously by a background thread. If this thread is running, user calls to #update does nothing. If auto update is disabled after it is enabled, it will take effect the next time the source gets played.

Gets the buffer of source. The default is nil.

Associates buffer with source so that the source is ready to play the audio contained in buffer. Can be applied only to sources in the initial or stopped states and that are not of streaming type. If successful, the source will become or remain as Type::STATIC.

If nil is specified, the source will give up the buffer it has and will reset the source to Type::UNDETERMINED and the source state to State::STOPPED. It will not free the buffer.

Gets the size, in byte, of source's streaming chunk. The default is 36864.

Sets the maximum size, in byte, of the audio chunk which buffers the audio data constantly fetched from an audio stream. Using small chunks may cause playback to occur before the required audio chunk is ready, which in turn causes unexpected stop of playback. fixnum must be in the interval [9216, 16773120] and must be a multiple of 9216; non-multiple value will be adjusted to the closest smaller multiple automatically.

Feeds an effect_slot with the output of source so the output is filtered based on the effect attached to effect_slot. Later calls to this method with a different effect slot and the same source and index will override the old association. index is the zero-based index for the effect. Each different effect slot that source is feeding must have a unique corresponding index. The max is Seal.per_src_effect_limit - 1.

Gets the gain of source. The default is 1.0.

Sets the scalar amplitude multiplier of source in the interval [0.0, +inf.). 1.0 means that the sound is unattenuated; 0.5 means an attenuation of 6 dB; 0.0 means silence.

Determines if source is looping. The default is false (0).

Sets whether the playback of source is looping. A looping source will never enter State::STOPPED; it will immediate enter State::INITIAL and then State::Playing after it reaches the end of the last buffer.

Moves the source (changes the position) based on the source velocity. This is a syntactic sugar for adding the velocity vector and position vector:

# Equivalent to `source.move`
source.position = source.position.zip(source.velocity).map do |a, b|
    a + b
end

Pauses the playing of source. Applying to a playing source will change its state to State::PAUSED. Applying to an initial, paused or stopped source has no effect.

Gets the pitch of source. The default is 1.0.

Sets the pitch shift multiplier of source. 1.0 means identity; each reduction by 1/2 means a pitch shift of -12 semitones; each doubling means a pitch shift of 12 semitones. Use of 0.0 is undefined. The valid range is (0.0, +inf.).

Starts to play source. Applying to a playing source will restart the playback from the beginning thus reset the sampling offset too. If the source is a streaming source, restarting the playback will automatically rewind the stream to the beginning. Applying to an initial or stopped source will start start playing and change its state to State::PLAYING. Applying to a paused source will resume playing and change its state to State::PLAYING.

Gets the position of source. The default is ( 0.0, 0.0, 0.0 ).

Sets the position of source in a right-handed Cartesian coordinate system. Use of NaN and infinity is undefined.

Gets the size, in byte, of source's streaming queue. The default is 3.

Sets the size of the streaming queue internally used by source. The queue maintains a multiple buffering mechanism when streaming the audio data. Multiple bufferring allows buffers in the queue to be processed while the one at the front of the queue is still being played. A queue of size 2 (double buffering) may still be inefficient in CPU-, and I/O-bound situations while triple, or even quad buffering generally produces better sound quality in non-memory-bound situations. fixnum must be in the interval [2, 63].

Determines if source is relative. The default is false.

Sets whether source's position, velocity, cone and direction are all relative to the listener position.

Rewinds source to the beginning. Applying to a playing, paused or stopped source will change its state to State::INITIAL. Applying to an initial source has no effect. The sampling offset will be reset to the beginning. Other attributes are preserved.

Gets the state of source.

Stops the playing of source. Applying to a playing or paused source will change its state to State::STOPPED. Applying to an initial or stopped source has no effect. Resets the sampling offset.

Gets the stream of source. The default is nil.

Associates (opened) stream with source so that audio data can be continuously fetched from a file rather than loading everything to memory at once. Can be applied to sources in any playing state but not on static sources. When replacing an attached stream, the new stream must have the same audio format as the old one. Also be aware of the fact that in this case there could still be some chunks of the old stream at the front of the streaming queue waiting to be played. If successful, the source will become or remain as Type::STREAMING. The streaming queue will be filled after this call returns; after the queue starts to be played, #update should be called to refill the queue.

If nil is specified, the source will give up the stream it has and will reset the source to Type::UNDETERMINED and the source state to State::STOPPED. It will not free the stream.

Gets the type of source.

Updates a streaming source by filling up the audio queue until it is full. If source is not up-to-date, the playback will end before the end of the stream is reached. Does nothing if source is not a streaming source. Also does nothing if auto update is on. When auto update is off, it is the caller's responsibility to handle cases where the consumer (OpenAL) consumes faster than the producer (the caller) produces and causes the playback to stop. Automatic sources automatically resume playing in such cases.

Gets the velocity of source. The default is ( 0.0, 0.0, 0.0 ).

Sets the velocity of source in a right-handed Cartesian coordinate system. The velocity of the source does not affect its position but is a factor used during the Doppler effect emulation. Use of NaN is undefined.