var searchIndex = {};
searchIndex["flac"] = {"doc":"An implementation of [FLAC](https://xiph.org/flac), free lossless audio\ncodec, written in Rust.","items":[[3,"Metadata","flac","Data associated with a single metadata block.",null,null],[12,"is_last","","Marks whether the current metadata block is the last.",0,null],[12,"length","","The length, in bytes, of the block being parsed. This does not include\nthe metadata block header.",0,null],[12,"data","","Block data containing one of the eight different types of metadata.",0,null],[3,"ReadStream","","Structure that hold a reader for a source of bytes.",null,null],[3,"ByteStream","","Structure that hold a slice of bytes.",null,null],[11,"new","","Construct a `ByteStream` based on the passed in byte slice.",1,null],[11,"len","","Return the number of bytes that haven't been consumed yet.",1,null],[11,"is_empty","","Return true if the stream contains no more bytes.",1,null],[11,"parse","","",1,null],[11,"new","","Constructor for `ReadStream` based on a `Read` source.",2,{"inputs":[{"name":"r"}],"output":{"name":"self"}}],[11,"parse","","",2,null],[0,"metadata","","Provides an interface for dealing with FLAC metadata blocks.",null,null],[3,"Metadata","flac::metadata","Data associated with a single metadata block.",null,null],[12,"is_last","","Marks whether the current metadata block is the last.",0,null],[12,"length","","The length, in bytes, of the block being parsed. This does not include\nthe metadata block header.",0,null],[12,"data","","Block data containing one of the eight different types of metadata.",0,null],[3,"StreamInfo","","Information regarding the entire audio stream.",null,null],[12,"min_block_size","","Minimum block size, in samples, used in the stream.",3,null],[12,"max_block_size","","Maximum block size, in samples, used in the stream.",3,null],[12,"min_frame_size","","Minimum frame size, in bytes, used in the stream. May be zero to imply\nthe value isn't know.",3,null],[12,"max_frame_size","","Maximum frame size, in bytes, used in the stream. May be zero to imply\nthe value isn't know.",3,null],[12,"sample_rate","","Sample rate in hertz (Hz).",3,null],[12,"channels","","Number of channels. FLAC supports one to eight channel.",3,null],[12,"bits_per_sample","","Bits per sample. FLAC supports four to thirty-two bits per sample.",3,null],[12,"total_samples","","Total samples in the stream. A value of zero means the number is\nunknown.",3,null],[12,"md5_sum","","MD5 signature of the unencoded audio data.",3,null],[3,"Application","","Data used by third-party applications.",null,null],[12,"id","","Registered application ID.",4,null],[12,"data","","Data used by the third-party application.",4,null],[3,"VorbisComment","","Stores human-readable name/value pairs.",null,null],[12,"vendor_string","","Vendor name.",5,null],[12,"comments","","Comments associated with a name, or category, followed by it's\ncontents.",5,null],[3,"CueSheet","","Stores cue information.",null,null],[12,"media_catalog_number","","Media catalog number.",6,null],[12,"lead_in","","Number of lead-in samples.",6,null],[12,"is_cd","","Whether or not this `CueSheet` corresponds to a Compact Disc.",6,null],[12,"tracks","","One or more tracks.",6,null],[3,"Picture","","Stores pictures associated with the FLAC file.",null,null],[12,"picture_type","","Picture type, based on the ID3v2 APIC frame.",7,null],[12,"mime_type","","Multipurpose Internet Mail Extensions (MIME) type.",7,null],[12,"description","","A string describing the picture.",7,null],[12,"width","","Width of the picture in pixels.",7,null],[12,"height","","Height of the picture in pixels.",7,null],[12,"depth","","Color depth of the picture in bits-per-pixel.",7,null],[12,"colors","","Number of colors used.",7,null],[12,"data","","Binary picture data.",7,null],[3,"SeekPoint","","Seek, or skip, to a point within the FLAC file.",null,null],[12,"sample_number","","Sample number of the first sample in the target frame.",8,null],[12,"stream_offset","","Byte offset of the target frame's header.",8,null],[12,"frame_samples","","Number of samples in the target frame.",8,null],[3,"CueSheetTrack","","Track information inside a cue sheet.",null,null],[12,"offset","","Track offset, in samples, relative to the beginning of the FLAC audio\nstream.",9,null],[12,"number","","Track number.",9,null],[12,"isrc","","Twelve digit alphanumeric code.",9,null],[12,"is_audio","","Whether the cue sheet track is audio.",9,null],[12,"is_pre_emphasis","","Whether the cue sheet track is pre-emphasis.",9,null],[12,"indices","","For all tracks except the lead-out track.",9,null],[3,"CueSheetTrackIndex","","An index point within a track, inside of a cue sheet.",null,null],[12,"offset","","Offset, in samples, relative to the track offset of the index point.",10,null],[12,"number","","Index point number.",10,null],[4,"Data","","General enum that hold all the different metadata block data.",null,null],[13,"StreamInfo","","Information regarding the entire audio stream.",11,null],[13,"Padding","","Block that represents a number of padded bytes.",11,null],[13,"Application","","Data used by third-party applications.",11,null],[13,"SeekTable","","Table of multiple points to seek, or skip, to within the FLAC file.",11,null],[13,"VorbisComment","","Stores human-readable name/value pairs.",11,null],[13,"CueSheet","","Stores cue information",11,null],[13,"Picture","","Stores pictures associated with the FLAC file.",11,null],[13,"Unknown","","A type of block data that isn't know or doesn't match the type above.",11,null],[4,"PictureType","","The picture type according to the ID3v2 attached picture frame.",null,null],[13,"Other","","Other picture type not categorized in this enum.",12,null],[13,"FileIconStandard","","32x32 pixels 'file icon'.",12,null],[13,"FileIcon","","Other, or non-standard, file icon.",12,null],[13,"FrontCover","","Cover (front).",12,null],[13,"BackCover","","Cover (back).",12,null],[13,"LeafletPage","","Leaflet page.",12,null],[13,"Media","","Media, like label side of a CD.",12,null],[13,"LeadArtist","","Lead artist, lead performer, or soloist.",12,null],[13,"Artist","","Artist or performer.",12,null],[13,"Conductor","","Conductor.",12,null],[13,"Band","","Band or orchestra.",12,null],[13,"Composer","","Composer.",12,null],[13,"Lyricist","","Lyricist or text writer.",12,null],[13,"RecordingLocation","","Recording location.",12,null],[13,"DuringRecording","","During recording.",12,null],[13,"DuringPerformace","","During performance.",12,null],[13,"VideoScreenCapture","","Movie, or video, screen capture.",12,null],[13,"Fish","","A bright colored fish.",12,null],[13,"Illustration","","Illustration.",12,null],[13,"BandLogo","","Band, or artist, logotype.",12,null],[13,"PublisherLogo","","Publisher, or studio, logotype.",12,null],[5,"metadata_parser","","Parse a metadata block.",null,null],[5,"get_stream_info","","Reads and returns the `StreamInfo` metadata block of the given FLAC\nfile.",null,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[5,"get_vorbis_comment","","Reads and returns the `VorbisComment` metadata block of the given FLAC\nfile.",null,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[5,"get_cue_sheet","","Reads and returns the `CueSheet` metadata block of the given FLAC file.",null,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[5,"get_picture","","Reads and returns a `Picture` metadata block of the given FLAC file.",null,{"inputs":[{"name":"str"},{"name":"option"},{"name":"option"},{"name":"option"},{"name":"option"},{"name":"option"},{"name":"option"},{"name":"option"}],"output":{"name":"result"}}],[11,"fmt","flac","",0,null],[11,"eq","flac::metadata","",11,null],[11,"ne","","",11,null],[11,"fmt","","",11,null],[11,"eq","","",3,null],[11,"ne","","",3,null],[11,"fmt","","",3,null],[11,"clone","","",3,null],[11,"new","","",3,{"inputs":[],"output":{"name":"streaminfo"}}],[11,"eq","","",4,null],[11,"ne","","",4,null],[11,"fmt","","",4,null],[11,"eq","","",8,null],[11,"ne","","",8,null],[11,"fmt","","",8,null],[11,"eq","","",5,null],[11,"ne","","",5,null],[11,"fmt","","",5,null],[11,"eq","","",6,null],[11,"ne","","",6,null],[11,"fmt","","",6,null],[11,"eq","","",9,null],[11,"ne","","",9,null],[11,"fmt","","",9,null],[11,"eq","","",10,null],[11,"ne","","",10,null],[11,"fmt","","",10,null],[11,"eq","","",7,null],[11,"ne","","",7,null],[11,"fmt","","",7,null],[11,"clone","","",12,null],[11,"eq","","",12,null],[11,"fmt","","",12,null],[0,"stream","flac","",null,null],[3,"Stream","flac::stream","FLAC stream that decodes and hold file information.",null,null],[3,"Iter","","An iterator over a reference of the decoded FLAC stream.",null,null],[6,"StreamReader","","Alias for a FLAC stream produced from `Read`.",null,null],[6,"StreamBuffer","","Alias for a FLAC stream produced from a byte stream buffer.",null,null],[11,"new","","Constructor for the default state of a FLAC stream.",13,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"info","","Returns information for the current stream.",13,null],[11,"metadata","","Returns a slice of `Metadata`",13,null],[11,"from_file","","Constructs a decoder with the given file name.",13,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"from_buffer","","Constructs a decoder with the given buffer.",13,null],[11,"iter","","Returns an iterator over the decoded samples.",13,null],[11,"next","","",14,null],[11,"size_hint","","",14,null],[8,"StreamProducer","flac","An interface for parsing through some type of producer to a byte stream.",null,null],[10,"parse","","",15,null]],"paths":[[3,"Metadata"],[3,"ByteStream"],[3,"ReadStream"],[3,"StreamInfo"],[3,"Application"],[3,"VorbisComment"],[3,"CueSheet"],[3,"Picture"],[3,"SeekPoint"],[3,"CueSheetTrack"],[3,"CueSheetTrackIndex"],[4,"Data"],[4,"PictureType"],[3,"Stream"],[3,"Iter"],[8,"StreamProducer"]]};
initSearch(searchIndex);