var searchIndex = {};
searchIndex["sdl2_mixer"] = {"doc":"A binding for SDL2_mixer.","items":[[3,"InitFlag","sdl2_mixer","",null,null],[3,"Chunk","","The internal format for an audio chunk.",null,null],[12,"raw","","",0,null],[12,"owned","","",0,null],[3,"Channel","","Sound effect channel.",null,null],[3,"Group","","Sound effect channel grouping.",null,null],[3,"Music","","This is an opaque data type used for Music data.",null,null],[12,"raw","","",1,null],[12,"owned","","",1,null],[4,"Fading","","Fader effect type enumerations",null,null],[13,"NoFading","","",2,null],[13,"FadingOut","","",2,null],[13,"FadingIn","","",2,null],[4,"MusicType","","Music type enumerations",null,null],[13,"MusicNone","","",3,null],[13,"MusicCmd","","",3,null],[13,"MusicWav","","",3,null],[13,"MusicMod","","",3,null],[13,"MusicMid","","",3,null],[13,"MusicOgg","","",3,null],[13,"MusicMp3","","",3,null],[13,"MusicMp3Mad","","",3,null],[13,"MusicFlac","","",3,null],[13,"MusicModPlug","","",3,null],[5,"get_linked_version","","Returns the version of the dynamically linked SDL_mixer library",null,{"inputs":[],"output":{"name":"version"}}],[5,"init","","Loads dynamic libraries and prepares them for use.  Flags should be\none or more flags from InitFlag.",null,{"inputs":[{"name":"initflag"}],"output":{"name":"initflag"}}],[5,"quit","","Cleans up all dynamically loaded library handles, freeing memory.",null,{"inputs":[],"output":null}],[5,"open_audio","","Open the mixer with a certain audio format.",null,{"inputs":[{"name":"isize"},{"name":"audioformat"},{"name":"isize"},{"name":"isize"}],"output":{"name":"sdlresult"}}],[5,"close_audio","","Shutdown and cleanup the mixer API.",null,{"inputs":[],"output":null}],[5,"query_spec","","Get the actual audio format in use by the opened audio device.",null,{"inputs":[],"output":{"name":"sdlresult"}}],[5,"get_chunk_decoders_number","","Get the number of sample chunk decoders available from the Mix_GetChunkDecoder function.",null,{"inputs":[],"output":{"name":"isize"}}],[5,"get_chunk_decoder","","Get the name of the indexed sample chunk decoder.",null,{"inputs":[{"name":"isize"}],"output":{"name":"string"}}],[5,"allocate_channels","","Set the number of channels being mixed.",null,{"inputs":[{"name":"isize"}],"output":{"name":"isize"}}],[5,"set_channel_finished","","When channel playback is halted, then the specified channel_finished function is called.",null,null],[5,"unset_channel_finished","","",null,{"inputs":[],"output":null}],[5,"get_playing_channels_number","","",null,{"inputs":[],"output":{"name":"isize"}}],[5,"get_paused_channels_number","","",null,{"inputs":[],"output":{"name":"isize"}}],[5,"reserve_channels","","Reserve num channels from being used when playing samples when\npassing in -1 as a channel number to playback functions.",null,{"inputs":[{"name":"isize"}],"output":{"name":"isize"}}],[5,"get_music_decoders_number","","Get the number of music decoders available.",null,{"inputs":[],"output":{"name":"isize"}}],[5,"get_music_decoder","","Get the name of the indexed music decoder.",null,{"inputs":[{"name":"isize"}],"output":{"name":"string"}}],[6,"AudioFormat","","",null,null],[17,"AUDIO_U8","","",null,null],[17,"AUDIO_S8","","",null,null],[17,"AUDIO_U16LSB","","",null,null],[17,"AUDIO_S16LSB","","",null,null],[17,"AUDIO_U16MSB","","",null,null],[17,"AUDIO_S16MSB","","",null,null],[17,"AUDIO_U16","","",null,null],[17,"AUDIO_S16","","",null,null],[17,"AUDIO_S32LSB","","",null,null],[17,"AUDIO_S32MSB","","",null,null],[17,"AUDIO_S32","","",null,null],[17,"AUDIO_F32LSB","","",null,null],[17,"AUDIO_F32MSB","","",null,null],[17,"AUDIO_F32","","",null,null],[17,"AUDIO_U16SYS","","",null,null],[17,"AUDIO_S16SYS","","",null,null],[17,"AUDIO_S32SYS","","",null,null],[17,"AUDIO_F32SYS","","",null,null],[17,"DEFAULT_FORMAT","","The suggested default is signed 16bit samples in host byte order.",null,null],[17,"DEFAULT_CHANNELS","","Defualt channels: Stereo.",null,null],[17,"DEFAULT_FREQUENCY","","Good default sample rate in Hz (samples per second) for PC sound cards.",null,null],[17,"MAX_VOLUME","","Maximum value for any volume setting.",null,null],[17,"INIT_FLAC","","",null,null],[17,"INIT_MOD","","",null,null],[17,"INIT_MODPLUG","","",null,null],[17,"INIT_MP3","","",null,null],[17,"INIT_OGG","","",null,null],[17,"INIT_FLUIDSYNTH","","",null,null],[8,"LoaderRWops","","Loader trait for RWops",null,null],[10,"load_wav","","Load src for use as a sample.",4,null],[11,"hash","","",5,null],[11,"cmp","","",5,null],[11,"partial_cmp","","",5,null],[11,"lt","","",5,null],[11,"le","","",5,null],[11,"gt","","",5,null],[11,"ge","","",5,null],[11,"clone","","",5,null],[11,"eq","","",5,null],[11,"ne","","",5,null],[11,"fmt","","",5,null],[11,"empty","","Returns an empty set of flags.",5,{"inputs":[],"output":{"name":"initflag"}}],[11,"all","","Returns the set containing all flags.",5,{"inputs":[],"output":{"name":"initflag"}}],[11,"bits","","Returns the raw value of the flags currently stored.",5,null],[11,"from_bits","","Convert from underlying bit representation, unless that\nrepresentation contains bits that do not correspond to a flag.",5,{"inputs":[{"name":"u32"}],"output":{"name":"option"}}],[11,"from_bits_truncate","","Convert from underlying bit representation, dropping any bits\nthat do not correspond to flags.",5,{"inputs":[{"name":"u32"}],"output":{"name":"initflag"}}],[11,"is_empty","","Returns `true` if no flags are currently stored.",5,null],[11,"is_all","","Returns `true` if all flags are currently set.",5,null],[11,"intersects","","Returns `true` if there are flags common to both `self` and `other`.",5,null],[11,"contains","","Returns `true` all of the flags in `other` are contained within `self`.",5,null],[11,"insert","","Inserts the specified flags in-place.",5,null],[11,"remove","","Removes the specified flags in-place.",5,null],[11,"toggle","","Toggles the specified flags in-place.",5,null],[11,"bitor","","Returns the union of the two sets of flags.",5,null],[11,"bitxor","","Returns the left flags, but with all the right flags toggled.",5,null],[11,"bitand","","Returns the intersection between the two sets of flags.",5,null],[11,"sub","","Returns the set difference of the two sets of flags.",5,null],[11,"not","","Returns the complement of this set of flags.",5,null],[11,"eq","","",0,null],[11,"ne","","",0,null],[11,"drop","","",0,null],[11,"from_file","","Load file for use as a sample.",0,{"inputs":[{"name":"path"}],"output":{"name":"sdlresult"}}],[11,"set_volume","","Set chunk->volume to volume.",0,null],[11,"get_volume","","current volume for the chunk.",0,null],[11,"hash","","",2,null],[11,"eq","","",2,null],[11,"clone","","",2,null],[11,"fmt","","",2,null],[11,"eq","","",6,null],[11,"ne","","",6,null],[11,"clone","","",6,null],[11,"fmt","","",6,null],[11,"all","","Represent for all channels (-1)",6,{"inputs":[],"output":{"name":"channel"}}],[11,"post","","This is the MIX_CHANNEL_POST (-2)",6,{"inputs":[],"output":{"name":"channel"}}],[11,"set_volume","","Set the volume for any allocated channel.",6,null],[11,"get_volume","","",6,null],[11,"play","","Play chunk on channel, or if channel is -1, pick the first free unreserved channel.",6,null],[11,"play_timed","","",6,null],[11,"fade_in","","Play chunk on channel, or if channel is -1, pick the first free unreserved channel.",6,null],[11,"fade_in_timed","","",6,null],[11,"pause","","Pause channel, or all playing channels if -1 is passed in.",6,null],[11,"resume","","Unpause channel, or all playing and paused channels if -1 is passed in.",6,null],[11,"halt","","Halt channel playback",6,null],[11,"expire","","Halt channel playback, after ticks milliseconds.",6,null],[11,"fade_out","","Gradually fade out which channel over ms milliseconds starting from now.",6,null],[11,"is_playing","","if channel is playing, or not.",6,null],[11,"is_paused","","if channel is paused, or not.",6,null],[11,"get_fading","","if channel is fading in, out, or not",6,null],[11,"get_chunk","","Get the most recent sample chunk pointer played on channel.",6,null],[11,"unregister_all_effects","","This removes all effects registered to channel.",6,null],[11,"set_panning","","",6,null],[11,"set_distance","","This effect simulates a simple attenuation of volume due to distance.",6,null],[11,"set_position","","This effect emulates a simple 3D audio effect.",6,null],[11,"set_reverse_stereo","","Simple reverse stereo, swaps left and right channel sound.",6,null],[11,"clone","","",7,null],[11,"default","","",7,{"inputs":[],"output":{"name":"group"}}],[11,"add_channels_range","","Add channels starting at from up through to to group tag,\nor reset it's group to the default group tag (-1).",7,null],[11,"add_channel","","Add which channel to group tag, or reset it's group to the default group tag",7,null],[11,"count","","Count the number of channels in group",7,null],[11,"find_available","","Find the first available (not playing) channel in group",7,null],[11,"find_oldest","","Find the oldest actively playing channel in group",7,null],[11,"find_newest","","Find the newest, most recently started, actively playing channel in group.",7,null],[11,"fade_out","","Gradually fade out channels in group over some milliseconds starting from now.\nReturns the number of channels set to fade out.",7,null],[11,"halt","","Halt playback on all channels in group.",7,null],[11,"fmt","","",3,null],[11,"hash","","",3,null],[11,"eq","","",3,null],[11,"clone","","",3,null],[11,"eq","","",1,null],[11,"ne","","",1,null],[11,"drop","","",1,null],[11,"fmt","","Shows the original regular expression.",1,null],[11,"from_file","","Load music file to use.",1,{"inputs":[{"name":"path"}],"output":{"name":"sdlresult"}}],[11,"get_type","","The file format encoding of the music.",1,null],[11,"play","","Play the loaded music loop times through from start to finish.",1,null],[11,"fade_in","","Fade in over ms milliseconds of time, the loaded music,\nplaying it loop times through from start to finish.",1,null],[11,"fade_in_from_pos","","Fade in over ms milliseconds of time, from position.",1,null],[11,"get_volume","","",1,{"inputs":[],"output":{"name":"isize"}}],[11,"set_volume","","Set the volume.",1,{"inputs":[{"name":"isize"}],"output":{"name":"isize"}}],[11,"pause","","Pause the music playback.",1,{"inputs":[],"output":null}],[11,"resume","","Unpause the music.",1,{"inputs":[],"output":null}],[11,"rewind","","Rewind the music to the start.",1,{"inputs":[],"output":null}],[11,"set_pos","","Set the position of the currently playing music.",1,{"inputs":[{"name":"f64"}],"output":{"name":"sdlresult"}}],[11,"set_command","","Setup a command line music player to use to play music.",1,{"inputs":[{"name":"str"}],"output":{"name":"sdlresult"}}],[11,"halt","","Halt playback of music.",1,{"inputs":[],"output":null}],[11,"fade_out","","Gradually fade out the music over ms milliseconds starting from now.",1,{"inputs":[{"name":"isize"}],"output":{"name":"sdlresult"}}],[11,"hook_finished","","",1,null],[11,"unhook_finished","","",1,{"inputs":[],"output":null}],[11,"is_playing","","If music is actively playing, or not.",1,{"inputs":[],"output":{"name":"bool"}}],[11,"is_paused","","If music is paused, or not.",1,{"inputs":[],"output":{"name":"bool"}}],[11,"get_fading","","If music is fading, or not.",1,{"inputs":[],"output":{"name":"fading"}}]],"paths":[[3,"Chunk"],[3,"Music"],[4,"Fading"],[4,"MusicType"],[8,"LoaderRWops"],[3,"InitFlag"],[3,"Channel"],[3,"Group"]]};
initSearch(searchIndex);