Skip navigation links
A B C D E G H I J L M O P R S T U W 

A

addDeviceListener(listener) - Method in class org.ocast.sdk.core.DeviceCenter
Adds a listener for the device events.
addEventListener(listener) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Adds a listener for the OCast protocol events.
addEventListener(listener) - Method in class org.ocast.sdk.core.DeviceCenter
Adds a listener for the OCast protocol events.
addMediaRouterCallback(mediaRouterCallback) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Adds a media router callback.
Axis(x, y, type) - Constructor for class org.ocast.sdk.core.models.SendGamepadEventCommandParams.Axis
Represents a gamepad axis.
Axis.Type - Enum in org.ocast.sdk.core.models
Represents a type of axis.

B

Bitflag - Interface in org.ocast.sdk.core.models
This interface is implemented by enums which represent bitflags.
BitflagsDeserializer<T extends Enum<T> & Bitflag> - Class in org.ocast.sdk.core.utils
A deserializer that deserializes an integer which represents bitflags to an EnumSet.
BitflagsDeserializer(clazz) - Constructor for class org.ocast.sdk.core.utils.BitflagsDeserializer
Creates an instance of class BitflagsDeserializer.
BitflagsSerializer<T extends Enum<T> & Bitflag> - Class in org.ocast.sdk.core.utils
A serializer that serializes an EnumSet to an integer which represents bitflags.
BitflagsSerializer() - Constructor for class org.ocast.sdk.core.utils.BitflagsSerializer
Creates an instance of class BitflagsSerializer.
BooleanExtKt - Class in org.ocast.sdk.common.extensions
 
build() - Method in class org.ocast.sdk.core.models.OCastCommandParams
Builds an instance of class OCastDataLayer from the command parameters and options.
BUILD_TYPE - Static variable in class org.ocast.mediaroute.BuildConfig
 
BuildConfig - Class in org.ocast.mediaroute
 

C

