Module tagtraum.obstspot

Package com.tagtraum.macos.spotify

Interface Application

All Superinterfaces:

Reference

@Code("capp")
@Name("application")
public interface Application
extends Reference

The Spotify application.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static Set<Class<?>>	APPLICATION_CLASSES	All classes belonging to this application.
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
Track	getCurrentTrack()	The current playing track.
static Application	getInstance()	Returns an instance for application Spotify.
String	getName()	The name of the application.
double	getPlayerPosition()	The player’s position within the currently playing track in seconds.
Epls	getPlayerState()	Is Spotify stopped, paused, or playing?
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
int	getSoundVolume()	The sound output volume (0 = minimum, 100 = maximum).
String	getVersion()	The version of the application.
boolean	isFrontmost()	Is this the frontmost (active) application?
boolean	isRepeating()	Is repeating on or off?
boolean	isRepeatingEnabled()	Is repeating enabled in the current playback context?
boolean	isShuffling()	Is shuffling on or off?
boolean	isShufflingEnabled()	Is shuffling enabled in the current playback context?
void	nextTrack()	Skip to the next track.
void	pause()	Pause playback.
void	play()	Resume playback.
void	playpause()	Toggle play/pause.
void	playTrack(String theUriOfTheTrackToPlay, String theUriOfTheContextToPlayIn)	Start playback of a track in the given context.
void	previousTrack()	Skip to the previous track.
void	setPlayerPosition(double playerPosition)	The player’s position within the currently playing track in seconds.
void	setRepeating(boolean repeating)	Is repeating on or off?
void	setShuffling(boolean shuffling)	Is shuffling on or off?
void	setSoundVolume(int soundVolume)	The sound output volume (0 = minimum, 100 = maximum).

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

APPLICATION_CLASSES

static final Set<Class<?>> APPLICATION_CLASSES

All classes belonging to this application.

Method Detail

nextTrack

@Kind("command")
@Name("next track")
void nextTrack()

Skip to the next track.

previousTrack

@Kind("command")
@Name("previous track")
void previousTrack()

Skip to the previous track.

playpause

@Kind("command")
@Name("playpause")
void playpause()

Toggle play/pause.

pause

@Kind("command")
@Name("pause")
void pause()

Pause playback.

play

@Kind("command")
@Name("play")
void play()

Resume playback.

playTrack

@Kind("command")
@Name("play track")
void playTrack(String theUriOfTheTrackToPlay,
               @Parameter("in context")
               String theUriOfTheContextToPlayIn)

Start playback of a track in the given context.

Parameters:

theUriOfTheTrackToPlay - the URI of the track to play

theUriOfTheContextToPlayIn - the URI of the context to play in

getCurrentTrack

@Code("pTrk")
@Kind("property")
@Name("current track")
@Type("track")
Track getCurrentTrack()

The current playing track.

Returns:

property value

getSoundVolume

@Code("pVol")
@Kind("property")
@Name("sound volume")
@Type("integer")
int getSoundVolume()

The sound output volume (0 = minimum, 100 = maximum).

Returns:

property value

setSoundVolume

@Code("pVol")
@Kind("property")
@Name("sound volume")
@Type("integer")
void setSoundVolume(int soundVolume)

The sound output volume (0 = minimum, 100 = maximum).

Parameters:

soundVolume - new property value

getPlayerState

@Code("pPlS")
@Kind("property")
@Name("player state")
@Type("ePlS")
Epls getPlayerState()

Is Spotify stopped, paused, or playing?

Returns:

property value

getPlayerPosition

@Code("pPos")
@Kind("property")
@Name("player position")
@Type("real")
double getPlayerPosition()

The player’s position within the currently playing track in seconds.

Returns:

property value

setPlayerPosition

@Code("pPos")
@Kind("property")
@Name("player position")
@Type("real")
void setPlayerPosition(double playerPosition)

The player’s position within the currently playing track in seconds.

Parameters:

playerPosition - new property value

isRepeatingEnabled

@Code("pReE")
@Kind("property")
@Name("repeating enabled")
@Type("boolean")
boolean isRepeatingEnabled()

Is repeating enabled in the current playback context?

Returns:

property value

isRepeating

@Code("pRep")
@Kind("property")
@Name("repeating")
@Type("boolean")
boolean isRepeating()

Is repeating on or off?

Returns:

property value

setRepeating

@Code("pRep")
@Kind("property")
@Name("repeating")
@Type("boolean")
void setRepeating(boolean repeating)

Is repeating on or off?

Parameters:

repeating - new property value

isShufflingEnabled

@Code("pReE")
@Kind("property")
@Name("shuffling enabled")
@Type("boolean")
boolean isShufflingEnabled()

Is shuffling enabled in the current playback context?

Returns:

property value

isShuffling

@Code("pShu")
@Kind("property")
@Name("shuffling")
@Type("boolean")
boolean isShuffling()

Is shuffling on or off?

Returns:

property value

setShuffling

@Code("pShu")
@Kind("property")
@Name("shuffling")
@Type("boolean")
void setShuffling(boolean shuffling)

Is shuffling on or off?

Parameters:

shuffling - new property value

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name of the application.

Returns:

property value

isFrontmost

@Code("pisf")
@Kind("property")
@Name("frontmost")
@Type("boolean")
boolean isFrontmost()

Is this the frontmost (active) application?

Returns:

property value

getVersion

@Code("vers")
@Kind("property")
@Name("version")
@Type("text")
String getVersion()

The version of the application.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties

getInstance

static Application getInstance()

Returns an instance for application Spotify.

Returns:

instance