kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

efl_player: convert docs

This commit is contained in:
Daniel Kolesa 2015-06-16 15:36:33 +01:00
parent 1745d0a994
commit 0d0439ecc3
1 changed files with 50 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
src/lib/efl/interfaces/efl_player.eo
View File

@ -2,139 +2,117 @@ interface Efl.Player {
legacy_prefix: null;
methods {
@property playable {
/*@
* @brief Whether or not the object data can be played.
*/
[[Whether or not the object data can be played.]]
get {
}
values {
play: bool; /*@ true if the object have playable data, false otherwise */
play: bool; [[true if the object have playable data, false otherwise]]
}
}
@property 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.
*/
[[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.
*/
[[Get play/pause state of the media file.]]
}
values {
play: bool; /*@ true if playing, false otherwise. */
play: bool; [[true if playing, false otherwise.]]
}
}
@property 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.
*/
[[Set the position in the media file.
This functions sets the current position of the media file
to "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.
*/
[[Get the position in the media file.
The position is returned as the number of seconds since the
beginning of the media file.
]]
}
values {
second: double; /*@ The position (in seconds). */
sec: double; [[The position (in seconds).]]
}
}
@property 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.
*/
[[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 {
progress: double; /*@ The progress within the [0, 1] range. */
progress: double; [[The progress within the [0, 1] range.]]
}
}
@property 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.
*
*/
[[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 {
speed: double; /*@ The play speed in the [0, infinity) range. */
speed: double; [[The play speed in the [0, infinity) range.]]
}
}
@property 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.
*/
[[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 {
volume: double; /*@ The volume level */
volume: double; [[The volume level]]
}
}
@property audio_mute {
/*@
* @brief This property controls the audio mute state.
*/
[[This property controls the audio mute state.]]
set {
}
get {
}
values {
mute: bool; /*@ The mute state. True or false. */
mute: bool; [[The mute state. True or false.]]
}
}
@property length {
/*@
* @brief Get the length of play for the media file.
*
* This function returns the length of the media file in seconds.
*/
[[Get the length of play for the media file.]]
get {
}
values {
length: double; /*@ The length of the stream in seconds. */
length: double; [[The length of the stream in seconds.]]
}
}
@property seekable {
/*@
* @brief Get whether the media file is seekable.
*/
[[Get whether the media file is seekable.]]
get {
}
values {
seekable: bool; /*@ True if seekable. */
seekable: bool; [[True if seekable.]]
}
}
}