From dd0880af3850c44ad143330827adf5a99cbe07be Mon Sep 17 00:00:00 2001 From: mannol Date: Thu, 9 Jul 2015 03:40:47 +0200 Subject: [PATCH] Fixed documentation. --- other/apidsl/toxav.in.h | 8 +++++--- toxav/toxav.h | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/other/apidsl/toxav.in.h b/other/apidsl/toxav.in.h index 8d1d8f6e..4b328a30 100644 --- a/other/apidsl/toxav.in.h +++ b/other/apidsl/toxav.in.h @@ -334,8 +334,10 @@ event call_state { * The function type for the ${event call_state} callback. * * @param friend_number The friend number for which the call state changed. - * @param state The new call state which is guaranteed to be different than - * the previous state. The state is set to 0 when the call is paused. + * @param state The bitmask of the new call state which is guaranteed to be + * different than the previous state. The state is set to 0 when the call is + * paused. The bitmask represents all the activities currently performed by the + * friend. */ typedef void(uint32_t friend_number, uint32_t state); } @@ -583,7 +585,7 @@ namespace audio { /** * 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. + * frames in the buffer. The received format is the same as in send function. * * @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). diff --git a/toxav/toxav.h b/toxav/toxav.h index f9d29de4..30ac66d1 100644 --- a/toxav/toxav.h +++ b/toxav/toxav.h @@ -341,8 +341,10 @@ enum TOXAV_FRIEND_CALL_STATE { * The function type for the call_state callback. * * @param friend_number The friend number for which the call state changed. - * @param state The new call state which is guaranteed to be different than - * the previous state. The state is set to 0 when the call is paused. + * @param state The bitmask of the new call state which is guaranteed to be + * different than the previous state. The state is set to 0 when the call is + * paused. The bitmask represents all the activities currently performed by the + * friend. */ typedef void toxav_call_state_cb(ToxAV *toxAV, uint32_t friend_number, uint32_t state, void *user_data); /** @@ -597,7 +599,7 @@ bool toxav_video_send_frame(ToxAV *toxAV, uint32_t friend_number, uint16_t width /** * 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. + * frames in the buffer. The received format is the same as in send function. * * @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).