diff options
Diffstat (limited to 'other/apidsl')
-rw-r--r-- | other/apidsl/toxav.in.h | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/other/apidsl/toxav.in.h b/other/apidsl/toxav.in.h index 63397420..8cb189f0 100644 --- a/other/apidsl/toxav.in.h +++ b/other/apidsl/toxav.in.h | |||
@@ -198,7 +198,7 @@ void kill(); | |||
198 | */ | 198 | */ |
199 | tox::this *tox { get(); } | 199 | tox::this *tox { get(); } |
200 | /******************************************************************************* | 200 | /******************************************************************************* |
201 | * | 201 | * |
202 | * :: A/V event loop | 202 | * :: A/V event loop |
203 | * | 203 | * |
204 | ******************************************************************************/ | 204 | ******************************************************************************/ |
@@ -209,12 +209,12 @@ tox::this *tox { get(); } | |||
209 | const uint32_t iteration_interval(); | 209 | const uint32_t iteration_interval(); |
210 | /** | 210 | /** |
211 | * Main loop for the session. This function needs to be called in intervals of | 211 | * Main loop for the session. This function needs to be called in intervals of |
212 | * toxav_iteration_interval() milliseconds. It is best called in the separate | 212 | * toxav_iteration_interval() milliseconds. It is best called in the separate |
213 | * thread from tox_iterate. | 213 | * thread from tox_iterate. |
214 | */ | 214 | */ |
215 | void iterate(); | 215 | void iterate(); |
216 | /******************************************************************************* | 216 | /******************************************************************************* |
217 | * | 217 | * |
218 | * :: Call setup | 218 | * :: Call setup |
219 | * | 219 | * |
220 | ******************************************************************************/ | 220 | ******************************************************************************/ |
@@ -223,7 +223,7 @@ void iterate(); | |||
223 | * | 223 | * |
224 | * It is the client's responsibility to stop ringing after a certain timeout, | 224 | * It is the client's responsibility to stop ringing after a certain timeout, |
225 | * if such behaviour is desired. If the client does not stop ringing, the | 225 | * if such behaviour is desired. If the client does not stop ringing, the |
226 | * library will not stop until the friend is disconnected. Audio and video | 226 | * library will not stop until the friend is disconnected. Audio and video |
227 | * receiving are both enabled by default. | 227 | * receiving are both enabled by default. |
228 | * | 228 | * |
229 | * @param friend_number The friend number of the friend that should be called. | 229 | * @param friend_number The friend number of the friend that should be called. |
@@ -263,7 +263,7 @@ bool call(uint32_t friend_number, uint32_t audio_bit_rate, uint32_t video_bit_ra | |||
263 | event call { | 263 | event call { |
264 | /** | 264 | /** |
265 | * The function type for the ${event call} callback. | 265 | * The function type for the ${event call} callback. |
266 | * | 266 | * |
267 | * @param friend_number The friend number from which the call is incoming. | 267 | * @param friend_number The friend number from which the call is incoming. |
268 | * @param audio_enabled True if friend is sending audio. | 268 | * @param audio_enabled True if friend is sending audio. |
269 | * @param video_enabled True if friend is sending video. | 269 | * @param video_enabled True if friend is sending video. |
@@ -309,13 +309,13 @@ bool answer(uint32_t friend_number, uint32_t audio_bit_rate, uint32_t video_bit_ | |||
309 | INVALID_BIT_RATE, | 309 | INVALID_BIT_RATE, |
310 | } | 310 | } |
311 | /******************************************************************************* | 311 | /******************************************************************************* |
312 | * | 312 | * |
313 | * :: Call state graph | 313 | * :: Call state graph |
314 | * | 314 | * |
315 | ******************************************************************************/ | 315 | ******************************************************************************/ |
316 | bitmask FRIEND_CALL_STATE { | 316 | bitmask FRIEND_CALL_STATE { |
317 | /** | 317 | /** |
318 | * Set by the AV core if an error occurred on the remote end or if friend | 318 | * Set by the AV core if an error occurred on the remote end or if friend |
319 | * timed out. This is the final state after which no more state | 319 | * timed out. This is the final state after which no more state |
320 | * transitions can occur for the call. This call state will never be triggered | 320 | * transitions can occur for the call. This call state will never be triggered |
321 | * in combination with other call states. | 321 | * in combination with other call states. |
@@ -323,7 +323,7 @@ bitmask FRIEND_CALL_STATE { | |||
323 | ERROR, | 323 | ERROR, |
324 | /** | 324 | /** |
325 | * The call has finished. This is the final state after which no more state | 325 | * The call has finished. This is the final state after which no more state |
326 | * transitions can occur for the call. This call state will never be | 326 | * transitions can occur for the call. This call state will never be |
327 | * triggered in combination with other call states. | 327 | * triggered in combination with other call states. |
328 | */ | 328 | */ |
329 | FINISHED, | 329 | FINISHED, |
@@ -357,7 +357,7 @@ event call_state { | |||
357 | typedef void(uint32_t friend_number, uint32_t state); | 357 | typedef void(uint32_t friend_number, uint32_t state); |
358 | } | 358 | } |
359 | /******************************************************************************* | 359 | /******************************************************************************* |
360 | * | 360 | * |
361 | * :: Call control | 361 | * :: Call control |
362 | * | 362 | * |
363 | ******************************************************************************/ | 363 | ******************************************************************************/ |
@@ -427,7 +427,7 @@ bool call_control (uint32_t friend_number, CALL_CONTROL control) { | |||
427 | INVALID_TRANSITION, | 427 | INVALID_TRANSITION, |
428 | } | 428 | } |
429 | /******************************************************************************* | 429 | /******************************************************************************* |
430 | * | 430 | * |
431 | * :: Controlling bit rates | 431 | * :: Controlling bit rates |
432 | * | 432 | * |
433 | ******************************************************************************/ | 433 | ******************************************************************************/ |
@@ -441,7 +441,7 @@ namespace bit_rate { | |||
441 | * audio sending. Set to -1 to leave unchanged. | 441 | * audio sending. Set to -1 to leave unchanged. |
442 | * @param video_bit_rate The new video bit rate in Kb/sec. Set to 0 to disable | 442 | * @param video_bit_rate The new video bit rate in Kb/sec. Set to 0 to disable |
443 | * video sending. Set to -1 to leave unchanged. | 443 | * video sending. Set to -1 to leave unchanged. |
444 | * | 444 | * |
445 | */ | 445 | */ |
446 | bool set(uint32_t friend_number, int32_t audio_bit_rate, int32_t video_bit_rate) { | 446 | bool set(uint32_t friend_number, int32_t audio_bit_rate, int32_t video_bit_rate) { |
447 | /** | 447 | /** |
@@ -455,7 +455,7 @@ namespace bit_rate { | |||
455 | /** | 455 | /** |
456 | * The video bit rate passed was not one of the supported values. | 456 | * The video bit rate passed was not one of the supported values. |
457 | */ | 457 | */ |
458 | INVALID_VIDEO_BIT_RATE, | 458 | INVALID_VIDEO_BIT_RATE, |
459 | /** | 459 | /** |
460 | * The friend_number passed did not designate a valid friend. | 460 | * The friend_number passed did not designate a valid friend. |
461 | */ | 461 | */ |
@@ -468,9 +468,9 @@ namespace bit_rate { | |||
468 | event status { | 468 | event status { |
469 | /** | 469 | /** |
470 | * The function type for the ${event status} callback. The event is triggered | 470 | * The function type for the ${event status} callback. The event is triggered |
471 | * when the network becomes too saturated for current bit rates at which | 471 | * when the network becomes too saturated for current bit rates at which |
472 | * point core suggests new bit rates. | 472 | * point core suggests new bit rates. |
473 | * | 473 | * |
474 | * @param friend_number The friend number of the friend for which to set the | 474 | * @param friend_number The friend number of the friend for which to set the |
475 | * bit rate. | 475 | * bit rate. |
476 | * @param audio_bit_rate Suggested maximum audio bit rate in Kb/sec. | 476 | * @param audio_bit_rate Suggested maximum audio bit rate in Kb/sec. |
@@ -480,7 +480,7 @@ namespace bit_rate { | |||
480 | } | 480 | } |
481 | } | 481 | } |
482 | /******************************************************************************* | 482 | /******************************************************************************* |
483 | * | 483 | * |
484 | * :: A/V sending | 484 | * :: A/V sending |
485 | * | 485 | * |
486 | ******************************************************************************/ | 486 | ******************************************************************************/ |
@@ -538,7 +538,7 @@ namespace audio { | |||
538 | * @param sampling_rate Audio sampling rate used in this frame. Valid sampling | 538 | * @param sampling_rate Audio sampling rate used in this frame. Valid sampling |
539 | * rates are 8000, 12000, 16000, 24000, or 48000. | 539 | * rates are 8000, 12000, 16000, 24000, or 48000. |
540 | */ | 540 | */ |
541 | bool send_frame(uint32_t friend_number, const int16_t *pcm, size_t sample_count, | 541 | bool send_frame(uint32_t friend_number, const int16_t *pcm, size_t sample_count, |
542 | uint8_t channels, uint32_t sampling_rate) with error for send_frame; | 542 | uint8_t channels, uint32_t sampling_rate) with error for send_frame; |
543 | } | 543 | } |
544 | namespace video { | 544 | namespace video { |
@@ -561,7 +561,7 @@ namespace video { | |||
561 | const uint8_t *y, const uint8_t *u, const uint8_t *v) with error for send_frame; | 561 | const uint8_t *y, const uint8_t *u, const uint8_t *v) with error for send_frame; |
562 | } | 562 | } |
563 | /******************************************************************************* | 563 | /******************************************************************************* |
564 | * | 564 | * |
565 | * :: A/V receiving | 565 | * :: A/V receiving |
566 | * | 566 | * |
567 | ******************************************************************************/ | 567 | ******************************************************************************/ |
@@ -571,7 +571,7 @@ namespace audio { | |||
571 | * The function type for the ${event receive_frame} callback. The callback can be | 571 | * The function type for the ${event receive_frame} callback. The callback can be |
572 | * called multiple times per single iteration depending on the amount of queued | 572 | * called multiple times per single iteration depending on the amount of queued |
573 | * frames in the buffer. The received format is the same as in send function. | 573 | * frames in the buffer. The received format is the same as in send function. |
574 | * | 574 | * |
575 | * @param friend_number The friend number of the friend who sent an audio frame. | 575 | * @param friend_number The friend number of the friend who sent an audio frame. |
576 | * @param pcm An array of audio samples (sample_count * channels elements). | 576 | * @param pcm An array of audio samples (sample_count * channels elements). |
577 | * @param sample_count The number of audio samples per channel in the PCM array. | 577 | * @param sample_count The number of audio samples per channel in the PCM array. |
@@ -591,18 +591,18 @@ namespace video { | |||
591 | * @param friend_number The friend number of the friend who sent a video frame. | 591 | * @param friend_number The friend number of the friend who sent a video frame. |
592 | * @param width Width of the frame in pixels. | 592 | * @param width Width of the frame in pixels. |
593 | * @param height Height of the frame in pixels. | 593 | * @param height Height of the frame in pixels. |
594 | * @param y | 594 | * @param y |
595 | * @param u | 595 | * @param u |
596 | * @param v Plane data. | 596 | * @param v Plane data. |
597 | * The size of plane data is derived from width and height where | 597 | * The size of plane data is derived from width and height where |
598 | * Y = MAX(width, abs(ystride)) * height, | 598 | * Y = MAX(width, abs(ystride)) * height, |
599 | * U = MAX(width/2, abs(ustride)) * (height/2) and | 599 | * U = MAX(width/2, abs(ustride)) * (height/2) and |
600 | * V = MAX(width/2, abs(vstride)) * (height/2). | 600 | * V = MAX(width/2, abs(vstride)) * (height/2). |
601 | * @param ystride | 601 | * @param ystride |
602 | * @param ustride | 602 | * @param ustride |
603 | * @param vstride Strides data. Strides represent padding for each plane | 603 | * @param vstride Strides data. Strides represent padding for each plane |
604 | * that may or may not be present. You must handle strides in | 604 | * that may or may not be present. You must handle strides in |
605 | * your image processing code. Strides are negative if the | 605 | * your image processing code. Strides are negative if the |
606 | * image is bottom-up hence why you MUST abs() it when | 606 | * image is bottom-up hence why you MUST abs() it when |
607 | * calculating plane buffer size. | 607 | * calculating plane buffer size. |
608 | */ | 608 | */ |