var searchIndex = {};
searchIndex["riff_wave"] = {"doc":"Basic support for reading and writing wave PCM files.","items":[[3,"PcmFormat","riff_wave","",null,null],[12,"num_channels","","",0,null],[12,"sample_rate","","",0,null],[12,"bits_per_sample","","",0,null],[3,"WaveReader","","Helper struct that takes ownership of a reader and can be used to read data\nfrom a PCM wave file.",null,null],[12,"pcm_format","","Represents the PCM format for this wave file.",1,null],[4,"ReadError","","Represents an error that occurred while reading a wave file.",null,null],[13,"Format","","The file format is incorrect or unsupported.",2,null],[13,"Io","","An IO error occurred.",2,null],[4,"FormatErrorKind","","Represents a file format error, when the wave file is incorrect or unsupported.",null,null],[13,"NotARiffFile","","The file does not start with a "RIFF" tag and chunk size.",3,null],[13,"NotAWaveFile","","The file doesn't continue with "WAVE" after the RIFF chunk header.",3,null],[13,"NotAnUncompressedPcmWaveFile","","This file is not an uncompressed PCM wave file. Only uncompressed files are supported.",3,null],[13,"FmtChunkTooShort","","This file is missing header data and can't be parsed.",3,null],[13,"NumChannelsIsZero","","The number of channels is zero, which is invalid.",3,null],[13,"SampleRateIsZero","","The sample rate is zero, which is invalid.",3,null],[13,"UnsupportedBitsPerSample","","Only 8-bit, 16-bit, 24-bit and 32-bit PCM files are supported.",3,null],[13,"InvalidBitsPerSample","","We don't currently support extended PCM wave files where the actual\nbits per sample is less than the container size.",3,null],[6,"ReadResult","","Represents a result when reading a wave file.",null,null],[11,"fmt","","",2,null],[11,"fmt","","",2,null],[11,"fmt","","",3,null],[11,"fmt","","",3,null],[11,"description","","",2,null],[11,"cause","","",2,null],[11,"from","","",2,{"inputs":[{"name":"error"}],"output":{"name":"readerror"}}],[11,"fmt","","",0,null],[11,"new","","Returns a new wave reader for the given reader.",1,{"inputs":[{"name":"t"}],"output":{"name":"readresult"}}],[11,"read_sample_u8","","Reads a single sample as an unsigned 8-bit value.",1,null],[11,"read_sample_i16","","Reads a single sample as a signed 16-bit value.",1,null],[11,"read_sample_i24","","Reads a single sample as a signed 24-bit value. The value will be padded\nto fit in a 32-bit buffer.",1,null],[11,"read_sample_i32","","Reads a single sample as a signed 32-bit value.",1,null],[11,"read_samples_as_u8","","Reads several samples as unsigned 8-bit values. Returns the number of\nsamples read, or an io error if one occurred before data was read.",1,null],[11,"read_samples_as_i16","","Reads several samples as signed 16-bit values. Returns the number of\nsamples read, or an io error if one occurred before data was read.",1,null],[11,"read_samples_as_i24","","Reads several samples as signed 24-bit values. The values will be padded\nto fit in a 32-bit buffer. Returns the number of samples read, or an io\nerror if one occurred before data was read.",1,null],[11,"read_samples_as_i32","","Reads several samples as signed 32-bit values. Returns the number of\nsamples read, or an io error if one occurred before data was read.",1,null]],"paths":[[3,"PcmFormat"],[3,"WaveReader"],[4,"ReadError"],[4,"FormatErrorKind"]]};
initSearch(searchIndex);