Home Manual Reference Source Test

Variable

Static Public Summary
public

LoopStatus: {"NONE": string, "TRACK": string, "PLAYLIST": string}

Constants for playback looping support

public

MessageMethod: {"GET": string, "SET": string, "PLAY": string, "PAUSE": string, "TOGGLE": string, "STOP": string, "NEXT": string, "PREVIOUS": string, "SEEK": string, "SET_POSITION": string}

public

MessageProperty: {"POSITION": string, "RATE": string, "VOLUME": string, "SHUFFLE": string, "LOOP_STATUS": string, "FULL_SCREEN": string}

public

MessageType: {"CHANGE": string, "RETURN": string, "SEEK": string, "QUIT": string}

public

PlaybackStatus: {"PLAYING": string, "PAUSED": string, "STOPPED": string}

Constants for playback status

public

The instance of Carrier for this web site.

public
public

The instance of Host for this web site.

public

host: *

public
public

The instance of Page for this web site.

public

pages: *[]

public

The instance of Playback for this web site.

Static Public

public LoopStatus: {"NONE": string, "TRACK": string, "PLAYLIST": string} source

Constants for playback looping support

By default only <b>NONE</b> and <b>TRACK</b> are supported, <b>PLAYLIST</b> looping should be implemented by provider

Properties:

NameTypeAttributeDescription
NONE string
  • default: None

default playback

TRACK string
  • default: Track

playback will loop current track

PLAYLIST string
  • default: Playlist

playback will loop current playlist

public MessageMethod: {"GET": string, "SET": string, "PLAY": string, "PAUSE": string, "TOGGLE": string, "STOP": string, "NEXT": string, "PREVIOUS": string, "SEEK": string, "SET_POSITION": string} source

Properties:

NameTypeAttributeDescription
GET string
  • default: Get

request a property from the client

SET string
  • default: Set

request to set a property in the client

PLAY string
  • default: Play

request to start playing the current media

PAUSE string
  • default: Pause

request to pause the current media

TOGGLE string
  • default: PlayPause

request to toggle playback of current media

STOP string
  • default: Stop

request to completely stop playback

NEXT string
  • default: Next

request to skip to next media

PREVIOUS string
  • default: Previous

request to skip to previous media

SEEK string
  • default: Seek

request to move current playback position by some offset

SET_POSITION string
  • default: SetPosition

request to move current playback position to specific point

public MessageProperty: {"POSITION": string, "RATE": string, "VOLUME": string, "SHUFFLE": string, "LOOP_STATUS": string, "FULL_SCREEN": string} source

Properties:

NameTypeAttributeDescription
POSITION string
  • default: Position

the time of playback

RATE string
  • default: Rate

the speed rate of playback

VOLUME string
  • default: Volume

the volume of playback

SHUFFLE string
  • default: Shuffle

the shuffle state of playback

LOOP_STATUS string
  • default: LoopStatus

the loop status of playback

FULL_SCREEN string
  • default: Fullscreen

the fullscreen state

public MessageType: {"CHANGE": string, "RETURN": string, "SEEK": string, "QUIT": string} source

Properties:

NameTypeAttributeDescription
CHANGE string
  • default: changed

whether a mrpis2 property has changed

RETURN string
  • default: return

if we are returning an expected value

SEEK string
  • default: seeked

seeking

QUIT string
  • default: quit

inform to close the player

public PlaybackStatus: {"PLAYING": string, "PAUSED": string, "STOPPED": string} source

Constants for playback status

Properties:

NameTypeAttributeDescription
PLAYING string
  • default: Playing

the media is playing

PAUSED string
  • default: Paused

the media is paused

STOPPED string
  • default: Stopped

the media is stopped

public carrier: Carrier source

The instance of Carrier for this web site. There should be no need to interact directly with it.

public connections: number source

public host: Host source

The instance of Host for this web site. There should be no need to interact directly with it.

public host: * source

public manifestData: * source

public page: Page source

The instance of Page for this web site. We define it here so it can be accessed by any provider specific code.

public pages: *[] source

public playback: Playback source

The instance of Playback for this web site. We define it here so it can be accessed by any provider specific code.