NAME

       WildMidi_GetOutput - retrieve raw audio data

LIBRARY

       libWildMidi

SYNOPSIS

       #include <wildmidi_lib.h>

       int WildMidi_GetOutput (midi *handle, int8_t *buffer, uint32_t size);

DESCRIPTION

       Places   size   bytes   of   audio   data  from  a  handle,  previously  opened  by  WildMidi_Open(3)  or
       WildMidi_OpenBuffer(3), into a buffer pointer to by buffer.

       buffer must be at least size bytes, with size being a multiple of 4  as  the  data  is  stored  in  16bit
       interleaved stereo format.

       handle The identifier obtained from opening a midi file with WildMidi_Open(3) or WildMidi_OpenBuffer(3)

       buffer The  location  supplied  by  the calling program where libWildMidi is to store the audio data. The
              audio data will be stored as signed 16bit interleaved stereo in native-endian byte order.

       size   The size of the buffer in bytes. Since libWildMidi processes the audio in 16bit interleaved stereo
              format, this value needs to be a multiple of 4.

RETURN VALUE

       Returns -1 on error along with an error message sent to stderr, 0 when  there  is  no  more  audio  data,
       otherwise the number of bytes of audio data written to buffer.

       NOTE:  if the return value is less than the size you gave, this does not denote an error, it simply means
       the lib reached the end of the midi before it could fill the buffer.

SEE ALSO

       WildMidi_GetVersion(3),       WildMidi_Init(3),        WildMidi_MasterVolume(3),        WildMidi_Open(3),
       WildMidi_OpenBuffer(3),     WildMidi_SetOption(3),     WildMidi_GetMidiOutput(3),    WildMidi_GetInfo(3),
       WildMidi_FastSeek(3), WildMidi_Close(3), WildMidi_Shutdown(3), wildmidi.cfg(5)

AUTHOR

       Chris Ison <chrisisonwildcode@gmail.com> Bret Curtis <psi29a@gmail.com>

COPYRIGHT

       Copyright (C) WildMidi Developers 2001-2016

       This file is part of WildMIDI.

       WildMIDI is free software: you can redistribute and/or modify the player  under  the  terms  of  the  GNU
       General  Public  License  and  you  can redistribute and/or modify the library under the terms of the GNU
       Lesser General Public License as published by the Free Software  Foundation,  either  version  3  of  the
       licenses, or(at your option) any later version.

       WildMIDI  is  distributed  in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
       implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE.  See  the  GNU  General  Public
       License and the GNU Lesser General Public License for more details.

       You  should  have  received  a  copy  of the GNU General Public License and the GNU Lesser General Public
       License along with WildMIDI. If not, see <http://www.gnu.org/licenses/>.

       This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view
       a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
       Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.

                                                  10 March 2016                            WildMidi_GetOutput(3)