diff options
author | Pierre Ossman <ossman@cendio.se> | 2006-05-17 11:10:59 +0000 |
---|---|---|
committer | Pierre Ossman <ossman@cendio.se> | 2006-05-17 11:10:59 +0000 |
commit | 6ab421381ab9047d92f2679b67a8a4e0ea611d11 (patch) | |
tree | 6a5e44d3a19d7fe571d184f73555711a8b322628 /src/polyp | |
parent | d4d1e5edf7af01b0d0e32da9fa323702f5174232 (diff) |
Update documentation to contain the UTF-8 requirement.
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@893 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp')
-rw-r--r-- | src/polyp/polypaudio.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/polyp/polypaudio.h b/src/polyp/polypaudio.h index 5dd7aa10..1830dea8 100644 --- a/src/polyp/polypaudio.h +++ b/src/polyp/polypaudio.h @@ -54,6 +54,11 @@ * \li The complete but somewhat complicated to use asynchronous API * \li The simplified, easy to use, but limited synchronous API * + * All strings in Polypaudio are in the UTF-8 encoding, regardless of current + * locale. Some functions will filter invalid sequences from the string, some + * will simply fail. To ensure reliable behaviour, make sure everything you + * pass to the API is already in UTF-8. + * \section simple_sec Simple API * * Use this if you develop your program in synchronous style and just |