summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_player.eo
blob: b1fab48d76b150564882138c1c795e032291054f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
interface Efl.Player {
   legacy_prefix: null;
   properties {
        play {
             set {
                  /*@
                   * @brief Set play/pause state of the media file.
                   *
                   * This functions sets the currently playing status of the video. Using this
                   * function to play or pause the video doesn't alter it's current position.
                   */
             }
             get {
                  /*@
                   * @brief Get play/pause state of the media file.
                   */
             }
             values {
                  bool play; /*@ true if playing, false otherwise. */
             }
        }
        position {
             set {
                  /*@
                   * @brief Set the position in the media file.
                   *
                   * @param obj The emotion object whose position will be changed.
                   * @param sec The position(in seconds) to which the media file will be set.
                   *
                   * This functions sets the current position of the media file to @p sec, this
                   * only works on seekable streams. Setting the position doesn't change the
                   * playing state of the media file.
                   */
             }
             get {
                  /*@
                   * @brief Get the position in the media file.
                   *
                   * @param obj The emotion object from which the position will be retrieved.
                   * @return The position of the media file.
                   *
                   * The position is returned as the number of seconds since the beginning of the
                   * media file.
                   */
             }
             values {
                  double second; /*@ The position (in seconds). */
             }
        }
        progress {
             get {
                  /*@
                   * @brief Get how much of the file has been played.
                   *
                   * This function gets the progress in playing the file, the return value is in
                   * the [0, 1] range.
                   */
             }
             values {
                  double progress; /*@ The progress within the [0, 1] range. */
             }
        }
        play_speed {
             /**
              * @brief Control the play speed of the media file.
              *
              * This function control the speed with which the media file will be played. 1.0
              * represents the normal speed, 2 double speed, 0.5 half speed and so on.
              *
              */
             set {
             }
             get {
             }
             values {
                  double speed; /*@ The play speed in the [0, infinity) range. */
             }
        }
        audio_volume {
             /**
              * @brief Control the audio volume.
              *
              * 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.
              */
             set {
             }
             get {
             }
             values {
                  double volume; /*@ The volume level */
             }
        }
        audio_mute {
             /**
              * @brief This property controls the audio mute state.
              */
             set {
             }
             get {
             }
             values {
                  bool mute; /*@ The mute state. True or false. */
             }
        }
        length {
             /**
              * @brief Get the length of play for the media file.
              *
              * This function returns the length of the media file in seconds.
              */
             get {
             }
             values {
                  double length; /*@ The length of the stream in seconds. */
             }
        }
        seekable {
             /**
              * @brief Get whether the media file is seekable.
              */
             get {
             }
             values {
                  bool seekable; /*@ True if seekable. */
             }
        }
   }
}