timer23
/
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; legacy_prefix: null;
methods { methods {
@property playable { @property playable {
/*@ [[Whether or not the object data can be played.]]
* @brief Whether or not the object data can be played.
*/
get { get {
} }
values { 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 { @property play {
set { set {
/*@ [[Set play/pause state of the media file.
* @brief Set play/pause state of the media file.
* This functions sets the currently playing status of the
* This functions sets the currently playing status of the video. Using this video. Using this function to play or pause the video
* function to play or pause the video doesn't alter it's current position. doesn't alter it's current position.
*/ ]]
} }
get { get {
/*@ [[Get play/pause state of the media file.]]
* @brief Get play/pause state of the media file.
*/
} }
values { values {
play: bool; /*@ true if playing, false otherwise. */ play: bool; [[true if playing, false otherwise.]]
} }
} }
@property position { @property position {
set { set {
/*@ [[Set the position in the media file.
* @brief Set the position in the media file.
* This functions sets the current position of the media file
* @param obj The emotion object whose position will be changed. to "sec", this only works on seekable streams. Setting the
* @param sec The position(in seconds) to which the media file will be set. position doesn't change the playing state of the media file.
* ]]
* 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 { get {
/*@ [[Get the position in the media file.
* @brief Get the position in the media file.
* The position is returned as the number of seconds since the
* @param obj The emotion object from which the position will be retrieved. beginning of the media file.
* @return The position of the media file. ]]
*
* The position is returned as the number of seconds since the beginning of the
* media file.
*/
} }
values { values {
second: double; /*@ The position (in seconds). */ sec: double; [[The position (in seconds).]]
} }
} }
@property progress { @property progress {
get { get {
/*@ [[Get how much of the file has been played.
* @brief Get how much of the file has been played.
* This function gets the progress in playing the file, the
* This function gets the progress in playing the file, the return value is in return value is in the [0, 1] range.
* the [0, 1] range. ]]
*/
} }
values { values {
progress: double; /*@ The progress within the [0, 1] range. */ progress: double; [[The progress within the [0, 1] range.]]
} }
} }
@property play_speed { @property play_speed {
/*@ [[Control the play speed of the media file.
* @brief Control the play speed of the media file.
* This function control the speed with which the media file will
* This function control the speed with which the media file will be played. 1.0 be played. 1.0 represents the normal speed, 2 double speed, 0.5
* represents the normal speed, 2 double speed, 0.5 half speed and so on. half speed and so on.
* ]]
*/
set { set {
} }
get { get {
} }
values { values {
speed: double; /*@ The play speed in the [0, infinity) range. */ speed: double; [[The play speed in the [0, infinity) range.]]
} }
} }
@property audio_volume { @property audio_volume {
/*@ [[Control the audio volume.
* @brief Control the audio volume.
* Controls the audio volume of the stream being played. This has
* Controls the audio volume of the stream being played. This has nothing to do with nothing to do with the system volume. This volume will be
* the system volume. This volume will be multiplied by the system volume. e.g.: multiplied by the system volume. e.g.: if the current volume
* if the current volume level is 0.5, and the system volume is 50%, it will be level is 0.5, and the system volume is 50%, it will be
* 0.5 * 0.5 = 0.25. 0.5 * 0.5 = 0.25.
*/ ]]
set { set {
} }
get { get {
} }
values { values {
volume: double; /*@ The volume level */ volume: double; [[The volume level]]
} }
} }
@property audio_mute { @property audio_mute {
/*@ [[This property controls the audio mute state.]]
* @brief This property controls the audio mute state.
*/
set { set {
} }
get { get {
} }
values { values {
mute: bool; /*@ The mute state. True or false. */ mute: bool; [[The mute state. True or false.]]
} }
} }
@property length { @property length {
/*@ [[Get the length of play for the media file.]]
* @brief Get the length of play for the media file.
*
* This function returns the length of the media file in seconds.
*/
get { get {
} }
values { values {
length: double; /*@ The length of the stream in seconds. */ length: double; [[The length of the stream in seconds.]]
} }
} }
@property seekable { @property seekable {
/*@ [[Get whether the media file is seekable.]]
* @brief Get whether the media file is seekable.
*/
get { get {
} }
values { values {
seekable: bool; /*@ True if seekable. */ seekable: bool; [[True if seekable.]]
} }
} }
} }