Skip to content

Commit 1b3fcef

Browse files
committed
Finished Plyer initial doc
1 parent c5452bd commit 1b3fcef

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/source/apis.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,16 @@ yet.
9595

9696
You can include Plyer in your APKs by adding the `Plyer` recipe to
9797
your build requirements. It is not included automatically.
98+
99+
You should check the Plyer documentation for details of all supported
100+
facades (platform APIs), but as an example the following is how you
101+
would achieve vibration as described in the Pyjnius section above::
102+
103+
from plyer.vibrator import vibrate
104+
vibrate(10) # in Plyer, the argument is in seconds
105+
106+
This is obviously *much* less verbose!
107+
108+
.. warning:: At the time of writing, the Plyer recipe is not yet
109+
ported, and Plyer doesn't support SDL2. These issues will
110+
be fixed soon.

0 commit comments

Comments
 (0)