var searchIndex = {};
searchIndex["opus"] = {"doc":"High-level bindings for libopus.","items":[[3,"Encoder","opus","An Opus encoder with associated state.",null,null],[3,"Decoder","","An Opus decoder with associated state.",null,null],[3,"SoftClip","","Soft-clipping to bring a float signal within the [-1,1] range.",null,null],[3,"Repacketizer","","A repacketizer used to merge together or split apart multiple Opus packets.",null,null],[3,"RepacketizerState","","An in-progress repacketization.",null,null],[3,"Error","","An error generated by the Opus library.",null,null],[4,"CodingMode","","The possible coding modes for the codec.",null,null],[13,"Voip","","Best for most VoIP/videoconference applications where listening quality and intelligibility matter most.",0,null],[13,"Audio","","Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input.",0,null],[13,"LowDelay","","Only use when lowest-achievable latency is what matters most.",0,null],[4,"Channels","","The available channel setings.",null,null],[13,"Mono","","One channel.",1,null],[13,"Stereo","","Two channels, left and right.",1,null],[4,"Bandwidth","","The available bandwidth level settings.",null,null],[13,"Auto","","Auto/default setting.",2,null],[13,"Narrowband","","4kHz bandpass.",2,null],[13,"Mediumband","","6kHz bandpass.",2,null],[13,"Wideband","","8kHz bandpass.",2,null],[13,"Superwideband","","12kHz bandpass.",2,null],[13,"Fullband","","20kHz bandpass.",2,null],[4,"ErrorCode","","Possible error codes.",null,null],[13,"BadArg","","One or more invalid/out of range arguments.",3,null],[13,"BufferTooSmall","","Not enough bytes allocated in the buffer.",3,null],[13,"InternalError","","An internal error was detected.",3,null],[13,"InvalidPacket","","The compressed data passed is corrupted.",3,null],[13,"Unimplemented","","Invalid/unsupported request number.",3,null],[13,"InvalidState","","An encoder or decoder structure is invalid or already freed.",3,null],[13,"AllocFail","","Memory allocation has failed.",3,null],[13,"Unknown","","An unknown failure.",3,null],[5,"version","","Get the libopus version string.",null,{"inputs":[],"output":{"name":"str"}}],[0,"packet","","Analyze raw Opus packets.",null,null],[3,"Packet","opus::packet","A parsed Opus packet, retuned from `parse`.",null,null],[12,"toc","","The TOC byte of the packet.",4,null],[12,"frames","","The frames contained in the packet.",4,null],[12,"payload_offset","","The offset into the packet at which the payload is located.",4,null],[5,"get_bandwidth","","Get the bandwidth of an Opus packet.",null,null],[5,"get_nb_channels","","Get the number of channels from an Opus packet.",null,null],[5,"get_nb_frames","","Get the number of frames in an Opus packet.",null,null],[5,"get_nb_samples","","Get the number of samples of an Opus packet.",null,null],[5,"get_samples_per_frame","","Get the number of samples per frame from an Opus packet.",null,null],[5,"parse","","Parse an Opus packet into one or more frames.",null,null],[5,"pad","","Pad a given Opus packet to a larger size.",null,null],[5,"unpad","","Remove all padding from a given Opus packet and rewrite the TOC sequence\nto minimize space usage.",null,null],[6,"Result","opus","Opus error Result alias.",null,null],[11,"hash","","",0,null],[11,"eq","","",0,null],[11,"clone","","",0,null],[11,"fmt","","",0,null],[11,"hash","","",1,null],[11,"eq","","",1,null],[11,"clone","","",1,null],[11,"fmt","","",1,null],[11,"hash","","",2,null],[11,"eq","","",2,null],[11,"clone","","",2,null],[11,"fmt","","",2,null],[11,"hash","","",3,null],[11,"eq","","",3,null],[11,"clone","","",3,null],[11,"fmt","","",3,null],[11,"new","","Create and initialize an encoder.",5,{"inputs":[{"name":"u32"},{"name":"channels"},{"name":"codingmode"}],"output":{"name":"result"}}],[11,"encode","","Encode an Opus frame.",5,null],[11,"encode_float","","Encode an Opus frame from floating point input.",5,null],[11,"reset_state","","Reset the codec state to be equivalent to a freshly initialized state.",5,null],[11,"get_final_range","","Get the final range of the codec's entropy coder.",5,null],[11,"get_bandwidth","","Get the encoder's configured bandpass.",5,null],[11,"get_sample_rate","","Get the samping rate the encoder was intialized with.",5,null],[11,"set_bitrate","","Set the encoder's bitrate.",5,null],[11,"get_bitrate","","Get the encoder's bitrate.",5,null],[11,"drop","","",5,null],[11,"new","","Create and initialize a decoder.",6,{"inputs":[{"name":"u32"},{"name":"channels"}],"output":{"name":"result"}}],[11,"decode","","Decode an Opus packet.",6,null],[11,"decode_float","","Decode an Opus packet with floating point output.",6,null],[11,"get_nb_samples","","Get the number of samples of an Opus packet.",6,null],[11,"reset_state","","Reset the codec state to be equivalent to a freshly initialized state.",6,null],[11,"get_final_range","","Get the final range of the codec's entropy coder.",6,null],[11,"get_bandwidth","","Get the decoder's last bandpass.",6,null],[11,"get_sample_rate","","Get the samping rate the decoder was intialized with.",6,null],[11,"drop","","",6,null],[11,"new","","Initialize a new soft-clipping state.",7,{"inputs":[{"name":"channels"}],"output":{"name":"softclip"}}],[11,"apply","","Apply soft-clipping to a float signal.",7,null],[11,"new","","Create and initialize a repacketizer.",8,{"inputs":[],"output":{"name":"result"}}],[11,"combine","","Shortcut to combine several smaller packets into one larger one.",8,null],[11,"begin","","Begin using the repacketizer.",8,null],[11,"drop","","",8,null],[11,"cat","","Add a packet to the current repacketizer state.",9,null],[11,"cat_move","","Add a packet to the current repacketizer state, moving it.",9,null],[11,"get_nb_frames","","Get the total number of frames contained in packet data submitted so\nfar via `cat`.",9,null],[11,"out","","Construct a new packet from data previously submitted via `cat`.",9,null],[11,"out_range","","Construct a new packet from data previously submitted via `cat`, with\na manually specified subrange.",9,null],[11,"fmt","","",10,null],[11,"function","","Get the name of the Opus function from which the error originated.",10,null],[11,"description","","Get a textual description of the error provided by Opus.",10,null],[11,"code","","Get the Opus error code of the error.",10,null],[11,"fmt","","",10,null],[11,"description","","",10,null]],"paths":[[4,"CodingMode"],[4,"Channels"],[4,"Bandwidth"],[4,"ErrorCode"],[3,"Packet"],[3,"Encoder"],[3,"Decoder"],[3,"SoftClip"],[3,"Repacketizer"],[3,"RepacketizerState"],[3,"Error"]]};
initSearch(searchIndex);