- Channel - Class in com.samsung.multiscreen
-
Base communication channel for MultiScreen-enabled devices.
- Channel.OnClientConnectListener - Interface in com.samsung.multiscreen
-
Interface to listen for client connect events, when clients
join the specified channel.
- Channel.OnClientDisconnectListener - Interface in com.samsung.multiscreen
-
Interface to listen for client disconnect events, when clients
leave the specified channel.
- Channel.OnConnectListener - Interface in com.samsung.multiscreen
-
Interface to listen for connect events.
- Channel.OnDisconnectListener - Interface in com.samsung.multiscreen
-
Interface to listen for disconnect events.
- Channel.OnErrorListener - Interface in com.samsung.multiscreen
-
Interface to listen for error events.
- Channel.OnMessageListener - Interface in com.samsung.multiscreen
-
Interface to listen for user-defined event messages on the specified
channel.
- Channel.OnReadyListener - Interface in com.samsung.multiscreen
-
Deprecated.
- clearList() - Method in class com.samsung.multiscreen.AudioPlayer
-
public API to delete whole list.
- clearList() - Method in class com.samsung.multiscreen.PhotoPlayer
-
public API to delete whole list.
- clearList() - Method in class com.samsung.multiscreen.VideoPlayer
-
public API to delete whole queue.
- clearStandbyDeviceList() - Method in class com.samsung.multiscreen.Search
-
Clears standby device list from the device.
- Client - Class in com.samsung.multiscreen
-
Encapsulates a client subscribed to the the specified
Channel
.
- Clients - Class in com.samsung.multiscreen
-
Provides convenience methods for working with a set of
Client
s
subscribed to the specified channel.
- com.samsung.multiscreen - package com.samsung.multiscreen
-
Contains classes for using the MultiScreen SDK Android API
- connect(Map<String, String>, Result<Client>) - Method in class com.samsung.multiscreen.Application
-
Connect to the specified channel.
- connect() - Method in class com.samsung.multiscreen.Channel
-
Connect to the specified channel.
- connect(Result<Client>) - Method in class com.samsung.multiscreen.Channel
-
Connect to the specified channel.
- connect(Map<String, String>, Result<Client>) - Method in class com.samsung.multiscreen.Channel
-
Connect to the specified channel.
- connect(Uri, Map<String, String>, Result<Client>) - Method in class com.samsung.multiscreen.Channel
-
- create(Context) - Static method in class com.samsung.multiscreen.BLESearchProvider
-
Create an instance of the BLESearchProvider
.
- create(Context) - Static method in class com.samsung.multiscreen.MDNSSearchProvider
-
Create an instance of the MDNSSearchProvider
.
- create(Context) - Static method in class com.samsung.multiscreen.MSFDSearchProvider
-
Create an instance of the MSFDSearchProvider
.
- createApplication(Uri, String) - Method in class com.samsung.multiscreen.Service
-
Create an application with the given uri and channel id.
- createApplication(Uri, String, Map<String, Object>) - Method in class com.samsung.multiscreen.Service
-
Create an application with the given uri and channel id.
- createApplication(String, String) - Method in class com.samsung.multiscreen.Service
-
Create an application with the given app and channel id.
- createApplication(String, String, Map<String, Object>) - Method in class com.samsung.multiscreen.Service
-
Create an application with the given app and channel id.
- createAudioPlayer(String) - Method in class com.samsung.multiscreen.Service
-
Create an Audio Player with the service id
- createChannel(Uri) - Method in class com.samsung.multiscreen.Service
-
Create a channel with the given uri.
- createPhotoPlayer(String) - Method in class com.samsung.multiscreen.Service
-
Create an Photo Player with the service id
- createVideoPlayer(String) - Method in class com.samsung.multiscreen.Service
-
Create an Video Player with the service id
- get(String) - Method in class com.samsung.multiscreen.Clients
-
Returns the client with the specified client id.
- getAttributes() - Method in class com.samsung.multiscreen.Client
-
Returns a map of attributes associated with this client.
- getById(Context, String, Result<Service>) - Static method in class com.samsung.multiscreen.Service
-
Retrieve the service given by the specified id.
- getByURI(Uri, Result<Service>) - Static method in class com.samsung.multiscreen.Service
-
Retrieve the service given by the specified uri.
- getByURI(Uri, int, Result<Service>) - Static method in class com.samsung.multiscreen.Service
-
Retrieve the service given by the specified uri.
- getChannel() - Method in class com.samsung.multiscreen.Client
-
Returns the channel associated with this client.
- getChannel() - Method in class com.samsung.multiscreen.Clients
-
The channel associated with the clients.
- getChannel() - Method in class com.samsung.multiscreen.Message
-
Returns the channel that this message is associated with.
- getClients() - Method in class com.samsung.multiscreen.Channel
-
Retrieve the clients subscribed to this channel.
- getCode() - Method in class com.samsung.multiscreen.Error
-
Returns the error code associated with this error.
- getConnectTime() - Method in class com.samsung.multiscreen.Client
-
Returns the time in milliseconds since epoch that this client connected
to the channel.
- getControlStatus() - Method in class com.samsung.multiscreen.Player
-
fetches the control status - volume, mute, shuffle and repeat
- getCountryCode() - Method in class com.samsung.multiscreen.Device
-
Returns the country code for this device.
- getData() - Method in class com.samsung.multiscreen.Message
-
The data for this message.
- getDescription() - Method in class com.samsung.multiscreen.Device
-
Returns a description for this device.
- getDeviceInfo(Result<Device>) - Method in class com.samsung.multiscreen.Service
-
Retrieve the underlying device information for the specified service.
- getDuid() - Method in class com.samsung.multiscreen.Device
-
Returns the device unique id.
- getEvent() - Method in class com.samsung.multiscreen.Message
-
Returns the channel event for this message.
- getFirmwareVersion() - Method in class com.samsung.multiscreen.Device
-
Returns the firmware version for this device.
- getFrom() - Method in class com.samsung.multiscreen.Message
-
The originating client for this message.
- getHost() - Method in class com.samsung.multiscreen.Clients
-
Returns the host for the channel associated with these clients.
- getId() - Method in class com.samsung.multiscreen.ApplicationInfo
-
Returns the id of the application.
- getId() - Method in class com.samsung.multiscreen.Channel
-
This channel's id.
- getId() - Method in class com.samsung.multiscreen.Client
-
Returns the unique id for this client.
- getId() - Method in class com.samsung.multiscreen.Device
-
Returns the id for this device.
- getId() - Method in class com.samsung.multiscreen.Service
-
Returns the id for this service.
- getInfo(Result<ApplicationInfo>) - Method in class com.samsung.multiscreen.Application
-
Retrieve information for the specified application.
- getIp() - Method in class com.samsung.multiscreen.Device
-
Returns the ip address for this device.
- getIsSecureModeSupported() - Method in class com.samsung.multiscreen.Service
-
Returns whether secure mode is supported by service.
- getIsStandbyService() - Method in class com.samsung.multiscreen.Service
-
Returns if this service is a service for standby device or not.
- getIsSupport() - Method in class com.samsung.multiscreen.Service
-
Returns the support features for this service.
- getList() - Method in class com.samsung.multiscreen.AudioPlayer
-
public API to fetch the list.
- getList() - Method in class com.samsung.multiscreen.PhotoPlayer
-
public API to fetch the list.
- getList() - Method in class com.samsung.multiscreen.VideoPlayer
-
public API to fetch the queue.
- getMessage() - Method in class com.samsung.multiscreen.Error
-
Returns the message associated with this error.
- getModel() - Method in class com.samsung.multiscreen.Device
-
Returns the model for this device.
- getName() - Method in class com.samsung.multiscreen.ApplicationInfo
-
Returns the name of the application.
- getName() - Method in class com.samsung.multiscreen.Device
-
Returns the name for this device.
- getName() - Method in class com.samsung.multiscreen.Error
-
Returns the name for this error.
- getName() - Method in class com.samsung.multiscreen.Service
-
Returns the name for this service.
- getNetworkType() - Method in class com.samsung.multiscreen.Device
-
Returns the network type this device is connected through.
- getPayload() - Method in class com.samsung.multiscreen.Message
-
The binary payload for this message.
- getPlatform() - Method in class com.samsung.multiscreen.Device
-
Returns platform name for this device.
- getResolution() - Method in class com.samsung.multiscreen.Device
-
Returns the resolution for this device.
- getServices() - Method in class com.samsung.multiscreen.Search
-
The list of services found during the search process.
- getServices() - Method in class com.samsung.multiscreen.SearchProvider
-
The list of services found with this provider.
- getSsid() - Method in class com.samsung.multiscreen.Device
-
Returns the ssid for this device.
- getType() - Method in class com.samsung.multiscreen.Service
-
Returns the type for this service.
- getUdn() - Method in class com.samsung.multiscreen.Device
-
Returns the unique device number for this device.
- getUri() - Method in class com.samsung.multiscreen.Channel
-
This channel's uri.
- getUri() - Method in class com.samsung.multiscreen.Service
-
Returns the endpoint uri for this service.
- getVersion() - Method in class com.samsung.multiscreen.ApplicationInfo
-
Returns the version of the application.
- getVersion() - Method in class com.samsung.multiscreen.Service
-
Returns the version for this service.
- getWifiMac() - Method in class com.samsung.multiscreen.Device
-
Returns wifi mac address for this device.
- install(Result<Boolean>) - Method in class com.samsung.multiscreen.Application
-
Install the specified application.
- isConnected() - Method in class com.samsung.multiscreen.Application
-
Returns if the channel is connected and the host is ready to listen
for messages.
- isConnected() - Method in class com.samsung.multiscreen.Channel
-
This only tracks websocket connection.
- isConnected() - Method in class com.samsung.multiscreen.Player
-
Returns if the channel is connected and the host is ready to listen
for messages.
- isDebug() - Method in class com.samsung.multiscreen.Channel
-
Get whether debug is set.
- isDebug() - Method in class com.samsung.multiscreen.Player
-
Get whether debug is set.
- isDMPSupported(Result<Boolean>) - Method in class com.samsung.multiscreen.Service
-
Checks whether support for DMP feature is provided or not
- isHost() - Method in class com.samsung.multiscreen.Client
-
Returns whether this client is the host.
- isMe(Client) - Method in class com.samsung.multiscreen.Clients
-
Checks if the specified client is your client.
- isRunning() - Method in class com.samsung.multiscreen.ApplicationInfo
-
Returns true if the application is running on the service.
- isSearching() - Method in class com.samsung.multiscreen.Search
-
Returns if any search is in progress.
- isSearchingBle() - Method in class com.samsung.multiscreen.Search
-
Returns if any BLE search is in progress.
- isSecurityMode() - Method in class com.samsung.multiscreen.Channel
-
Retrieve whether security mode was set or not
- isSupportBle() - Method in class com.samsung.multiscreen.Search
-
Checks whether BLE is supported.
- isWebapp() - Method in class com.samsung.multiscreen.Application
-
Returns whether the specified application is a web application.
- pause() - Method in class com.samsung.multiscreen.Player
-
Pause Content
- PhotoPlayer - Class in com.samsung.multiscreen
-
The
PhotoPlayer
class allows control Photo Player on TV side.
- PhotoPlayer.OnPhotoPlayerListener - Interface in com.samsung.multiscreen
-
Public Listener Interface for Photo Player Notice events
- play() - Method in class com.samsung.multiscreen.Player
-
Play Content
- playContent(Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.AudioPlayer
-
public API to play audio content
- playContent(Uri, String, String, Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.AudioPlayer
-
public API to play audio content
- playContent(Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.PhotoPlayer
-
public API to play photo content
- playContent(Uri, String, Result<Boolean>) - Method in class com.samsung.multiscreen.PhotoPlayer
-
public API to play photo content
- playContent(Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.VideoPlayer
-
public API to play video content
- playContent(Uri, String, Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.VideoPlayer
-
public API to play video content
- Player - Class in com.samsung.multiscreen
-
The
Player
class allows control Default Media Player (DMP) on TV side.
- Player.RepeatMode - Enum in com.samsung.multiscreen
-
Defines all possible values for Repeat.
- previous() - Method in class com.samsung.multiscreen.Player
-
Launch Previous Content
- PROPERTY_MESSAGE_ID - Static variable in class com.samsung.multiscreen.Message
-
- PROPERTY_VALUE_LIBRARY - Static variable in class com.samsung.multiscreen.Application
-
- publish(String, Object) - Method in class com.samsung.multiscreen.Channel
-
Send a message to the host on this channel.
- publish(String, Object, byte[]) - Method in class com.samsung.multiscreen.Channel
-
Send a message and (binary) payload to the host on this channel.
- publish(String, Object, String) - Method in class com.samsung.multiscreen.Channel
-
Send a message on this channel.
- publish(String, Object, String, byte[]) - Method in class com.samsung.multiscreen.Channel
-
Send a message and (binary) payload on this channel.
- publish(String, Object, Client) - Method in class com.samsung.multiscreen.Channel
-
Send a message to the specified client on this channel.
- publish(String, Object, Client, byte[]) - Method in class com.samsung.multiscreen.Channel
-
Send a message and (binary) payload to the specified client on this channel.
- publish(String, Object, List<Client>) - Method in class com.samsung.multiscreen.Channel
-
Send a message to the specified clients on this channel.
- publish(String, Object, List<Client>, byte[]) - Method in class com.samsung.multiscreen.Channel
-
Send a message and (binary) payload to the specified client on this channel.
- remove() - Method in class com.samsung.multiscreen.Service
-
Removes standby device service from standby device list.
- removeAllListeners() - Method in class com.samsung.multiscreen.Channel
-
Remove all listeners from this channel.
- removeAllProviders() - Method in class com.samsung.multiscreen.Search
-
Remove all search providers.
- removeFromList(Uri) - Method in class com.samsung.multiscreen.AudioPlayer
-
public API to delete content from list.
- removeFromList(Uri) - Method in class com.samsung.multiscreen.PhotoPlayer
-
public API to delete content from list.
- removeFromList(Uri) - Method in class com.samsung.multiscreen.VideoPlayer
-
public API to delete content from queue.
- removeOnMessageListener(String, Channel.OnMessageListener) - Method in class com.samsung.multiscreen.Channel
-
Remove the specified message listener subscribed to the event on this channel.
- removeOnMessageListeners(String) - Method in class com.samsung.multiscreen.Channel
-
Remove all message listeners subscribed to the given event on this channel.
- removeOnMessageListeners() - Method in class com.samsung.multiscreen.Channel
-
Remove all message listeners on this channel.
- removePlayerWatermark() - Method in class com.samsung.multiscreen.Player
-
Removes watermark from player.
- removeProvider(SearchProvider) - Method in class com.samsung.multiscreen.Search
-
Removes the specified search provider
- repeat() - Method in class com.samsung.multiscreen.AudioPlayer
-
toggles repeat mode on/off
- repeat() - Method in class com.samsung.multiscreen.VideoPlayer
-
toggles repeat mode on/off
- Result<T> - Interface in com.samsung.multiscreen
-
Generic interface for MultiScreen communication callbacks.
- resumeApplicationInForeground() - Method in class com.samsung.multiscreen.Player
-
resumes TV widget/application from background process.
- rewind() - Method in class com.samsung.multiscreen.VideoPlayer
-
Rewind Content
- ROUTE_APPLICATION - Static variable in class com.samsung.multiscreen.Application
-
- ROUTE_WEBAPPLICATION - Static variable in class com.samsung.multiscreen.Application
-
- Search - Class in com.samsung.multiscreen
-
Provides management facilities for discovering MultiScreen-enabled
Service
s.
- search(Context) - Static method in class com.samsung.multiscreen.Service
-
Get an instance of
Search
for service discovery.
- Search.OnBleFoundListener - Interface in com.samsung.multiscreen
-
Interface to listen for TV found events using BLE.
- Search.OnServiceFoundListener - Interface in com.samsung.multiscreen
-
Interface to listen for service found events.
- Search.OnServiceLostListener - Interface in com.samsung.multiscreen
-
Interface to listen for service lost events.
- Search.OnStartListener - Interface in com.samsung.multiscreen
-
Interface to listen for search start events.
- Search.OnStopListener - Interface in com.samsung.multiscreen
-
Interface to listen for search stop events.
- SearchProvider - Class in com.samsung.multiscreen
-
SearchProvider
is the base search provider class.
- seekTo(int, TimeUnit) - Method in class com.samsung.multiscreen.AudioPlayer
-
seeks audio to specified time position.
- seekTo(int, TimeUnit) - Method in class com.samsung.multiscreen.VideoPlayer
-
seeks video to specified time position.
- Service - Class in com.samsung.multiscreen
-
Encapsulates a MultiScreen-enabled service.
- setBackgroundMusic(Uri) - Method in class com.samsung.multiscreen.PhotoPlayer
-
sets background audio in slide show.
- setConnectionTimeout(int) - Method in class com.samsung.multiscreen.Channel
-
Sets the interval for checking the channel connection.
- setDebug(boolean) - Method in class com.samsung.multiscreen.Channel
-
Get whether debug is set.
- setDebug(boolean) - Method in class com.samsung.multiscreen.Player
-
Get whether debug is set.
- setIsSecureModeSupported(Service.SecureModeState) - Method in class com.samsung.multiscreen.Service
-
Returns whether secure mode is supported by service.
- setOnBleFoundListener(Search.OnBleFoundListener) - Method in class com.samsung.multiscreen.Search
-
Set the listener for service found events using BLE.
- setOnClientConnectListener(Channel.OnClientConnectListener) - Method in class com.samsung.multiscreen.Channel
-
Set the listener for client connect (subscribe) events.
- setOnClientConnectListener(Channel.OnClientConnectListener) - Method in class com.samsung.multiscreen.Player
-
Set channel client connect Listener
- setOnClientDisconnectListener(Channel.OnClientDisconnectListener) - Method in class com.samsung.multiscreen.Channel
-
Set the listener for client disconnect (unsubscribe) events.
- setOnClientDisconnectListener(Channel.OnClientDisconnectListener) - Method in class com.samsung.multiscreen.Player
-
Set channel client disconnect Listener
- setOnConnectListener(Channel.OnConnectListener) - Method in class com.samsung.multiscreen.Application
-
- setOnConnectListener(Channel.OnConnectListener) - Method in class com.samsung.multiscreen.Channel
-
Set the listener for connect events.
- setOnConnectListener(Channel.OnConnectListener) - Method in class com.samsung.multiscreen.Player
-
Set connect channel Listener
- setOnDisconnectListener(Channel.OnDisconnectListener) - Method in class com.samsung.multiscreen.Channel
-
Set the listener for disconnect events.
- setOnDisconnectListener(Channel.OnDisconnectListener) - Method in class com.samsung.multiscreen.Player
-
Set disconnect channel Listener
- setOnErrorListener(Channel.OnErrorListener) - Method in class com.samsung.multiscreen.Channel
-
Set the listener for error events.
- setOnErrorListener(Channel.OnErrorListener) - Method in class com.samsung.multiscreen.Player
-
Remove all listeners from remote control channel.
- setOnReadyListener(Channel.OnReadyListener) - Method in class com.samsung.multiscreen.Channel
-
Deprecated.
- setOnReadyListener(Channel.OnReadyListener) - Method in class com.samsung.multiscreen.Player
-
Set ready channel Listener
- setOnServiceFoundListener(Search.OnServiceFoundListener) - Method in class com.samsung.multiscreen.Search
-
Set the listener for service found events.
- setOnServiceLostListener(Search.OnServiceLostListener) - Method in class com.samsung.multiscreen.Search
-
Set the listener for service lost events.
- setOnStartListener(Search.OnStartListener) - Method in class com.samsung.multiscreen.Search
-
Set the listener for start (search) events.
- setOnStopListener(Search.OnStopListener) - Method in class com.samsung.multiscreen.Search
-
Set the listener for stop (search) events.
- setPlayerWatermark(Uri) - Method in class com.samsung.multiscreen.Player
-
Sets watermark on player's screen.
- setRepeat(Player.RepeatMode) - Method in class com.samsung.multiscreen.AudioPlayer
-
sets repeat mode to ON or OFF
- setRepeat(Player.RepeatMode) - Method in class com.samsung.multiscreen.VideoPlayer
-
sets repeat mode to ON or OFF
- setSecurityMode(boolean, Result<Boolean>) - Method in class com.samsung.multiscreen.Channel
-
Set security mode status to for web socket connection or rest API
- setShuffle(boolean) - Method in class com.samsung.multiscreen.AudioPlayer
-
sets shuffle mode to ON (true) or OFF (false)
- setVolume(int) - Method in class com.samsung.multiscreen.Player
-
sets the volume
- shuffle() - Method in class com.samsung.multiscreen.AudioPlayer
-
toggles shuffle mode on/off
- size() - Method in class com.samsung.multiscreen.Clients
-
Returns the number of clients connected to the associated channel.
- standbyConnect(Result<Boolean>) - Method in class com.samsung.multiscreen.Player
-
Establish DMP Connection with a standby screen.
- standbyConnect(Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.Player
-
Establish DMP Connection with a standby screen.
- standbyConnect(Uri, Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.Player
-
Establish DMP Connection with a standby screen.
- standbyConnect(Uri, Uri, Uri, Result<Boolean>) - Method in class com.samsung.multiscreen.Player
-
Establish DMP Connection with a standby screen.
- start(Result<Boolean>) - Method in class com.samsung.multiscreen.Application
-
Start or launch the specified application.
- start() - Method in class com.samsung.multiscreen.BLESearchProvider
-
- start() - Method in class com.samsung.multiscreen.MDNSSearchProvider
-
- start() - Method in class com.samsung.multiscreen.MSFDSearchProvider
-
- start() - Method in class com.samsung.multiscreen.Search
-
Start the search process.
- start(Boolean) - Method in class com.samsung.multiscreen.Search
-
Start the search process.
- start() - Method in class com.samsung.multiscreen.SearchProvider
-
Start a search using this provider.
- startUsingBle() - Method in class com.samsung.multiscreen.Search
-
Start the ble search process.
- stop(Result<Boolean>) - Method in class com.samsung.multiscreen.Application
-
Stop the specified application.
- stop() - Method in class com.samsung.multiscreen.BLESearchProvider
-
- stop() - Method in class com.samsung.multiscreen.MDNSSearchProvider
-
- stop() - Method in class com.samsung.multiscreen.MSFDSearchProvider
-
- stop() - Method in class com.samsung.multiscreen.Player
-
Stop Content
- stop() - Method in class com.samsung.multiscreen.Search
-
Stop the search process.
- stop() - Method in class com.samsung.multiscreen.SearchProvider
-
Stop a search using this provider.
- stopBackgroundMusic() - Method in class com.samsung.multiscreen.PhotoPlayer
-
stops background audio in slide show.
- stopUsingBle() - Method in class com.samsung.multiscreen.Search
-
Stop the search process.
- SUPPORT_DMP - Static variable in class com.samsung.multiscreen.Service
-