Ceci est une ancienne révision du document !
Table des matières
MediaPlaylist [En cours de Traduction Wismerheal][WSL]
Cet objet vous permet de jouer des fichiers média.
Fonctions
MediaPlaylist
Fonction de construction.
Syntaxe
var myObject = new MediaPlaylist();
Méthodes
setPlaybackRate
Définit le ratio du playback.
Syntaxe
myObject.setPlaybackRate(rate);
Arguments
- rate - (float) le ratio du playback
Renvoie
- (MediaPlaylist) cette MediaPlaylist
setVolume
Défnit le volume.
Syntaxe
myObject.setVolume(volume);
Arguments
- volume - (float) le volume
Renvoie
- (MediaPlaylist) cette MediaPlaylist
setPosition
Définit la position de l'élément en vours de lecture.
Syntaxe
myObject.setPosition(position);
Arguments
- position - (integer) la position en millisecondes
Returns
- (MediaPlaylist) cette MediaPlaylist
setMuted
Coupe ou met le son du média actuellement joué.
Syntaxe
myObject.setMuted(muted);
Arguments
- muted - (boolean) le statut du média dont le son est coupé
Renvoi
- (MediaPlaylist) cette MediaPlaylist
duration
Renvoie la durée du média en cours.
Syntaxe
myObject.duration();
Renvoie
- (integer) la durée du média en cours
hasAudio
Renvoie vrai si le média en cours est un média audio.
Syntaxe
myObject.hasAudio();
Returns
- (boolean) vrai si le média en cours est un média audio
hasVideo
Renvoie vrai si le média en cours est un média vidéo.
Syntaxe
myObject.hasVideo();
Renvoie
- (boolean) vrai si le média en cours est un média vidéo
playbackRate
Renvoie l'actuel ratio du playback.
Syntaxe
myObject.playbackRate();
Returns
- (boolean) l'actuel ratio du playback
volume
Renvoie le volume actuel.
Syntaxe
myObject.volume();
Renvoie
- (boolean) le volume actuel
position
Renvoi la position actuelle.
Syntaxe
myObject.position();
Returns
- (boolean) la position actuelle en millisecondes
isMuted
Renvoie vrai si le média actuel à le son coupé.
Syntaxe
myObject.isMuted();
Renvoie
- (boolean) vrai si le média actuel à le son coupé
isSeekable
Renvoie vrai si le média actuel est recherchable/atteignable. Cela signifie que l'on peut ou non spécifier une position à jouer.
Syntaxe
myObject.isSeekable();
Renvoie
- (boolean) vrai si l'on peu jouer la position demandée
bufferStatus
Renvoie le pourcentage de complétion du tampon.
Syntaxe
myObject.bufferStatus();
Renvoie
- (boolean) le pourcentage de complétion du tampon
play
Débute la lecture d'une playlist. (ouai et alors.. je laisse playlist en anglois…n'ayez pas peur ;) )
Syntaxe
myObject.play();
Renvoie
- (MediaPlaylist) cette MediaPlaylist (voyez la aussi et pourtant vous en faites pas tout un fromage .. #Mouse…mie za part)
pause
Pauses the playing.
Syntax
myObject.pause();
Returns
- (MediaPlaylist) this MediaPlaylist
stop
Stops the playing.
Syntax
myObject.stop();
Returns
- (MediaPlaylist) this MediaPlaylist
addLocalMedia
Adds a local media to the playlist.
Syntax
myObject.addLocalMedia(path);
Arguments
- path - (string) the local media to add
Returns
- (MediaPlaylist) this MediaPlaylist
Exceptions
- (AddMediaError) add media failed
addDistantMedia
Adds a distant media to the playlist.
Syntax
myObject.addDistantMedia(url);
Arguments
- url - (string) the distant media to add
Returns
- (MediaPlaylist) this MediaPlaylist
Exceptions
- (AddMediaError) add media failed
insertLocalMedia
Inserts a local media to the playlist.
Syntax
myObject.insertLocalMedia(position, path);
Arguments
- position - (integer) the position where to insert the media
- path - (string) the local media to insert
Returns
- (MediaPlaylist) this MediaPlaylist
Exceptions
- (InsertMediaError) insert media failed
insertDistantMedia
Inserts a distant media to the playlist.
Syntax
myObject.insertDistantMedia(position, path);
Arguments
- position - (integer) the position where to insert the media
- path - (string) the distant media to insert
Returns
- (MediaPlaylist) this MediaPlaylist
Exceptions
- (InsertMediaError) insert media failed
clear
Clears the playlist contents.
Syntax
myObject.clear();
Returns
- (MediaPlaylist) this MediaPlaylist
Exceptions
- (ClearMediaError) clearing playlist failed
next
Plays the next playlist item.
Syntax
myObject.next();
Returns
- (MediaPlaylist) this MediaPlaylist
previous
Plays the previous playlist item.
Syntax
myObject.previous();
Returns
- (MediaPlaylist) this MediaPlaylist
setCurrentMedia
Sets the current media to play.
Syntax
myObject.setCurrentMedia(mediaIndex);
Arguments
- mediaIndex - (integer) the media index
Returns
- (MediaPlaylist) this MediaPlaylist
shuffle
Shuffles randomly the playlist.
Syntax
myObject.shuffle();
Returns
- (MediaPlaylist) this MediaPlaylist
setPlaybackMode
Sets the playback mode.
Syntax
myObject.setPlaybackMode(playbackMode);
Arguments
- playbackMode - (PlaybackMode) the playback mode
Returns
- (MediaPlaylist) this MediaPlaylist
removeMedia
Removes a media from the list.
Syntax
myObject.removeMedia(mediaIndex);
Arguments
- mediaIndex - (integer) the media index
Returns
- (MediaPlaylist) this MediaPlaylist
Exceptions
- (RemoveMediaError) remove media failed
currentMedia
Returns the current playing media index.
Syntax
myObject.currentMedia();
Returns
- (integer) the current playing media index
isEmpty
Returns true if the playlist is empty.
Syntax
myObject.isEmpty();
Returns
- (boolean) true if the playlist is empty
mediaCount
Returns the playlist size.
Syntax
myObject.mediaCount();
Returns
- (integer) the playlist size
nextMedia
Returns the next media index.
Syntax
myObject.nextMedia();
Returns
- (integer) the next media index
previousMedia
Returns the previous media index.
Syntax
myObject.previousMedia();
Returns
- (integer) the previous media index
playbackMode
Returns the playback mode.
Syntax
myObject.playbackMode();
Returns
- (PlaybackMode) the playback mode
Attributes
playbackRate
The playback rate. (float)
volume
The volume. (float)
position
The position in milliseconds. (integer)
muted
If the media is muted. (boolean)
currentMedia
The current media index. (integer)
playbackMode
The playback mode. (PlaybackMode)
Enumerations
PlaybackMode
The playback mode.
Values
- CurrentItemOnce: the current item is played only one
- CurrentItemInLoop: the current item is played in the loop
- Sequential: playback starts from the first to the last items and stops
- Loop: playback restarts at the first item after the last has finished playing
- Random: plays items in random order