| Package | vn.karaokeplayer |
| Class | public class KarPlayer |
| Inheritance | KarPlayer  flash.display.Sprite |
| Implements | IKarPlayer |
| Property | Defined by | ||
|---|---|---|---|
| audioCompleted : ISignal [read-only]
Dispatches when audio completes playing
| KarPlayer | ||
| beatPlayer : IAudioPlayer
[read-only]
| KarPlayer | ||
| height : Number
Height of this player.
| KarPlayer | ||
| length : Number [read-only]
Audio length (in milliseconds)
| KarPlayer | ||
| loadCompleted : ISignal [read-only]
Dispatches when audio (mp3) loading is completed
| KarPlayer | ||
| loadProgress : ISignal [read-only]
Dispatches loading progress
arguments (percent: Number, byteLoaded: uint, byteTotal: uint) | KarPlayer | ||
| lyricPlayer : ILyricsPlayer
[read-only]
| KarPlayer | ||
| pausing : Boolean [read-only]
Is player pausing
| KarPlayer | ||
| playing : Boolean [read-only]
Is player playing
| KarPlayer | ||
| playProgress : ISignal [read-only]
Dispatches playing progress
arguments (position: Number, length: Number) | KarPlayer | ||
| position : Number [read-only]
Current position of play head (in milliseconds)
| KarPlayer | ||
| ready : ISignal [read-only]
Dispatches when data and sound are ready
| KarPlayer | ||
| songInfo : SongInfo
[read-only]
SongInfo object which is parsed from the lyrics XML
| KarPlayer | ||
| songReady : Boolean [read-only]
Whether song is ready to play
| KarPlayer | ||
| width : Number
Width of this player.
| KarPlayer | ||
| Method | Defined by | ||
|---|---|---|---|
|
KarPlayer(options:KarPlayerOptions = null)
| KarPlayer | ||
|
loadSong(urlOrSongInfo:Object):void
Loads song data from URL or object SongInfo
Note: currently assuming that beat audio is loaded with SongInfo | KarPlayer | ||
|
pause():void
Pauses the karaoke
| KarPlayer | ||
|
play():void
Plays the karaoke
| KarPlayer | ||
|
seek(pos:Number):void
Seeks to a position (in milliseconds)
| KarPlayer | ||
|
stop():void
Stops the player
| KarPlayer | ||
| Constant | Defined by | ||
|---|---|---|---|
| VERSION : String = "0.8.71" [static]
| KarPlayer | ||
| audioCompleted | property |
audioCompleted:ISignal [read-only]Dispatches when audio completes playing
Implementation public function get audioCompleted():ISignal
| beatPlayer | property |
| height | property |
height:Number [read-write]Height of this player. This can be used for positioning and layout. This property is overriden so it only measures the logical visible part of the player. It is read-only.
Implementation public function get height():Number
public function set height(value:Number):void
| length | property |
length:Number [read-only]Audio length (in milliseconds)
Implementation public function get length():Number
| loadCompleted | property |
loadCompleted:ISignal [read-only]Dispatches when audio (mp3) loading is completed
Implementation public function get loadCompleted():ISignal
| loadProgress | property |
loadProgress:ISignal [read-only]
Dispatches loading progress
arguments (percent: Number, byteLoaded: uint, byteTotal: uint)
public function get loadProgress():ISignal
| lyricPlayer | property |
| pausing | property |
pausing:Boolean [read-only]Is player pausing
Implementation public function get pausing():Boolean
| playing | property |
playing:Boolean [read-only]Is player playing
Implementation public function get playing():Boolean
| playProgress | property |
playProgress:ISignal [read-only]
Dispatches playing progress
arguments (position: Number, length: Number)
public function get playProgress():ISignal
| position | property |
position:Number [read-only]Current position of play head (in milliseconds)
Implementation public function get position():Number
| ready | property |
ready:ISignal [read-only]Dispatches when data and sound are ready
Implementation public function get ready():ISignal
| songInfo | property |
songInfo:SongInfo [read-only]SongInfo object which is parsed from the lyrics XML
Implementation public function get songInfo():SongInfo
| songReady | property |
songReady:Boolean [read-only]Whether song is ready to play
Implementation public function get songReady():Boolean
| width | property |
width:Number [read-write]Width of this player. This can be used for positioning and layout. This property is overriden so it only measures the logical visible part of the player. It is read-only.
Implementation public function get width():Number
public function set width(value:Number):void
| KarPlayer | () | constructor |
public function KarPlayer(options:KarPlayerOptions = null)Parameters
options:KarPlayerOptions (default = null) |
| debug | () | method |
karplayer_internal function debug():void
| loadSong | () | method |
public function loadSong(urlOrSongInfo:Object):void
Loads song data from URL or object SongInfo
Note: currently assuming that beat audio is loaded with SongInfo
urlOrSongInfo:Object — url of song lyrics XML or SongInfo
|
| pause | () | method |
public function pause():voidPauses the karaoke
| play | () | method |
public function play():voidPlays the karaoke
| prepareDebug | () | method |
karplayer_internal function prepareDebug():void
| seek | () | method |
public function seek(pos:Number):voidSeeks to a position (in milliseconds)
Parameterspos:Number |
| stop | () | method |
public function stop():voidStops the player
| VERSION | constant |
public static const VERSION:String = "0.8.71"