MediaPlaylist

This object allows you to play media files.

Constructor function.

var myObject = new MediaPlaylist();

Sets the playback rate.

myObject.setPlaybackRate(rate);

1. rate - (float) the playback rate

• (MediaPlaylist) this MediaPlaylist

Sets the volume.

myObject.setVolume(volume);

1. volume - (float) the volume

• (MediaPlaylist) this MediaPlaylist

Sets the position of the current playing item.

myObject.setPosition(position);

1. position - (integer) the position in milliseconds

• (MediaPlaylist) this MediaPlaylist

Mutes or unmutes the current playing media.

myObject.setMuted(muted);

1. muted - (boolean) the media's muted status

• (MediaPlaylist) this MediaPlaylist

Returns the duration of the current media.

myObject.duration();

• (integer) the duration of the current media

Returns true if the current media has audio.

myObject.hasAudio();

• (boolean) true if the current media has audio

Returns true if the current media has video.

myObject.hasVideo();

• (boolean) true if the current media has video

Returns the current playback rate.

myObject.playbackRate();

• (boolean) the current playback rate

Returns the current volume.

myObject.volume();

• (boolean) the current volume

Returns the current position.

myObject.position();

• (boolean) the current position in milliseconds

Returns true if the current media is muted.

myObject.isMuted();

• (boolean) true if the current media is muted

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

myObject.isSeekable();

• (boolean) true if the current media is seekable

Returns the percentage of filled buffer.

myObject.bufferStatus();

• (boolean) the percentage of filled buffer

Begins playing the playlist.

myObject.play();

• (MediaPlaylist) this MediaPlaylist

Pauses the playing.

myObject.pause();

• (MediaPlaylist) this MediaPlaylist

Stops the playing.

myObject.stop();

• (MediaPlaylist) this MediaPlaylist

Adds a local media to the playlist.

myObject.addLocalMedia(path);

1. path - (string) the local media to add

• (MediaPlaylist) this MediaPlaylist

• (AddMediaError) add media failed

Adds a distant media to the playlist.

myObject.addDistantMedia(url);

1. url - (string) the distant media to add

• (MediaPlaylist) this MediaPlaylist

• (AddMediaError) add media failed

Inserts a local media to the playlist.

myObject.insertLocalMedia(position, path);

1. position - (integer) the position where to insert the media
2. path - (string) the local media to insert

• (MediaPlaylist) this MediaPlaylist

• (InsertMediaError) insert media failed

Inserts a distant media to the playlist.

myObject.insertDistantMedia(position, path);

1. position - (integer) the position where to insert the media
2. path - (string) the distant media to insert

• (MediaPlaylist) this MediaPlaylist

• (InsertMediaError) insert media failed

Clears the playlist contents.

myObject.clear();

• (MediaPlaylist) this MediaPlaylist

• (ClearMediaError) clearing playlist failed

Plays the next playlist item.

myObject.next();

• (MediaPlaylist) this MediaPlaylist

Plays the previous playlist item.

myObject.previous();

• (MediaPlaylist) this MediaPlaylist

Sets the current media to play.

myObject.setCurrentMedia(mediaIndex);

1. mediaIndex - (integer) the media index

• (MediaPlaylist) this MediaPlaylist

Shuffles randomly the playlist.

myObject.shuffle();

• (MediaPlaylist) this MediaPlaylist

Sets the playback mode.

myObject.setPlaybackMode(playbackMode);

1. playbackMode - (PlaybackMode) the playback mode

• (MediaPlaylist) this MediaPlaylist

Removes a media from the list.

myObject.removeMedia(mediaIndex);

1. mediaIndex - (integer) the media index

• (MediaPlaylist) this MediaPlaylist

• (RemoveMediaError) remove media failed

Returns the current playing media index.

myObject.currentMedia();

• (integer) the current playing media index

Returns true if the playlist is empty.

myObject.isEmpty();

• (boolean) true if the playlist is empty

Returns the playlist size.

myObject.mediaCount();

• (integer) the playlist size

Returns the next media index.

myObject.nextMedia();

• (integer) the next media index

Returns the previous media index.

myObject.previousMedia();

• (integer) the previous media index

Returns the playback mode.

myObject.playbackMode();

• (PlaybackMode) the playback mode

The playback rate. (float)

The volume. (float)

The position in milliseconds. (integer)

If the media is muted. (boolean)

The current media index. (integer)

The playback mode. (PlaybackMode)

The playback mode.

1. CurrentItemOnce: the current item is played only one
2. CurrentItemInLoop: the current item is played in the loop
3. Sequential: playback starts from the first to the last items and stops
4. Loop: playback restarts at the first item after the last has finished playing
5. Random: plays items in random order