Added explanation about how audio callback works

pull/1336/head
mannol 2015-06-27 16:12:33 +02:00
parent 08bc4eb0e0
commit 1ba55d0ca7
2 changed files with 7 additions and 3 deletions

View File

@ -578,8 +578,10 @@ namespace video {
namespace audio {
event receive_frame {
/**
* The function type for the ${event receive_frame} callback.
*
* The function type for the ${event receive_frame} callback. The callback can be
* called multiple times per single iteration depending on the amount of queued
* frames in the buffer.
*
* @param friend_number The friend number of the friend who sent an audio frame.
* @param pcm An array of audio samples (sample_count * channels elements).
* @param sample_count The number of audio samples per channel in the PCM array.

View File

@ -592,7 +592,9 @@ bool toxav_video_send_frame(ToxAV *toxAV, uint32_t friend_number, uint16_t width
*
******************************************************************************/
/**
* The function type for the audio_receive_frame callback.
* The function type for the audio_receive_frame callback. The callback can be
* called multiple times per single iteration depending on the amount of queued
* frames in the buffer.
*
* @param friend_number The friend number of the friend who sent an audio frame.
* @param pcm An array of audio samples (sample_count * channels elements).