CallbackWrapper - Interface in org.ocast.sdk.core.wrapper
An interface which is implemented by objects that wrap callbacks.
Companion - Static variable in class org.ocast.sdk.core.DeviceCenter
The companion object.
Companion - Static variable in interface org.ocast.sdk.core.models.ErrorStatus
The companion object.
Companion - Static variable in class org.ocast.sdk.core.models.Event.Device
The companion object.
Companion - Static variable in class org.ocast.sdk.core.models.Event.Media
The companion object.
Companion - Static variable in class org.ocast.sdk.core.models.Service
The companion object.
Companion - Static variable in class org.ocast.sdk.core.models.SettingsService
The companion object.
Companion - Static variable in class org.ocast.sdk.core.ReferenceDevice
Deprecated. 
Companion - Static variable in class org.ocast.sdk.core.utils.OCastLog
The companion object.
Companion - Static variable in class org.ocast.sdk.core.WebSocket
The companion object.
component1() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
The error status.
component1() - Method in class org.ocast.sdk.core.models.OCastError
The error code.
component1() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
The error status.
component1() - Method in class org.ocast.sdk.core.models.OCastMediaError
The error status.
component1() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The identifier of the device.
component2() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
The error message.
component2() - Method in class org.ocast.sdk.core.models.OCastError
The error message.
component2() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
The error message.
component2() - Method in class org.ocast.sdk.core.models.OCastMediaError
The error message.
component2() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The URL of the DIAL service.
component3() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
The cause of the error,
component3() - Method in class org.ocast.sdk.core.models.OCastError
The cause of the error,
component3() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
The cause of the error,
component3() - Method in class org.ocast.sdk.core.models.OCastMediaError
The cause of the error,
component3() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The friendly name of the device.
component4() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The manufacturer of the device.
component5() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The model name.
connect(sslConfiguration, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Connects to the device.
connect(sslConfiguration, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
connect() - Method in class org.ocast.sdk.core.WebSocket
Connects the web socket to the remote host.
Consumer<T> - Interface in org.ocast.sdk.core.models
Represents an operation that accepts a single input argument and returns no result.
ConsumerCallback<T> - Class in org.ocast.sdk.core.models
Represents a callback for an asynchronous task, with a interface Consumer of T as the success operation.
ConsumerCallback(onSuccess, onError) - Constructor for class org.ocast.sdk.core.models.ConsumerCallback
Creates an instance of class ConsumerCallback.
copy(status, message, cause) - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
Creates an instance of class OCastDeviceSettingsError.
copy(code, message, cause) - Method in class org.ocast.sdk.core.models.OCastError
Creates an class OCastError.
copy(status, message, cause) - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
copy(status, message, cause) - Method in class org.ocast.sdk.core.models.OCastMediaError
copy(id, dialURL, friendlyName, manufacturer, modelName) - Method in class org.ocast.sdk.discovery.models.UpnpDevice
Creates an instance of class UpnpDevice.
createWebSocket() - Method in class org.ocast.sdk.core.WebSocket
Creates and returns a web socket.

D

DEBUG - Static variable in class org.ocast.mediaroute.BuildConfig
 
debug(message) - Method in class org.ocast.sdk.core.utils.OCastLog.Companion
Logs a debug message.
debug(message) - Static method in class org.ocast.sdk.core.utils.OCastLog
Logs a debug message.
decode(json, clazz) - Method in class org.ocast.sdk.core.utils.JsonTools
Decodes a JSON string to an object.
DEFAULT_DISCOVERY_INTERVAL - Static variable in class org.ocast.sdk.core.DeviceCenter
The default value for the discovery interval.
deserialize(p, ctxt) - Method in class org.ocast.sdk.core.utils.BitflagsDeserializer
 
deserialize(parser, context) - Method in class org.ocast.sdk.core.utils.RawJsonDeserializer
 
Device - Class in org.ocast.sdk.core
Represents a remote OCast device.
Device() - Constructor for class org.ocast.sdk.core.models.Event.Device
Represents a device settings event.
Device.Companion - Class in org.ocast.sdk.core.models
The companion object.
Device.State - Enum in org.ocast.sdk.core
Represents the state of an OCast device.
DeviceCenter - Class in org.ocast.sdk.core
This class is the entry point to discover and use OCast devices.
DeviceCenter() - Constructor for class org.ocast.sdk.core.DeviceCenter
Creates an instance of class DeviceCenter.
DeviceCenter.Companion - Class in org.ocast.sdk.core
The companion object.
DeviceID - Class in org.ocast.sdk.core.models
Represents the device identifier.
DeviceID(id) - Constructor for class org.ocast.sdk.core.models.DeviceID
Creates an instance of class DeviceID.
DeviceListener - Interface in org.ocast.sdk.core
Represents a listener of events related to devices and discovery.
DeviceListener.DefaultImpls - Class in org.ocast.sdk.core
Represents a listener of events related to devices and discovery.
DeviceMessage<T> - Class in org.ocast.sdk.core.models
Represents a public settings device message.
DeviceMessage(data) - Constructor for class org.ocast.sdk.core.models.DeviceMessage
Creates an instance of class DeviceMessage.
disconnect(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Disconnects from the device.
disconnect(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
disconnect() - Method in class org.ocast.sdk.core.WebSocket
Disconnects the web socket from the remote host.

E

encode(value) - Method in class org.ocast.sdk.core.utils.JsonTools
Encodes a JSON object to a string.
equals(p) - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
 
equals(p) - Method in class org.ocast.sdk.core.models.OCastError
 
equals(p) - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
 
equals(p) - Method in class org.ocast.sdk.core.models.OCastMediaError
 
equals(p) - Method in class org.ocast.sdk.discovery.models.UpnpDevice
 
error(throwable, message) - Method in class org.ocast.sdk.core.utils.OCastLog.Companion
Logs an error message.
error(throwable, message) - Static method in class org.ocast.sdk.core.utils.OCastLog
Logs an error message.
ErrorStatus - Interface in org.ocast.sdk.core.models
This interface is implemented by all enums which represent OCast error statuses.
ErrorStatus.Companion - Class in org.ocast.sdk.core.models
The companion object.
Event - Class in org.ocast.sdk.core.models
Represents an OCast event.
Event() - Constructor for class org.ocast.sdk.core.models.Event
Represents an OCast event.
Event.Device - Class in org.ocast.sdk.core.models
Represents a device settings event.
Event.Media - Class in org.ocast.sdk.core.models
Represents a media event.
EventListener - Interface in org.ocast.sdk.core
Represents a listener of OCast protocol events.
EventListener.DefaultImpls - Class in org.ocast.sdk.core
Represents a listener of OCast protocol events.

G

generateSequenceID() - Method in class org.ocast.sdk.core.ReferenceDevice
Generates a message identifier.
getAlt() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
Indicates if the
getApplicationName() - Method in class org.ocast.sdk.core.Device
Returns the name of the web application to use.
getAudioTracks() - Method in class org.ocast.sdk.core.models.MediaMetadata
The list of audio tracks of the media.
getAutoplay() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
Indicates if the media should play automatically once the prepare command is complete.
getAxes() - Method in class org.ocast.sdk.core.models.SendGamepadEventCommandParams
The axes of the gamepad.
getBit() - Method in interface org.ocast.sdk.core.models.Bitflag
The index of the bit for this flag.
getBit() - Method in enum org.ocast.sdk.core.models.SendGamepadEventCommandParams.Button
The index of the bit for this flag.
getBit() - Method in enum org.ocast.sdk.core.models.SendMouseEventCommandParams.Button
The index of the bit for this flag.
getButtons() - Method in class org.ocast.sdk.core.models.SendGamepadEventCommandParams
The combination of gamepad buttons pressed.
getButtons() - Method in class org.ocast.sdk.core.models.SendMouseEventCommandParams
The combination of mouse buttons clicked.
getCallbackWrapper() - Method in class org.ocast.sdk.core.Device
Returns the callback wrapper.
getCallbackWrapper() - Method in class org.ocast.sdk.core.DeviceCenter
The callback wrapper.
getCause() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
The cause of the error,
getCause() - Method in class org.ocast.sdk.core.models.OCastError
The cause of the error,
getCause() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
The cause of the error,
getCause() - Method in class org.ocast.sdk.core.models.OCastMediaError
The cause of the error,
getCause() - Method in interface org.ocast.sdk.core.utils.LoggableError
The cause of the error, if any.
getClientUuid() - Method in class org.ocast.sdk.core.ReferenceDevice
An identifier which uniquely identifies the device when sending OCast messages.
getCode() - Method in interface org.ocast.sdk.core.models.ErrorStatus
The status code.
getCode() - Method in enum org.ocast.sdk.core.models.OCastDeviceSettingsError.Status
The status code.
getCode() - Method in class org.ocast.sdk.core.models.OCastError
The error code.
getCode() - Method in enum org.ocast.sdk.core.models.OCastError.Status
The status code.
getCode() - Method in enum org.ocast.sdk.core.models.OCastInputSettingsError.Status
The status code.
getCode() - Method in enum org.ocast.sdk.core.models.OCastMediaError.Status
The status code.
getCode() - Method in class org.ocast.sdk.core.models.OCastReplyEventParams
The code associated with the data.
getCode() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
A string that identifies the physical key being pressed.
getConnectCallback() - Method in class org.ocast.sdk.core.ReferenceDevice
The callback executed when the device connect process is complete.
getCtrl() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
Indicates if the
getData() - Method in class org.ocast.sdk.core.models.OCastApplicationLayer
The data.
getData() - Method in class org.ocast.sdk.core.models.OCastRawApplicationLayer
The raw data.
getDestination() - Method in class org.ocast.sdk.core.models.OCastCommandDeviceLayer
The component to which the message is sent to.
getDestination() - Method in class org.ocast.sdk.core.models.OCastRawDeviceLayer
The component to which the message is sent to.
getDeviceFromRoute(routeInfo) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Returns the OCast device which is associated to a MediaRouter.RouteInfo.
getDeviceID(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Retrieves the device identifier.
getDeviceID(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
GetDeviceIDCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a getDeviceID command.
GetDeviceIDCommandParams() - Constructor for class org.ocast.sdk.core.models.GetDeviceIDCommandParams
Creates an instance of class GetDeviceIDCommandParams.
getDeviceListener() - Method in class org.ocast.sdk.core.Device
Returns the device listener.
getDevices() - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
The discovered OCast devices.
getDevices() - Method in class org.ocast.sdk.core.DeviceCenter
The list of detected OCast devices.
getDialURL() - Method in class org.ocast.sdk.core.Device
Returns the URL of the DIAL service.
getDialURL() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The URL of the DIAL service.
getDisconnectCallback() - Method in class org.ocast.sdk.core.ReferenceDevice
The callback executed when the device disconnect process is complete.
getDiscoveryInterval() - Method in class org.ocast.sdk.core.DeviceCenter
The interval to refresh the devices, in milliseconds.
getDuration() - Method in class org.ocast.sdk.core.models.MediaPlaybackStatus
The media duration,
getEventListener() - Method in class org.ocast.sdk.core.Device
Returns the event listener.
getFriendlyName() - Method in class org.ocast.sdk.core.Device
Returns the friendly name of the device.
getFriendlyName() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The friendly name of the device.
getHost() - Method in class org.ocast.sdk.core.Device
Returns the device host.
getHostnameVerifier() - Method in class org.ocast.sdk.core.models.SSLConfiguration
The hostname verifier.
getId() - Method in class org.ocast.sdk.core.models.DeviceID
The device identifier.
getId() - Method in class org.ocast.sdk.core.models.MediaMetadata.Track
The track identifier.
getId() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The identifier of the device.
getIdentifier() - Method in class org.ocast.sdk.core.models.OCastCommandDeviceLayer
The message identifier.
getIdentifier() - Method in class org.ocast.sdk.core.models.OCastRawDeviceLayer
The message identifier.
getKey() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
The key attribute value corresponding to the key pressed.
getLabel() - Method in class org.ocast.sdk.core.models.MediaMetadata.Track
The track label.
getLanguage() - Method in class org.ocast.sdk.core.models.MediaMetadata.Track
The track language.
getLevel() - Method in class org.ocast.sdk.core.utils.OCastLog.Companion
The current OCast log level.
getLevel() - Static method in class org.ocast.sdk.core.utils.OCastLog
The current OCast log level.
getLocation() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
The location of the key on the keyboard.
getLogo() - Method in class org.ocast.sdk.core.models.MediaMetadata
The media thumbnail.
getLogo() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The media thumbnail.
getManufacturer() - Method in class org.ocast.sdk.core.Device
Returns the manufacturer of the device.
getManufacturer() - Method in class org.ocast.sdk.core.ReferenceDevice
 
getManufacturer() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The manufacturer of the device.
getMediaMetadata(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Retrieves the metadata of the current media.
getMediaMetadata(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
GetMediaMetadataCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a getMetadata command.
GetMediaMetadataCommandParams() - Constructor for class org.ocast.sdk.core.models.GetMediaMetadataCommandParams
Creates an instance of class GetMediaMetadataCommandParams.
getMediaPlaybackStatus(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Retrieves the playback status of the current media.
getMediaPlaybackStatus(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
GetMediaPlaybackStatusCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a getPlaybackStatus command.
GetMediaPlaybackStatusCommandParams() - Constructor for class org.ocast.sdk.core.models.GetMediaPlaybackStatusCommandParams
getMediaRouteSelector() - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
The OCast media route selector.
getMediaType() - Method in class org.ocast.sdk.core.models.MediaMetadata
The media type.
getMediaType() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The media type.
getMessage() - Method in class org.ocast.sdk.core.models.OCastCommandDeviceLayer
The message to send.
getMessage() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
The error message.
getMessage() - Method in class org.ocast.sdk.core.models.OCastError
The error message.
getMessage() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
The error message.
getMessage() - Method in class org.ocast.sdk.core.models.OCastMediaError
The error message.
getMessage() - Method in class org.ocast.sdk.core.models.OCastRawDeviceLayer
The raw message to send.
getMessage() - Method in interface org.ocast.sdk.core.utils.LoggableError
The error message, if any.
getMeta() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
Indicates if the
getModelName() - Method in class org.ocast.sdk.core.Device
Returns the model name of the device.
getModelName() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
The model name.
getName() - Method in class org.ocast.sdk.core.models.OCastCommandParams
The name of the command.
getName() - Method in class org.ocast.sdk.core.models.OCastDataLayer
The name of the data.
getName() - Method in class org.ocast.sdk.core.models.OCastRawDataLayer
The name of the data.
getOnError() - Method in class org.ocast.sdk.core.models.ConsumerCallback
The operation executed if the task failed.
getOnError() - Method in class org.ocast.sdk.core.models.RunnableCallback
The operation executed if the task failed.
getOnSuccess() - Method in class org.ocast.sdk.core.models.ConsumerCallback
The operation executed if the task succeeded.
getOnSuccess() - Method in class org.ocast.sdk.core.models.RunnableCallback
The operation executed if the task succeeded.
getOptions() - Method in class org.ocast.sdk.core.models.OCastDataLayer
The options associated with this data,
getOptions() - Method in class org.ocast.sdk.core.models.OCastRawDataLayer
The options associated with this data,
getParams() - Method in class org.ocast.sdk.core.models.OCastDataLayer
The data parameters.
getParams() - Method in class org.ocast.sdk.core.models.OCastRawDataLayer
The raw data parameters.
getPosition() - Method in class org.ocast.sdk.core.models.MediaPlaybackStatus
The media position,
getPosition() - Method in class org.ocast.sdk.core.models.PlayMediaCommandParams
The starting position of the media,
getPosition() - Method in class org.ocast.sdk.core.models.SeekMediaCommandParams
The media position,
getProgress() - Method in class org.ocast.sdk.core.models.UpdateStatus
The download progress.
getReplyCallbacksBySequenceID() - Method in class org.ocast.sdk.core.ReferenceDevice
A map of callbacks that will be executed when receiving reply messages, indexed by the identifier of their associated command message.
getReplyClass() - Method in class org.ocast.sdk.core.models.ReplyCallback
The expected class of the reply data.
getSearchTarget() - Method in class org.ocast.sdk.core.Device
Returns the SSDP search target.
getSearchTarget() - Method in class org.ocast.sdk.core.ReferenceDevice
 
getService() - Method in class org.ocast.sdk.core.models.OCastApplicationLayer
The identifier of the service associated to the data.
getService() - Method in class org.ocast.sdk.core.models.OCastRawApplicationLayer
The identifier of the service associated to the data.
getShift() - Method in class org.ocast.sdk.core.models.SendKeyEventCommandParams
Indicates if the
getSocketFactory() - Method in class org.ocast.sdk.core.models.SSLConfiguration
The SSL socket factory.
getSource() - Method in class org.ocast.sdk.core.models.OCastCommandDeviceLayer
The component which sends the message.
getSource() - Method in class org.ocast.sdk.core.models.OCastRawDeviceLayer
The component which sends the message.
getState() - Method in class org.ocast.sdk.core.Device
Returns the current state of the device.
getState() - Method in class org.ocast.sdk.core.models.MediaPlaybackStatus
The playback state.
getState() - Method in class org.ocast.sdk.core.models.UpdateStatus
The firmware update state.
getState() - Method in class org.ocast.sdk.core.WebSocket
The current state of the web socket.
getStatus() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
The error status.
getStatus() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
The error status.
getStatus() - Method in class org.ocast.sdk.core.models.OCastMediaError
The error status.
getStatus() - Method in class org.ocast.sdk.core.models.OCastRawDeviceLayer
The device layer transport status.
getStatus() - Method in class org.ocast.sdk.core.models.WebAppConnectedStatusEvent
The status of the web app.
getStatusCode() - Method in exception org.ocast.sdk.common.models.HttpException
The HTTP status code.
getSubtitle() - Method in class org.ocast.sdk.core.models.MediaMetadata
The media subtitle.
getSubtitle() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The media subtitle.
getSubtitleTracks() - Method in class org.ocast.sdk.core.models.MediaMetadata
The list of subtitle tracks of the media.
getTitle() - Method in class org.ocast.sdk.core.models.MediaMetadata
The media title.
getTitle() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The media title.
getTrackID() - Method in class org.ocast.sdk.core.models.SetMediaTrackCommandParams
The track identifier.
getTransferMode() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The media transfer mode.
getTrustManager() - Method in class org.ocast.sdk.core.models.SSLConfiguration
The trust manager.
getType() - Method in class org.ocast.sdk.core.models.OCastCommandDeviceLayer
 
getType() - Method in class org.ocast.sdk.core.models.OCastRawDeviceLayer
The type of message.
getType() - Method in class org.ocast.sdk.core.models.SendGamepadEventCommandParams.Axis
The axis type.
getType() - Method in class org.ocast.sdk.core.models.SetMediaTrackCommandParams
The track type.
getUpdateFrequency() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The frequency of
getUpdateStatus(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Retrieves the firmware update status of the device.
getUpdateStatus(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
GetUpdateStatusCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a getUpdateStatus command.
GetUpdateStatusCommandParams() - Constructor for class org.ocast.sdk.core.models.GetUpdateStatusCommandParams
Creates an instance of class GetUpdateStatusCommandParams.
getUpnpID() - Method in class org.ocast.sdk.core.Device
Returns the UPnP identifier of the device.
getUrl() - Method in class org.ocast.sdk.core.models.PrepareMediaCommandParams
The media URL.
getValue() - Method in enum org.ocast.sdk.core.models.OCastDomain
The domain raw value.
getVersion() - Method in class org.ocast.sdk.core.models.UpdateStatus
The version of the firmware to update.
getVideoTracks() - Method in class org.ocast.sdk.core.models.MediaMetadata
The list of video tracks of the media.
getVolume() - Method in class org.ocast.sdk.core.models.MediaPlaybackStatus
The media volume,
getVolume() - Method in class org.ocast.sdk.core.models.SetMediaVolumeCommandParams
The media volume,
getWebSocketURL() - Method in class org.ocast.sdk.core.WebSocket
The web socket URL.
getX() - Method in class org.ocast.sdk.core.models.SendGamepadEventCommandParams.Axis
The horizontal axis value,
getX() - Method in class org.ocast.sdk.core.models.SendMouseEventCommandParams
The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
getY() - Method in class org.ocast.sdk.core.models.SendGamepadEventCommandParams.Axis
The vertical axis value,
getY() - Method in class org.ocast.sdk.core.models.SendMouseEventCommandParams
The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

H

hashCode() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
 
hashCode() - Method in class org.ocast.sdk.core.models.OCastError
 
hashCode() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
 
hashCode() - Method in class org.ocast.sdk.core.models.OCastMediaError
 
hashCode() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
 
HttpException - Exception in org.ocast.sdk.common.models
Represents an HTTP error.
HttpException(statusCode) - Constructor for exception org.ocast.sdk.common.models.HttpException
Creates an instance of exception HttpException.

I

ifNotNull($receiver, block) - Static method in class org.ocast.sdk.common.extensions.StandardExtKt
Calls the specified function block if this is not null.
info(message) - Method in class org.ocast.sdk.core.utils.OCastLog.Companion
Logs an info message.
info(message) - Static method in class org.ocast.sdk.core.utils.OCastLog
Logs an info message.
initialize(context, devices) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Initializes the class OCastMediaRouteHelper singleton with the specified device classes.
InputMessage<T> - Class in org.ocast.sdk.core.models
Represents a public settings input message.
InputMessage(data) - Constructor for class org.ocast.sdk.core.models.InputMessage
Creates an instance of class InputMessage.
INSTANCE - Static variable in class org.ocast.mediaroute.OCastMediaRouteHelper
This singleton provides methods to take advantage of the Android media route framework with OCast devices.
INSTANCE - Static variable in class org.ocast.sdk.core.utils.JsonTools
A singleton object that decodes and encodes JSON.
isApplicationRunning() - Method in class org.ocast.sdk.core.ReferenceDevice
A boolean which indicates if the web application specified by applicationName is currently running or not.
isEnabled() - Method in class org.ocast.sdk.core.models.MediaMetadata.Track
Indicates if the track is enabled or not.
isEnabled() - Method in class org.ocast.sdk.core.models.SetMediaTrackCommandParams
Indicates if the track is enabled or not.
isMuted() - Method in class org.ocast.sdk.core.models.MediaPlaybackStatus
Indicates if the media is muted or not.
isMuted() - Method in class org.ocast.sdk.core.models.MuteMediaCommandParams
Indicates if the media is muted or not.
isOCastRouteInfo(routeInfo) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Indicates if a route info is associated with an OCast device.

J

JsonTools - Class in org.ocast.sdk.core.utils
A singleton object that decodes and encodes JSON.

L

LIBRARY_PACKAGE_NAME - Static variable in class org.ocast.mediaroute.BuildConfig
 
log($receiver) - Static method in class org.ocast.sdk.core.utils.OCastLogKt
Logs an error.
LoggableError - Interface in org.ocast.sdk.core.utils
An interface implemented by errors which can be logged using the OCast logs.

M

MAX_PAYLOAD_SIZE - Static variable in class org.ocast.sdk.core.WebSocket
The maximum payload size in bytes.
Media() - Constructor for class org.ocast.sdk.core.models.Event.Media
Represents a media event.
Media - Class in org.ocast.sdk.core.models
This class is a container for enum classes which are used by several other media classes.
Media() - Constructor for class org.ocast.sdk.core.models.Media
This class is a container for enum classes which are used by several other media classes.
Media.Companion - Class in org.ocast.sdk.core.models
The companion object.
Media.TransferMode - Enum in org.ocast.sdk.core.models
Represents the transfer mode of a media.
Media.Type - Enum in org.ocast.sdk.core.models
Represents the type of a media.
MediaMessage<T> - Class in org.ocast.sdk.core.models
Represents a media message.
MediaMessage(data) - Constructor for class org.ocast.sdk.core.models.MediaMessage
Creates an instance of class MediaMessage.
MediaMetadata - Class in org.ocast.sdk.core.models
Represents the media metadata.
MediaMetadata(title, subtitle, logo, mediaType, subtitleTracks, audioTracks, videoTracks) - Constructor for class org.ocast.sdk.core.models.MediaMetadata
Creates an instance of class MediaMetadata.
MediaMetadata.Track - Class in org.ocast.sdk.core.models
Represents a media track.
MediaPlaybackStatus - Class in org.ocast.sdk.core.models
Represents the playback status of a media.
MediaPlaybackStatus(position, duration, state, volume, isMuted) - Constructor for class org.ocast.sdk.core.models.MediaPlaybackStatus
Creates an instance of class MediaPlaybackStatus.
MediaPlaybackStatus.State - Enum in org.ocast.sdk.core.models
Represents the playback states of a media.
MINIMUM_DISCOVERY_INTERVAL - Static variable in class org.ocast.sdk.core.DeviceCenter
The minimum value for the discovery interval.
muteMedia(mute, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Mutes or unmutes the current media.
muteMedia(mute, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
MuteMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a mute command.
MuteMediaCommandParams(isMuted) - Constructor for class org.ocast.sdk.core.models.MuteMediaCommandParams
Creates an instance of class MuteMediaCommandParams.

O

OCastApplicationLayer<T> - Class in org.ocast.sdk.core.models
Represents an OCast application layer containing data.
OCastApplicationLayer(service, data) - Constructor for class org.ocast.sdk.core.models.OCastApplicationLayer
Creates an instance of class OCastApplicationLayer.
OCastCommandDeviceLayer<T> - Class in org.ocast.sdk.core.models
Represents an OCast device layer containing a command message.
OCastCommandDeviceLayer(source, destination, identifier, message) - Constructor for class org.ocast.sdk.core.models.OCastCommandDeviceLayer
Creates an instance of class OCastCommandDeviceLayer.
OCastCommandParams - Class in org.ocast.sdk.core.models
Represents parameters for the data layer of a command.
OCastCommandParams(name) - Constructor for class org.ocast.sdk.core.models.OCastCommandParams
Creates an instance of class OCastCommandParams.
OCastDataLayer<T> - Class in org.ocast.sdk.core.models
Represents an OCast data layer.
OCastDataLayer(name, params, options) - Constructor for class org.ocast.sdk.core.models.OCastDataLayer
Creates an instance of class OCastDataLayer.
OCastDeviceSettingsError - Class in org.ocast.sdk.core.models
Represents an error from the device settings service.
OCastDeviceSettingsError(status, message, cause) - Constructor for class org.ocast.sdk.core.models.OCastDeviceSettingsError
Creates an instance of class OCastDeviceSettingsError.
OCastDeviceSettingsError(error) - Constructor for class org.ocast.sdk.core.models.OCastDeviceSettingsError
Creates an instance of class OCastDeviceSettingsError from a generic class OCastError.
OCastDeviceSettingsError.Status - Enum in org.ocast.sdk.core.models
Represents the status of an class OCastDeviceSettingsError.
OCastDomain - Enum in org.ocast.sdk.core.models
Represents the OCast domains.
OCastError - Class in org.ocast.sdk.core.models
Represents a generic OCast error.
OCastError(code, message, cause) - Constructor for class org.ocast.sdk.core.models.OCastError
Creates an class OCastError.
OCastError(message, cause) - Constructor for class org.ocast.sdk.core.models.OCastError
Creates an class OCastError with a CLIENT_ERROR status.
OCastError.Status - Enum in org.ocast.sdk.core.models
Represents the status of an class OCastError.
OCastExtKt - Class in org.ocast.sdk.core.models
 
OCastInputSettingsError - Class in org.ocast.sdk.core.models
Represents an error from the input settings service.
OCastInputSettingsError(status, message, cause) - Constructor for class org.ocast.sdk.core.models.OCastInputSettingsError
OCastInputSettingsError(error) - Constructor for class org.ocast.sdk.core.models.OCastInputSettingsError
Creates an instance of class OCastInputSettingsError from a generic class OCastError.
OCastInputSettingsError.Status - Enum in org.ocast.sdk.core.models
Represents the status of an class OCastInputSettingsError.
OCastLog - Class in org.ocast.sdk.core.utils
This class logs OCast messages.
OCastLog() - Constructor for class org.ocast.sdk.core.utils.OCastLog
This class logs OCast messages.
OCastLog.Companion - Class in org.ocast.sdk.core.utils
The companion object.
OCastLog.Level - Enum in org.ocast.sdk.core.utils
Represents the OCast log level.
OCastLogKt - Class in org.ocast.sdk.core.utils
 
OCastMediaError - Class in org.ocast.sdk.core.models
Represents an error from the media service.
OCastMediaError(status, message, cause) - Constructor for class org.ocast.sdk.core.models.OCastMediaError
OCastMediaError(error) - Constructor for class org.ocast.sdk.core.models.OCastMediaError
Creates an instance of class OCastMediaError from a generic class OCastError.
OCastMediaError.Status - Enum in org.ocast.sdk.core.models
Represents the status of an class OCastMediaError.
OCastMediaRouteHelper - Class in org.ocast.mediaroute
This singleton provides methods to take advantage of the Android media route framework with OCast devices.
OCastRawApplicationLayer - Class in org.ocast.sdk.core.models
Represents an OCast application layer containing raw data (i.e. the data property is a String).
OCastRawApplicationLayer(service, data) - Constructor for class org.ocast.sdk.core.models.OCastRawApplicationLayer
Creates an instance of class OCastRawApplicationLayer.
OCastRawDataLayer - Class in org.ocast.sdk.core.models
Represents an OCast data layer containing raw parameters (i.e. the params property is a String).
OCastRawDataLayer(name, params, options) - Constructor for class org.ocast.sdk.core.models.OCastRawDataLayer
Creates an instance of class OCastRawDataLayer.
OCastRawDeviceLayer - Class in org.ocast.sdk.core.models
Represents an OCast device layer containing a raw message (i.e. the data property of message is a String).
OCastRawDeviceLayer(source, destination, type, status, identifier, message) - Constructor for class org.ocast.sdk.core.models.OCastRawDeviceLayer
Creates an instance of class OCastRawDeviceLayer.
OCastRawDeviceLayer.Status - Enum in org.ocast.sdk.core.models
Represents the transport status of an OCast device layer.
OCastRawDeviceLayer.Type - Enum in org.ocast.sdk.core.models
Represents the type of message being sent in a device layer.
OCastReplyEventParams - Class in org.ocast.sdk.core.models
Represents parameters for the data layer of a reply or an event.
OCastReplyEventParams(code) - Constructor for class org.ocast.sdk.core.models.OCastReplyEventParams
Creates an instance of class OCastReplyEventParams.
OkHttpExtKt - Class in org.ocast.sdk.common.extensions
 
onAddDevice(device) - Method in class org.ocast.sdk.core.DeviceCenter
This method is called when an OCast device has been created and before it is added to the list of detected devices.
onClosed(webSocket, code, reason) - Method in class org.ocast.sdk.core.WebSocket
 
onConnected(webSocket) - Method in class org.ocast.sdk.core.ReferenceDevice
Tells the listener that the socket is connected to the device.
onConnected(webSocket) - Method in interface org.ocast.sdk.core.WebSocket.Listener
Tells the listener that the socket is connected to the device.
onCreateWebSockets(sslConfiguration, onComplete) - Method in class org.ocast.sdk.core.ReferenceDevice
Creates all the web sockets.
onCustomEvent(device, name, params) - Method in interface org.ocast.sdk.core.EventListener
Tells the listener that a custom event from a web application was sent by a device.
onDataReceived(webSocket, data) - Method in class org.ocast.sdk.core.ReferenceDevice
Tells the listener that the socket has received a message.
onDataReceived(webSocket, data) - Method in interface org.ocast.sdk.core.WebSocket.Listener
Tells the listener that the socket has received a message.
onDeviceDisconnected(device, error) - Method in interface org.ocast.sdk.core.DeviceListener
Tells the listener that a device has been disconnected.
onDevicesAdded(devices) - Method in interface org.ocast.sdk.core.DeviceListener
Tells the listener that one or more devices have been discovered.
onDevicesChanged(devices) - Method in interface org.ocast.sdk.core.DeviceListener
Tells the listener that one or more devices have changed.
onDevicesRemoved(devices) - Method in interface org.ocast.sdk.core.DeviceListener
Tells the listener that one or more devices have been lost.
onDisconnected(webSocket, error) - Method in class org.ocast.sdk.core.ReferenceDevice
Tells the listener that the socket has been disconnected from the device.
onDisconnected(webSocket, error) - Method in interface org.ocast.sdk.core.WebSocket.Listener
Tells the listener that the socket has been disconnected from the device.
onDiscoveryStopped(error) - Method in interface org.ocast.sdk.core.DeviceListener
Tells the listener that the device discovery stopped.
onFailure(webSocket, throwable, response) - Method in class org.ocast.sdk.core.WebSocket
 
onMediaMetadataChanged(device, mediaMetadata) - Method in interface org.ocast.sdk.core.EventListener
Tells the listener that a media metadata changed event was sent by a device.
onMediaPlaybackStatus(device, mediaPlaybackStatus) - Method in interface org.ocast.sdk.core.EventListener
Tells the listener that a media playback status event was sent by a device.
onMessage(webSocket, text) - Method in class org.ocast.sdk.core.WebSocket
 
onOpen(webSocket, response) - Method in class org.ocast.sdk.core.WebSocket
 
onRemoveDevice(device) - Method in class org.ocast.sdk.core.DeviceCenter
This method is called before an OCast device is removed from the list of detected devices.
onUpdateStatus(device, updateStatus) - Method in interface org.ocast.sdk.core.EventListener
Tells the listener that a firmware update status event was sent by a device.
options(options) - Method in class org.ocast.sdk.core.models.OCastCommandParams
Apply the specified options to the command.
orElse($receiver, block) - Static method in class org.ocast.sdk.common.extensions.StandardExtKt
Calls the specified function block and returns its result if this is null.
orFalse($receiver) - Static method in class org.ocast.sdk.common.extensions.BooleanExtKt
Returns the boolean if it is not null, or false otherwise.
org.ocast.mediaroute - package org.ocast.mediaroute
 
org.ocast.sdk.common.extensions - package org.ocast.sdk.common.extensions
 
org.ocast.sdk.common.models - package org.ocast.sdk.common.models
 
org.ocast.sdk.core - package org.ocast.sdk.core
 
org.ocast.sdk.core.models - package org.ocast.sdk.core.models
 
org.ocast.sdk.core.utils - package org.ocast.sdk.core.utils
 
org.ocast.sdk.core.wrapper - package org.ocast.sdk.core.wrapper
 
org.ocast.sdk.discovery.models - package org.ocast.sdk.discovery.models
 
orTrue($receiver) - Static method in class org.ocast.sdk.common.extensions.BooleanExtKt
Returns the boolean if it is not null, or true otherwise.

P

pauseDiscovery() - Method in class org.ocast.sdk.core.DeviceCenter
Pauses the discovery process.
pauseMedia(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Pauses the current media.
pauseMedia(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
PauseMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a pause command.
PauseMediaCommandParams() - Constructor for class org.ocast.sdk.core.models.PauseMediaCommandParams
Creates an instance of class PauseMediaCommandParams.
PING_INTERVAL - Static variable in class org.ocast.sdk.core.WebSocket
The ping interval in seconds.
playMedia(position, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Plays a media at the specified position.
playMedia(position, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
PlayMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a play command.
PlayMediaCommandParams(position) - Constructor for class org.ocast.sdk.core.models.PlayMediaCommandParams
Creates an instance of class PlayMediaCommandParams.
PlayMediaCommandParams() - Constructor for class org.ocast.sdk.core.models.PlayMediaCommandParams
Creates an instance of class PlayMediaCommandParams.
prepareMedia(params, options, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Prepares a media to be played.
prepareMedia(params, options, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
PrepareMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a prepare command.
PrepareMediaCommandParams(url, updateFrequency, title, subtitle, logo, mediaType, transferMode, autoplay) - Constructor for class org.ocast.sdk.core.models.PrepareMediaCommandParams
Creates an instance of class PrepareMediaCommandParams.

R

RawJsonDeserializer - Class in org.ocast.sdk.core.utils
A Jackson StdDeserializer that deserializes a JSON object to a raw string.
RawJsonDeserializer() - Constructor for class org.ocast.sdk.core.utils.RawJsonDeserializer
A Jackson StdDeserializer that deserializes a JSON object to a raw string.
REFERENCE_WEB_SOCKET_ID - Static variable in class org.ocast.sdk.core.ReferenceDevice
The identifier of the web socket of the reference device.
ReferenceDevice - Class in org.ocast.sdk.core
The reference OCast device.
ReferenceDevice(upnpDevice) - Constructor for class org.ocast.sdk.core.ReferenceDevice
Creates an instance of class ReferenceDevice from an class UpnpDevice.
ReferenceDevice.Companion - Class in org.ocast.sdk.core
The companion object.
registerDevice(deviceClass) - Method in class org.ocast.sdk.core.DeviceCenter
Registers a class of devices to discover.
removeDeviceListener(listener) - Method in class org.ocast.sdk.core.DeviceCenter
Removes a listener which has been previously added with the addDeviceListener(@NotNull EventListener listener) method.
removeEventListener(listener) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Removes a listener which has been previously added with the addEventListener(@NotNull EventListener listener) method.
removeEventListener(listener) - Method in class org.ocast.sdk.core.DeviceCenter
Removes a listener which has been previously added with the addEventListener(@NotNull EventListener listener) method.
removeMediaRouterCallback(mediaRouterCallback) - Method in class org.ocast.mediaroute.OCastMediaRouteHelper
Removes a media router callback that has been previously added with the addMediaRouterCallback(@NotNull MediaRouter.Callback mediaRouterCallback) method.
ReplyCallback<T> - Class in org.ocast.sdk.core.models
Represents a callback for an OCast reply.
ReplyCallback(replyClass, onSuccess, onError) - Constructor for class org.ocast.sdk.core.models.ReplyCallback
Creates an instance of class ReplyCallback.
resumeDiscovery() - Method in class org.ocast.sdk.core.DeviceCenter
Resumes the discovery process.
resumeMedia(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Resumes the current media.
resumeMedia(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
ResumeMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a resume command.
ResumeMediaCommandParams() - Constructor for class org.ocast.sdk.core.models.ResumeMediaCommandParams
Creates an instance of class ResumeMediaCommandParams.
run(t) - Method in interface org.ocast.sdk.core.models.Consumer
Performs this operation on the given argument.
RunnableCallback - Class in org.ocast.sdk.core.models
Represents a callback for an asynchronous task, with a Runnable as the success operation.
RunnableCallback(onSuccess, onError) - Constructor for class org.ocast.sdk.core.models.RunnableCallback
Creates an instance of class RunnableCallback.

S

seekMedia(position, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Seeks the current media to the specified position.
seekMedia(position, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SeekMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a seek command.
SeekMediaCommandParams(position) - Constructor for class org.ocast.sdk.core.models.SeekMediaCommandParams
Creates an instance of class SeekMediaCommandParams.
send(message, domain, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Sends a message which does not expect any reply data to the specified OCast domain.
send(message, domain, replyClass, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Sends a message which expects a reply data to the specified OCast domain.
send(message, domain, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
send(message, domain, replyClass, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
send(message) - Method in class org.ocast.sdk.core.WebSocket
Sends a message on the web socket.
sendGamepadEvent(params, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Sends a gamepad event.
sendGamepadEvent(params, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SendGamepadEventCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a gamepadEvent command.
SendGamepadEventCommandParams(axes, buttons) - Constructor for class org.ocast.sdk.core.models.SendGamepadEventCommandParams
Creates an instance of class SendGamepadEventCommandParams.
SendGamepadEventCommandParams.Axis - Class in org.ocast.sdk.core.models
Represents a gamepad axis.
SendGamepadEventCommandParams.Button - Enum in org.ocast.sdk.core.models
Represents a gamepad button.
sendKeyEvent(params, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Sends a keyboard event.
sendKeyEvent(params, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SendKeyEventCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a keyPressed command.
SendKeyEventCommandParams(key, code, ctrl, alt, shift, meta, location) - Constructor for class org.ocast.sdk.core.models.SendKeyEventCommandParams
Creates an instance of class SendKeyEventCommandParams.
SendKeyEventCommandParams.DOMKeyLocation - Enum in org.ocast.sdk.core.models
Represents the location of a key on the keyboard.
sendMouseEvent(params, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Sends a mouse event.
sendMouseEvent(params, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SendMouseEventCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a mouseEvent command.
SendMouseEventCommandParams(x, y, buttons) - Constructor for class org.ocast.sdk.core.models.SendMouseEventCommandParams
Creates an instance of class SendMouseEventCommandParams.
SendMouseEventCommandParams.Button - Enum in org.ocast.sdk.core.models
Represents a mouse button.
sendToWebSocket(id, message, startApplicationIfNeeded, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
Sends a message on the web socket.
serialize(value, gen, serializers) - Method in class org.ocast.sdk.core.utils.BitflagsSerializer
 
Service - Class in org.ocast.sdk.core.models
Represents an OCast service.
Service() - Constructor for class org.ocast.sdk.core.models.Service
Represents an OCast service.
Service.Companion - Class in org.ocast.sdk.core.models
The companion object.
setApplicationName(applicationName) - Method in class org.ocast.sdk.core.Device
Changes the name of the web application to use.
setApplicationName(applicationName) - Method in class org.ocast.sdk.core.ReferenceDevice
 
setApplicationRunning(p) - Method in class org.ocast.sdk.core.ReferenceDevice
A boolean which indicates if the web application specified by applicationName is currently running or not.
setCallbackWrapper(callbackWrapper) - Method in class org.ocast.sdk.core.Device
Changes the callback wrapper.
setCallbackWrapper(value) - Method in class org.ocast.sdk.core.DeviceCenter
The callback wrapper.
setClientUuid(p) - Method in class org.ocast.sdk.core.ReferenceDevice
An identifier which uniquely identifies the device when sending OCast messages.
setConnectCallback(p) - Method in class org.ocast.sdk.core.ReferenceDevice
The callback executed when the device connect process is complete.
setDeviceListener(deviceListener) - Method in class org.ocast.sdk.core.Device
Changes the device listener.
setDisconnectCallback(p) - Method in class org.ocast.sdk.core.ReferenceDevice
The callback executed when the device disconnect process is complete.
setDiscoveryInterval(value) - Method in class org.ocast.sdk.core.DeviceCenter
The interval to refresh the devices, in milliseconds.
setEventListener(eventListener) - Method in class org.ocast.sdk.core.Device
Changes the event listener.
setLevel(p) - Method in class org.ocast.sdk.core.utils.OCastLog.Companion
The current OCast log level.
setLevel(p) - Static method in class org.ocast.sdk.core.utils.OCastLog
The current OCast log level.
setMediaTrack(params, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Changes the current track of the current media.
setMediaTrack(params, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SetMediaTrackCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a track command.
SetMediaTrackCommandParams(type, trackID, isEnabled) - Constructor for class org.ocast.sdk.core.models.SetMediaTrackCommandParams
Creates an instance of class SetMediaTrackCommandParams.
SetMediaTrackCommandParams.Type - Enum in org.ocast.sdk.core.models
Represents the different types of class MediaMetadata.Track.
setMediaVolume(volume, onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Changes the media volume.
setMediaVolume(volume, onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SetMediaVolumeCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a volume command.
SetMediaVolumeCommandParams(volume) - Constructor for class org.ocast.sdk.core.models.SetMediaVolumeCommandParams
Creates an instance of class SetMediaVolumeCommandParams.
setName(p) - Method in class org.ocast.sdk.core.models.OCastDataLayer
The name of the data.
setName(p) - Method in class org.ocast.sdk.core.models.OCastRawDataLayer
The name of the data.
setState(state) - Method in class org.ocast.sdk.core.Device
Changes the current state of the device.
setState(state) - Method in class org.ocast.sdk.core.ReferenceDevice
 
SettingsService - Class in org.ocast.sdk.core.models
Represents an OCast settings service.
SettingsService() - Constructor for class org.ocast.sdk.core.models.SettingsService
Represents an OCast settings service.
SettingsService.Companion - Class in org.ocast.sdk.core.models
The companion object.
SimpleCallbackWrapper - Class in org.ocast.sdk.core.wrapper
This class is a simple implementation of interface CallbackWrapper.
SimpleCallbackWrapper() - Constructor for class org.ocast.sdk.core.wrapper.SimpleCallbackWrapper
This class is a simple implementation of interface CallbackWrapper.
SSLConfiguration - Class in org.ocast.sdk.core.models
This class represents an SSL configuration.
SSLConfiguration(trustManager, socketFactory, hostnameVerifier) - Constructor for class org.ocast.sdk.core.models.SSLConfiguration
Creates an instance of class SSLConfiguration.
StandardExtKt - Class in org.ocast.sdk.common.extensions
 
startApplication(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Starts the application identified by the return value of `getApplicationName()`.
startApplication(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
stopApplication(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Stops the application identified by the return value of `getApplicationName()`.
stopApplication(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
stopDiscovery() - Method in class org.ocast.sdk.core.DeviceCenter
Stops the discovery process.
stopMedia(onSuccess, onError) - Method in class org.ocast.sdk.core.Device
Stops the current media.
stopMedia(onSuccess, onError) - Method in class org.ocast.sdk.core.ReferenceDevice
 
StopMediaCommandParams - Class in org.ocast.sdk.core.models
Represents the parameters of a stop command.
StopMediaCommandParams() - Constructor for class org.ocast.sdk.core.models.StopMediaCommandParams
Creates an instance of class StopMediaCommandParams.

T

toString() - Method in class org.ocast.sdk.core.models.OCastDeviceSettingsError
 
toString() - Method in class org.ocast.sdk.core.models.OCastError
 
toString() - Method in class org.ocast.sdk.core.models.OCastInputSettingsError
 
toString() - Method in class org.ocast.sdk.core.models.OCastMediaError
 
toString() - Method in class org.ocast.sdk.discovery.models.UpnpDevice
 
toValue() - Method in enum org.ocast.sdk.core.models.MediaPlaybackStatus.State
Returns the raw state value.
toValue() - Method in enum org.ocast.sdk.core.models.Axis.Type
Returns the raw axis type value.
toValue() - Method in enum org.ocast.sdk.core.models.SendGamepadEventCommandParams.Button
Returns the raw button value.
toValue() - Method in enum org.ocast.sdk.core.models.SendKeyEventCommandParams.DOMKeyLocation
Returns the raw key location value.
toValue() - Method in enum org.ocast.sdk.core.models.SendMouseEventCommandParams.Button
Returns the raw button value.
toValue() - Method in enum org.ocast.sdk.core.models.UpdateStatus.State
Returns the raw firmware update state value.
Track(language, label, isEnabled, id) - Constructor for class org.ocast.sdk.core.models.MediaMetadata.Track
Creates an instance of class MediaMetadata.Track.

U

UpdateStatus - Class in org.ocast.sdk.core.models
Represents the firmware update status of a device.
UpdateStatus(state, version, progress) - Constructor for class org.ocast.sdk.core.models.UpdateStatus
Creates an instance of class UpdateStatus.
UpdateStatus.State - Enum in org.ocast.sdk.core.models
Represents the state of a firmware update.
UpnpDevice - Class in org.ocast.sdk.discovery.models
This class represents an UPnP device.
UpnpDevice(id, dialURL, friendlyName, manufacturer, modelName) - Constructor for class org.ocast.sdk.discovery.models.UpnpDevice
Creates an instance of class UpnpDevice.

W

WebAppConnectedStatusEvent - Class in org.ocast.sdk.core.models
Represents the connected status event of a web app.
WebAppConnectedStatusEvent(status) - Constructor for class org.ocast.sdk.core.models.WebAppConnectedStatusEvent
Creates an instance of class WebAppConnectedStatusEvent.
WebAppStatus - Enum in org.ocast.sdk.core.models
Represents the status of a web app.
WebSocket - Class in org.ocast.sdk.core
This class represents a web socket.
WebSocket(webSocketURL, sslConfiguration, listener) - Constructor for class org.ocast.sdk.core.WebSocket
Creates an instance of class WebSocket.
WebSocket.Companion - Class in org.ocast.sdk.core
The companion object.
WebSocket.Listener - Interface in org.ocast.sdk.core
A listener of events on a class WebSocket.
WebSocket.State - Enum in org.ocast.sdk.core
Represents the states of the web socket.
wrap(consumer) - Method in interface org.ocast.sdk.core.wrapper.CallbackWrapper
Wraps a interface Consumer into a new one.
wrap(runnable) - Method in interface org.ocast.sdk.core.wrapper.CallbackWrapper
Wraps a Runnable into a new one.
wrap(consumer) - Method in class org.ocast.sdk.core.wrapper.SimpleCallbackWrapper
Wraps a interface Consumer into a new one.
wrap(runnable) - Method in class org.ocast.sdk.core.wrapper.SimpleCallbackWrapper
Wraps a Runnable into a new one.
A B C D E G H I J L M O P R S T U W 
Skip navigation links