org.intellimate.izou.sdk.frameworks.music.user

Class PlayerRequest

java.lang.Object

org.intellimate.izou.sdk.frameworks.music.user.PlayerRequest

public class PlayerRequest
extends Object

this is a simple class which should, added as a resource to an Event, request the Player to play the selected track or playlist.

To use this class the player has to meet a few criteria:

• the player must exist and be support the standard defined through the sdk
• the players-capabilities must allow requests from outside
• (maybe, depends on the create-method) the players-capabilities must allow a requests with specified a specified playlist/trackInfo

an example:

 

 Identification playerID;
 Playlist playlist;
 List<ResourceModel> resources = PlayerRequest.createPlayerRequest(playlist, player, this) //create a new PlayerRequest
          .map(PlayerRequest::resourcesForExisting) //creates the resources needed to add to the event
          .orElseGet(ArrayList::new);
 
 

Version:

1.0

Author:

LeanderK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlayerRequest(TrackInfo trackInfo, Playlist playlist, boolean permanent, Identification player, Capabilities capabilities, Context context, Identifiable identifiable) internal Constructor
protected	PlayerRequest(TrackInfo trackInfo, Playlist playlist, boolean permanent, Identification player, Capabilities capabilities, Context context, Identifiable identifiable, Volume volume) internal Constructor

Method Summary

Modifier and Type	Method and Description
static Optional<PlayerRequest>	createPlayerRequest(boolean permanent, Identification player, AddOnModule source) creates a new PlayerRequest.
static Optional<PlayerRequest>	createPlayerRequest(Playlist playlist, boolean permanent, Identification player, AddOnModule source) creates a new PlayerRequest.
static Optional<PlayerRequest>	createPlayerRequest(Playlist playlist, Identification player, AddOnModule source) creates a new PlayerRequest.
static Optional<PlayerRequest>	createPlayerRequest(TrackInfo trackInfo, boolean permanent, Identification player, AddOnModule source) creates a new PlayerRequest.
static Optional<PlayerRequest>	createPlayerRequest(TrackInfo trackInfo, Identification player, AddOnModule source) creates a new PlayerRequest.
List<ResourceModel>	resourcesForExisting() returns a List of Resources that can be added to an already existing event.
boolean	setVolume(Volume volume) sets the Volume if the Player supports it.
PlayerRequest	trySetVolume(Volume volume) tries to set the Volume of the PlayerRequest.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlayerRequest

protected PlayerRequest(TrackInfo trackInfo,
                        Playlist playlist,
                        boolean permanent,
                        Identification player,
                        Capabilities capabilities,
                        Context context,
                        Identifiable identifiable)

internal Constructor

Parameters:

trackInfo - the trackInfo

playlist - the playlist

permanent - whether the Request is permanent

player - the player

capabilities - the capabilities

context - the context

identifiable - the identifiable

PlayerRequest

protected PlayerRequest(TrackInfo trackInfo,
                        Playlist playlist,
                        boolean permanent,
                        Identification player,
                        Capabilities capabilities,
                        Context context,
                        Identifiable identifiable,
                        Volume volume)

internal Constructor

Parameters:

trackInfo - the trackInfo

playlist - the playlist

permanent - whether the Request is permanent

player - the player

capabilities - the capabilities

context - the Context

identifiable - the identifiable

volume - the Volume to set to

Method Detail

setVolume

public boolean setVolume(Volume volume)

sets the Volume if the Player supports it.

Parameters:

volume - the Volume to set to

Returns:

true if the Player supports setting the Volume

trySetVolume

public PlayerRequest trySetVolume(Volume volume)

tries to set the Volume of the PlayerRequest.

if the Player supports the Change of the Volume, it will create a new PlayerRequest and return it, if not it returns this.

Parameters:

volume - the Volume to set to

Returns:

a new PlayerRequest or this.

resourcesForExisting

public List<ResourceModel> resourcesForExisting()

returns a List of Resources that can be added to an already existing event.

This causes the Addon to block the Event in the OutputPlugin lifecycle of the Event.

Returns:

a List of Resources

createPlayerRequest

public static Optional<PlayerRequest> createPlayerRequest(boolean permanent,
                                                          Identification player,
                                                          AddOnModule source)

creates a new PlayerRequest.

For this method to return a non-empty Optional the following criteria must be met:

• the player must exist and be support the standard defined through the sdk
• the players-capabilities must allow requests from outside

Parameters:

permanent - true means the player can play indefinitely, but only if no one is currently using audio as permanent. It will also not block. false is limited to 10 minutes playback, but will block.

player - the player to target

source - the addOnModule used for Context etc.

Returns:

the optional PlayerRequest

createPlayerRequest

public static Optional<PlayerRequest> createPlayerRequest(TrackInfo trackInfo,
                                                          Identification player,
                                                          AddOnModule source)

creates a new PlayerRequest.

the resulting PlayerRequest is not permanent, which means that it will mute all other sound but is limited to 10 minutes.
For this method to return a non-empty Optional the following criteria must be met:

• the player must exist and be support the standard defined through the sdk
• the players-capabilities must allow requests from outside
• the players-capabilities must allow a requests with specified a specified playlist/trackInfo

Parameters:

trackInfo - the trackInfo to pass with the request

player - the player to target

source - the addOnModule used for Context etc.

Returns:

the optional PlayerRequest

createPlayerRequest

public static Optional<PlayerRequest> createPlayerRequest(TrackInfo trackInfo,
                                                          boolean permanent,
                                                          Identification player,
                                                          AddOnModule source)

creates a new PlayerRequest.

For this method to return a non-empty Optional the following criteria must be met:

• the player must exist and be support the standard defined through the sdk
• the players-capabilities must allow requests from outside
• the players-capabilities must allow a requests with specified a specified playlist/trackInfo

Parameters:

trackInfo - the trackInfo to pass with the request

permanent - true means the player can play indefinitely, but only if no one is currently using audio as permanent. It will also not block. false is limited to 10 minutes playback, but will block.

player - the player to target

source - the addOnModule used for Context etc.

Returns:

the optional PlayerRequest

createPlayerRequest

public static Optional<PlayerRequest> createPlayerRequest(Playlist playlist,
                                                          Identification player,
                                                          AddOnModule source)

creates a new PlayerRequest.

the resulting PlayerRequest is not permanent, which means that it will mute all other sound but is limited to 10 minutes.
For this method to return a non-empty Optional the following criteria must be met:

• the player must exist and be support the standard defined through the sdk
• the players-capabilities must allow requests from outside
• the players-capabilities must allow a requests with specified a specified playlist/trackInfo

Parameters:

playlist - the playlist to pass with the request

player - the player to target

source - the addOnModule used for Context etc.

Returns:

the optional PlayerRequest

createPlayerRequest

public static Optional<PlayerRequest> createPlayerRequest(Playlist playlist,
                                                          boolean permanent,
                                                          Identification player,
                                                          AddOnModule source)

creates a new PlayerRequest.

For this method to return a non-empty Optional the following criteria must be met:

• the player must exist and be support the standard defined through the sdk
• the players-capabilities must allow requests from outside
• the players-capabilities must allow a requests with specified a specified playlist/trackInfo

Parameters:

playlist - the playlist to pass with the request

permanent - true means the player can play indefinitely, but only if no one is currently using audio as permanent. It will also not block. false is limited to 10 minutes playback, but will block.

player - the player to target

source - the addOnModule used for Context etc.

Returns:

the optional PlayerRequest