var searchIndex = {};
searchIndex["hound"] = {"doc":"Hound, a wav encoding and decoding library.","items":[[3,"WavReader","hound","A reader that reads the WAVE format from the underlying reader.",null,null],[3,"WavIntoSamples","","An iterator that yields samples of type `S` read from a `WavReader`.",null,null],[3,"WavSamples","","An iterator that yields samples of type `S` read from a `WavReader`.",null,null],[3,"WavWriter","","A writer that accepts samples and writes the WAVE format.",null,null],[3,"WavSpec","","Specifies properties of the audio data.",null,null],[12,"channels","","The number of channels.",0,null],[12,"sample_rate","","The number of samples per second.",0,null],[12,"bits_per_sample","","The number of bits per sample.",0,null],[12,"sample_format","","Whether the wav's samples are float or integer values.",0,null],[4,"SampleFormat","","Specifies whether a sample is stored as an "IEEE Float" or an integer.",null,null],[13,"Float","","Wave files with the `WAVE_FORMAT_IEEE_FLOAT` format tag store samples as floating point\nvalues.",1,null],[13,"Int","","Wave files with the `WAVE_FORMAT_PCM` format tag store samples as integer values.",1,null],[4,"Error","","The error type for operations on `WavReader` and `WavWriter`.",null,null],[13,"IoError","","An IO error occured in the underlying reader or writer.",2,null],[13,"FormatError","","Ill-formed WAVE data was encountered.",2,null],[13,"TooWide","","The sample has more bits than the destination type.",2,null],[13,"UnfinishedSample","","The number of samples written is not a multiple of the number of channels.",2,null],[13,"Unsupported","","The format is not supported.",2,null],[13,"InvalidSampleFormat","","The sample format is different than the destination format.",2,null],[11,"new","","Attempts to create a reader that reads the WAVE format.",3,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"spec","","Returns information about the WAVE file.",3,null],[11,"samples","","Returns an iterator over all samples.",3,null],[11,"into_samples","","Same as `samples`, but takes ownership of the `WavReader`.",3,null],[11,"duration","","Returns the duration of the file in samples.",3,null],[11,"len","","Returns the number of values that the sample iterator will yield.",3,null],[11,"into_inner","","Destroys the `WavReader` and returns the underlying reader.",3,null],[11,"open","","Attempts to create a reader that reads from the specified file.",3,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"next","","",4,null],[11,"size_hint","","",4,null],[11,"next","","",5,null],[11,"size_hint","","",5,null],[11,"new","","Creates a writer that writes the WAVE format to the underlying writer.",6,{"inputs":[{"name":"w"},{"name":"wavspec"}],"output":{"name":"wavwriter"}}],[11,"write_sample","","Writes a single sample for one channel.",6,null],[11,"finalize","","Writes the parts of the WAVE format that require knowing all samples.",6,null],[11,"drop","","",6,null],[11,"create","","Creates a writer that writes the WAVE format to a file.",6,{"inputs":[{"name":"p"},{"name":"wavspec"}],"output":{"name":"result"}}],[6,"Result","","A type for results generated by Hound where the error type is hard-wired.",null,null],[8,"Sample","","A type that can be used to represent audio samples.",null,null],[10,"write","","Writes the audio sample to the WAVE data chunk.",7,null],[10,"read","","Reads the audio sample from the WAVE data chunk.",7,{"inputs":[{"name":"r"},{"name":"sampleformat"},{"name":"u16"},{"name":"u16"}],"output":{"name":"result"}}],[11,"eq","","",1,null],[11,"fmt","","",1,null],[11,"clone","","",1,null],[11,"eq","","",0,null],[11,"ne","","",0,null],[11,"fmt","","",0,null],[11,"clone","","",0,null],[11,"fmt","","",2,null],[11,"fmt","","",2,null],[11,"description","","",2,null],[11,"cause","","",2,null],[11,"from","","",2,{"inputs":[{"name":"error"}],"output":{"name":"error"}}]],"paths":[[3,"WavSpec"],[4,"SampleFormat"],[4,"Error"],[3,"WavReader"],[3,"WavSamples"],[3,"WavIntoSamples"],[3,"WavWriter"],[8,"Sample"]]};
initSearch(searchIndex);