diff options
author | mannol <eniz_vukovic@hotmail.com> | 2015-07-09 03:40:47 +0200 |
---|---|---|
committer | mannol <eniz_vukovic@hotmail.com> | 2015-07-09 03:40:47 +0200 |
commit | dd0880af3850c44ad143330827adf5a99cbe07be (patch) | |
tree | 2bdf56ce5b573df595d99d384e6bd3f008b8bcd7 | |
parent | 4bc2413c4451560e912617fd7432c4b6f141ccf7 (diff) |
Fixed documentation.
-rw-r--r-- | other/apidsl/toxav.in.h | 8 | ||||
-rw-r--r-- | 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 { | |||
334 | * The function type for the ${event call_state} callback. | 334 | * The function type for the ${event call_state} callback. |
335 | * | 335 | * |
336 | * @param friend_number The friend number for which the call state changed. | 336 | * @param friend_number The friend number for which the call state changed. |
337 | * @param state The new call state which is guaranteed to be different than | 337 | * @param state The bitmask of the new call state which is guaranteed to be |
338 | * the previous state. The state is set to 0 when the call is paused. | 338 | * different than the previous state. The state is set to 0 when the call is |
339 | * paused. The bitmask represents all the activities currently performed by the | ||
340 | * friend. | ||
339 | */ | 341 | */ |
340 | typedef void(uint32_t friend_number, uint32_t state); | 342 | typedef void(uint32_t friend_number, uint32_t state); |
341 | } | 343 | } |
@@ -583,7 +585,7 @@ namespace audio { | |||
583 | /** | 585 | /** |
584 | * The function type for the ${event receive_frame} callback. The callback can be | 586 | * The function type for the ${event receive_frame} callback. The callback can be |
585 | * called multiple times per single iteration depending on the amount of queued | 587 | * called multiple times per single iteration depending on the amount of queued |
586 | * frames in the buffer. | 588 | * frames in the buffer. The received format is the same as in send function. |
587 | * | 589 | * |
588 | * @param friend_number The friend number of the friend who sent an audio frame. | 590 | * @param friend_number The friend number of the friend who sent an audio frame. |
589 | * @param pcm An array of audio samples (sample_count * channels elements). | 591 | * @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 { | |||
341 | * The function type for the call_state callback. | 341 | * The function type for the call_state callback. |
342 | * | 342 | * |
343 | * @param friend_number The friend number for which the call state changed. | 343 | * @param friend_number The friend number for which the call state changed. |
344 | * @param state The new call state which is guaranteed to be different than | 344 | * @param state The bitmask of the new call state which is guaranteed to be |
345 | * the previous state. The state is set to 0 when the call is paused. | 345 | * different than the previous state. The state is set to 0 when the call is |
346 | * paused. The bitmask represents all the activities currently performed by the | ||
347 | * friend. | ||
346 | */ | 348 | */ |
347 | typedef void toxav_call_state_cb(ToxAV *toxAV, uint32_t friend_number, uint32_t state, void *user_data); | 349 | typedef void toxav_call_state_cb(ToxAV *toxAV, uint32_t friend_number, uint32_t state, void *user_data); |
348 | /** | 350 | /** |
@@ -597,7 +599,7 @@ bool toxav_video_send_frame(ToxAV *toxAV, uint32_t friend_number, uint16_t width | |||
597 | /** | 599 | /** |
598 | * The function type for the audio_receive_frame callback. The callback can be | 600 | * The function type for the audio_receive_frame callback. The callback can be |
599 | * called multiple times per single iteration depending on the amount of queued | 601 | * called multiple times per single iteration depending on the amount of queued |
600 | * frames in the buffer. | 602 | * frames in the buffer. The received format is the same as in send function. |
601 | * | 603 | * |
602 | * @param friend_number The friend number of the friend who sent an audio frame. | 604 | * @param friend_number The friend number of the friend who sent an audio frame. |
603 | * @param pcm An array of audio samples (sample_count * channels elements). | 605 | * @param pcm An array of audio samples (sample_count * channels elements). |