explain enabling in API comment

This commit is contained in:
zugz (tox) 2019-02-10 00:00:00 +00:00
parent 959f468eac
commit 695fa4373a
No known key found for this signature in database
GPG Key ID: 6F2BDA289D04F249
2 changed files with 16 additions and 0 deletions

View File

@ -783,6 +783,14 @@ int toxav_group_send_audio(Tox *tox, uint32_t groupnumber, const int16_t *pcm, u
uint32_t sample_rate);
/* Enable A/V in a groupchat.
*
* A/V must be enabled on a groupchat for audio to be sent to it and for
* received audio to be handled.
*
* An A/V group created with toxav_add_av_groupchat or toxav_join_av_groupchat
* will start with A/V enabled.
*
* An A/V group loaded from a savefile will start with A/V disabled.
*
* return 0 on success.
* return -1 on failure.

View File

@ -82,6 +82,14 @@ int toxav_group_send_audio(Tox *tox, uint32_t groupnumber, const int16_t *pcm, u
}
/* Enable A/V in a groupchat.
*
* A/V must be enabled on a groupchat for audio to be sent to it and for
* received audio to be handled.
*
* An A/V group created with toxav_add_av_groupchat or toxav_join_av_groupchat
* will start with A/V enabled.
*
* An A/V group loaded from a savefile will start with A/V disabled.
*
* return 0 on success.
* return -1 on failure.