summaryrefslogtreecommitdiff
path: root/pages/docs/efl/auto/interface/efl/player/property/volume.txt
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-12-02 13:36:55 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-12-02 13:36:55 +0100
commitba04de156f4854a702cc1eaf16f89176e5fc79a1 (patch)
tree3ff1c12ecdf6bcecd4b80fd2418e5e5d88875e6a /pages/docs/efl/auto/interface/efl/player/property/volume.txt
parent18d88edad46c53f70afbfe9f76edec1a667dc63d (diff)
www: eo-docs: initial commit of our generated eo based API documentation
Generated with the gendoc lua script to parse the eo file documentation and generate files matching the dokuwiki syntax. This will be integrated into our main website dokuwiki setup at some point. For now we keep the files separate to allow for more testing and potential failures. At the current state the documentation covers 100% of the item we have in our eo files. If you want to play around with this on your own I would recommend a local setup as described here: https://phab.enlightenment.org/w/run_doc_system_locally/
Diffstat (limited to 'pages/docs/efl/auto/interface/efl/player/property/volume.txt')
-rw-r--r--pages/docs/efl/auto/interface/efl/player/property/volume.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/pages/docs/efl/auto/interface/efl/player/property/volume.txt b/pages/docs/efl/auto/interface/efl/player/property/volume.txt
new file mode 100644
index 0000000..2f6dd3a
--- /dev/null
+++ b/pages/docs/efl/auto/interface/efl/player/property/volume.txt
@@ -0,0 +1,35 @@
1<title>Efl.Player.volume</title>
2===== Signature =====
3
4<code>
5@property Efl.Player.volume @virtual_pure {
6 get {
7 values {
8 volume: double;
9 }
10 }
11 set {
12 values {
13 volume: double;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22double efl_player_volume_get(const Eo *obj);
23void efl_player_volume_set(Eo *obj, double volume);
24</code>
25
26===== Values =====
27
28 * **volume** - %%The volume level%%
29===== Description =====
30
31%%Control the audio volume.%%
32
33%%Controls the audio volume of the stream being played. This has nothing to do with the system volume. This volume will be multiplied by the system volume. e.g.: if the current volume level is 0.5, and the system volume is 50%, it will be 0.5 * 0.5 = 0.25.%%{{page>:docs:efl:user:interface:efl:player:property:volume:description&nodate&nolink&nouser}}
34
35