diff options
author | zugz (tox) <mbays+tox@sdf.org> | 2019-02-10 00:00:00 +0000 |
---|---|---|
committer | zugz (tox) <mbays+tox@sdf.org> | 2019-02-10 00:00:00 +0000 |
commit | 695fa4373aef9f9632a93c70a4138688325499e2 (patch) | |
tree | 1c0d93d1ef1193f137ef94f00081552575628176 | |
parent | 959f468eac8b1c2a0d10a5cc1d4f95ec4ad8b144 (diff) |
explain enabling in API comment
-rw-r--r-- | toxav/toxav.h | 8 | ||||
-rw-r--r-- | toxav/toxav_old.c | 8 |
2 files changed, 16 insertions, 0 deletions
diff --git a/toxav/toxav.h b/toxav/toxav.h index 5d4f3bd3..bfb7617c 100644 --- a/toxav/toxav.h +++ b/toxav/toxav.h | |||
@@ -784,6 +784,14 @@ int toxav_group_send_audio(Tox *tox, uint32_t groupnumber, const int16_t *pcm, u | |||
784 | 784 | ||
785 | /* Enable A/V in a groupchat. | 785 | /* Enable A/V in a groupchat. |
786 | * | 786 | * |
787 | * A/V must be enabled on a groupchat for audio to be sent to it and for | ||
788 | * received audio to be handled. | ||
789 | * | ||
790 | * An A/V group created with toxav_add_av_groupchat or toxav_join_av_groupchat | ||
791 | * will start with A/V enabled. | ||
792 | * | ||
793 | * An A/V group loaded from a savefile will start with A/V disabled. | ||
794 | * | ||
787 | * return 0 on success. | 795 | * return 0 on success. |
788 | * return -1 on failure. | 796 | * return -1 on failure. |
789 | * | 797 | * |
diff --git a/toxav/toxav_old.c b/toxav/toxav_old.c index 0ae9231d..1362798d 100644 --- a/toxav/toxav_old.c +++ b/toxav/toxav_old.c | |||
@@ -83,6 +83,14 @@ int toxav_group_send_audio(Tox *tox, uint32_t groupnumber, const int16_t *pcm, u | |||
83 | 83 | ||
84 | /* Enable A/V in a groupchat. | 84 | /* Enable A/V in a groupchat. |
85 | * | 85 | * |
86 | * A/V must be enabled on a groupchat for audio to be sent to it and for | ||
87 | * received audio to be handled. | ||
88 | * | ||
89 | * An A/V group created with toxav_add_av_groupchat or toxav_join_av_groupchat | ||
90 | * will start with A/V enabled. | ||
91 | * | ||
92 | * An A/V group loaded from a savefile will start with A/V disabled. | ||
93 | * | ||
86 | * return 0 on success. | 94 | * return 0 on success. |
87 | * return -1 on failure. | 95 | * return -1 on failure. |
88 | * | 96 | * |