Creates a new VgmPlayer instance that will play the given VGM file. #bufferSize is the size of buffers that you will use for rendering audio. See #render for more details and important notes. #bufferSize must be even, and must be greater than or equal to the minimum buffer size for the requested sample rate.

If the VgmFile uses any chips that are not currently supported by YunoSynth, then this will raise an UnsupportedChipError.

Given a VGM file, an output sample rate, and some other information, this calculates multiplier and divider values that can be used for resampling. The playbackRate parameter is a multiplier of how fast you intend to play back the VGM file. A value of 0 means to use the default playback rate. The vgmSampleRate parameter is the rate of VGM sampling rate.

In nearly all cases, you want to instead use VgmPlayer.calcResampling(UInt32, VgmFile).

The returned Tuple contains (in order):

1. The multiplier for the PCM sample rate
2. The divider for the PCM sample rate
3. The multiplier for the VGM sample rate
4. The divider for the VGM sample rate

Given a VGM file and an output PCM sample rate, this calculates multiplier and divider values that can be used for resampling.

The returned Tuple contains (in order):

1. The multiplier for the PCM sample rate
2. The divider for the PCM sample rate

When true, then the player has reached the end of the VGM file.

The size of the buffers used for rendering. This is provided when creating a new instance of the class. See #render for details and important notes.

Returns the list of all the fancy names for the chips that are used in this VGM. This only returns a valid set after the #play method has been run.

If useShort is true, then the short names are returned for each chip instead of the full name.

Returns the Hash where the keys are ChipTypes for the chips that are used in this VGM, and the values are the number of instances of that chip.

Returns the total number of PCM samples that the loaded VGM will generate in one loop when it is played back.

The main output volume. If you want to change the volume, change this first. 1.0 is the "normal" output volume.

Sets the main output volume of the rendered PCM data. 1.0 is the "normal" output volume.

The minimum size for the buffer to use to pass to #render. This is per-channel.

Starts playback. This must be called before calling #render. Calling this more than once is effectively a non-op.

If this is true, then #play has been called and cannot be called again.

The total number of samples rendered so far.

Renders new PCM data to the left and right buffers, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally).

You must call #play once before calling this.

The size of left and right MUST be even and MUST be equal to the #bufferSize provided when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM data to the left and right buffers, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally), then automatically dithered to signed 16-bit PCM using high quality dithering.

You must call #play once before calling this.

The size of left and right MUST be even and MUST be equal to the #bufferSize provided when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM data to the left and right buffers, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally), then automatically converted to 64-bit IEEE floating point audio.

You must call #play once before calling this.

The size of left and right MUST be even and MUST be equal to the #bufferSize provided when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM data to the left and right buffers, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally), then automatically converted to 32-bit IEEE floating point audio.

You must call #play once before calling this.

The size of left and right MUST be even and MUST be equal to the #bufferSize provided when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new interleaved PCM data to dest as interleaved audio, and advances the playback state. The audio is rendered in signed 32-bit integer format (the native format internally).

You must call #play once before calling this.

The size of `` MUST be exactly twice the #bufferSize that was requested when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM interleaved data to dest as interleaved audio, and advances the playback state. The audio is rendered in signed 32-bit integer format (the native format internally), then automatically dithered to signed 16-bit PCM using high quality dithering.

You must call #play once before calling this.

The size of `` MUST be exactly twice the #bufferSize that was requested when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new interleaved PCM data to dest as interleaved audio, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally), then automatically converted to 64-bit IEEE floating point audio.

You must call #play once before calling this.

The size of `` MUST be exactly twice the #bufferSize that was requested when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM interleaved data to dest as interleaved audio, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally), then automatically converted to 32-bit IEEE floating point audio.

You must call #play once before calling this.

The size of `` MUST be exactly twice the #bufferSize that was requested when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM data to the left and right buffers, and advances the playback state. The audio is rendered in signed 32-bit PCM format (the native format internally), then automatically converted to signed 16-bit PCM using a slightly lower quality (but slightly faster) sample conversion.

You must call #play once before calling this.

The size of left and right MUST be even and MUST be equal to the #bufferSize provided when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Renders new PCM interleaved data to dest as interleaved audio, and advances the playback state. The audio is rendered in signed 32-bit integer format (the native format internally), then automatically converted to signed 16-bit PCM using a slightly lower quality (but slightly faster) sample conversion.

You must call #play once before calling this.

The size of `` MUST be exactly twice the #bufferSize that was requested when you created this instance. If your program is compiled without the -Dyunosynth_wd40, this will be checked, otherwise this check is left out at compile time.

Resets the player to the beginning.

The output sample rate.

The currently loaded settings for the player.

Sets "#atEnd?totrue`.

The number of times the VGM file has currently played one full loop. This starts at 0.

The number of times the VGM file has currently played one full loop. This starts at 0.

Returns the total number of PCM samples that the loaded VGM will generate when the loop is ignored and it is played back.

The currently loaded VgmFile instance.

The main volume will be multiplied by this when calculating the final output volume. When this is needed, the VGM file's header usually sets the appropriate value. This is automatically calculated and is provided for informational purposes.