Module org.refcodes.audio
Package org.refcodes.audio

Class SvgMonoSampleWriter

java.lang.Object
org.refcodes.audio.AbstractSvgSampleWriter<MonoSample,SvgMonoSampleWriter>
org.refcodes.audio.SvgMonoSampleWriter
All Implemented Interfaces:
AutoCloseable, MonoSampleWriter<SvgMonoSampleWriter>, SampleWriter<MonoSample,SvgMonoSampleWriter>, SamplingRateAccessor, SamplingRateAccessor.SamplingRateBuilder<SvgMonoSampleWriter>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty, org.refcodes.io.RowWriter<MonoSample>
public class SvgMonoSampleWriter extends AbstractSvgSampleWriter<MonoSample,SvgMonoSampleWriter> implements MonoSampleWriter<SvgMonoSampleWriter>
The SvgMonoSampleWriter provides means to write sound samples to a SVG file.

  • Constructor Details

    • SvgMonoSampleWriter

      public SvgMonoSampleWriter(File aFile) throws FileNotFoundException
      Constructs the SvgMonoSampleWriter for writing sound samples to a SVG file or stream.
      Parameters:
      aFile - The File where to write the SVG records to.
      Throws:
      FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file.

    • SvgMonoSampleWriter

      public SvgMonoSampleWriter(OutputStream aOutputStream)
      Constructs the SvgMonoSampleWriter for writing sound samples to a SVG file or stream.
      Parameters:
      aOutputStream - The OutputStream where to write the SVG records to.

    • SvgMonoSampleWriter

      public SvgMonoSampleWriter(PrintStream aPrintStream)
      Constructs the SvgMonoSampleWriter for writing sound samples to a SVG file or stream.
      Parameters:
      aPrintStream - The PrintStream where to write the SVG records to.

  • Method Details

    • writeNext

      public void writeNext(double aSampleData)
      Writes the next samples, one sample for each channel. Provide one sample for mono audio, two samples for stereo audio and so on. In case you provide more or less samples than channels being supported by the writer, then it is up to the writer whether to duplicate the samples or calculate an average or the like.
      Specified by:
      writeNext in interface MonoSampleWriter<SvgMonoSampleWriter>
      Parameters:
      aSampleData - The samples, one for each channel.

    • writeNext

      public void writeNext(MonoSample aSample)
      Writes the next samples, one sample for each channel. Provide one sample for mono audio, two samples for stereo audio and so on. In case you provide more or less samples than channels being supported by the writer, then it is up to the writer whether to duplicate the samples or calculate an average or the like.
      Specified by:
      writeNext in interface org.refcodes.io.RowWriter<MonoSample>
      Specified by:
      writeNext in interface SampleWriter<MonoSample,SvgMonoSampleWriter>
      Parameters:
      aSample - The samples, one for each channel.

    • close

      public void close() throws IOException
      Description copied from class: AbstractSvgSampleWriter
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface SampleWriter<MonoSample,SvgMonoSampleWriter>
      Overrides:
      close in class AbstractSvgSampleWriter<MonoSample,SvgMonoSampleWriter>
      Throws:
      IOException

    • getSamplingRate

      public int getSamplingRate()
      Retrieves the sampling rate from the sampling rate property.
      Specified by:
      getSamplingRate in interface SamplingRateAccessor
      Returns:
      The sampling rate stored by the sampling rate property.

    • setSamplingRate

      public void setSamplingRate(int aSamplingRate)
      Sets the sampling rate for the sampling rate property.
      Specified by:
      setSamplingRate in interface SamplingRateAccessor.SamplingRateMutator
      Parameters:
      aSamplingRate - The sampling rate to be stored by the sampling rate property.

    • withSamplingRate

      public SvgMonoSampleWriter withSamplingRate(int aSamplingRate)
      Sets the sampling rate for the sampling rate property.
      Specified by:
      withSamplingRate in interface SamplingRateAccessor.SamplingRateBuilder<SvgMonoSampleWriter>
      Parameters:
      aSamplingRate - The sampling rate to be stored by the sampling rate property.
      Returns:
      The builder for applying multiple build operations.