The slots SunVox can use. MAX: 16
Constructors
from_int(in_int :
Int) :
Slot Converts an integer index (0..15) into a Slot, raising if out of range.
open(slot :
Slot |
Int =
Slot::Zero) :
Slot Opens a slot (defaults to Slot::Zero) and returns it.
Class methods
open(slot :
Slot |
Int =
Slot::Zero, & :
Slot -> )
Opens a slot, yields it to the block, and ensures it is closed afterwards.
Instance methods
Creates a new module in this slot and returns its SunVox::Module wrapper.
Enables or disables autostop on this slot.
autostop?
Returns true if autostop is enabled (song stops at end instead of looping).
base_version
Gets the SunVox version used to create the project.
bpm
Gets the project BPM (Beats Per Minute).
close
Closes this slot in the SunVox engine.
current_line
Gets the current line number on the timeline.
current_line2
Gets the current line number in fixed-point 27.5 format.
current_line_float
Gets the current line number as a floating-point value.
duration
Gets the approximate duration of the project.
eight?
Returns true if this enum value equals Eight
eleven?
Returns true if this enum value equals Eleven
end_of_song?
Returns true if the song has stopped / finished playing.
export_to_wav(out_filename :
String |
Path, song_len_frames :
Int = length_frames) : self
Exports the project in this slot to a WAV file (requires engine started with offline: true).
fifteen?
Returns true if this enum value equals Fifteen
find_module(name :
String) :
Module |
Nil Finds a module by name and returns it, or nil if not found.
find_pattern(name :
String) :
Pattern |
Nil Finds a pattern by name and returns it, or nil if not found.
five?
Returns true if this enum value equals Five
four?
Returns true if this enum value equals Four
fourteen?
Returns true if this enum value equals Fourteen
from_int(in_int :
Int) :
Slot Instance-level helper preserved for backwards compatibility.
length_frames
Gets the project length in audio frames.
length_lines
Gets the project length in tracker lines.
Loads a project file (.sunvox, .mod, .xm) from disk into this slot.
load(data :
Bytes) : self
Loads a project from a memory buffer (Bytes) into this slot.
load_from_memory(data :
Bytes) : self
Alias for #load(data : Bytes).
Loads a module or sample from a file (sunsynth, xi, wav, aiff, ogg, mp3, flac) and returns a SunVox::Module.
Loads a module or sample from memory (Bytes) and returns a SunVox::Module.
Alias for #load_module(data : Bytes, ...).
lock
Locks this slot for thread-safe access/modification.
module(id :
Int32) :
Module Returns a SunVox::Module handle for id.
module(name :
String) :
Module Finds a module by name and returns its SunVox::Module, raising if not found.
module?(id :
Int32) :
Module |
Nil Returns a SunVox::Module for id if it exists in this slot, or nil.
module?(name :
String) :
Module |
Nil Finds a module by name and returns it, or nil if not found.
module_slots_count
Returns the number of module slots in the project (some slots may be empty).
modules
Returns all active modules currently existing in this slot.
name
Gets the project/song name.
Sets the project/song name.
Creates a new pattern in this slot and returns its SunVox::Pattern wrapper.
nine?
Returns true if this enum value equals Nine
one?
Returns true if this enum value equals One
open
Opens this slot in the SunVox engine.
open?
Returns true if this slot is currently open.
output
Returns the built-in Output module (module 0) for this slot.
pattern(id :
Int32) :
Pattern Returns a SunVox::Pattern handle for id.
pattern(name :
String) :
Pattern Finds a pattern by name and returns its SunVox::Pattern, raising if not found.
pattern?(id :
Int32) :
Pattern |
Nil Returns a SunVox::Pattern for id if it exists in this slot, or nil.
pattern?(name :
String) :
Pattern |
Nil Finds a pattern by name and returns it, or nil if not found.
pattern_slots_count
Returns the number of pattern slots in the project (some slots may be empty).
patterns
Returns all active patterns currently existing in this slot.
pause
Pauses the audio stream on this slot.
play
Plays the current project from the current playhead position.
play_from_beginning
Plays the current project from the beginning (line 0).
playing?
Returns true if the song is currently playing.
Sets whether the song repeats when the end is reached.
repeats?
Returns whether the song repeats (i.e. autostop is disabled).
reset_event_time
Resets event timing on this slot back to automatic mode.
resume
Resumes the audio stream on this slot.
rewind(line_num :
Int32) : self
Jumps the playhead to line_num.
Saves the current project in this slot to a file on disk.
save_to_bytes
Saves the current project in this slot to a Bytes buffer in memory.
save_to_memory
Alias for #save_to_bytes.
send_event(track_num :
Int32, note :
Note |
Int32 =
Note::None, velocity :
Int32 = 0, mod :
Module |
Int32 = -1, ctl :
Int32 = 0, effect :
Int32 = 0, ctl_value :
Int32 = 0) : self
Sends a real-time event to this slot.
send_event(track_num :
Int32, event :
Event) : self
Sends a SunVox::Event record to track_num on this slot.
set_event_time(timestamp :
UInt32 = 0_u32, set :
Bool = true) : self
Sets the timestamp for subsequent events sent to this slot.
seven?
Returns true if this enum value equals Seven
Gets the current real-time output signal level (0..255) for channel (0 = left, 1 = right).
six?
Returns true if this enum value equals Six
stop
Stops playback (second call puts all modules into standby mode).
sync_resume
Waits for sync (pattern effect 0x33) and resumes the audio stream on this slot.
synchronize
Locks this slot, yields self, and unlocks in an ensure block.
ten?
Returns true if this enum value equals Ten
thirteen?
Returns true if this enum value equals Thirteen
three?
Returns true if this enum value equals Three
time_map(start_line :
Int32 = 0, len :
Int32 = length_lines.to_i, flags :
TimeMapFlags |
Int32 =
TimeMapFlags::Speed) :
Slice(
UInt32)
Gets the project time map for len lines starting at start_line.
tpl
Gets the project TPL (Ticks Per Line).
twelve?
Returns true if this enum value equals Twelve
two?
Returns true if this enum value equals Two
Sets the volume of this slot (0..256) and returns the previous volume.
volume
Gets the current volume of this slot (0..256).
Sets the volume of this slot (0..256).
zero?
Returns true if this enum value equals Zero