DeviceCenter

org.ocast.sdk.core.DeviceCenter

```
public class DeviceCenter
```
This class is the entry point to discover and use OCast devices.
In order to receive discovery events, you first need to register a device class by calling the registerDevice(@NotNull Class deviceClass) method. Then add a interface DeviceListener with addDeviceListener(@NotNull DeviceListener listener) and start the discovery with resumeDiscovery().

See Also:

interface DeviceListener

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeviceCenter.Companion
The companion object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeviceCenter.Companion` The companion object.

Field Summary

Fields
Modifier and Type	Field and Description
`static DeviceCenter.Companion`	`Companion` The companion object.
`static long`	`DEFAULT_DISCOVERY_INTERVAL` The default value for the discovery interval.
`static long`	`MINIMUM_DISCOVERY_INTERVAL` The minimum value for the discovery interval.

Constructor Summary

Constructors
Constructor and Description

DeviceCenter()
Creates an instance of class DeviceCenter.

Constructors
Constructor and Description
`DeviceCenter()` Creates an instance of `class DeviceCenter`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDeviceListener(DeviceListener listener)` Adds a listener for the device events.
`void`	`addEventListener(EventListener listener)` Adds a listener for the OCast protocol events.
`CallbackWrapper`	`getCallbackWrapper()` The callback wrapper.
`java.util.List<org.ocast.sdk.core.Device>`	`getDevices()` The list of detected OCast devices.
`long`	`getDiscoveryInterval()` The interval to refresh the devices, in milliseconds.
`protected void`	`onAddDevice(Device device)` This method is called when an OCast device has been created and before it is added to the list of detected devices.
`protected void`	`onRemoveDevice(Device device)` This method is called before an OCast device is removed from the list of detected devices.
`boolean`	`pauseDiscovery()` Pauses the discovery process.
`void`	`registerDevice(java.lang.Class<? extends org.ocast.sdk.core.Device> deviceClass)` Registers a class of devices to discover.
`void`	`removeDeviceListener(DeviceListener listener)` Removes a listener which has been previously added with the `addDeviceListener(@NotNull EventListener listener)` method.
`void`	`removeEventListener(EventListener listener)` Removes a listener which has been previously added with the `addEventListener(@NotNull EventListener listener)` method.
`boolean`	`resumeDiscovery()` Resumes the discovery process.
`void`	`setCallbackWrapper(CallbackWrapper value)` The callback wrapper.
`void`	`setDiscoveryInterval(long value)` The interval to refresh the devices, in milliseconds.
`boolean`	`stopDiscovery()` Stops the discovery process.

- Field Detail
  - DEFAULT_DISCOVERY_INTERVAL
```
public static long DEFAULT_DISCOVERY_INTERVAL
```
    The default value for the discovery interval.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_DISCOVERY_INTERVAL
```
public static long MINIMUM_DISCOVERY_INTERVAL
```
    The minimum value for the discovery interval.
    
    See Also:
    
    Constant Field Values
  - Companion
```
public static DeviceCenter.Companion Companion
```
    The companion object.
- Constructor Detail
  - DeviceCenter
```
public DeviceCenter()
```
    Creates an instance of class DeviceCenter.
    
    See Also:
    
    class DeviceCenter
- Method Detail
  - getCallbackWrapper
```
@NotNull
public CallbackWrapper getCallbackWrapper()
```
    The callback wrapper.
  - setCallbackWrapper
```
public void setCallbackWrapper(@NotNull
                               CallbackWrapper value)
```
    The callback wrapper.
  - getDevices
```
@NotNull
public java.util.List<org.ocast.sdk.core.Device> getDevices()
```
    The list of detected OCast devices.
  - getDiscoveryInterval
```
public long getDiscoveryInterval()
```
    The interval to refresh the devices, in milliseconds.
    Minimum value is 5000 milliseconds. Setting this property results in sending an SSDP M-SEARCH request immediately if discovery is on-going.
  - setDiscoveryInterval
```
public void setDiscoveryInterval(long value)
```
    The interval to refresh the devices, in milliseconds.
    Minimum value is 5000 milliseconds. Setting this property results in sending an SSDP M-SEARCH request immediately if discovery is on-going.
  - onAddDevice
```
protected void onAddDevice(@NotNull
                           Device device)
```
    This method is called when an OCast device has been created and before it is added to the list of detected devices.
    Default implementation does nothing. This method is meant to be overridden by subclasses.
    
    Parameters:
    
    device - The device to add.
  - onRemoveDevice
```
protected void onRemoveDevice(@NotNull
                              Device device)
```
    This method is called before an OCast device is removed from the list of detected devices.
    Default implementation does nothing. This method is meant to be overridden by subclasses.
    
    Parameters:
    
    device - The device to remove.
  - registerDevice
```
public void registerDevice(@NotNull
                           java.lang.Class<? extends org.ocast.sdk.core.Device> deviceClass)
```
    Registers a class of devices to discover.
    
    Parameters:
    
    deviceClass - The class of devices that will be searched during the discovery process.
  - addEventListener
```
public void addEventListener(@NotNull
                             EventListener listener)
```
    Adds a listener for the OCast protocol events.
    
    Parameters:
    
    listener - The listener to add.
  - removeEventListener
```
public void removeEventListener(@NotNull
                                EventListener listener)
```
    Removes a listener which has been previously added with the addEventListener(@NotNull EventListener listener) method.
    
    Parameters:
    
    listener - The listener to remove.
  - addDeviceListener
```
public void addDeviceListener(@NotNull
                              DeviceListener listener)
```
    Adds a listener for the device events.
    
    Parameters:
    
    listener - The listener to add.
  - removeDeviceListener
```
public void removeDeviceListener(@NotNull
                                 DeviceListener listener)
```
    Removes a listener which has been previously added with the addDeviceListener(@NotNull EventListener listener) method.
    
    Parameters:
    
    listener - The listener to remove.
  - resumeDiscovery
```
public boolean resumeDiscovery()
```
    Resumes the discovery process.
    Newly initialized instances of class DeviceCenter begin in a paused state, so you need to call this method to start the discovery.
    
    Returns:
    
    true if the discovery was successfully resumed, false if there was an issue or if the discovery was already running.
    
    See Also:
    
    class DeviceCenter
  - stopDiscovery
```
public boolean stopDiscovery()
```
    Stops the discovery process.
    This clears the list of detected devices if the discovery was not in a paused state.
    
    Returns:
    
    true if the discovery was successfully stopped, false if the discovery was already stopped.
  - pauseDiscovery
```
public boolean pauseDiscovery()
```
    Pauses the discovery process.
    This does not clear the list of detected devices.
    
    Returns:
    
    true if the discovery was successfully paused, false if the discovery was not running.

Class DeviceCenter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

DEFAULT_DISCOVERY_INTERVAL

MINIMUM_DISCOVERY_INTERVAL

Companion

Constructor Detail

DeviceCenter

Method Detail

getCallbackWrapper

setCallbackWrapper

getDevices

getDiscoveryInterval

setDiscoveryInterval

onAddDevice

onRemoveDevice

registerDevice

addEventListener

removeEventListener

addDeviceListener

removeDeviceListener

resumeDiscovery

stopDiscovery

pauseDiscovery