Actiona Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== MediaPlayer ======
This object allows you to play media files.

//Added in Actiona 3.12.0//
===== Functions =====

==== MediaPlayer ====
Constructor function.

=== Syntax ===
<code javascript>
var myObject = new MediaPlayer();
</code>

===== Methods =====

==== setPlaybackRate ====
Sets the playback rate.

=== Syntax ===
<code javascript>
myObject.setPlaybackRate(rate);
</code>

=== Arguments ===
  - rate - (float) the playback rate

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== setVolume ====
Sets the volume.

=== Syntax ===
<code javascript>
myObject.setVolume(volume);
</code>

=== Arguments ===
  - volume - (float) the volume

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== setPosition ====
Sets the position of the current playing item.

=== Syntax ===
<code javascript>
myObject.setPosition(position);
</code>

=== Arguments ===
  - position - (integer) the position in milliseconds

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== setMuted ====
Mutes or unmutes the current playing media.

=== Syntax ===
<code javascript>
myObject.setMuted(muted);
</code>

=== Arguments ===
  - muted - (boolean) the media's muted status

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== duration ====
Returns the duration of the current media.

=== Syntax ===
<code javascript>
myObject.duration();
</code>

=== Returns ===
  * (integer) the duration of the current media

==== hasAudio ====
Returns true if the current media has audio.

=== Syntax ===
<code javascript>
myObject.hasAudio();
</code>

=== Returns ===
  * (boolean) true if the current media has audio

==== hasVideo ====
Returns true if the current media has video.

=== Syntax ===
<code javascript>
myObject.hasVideo();
</code>

=== Returns ===
  * (boolean) true if the current media has video

==== playbackRate ====
Returns the current playback rate.

=== Syntax ===
<code javascript>
myObject.playbackRate();
</code>

=== Returns ===
  * (boolean) the current playback rate

==== volume ====
Returns the current volume.

=== Syntax ===
<code javascript>
myObject.volume();
</code>

=== Returns ===
  * (boolean) the current volume

==== position ====
Returns the current position.

=== Syntax ===
<code javascript>
myObject.position();
</code>

=== Returns ===
  * (boolean) the current position in milliseconds

==== isMuted ====
Returns true if the current media is muted.

=== Syntax ===
<code javascript>
myObject.isMuted();
</code>

=== Returns ===
  * (boolean) true if the current media is muted

==== isSeekable ====
Returns true if the current media is seekable.
Seekable means that you can seek to a specific position to play.

=== Syntax ===
<code javascript>
myObject.isSeekable();
</code>

=== Returns ===
  * (boolean) true if the current media is seekable

==== bufferStatus ====
Returns the percentage of filled buffer.

=== Syntax ===
<code javascript>
myObject.bufferStatus();
</code>

=== Returns ===
  * (boolean) the percentage of filled buffer

==== play ====
Begins playing.

=== Syntax ===
<code javascript>
myObject.play();
</code>

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== pause ====
Pauses the playing.

=== Syntax ===
<code javascript>
myObject.pause();
</code>

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== stop ====
Stops the playing.

=== Syntax ===
<code javascript>
myObject.stop();
</code>

=== Returns ===
  * (MediaPlayer) this MediaPlayer

==== setLocalMedia ====
Plays a local media.

=== Syntax ===
<code javascript>
myObject.setLocalMedia(path);
</code>

=== Arguments ===
  - path - (string) the local media to play

=== Returns ===
  * (MediaPlayer) this MediaPlayer

=== Exceptions ===
  * (SetMediaError) set media failed

==== setDistantMedia ====
Plays a distant media.

=== Syntax ===
<code javascript>
myObject.setDistantMedia(url);
</code>

=== Arguments ===
  - url - (string) the distant media to play

=== Returns ===
  * (MediaPlayer) this MediaPlayer

=== Exceptions ===
  * (SetMediaError) set media failed

===== Attributes =====

==== playbackRate ====
The playback rate. (float)

==== volume ====
The volume. (float)

==== position ====
The position in milliseconds. (integer)

==== muted ====
If the media is muted. (boolean)