- accept(ContentEntry) - Method in class org.ocap.hn.content.navigation.ContentDatabaseFilter
-
This method is called for every ContentEntry in the database/list this
filter is applied to.
- accept(ContentEntry) - Method in class org.ocap.hn.content.navigation.DeviceFilter
-
Inherited from ContentDatabaseFilter.
- accept(Object) - Method in class org.ocap.hn.PropertyFilter
-
Checks whether an element is accepted by this filter, the element
must be either NetModule or Device.
- ACTION_CANCELED - Static variable in class org.ocap.hn.NetActionEvent
-
- ACTION_COMPLETED - Static variable in class org.ocap.hn.NetActionEvent
-
Action status for a completed action
- ACTION_FAILED - Static variable in class org.ocap.hn.NetActionEvent
-
- ACTION_IN_PROGRESS - Static variable in class org.ocap.hn.NetActionEvent
-
- ACTION_STATUS_NOT_AVAILABLE - Static variable in class org.ocap.hn.NetActionEvent
-
ACTION_STATUS_NOT_AVAILABLE is returned by
NetActionEvent.getActionStatus() when the transaction has completed
successfully or failed sometime before this method was called and the
implementation is no longer maintaining a status for it.
- ACTOR - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of an actor appearing in a video item.
- ACTOR_AT_ROLE - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Role of an actor in the work.
- addContentEntries(ContentEntry[]) - Method in interface org.ocap.hn.content.ContentContainer
-
Adds ContentEntry objects to this ContentContainer.
- addContentEntry(ContentEntry) - Method in interface org.ocap.hn.content.ContentContainer
-
Adds a ContentEntry to this ContentContainer.
- addContentServerListener(ContentServerListener) - Method in interface org.ocap.hn.ContentServerNetModule
-
Adds a ContentServerListener to this ContentContainer.
- addDeviceEventListener(DeviceEventListener) - Method in interface org.ocap.hn.Device
-
Adds a DeviceEventListener instance to this Device.
- addDeviceEventListener(DeviceEventListener) - Method in class org.ocap.hn.NetManager
-
Adds a Device event listener to NetManager.
- addMetadata(String, Object) - Method in class org.ocap.hn.content.MetadataNode
-
Adds a new metadata entry, modifies an existing metadata entry, or
removes an existing metadata entry.
- addMetadata(String, Object, ExtendedFileAccessPermissions) - Method in class org.ocap.hn.content.MetadataNode
-
Adds a new metadata entry, modifies an existing metadata entry, or
removes an existing metadata entry, with specification of
ExtendedFileAccessPermissions.
- addNameSpace(String, String) - Method in class org.ocap.hn.content.MetadataNode
-
Adds a namespace declaration to this MetadataNode.
- addNetModuleEventListener(NetModuleEventListener) - Method in class org.ocap.hn.NetManager
-
Adds a NetModule event listener to NetManager.
- addNetModuleEventListener(NetModuleEventListener) - Method in interface org.ocap.hn.NetModule
-
Adds a NetModuleEventListener instance to this NetModule.
- addProperty(String, String) - Method in class org.ocap.hn.PropertyFilter
-
Adds a (key,value) pair to the filter.
- addRecordingContentItem(RecordingContentItem) - Method in interface org.ocap.hn.recording.NetRecordingEntry
-
Adds a local RecordingContentItem to this recording object
- ALBUM - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
This identifies a ALBUM this piece of content belongs to.
- ALBUM_ART - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Reference to album art.
- ALBUM_CONTAINER - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents the base album container.
- ALBUM_CONTAINER_MUSIC - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents a music album container.
- ALBUM_CONTAINER_PHOTO - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents a photo album container.
- and(DatabaseQuery) - Method in class org.ocap.hn.content.navigation.DatabaseQuery
-
Create a new DatabaseQuery based upon the logical AND of the predicates
represented by this query and the argument query.
- and(DatabaseQuery, String) - Method in class org.ocap.hn.content.navigation.DatabaseQuery
-
Create a new DatabaseQuery object based upon the logical AND of the
predicates represented by this query and the argument query.
- ARTIST - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of an artist.
- ARTIST_AT_ROLE - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Role of an artist in the work.
- ARTIST_DISCOGRAPHY - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Reference to artist discography.
- AUDIO_ITEM - Static variable in interface org.ocap.hn.content.ContentItem
-
Represents the base audio content.
- AUDIO_ITEM_BOOK - Static variable in interface org.ocap.hn.content.ContentItem
-
In addition to being an AUDIO_ITEM content MAY be an audio book.
- AUDIO_ITEM_BROADCAST - Static variable in interface org.ocap.hn.content.ContentItem
-
In addition to being an AUDIO_ITEM content MAY be broadcast on a radio
station.
- AUDIO_ITEM_TRACK - Static variable in interface org.ocap.hn.content.ContentItem
-
In addition to being an AUDIO_ITEM content MAY be a track such as a song.
- AudioResource - Interface in org.ocap.hn.content
-
Interface implemented by subclasses of ContentResource to identify that a content contains audio.
- AUTHOR - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of an author.
- AUTHOR_AT_ROLE - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Role of an author in the work (e.g. lyrics, music).
- cancel() - Method in interface org.ocap.hn.NetActionRequest
-
Cancels the Action associated with this ActionRequest.
- CAP_RECORDING_SUPPORTED - Static variable in interface org.ocap.hn.Device
-
A constant indicating MSO content recording capability.
- CAP_REMOTE_STORAGE_SUPPORTED - Static variable in interface org.ocap.hn.Device
-
A constant indicating remote storage capability.
- CAP_STREAMING_SUPPORTED - Static variable in interface org.ocap.hn.Device
-
A constant indicating streaming capability of the device.
- CAP_TUNER_SUPPORTED - Static variable in interface org.ocap.hn.Device
-
A constant indicating if the device has a tuner.
- CHANNEL_NAME - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Used for identification of channels themselves, or information associated with a
piece of recorded content.
- CHANNEL_NUMBER - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Used for identification of tuner channels themselves or information associated
with a piece of recorded content.
- COMMENTS - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
General-purpose tag where a user can annotate an object with some user-specific
information.
- CONTAINER - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents the base container class.
- contains(ContentEntry) - Method in interface org.ocap.hn.content.ContentContainer
-
Checks whether the given
ContentEntry is in this ContentContainer
in local cache only.
- contains(String) - Static method in class org.ocap.hn.content.MetadataIdentifiers
-
Indicates if the parameter identifier is contained within the set of
supported identifiers.
- CONTAINS - Static variable in class org.ocap.hn.content.navigation.DatabaseQuery
-
Operator to check for a String being contained within the field The
comparison is case insensitive, non whole word.
- contains(Object) - Method in interface org.ocap.hn.NetList
-
Indicates whether an element is included in this NetList.
- contains(String) - Method in class org.ocap.hn.PropertyFilter
-
Checks whether a key is in the list.
- containsResource(ContentResource) - Method in interface org.ocap.hn.content.ContentItem
-
- CONTENT_ADDED - Static variable in class org.ocap.hn.ContentServerEvent
-
Event ID indicating that content got added to a ContentServerNetModule.
- CONTENT_CHANGED - Static variable in class org.ocap.hn.ContentServerEvent
-
Event ID indicating that metadata associated with content has
been updated.
- CONTENT_LIST - Static variable in interface org.ocap.hn.NetModule
-
A constant indicating content listing NetModule.
- CONTENT_MANAGER - Static variable in interface org.ocap.hn.NetModule
-
A constant indicating content manager NetModule.
- CONTENT_RECORDER - Static variable in interface org.ocap.hn.NetModule
-
A constant indicating content recording NetModule.
- CONTENT_REMOVED - Static variable in class org.ocap.hn.ContentServerEvent
-
Event ID indicating that content got removed from a ContentServerNetModule
- CONTENT_RENDERER - Static variable in interface org.ocap.hn.NetModule
-
A constant indicating content renderer NetModule.
- CONTENT_SERVER - Static variable in interface org.ocap.hn.NetModule
-
A constant indicating content server NetModule.
- ContentContainer - Interface in org.ocap.hn.content
-
This class represents a container that contains one or more content entries.
- ContentDatabaseFilter - Class in org.ocap.hn.content.navigation
-
This class represent a filtering criteria to be applied while creating a ContentList.
- ContentDatabaseFilter() - Constructor for class org.ocap.hn.content.navigation.ContentDatabaseFilter
-
- ContentEntry - Interface in org.ocap.hn.content
-
This interface represents a basic content entry.
- ContentItem - Interface in org.ocap.hn.content
-
This class represents a piece of content.
- ContentList - Interface in org.ocap.hn.content.navigation
-
This interface represents a list of filtered ContentEntry objects.
- ContentResource - Interface in org.ocap.hn.content
-
Abstract class representing a media stream/file.
- ContentServerEvent - Class in org.ocap.hn
-
Event which will be sent to registered ContentServerListeners when
ContentEntrys have been added, changed or removed.
- ContentServerEvent(Object, String[], int) - Constructor for class org.ocap.hn.ContentServerEvent
-
Creates a new ContentServerEvent with the given source object, the ContentItem involved and
an event ID indicating whether the content got added or removed.
- ContentServerListener - Interface in org.ocap.hn
-
Listener interface for classes which are interested in changes to a ContentServerNetModule.
- ContentServerNetModule - Interface in org.ocap.hn
-
Class representing a NetModule which serves content.
- contentUpdated(ContentServerEvent) - Method in interface org.ocap.hn.ContentServerListener
-
- CONTRIBUTOR - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of a contributor.
- createContentContainer(String, ExtendedFileAccessPermissions) - Method in interface org.ocap.hn.content.ContentContainer
-
Creates a new ContentContainer as a child of this ContentContainer.
- createContentItem(File, String, ExtendedFileAccessPermissions) - Method in interface org.ocap.hn.content.ContentContainer
-
Creates a new ContentItem representing a local file as a child of this
ContentContainer.
- createMetadataNode() - Static method in class org.ocap.hn.content.MetadataNode
-
Creates a MetadataNode.
- createMetadataNode(String) - Static method in class org.ocap.hn.content.MetadataNode
-
- createNetRecordingEntry() - Method in interface org.ocap.hn.recording.NetRecordingRequestManager
-
This method creates a local entry which represents a network visible
collection of recording items.
- CREATION_DATE - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
This identifies the CREATION_DATE of a piece of content.
- CREATOR - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
This identifies the CREATOR of a piece of content.
- GENERAL_ERROR - Static variable in exception org.ocap.hn.content.DatabaseException
-
- GENRE - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of the genre to which an object belongs.
- GENRE_CONTAINER - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents an unordered collection of 'objects' that "belong" to the
genre.
- GENRE_CONTAINER_MOVIE - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents a movie genre container.
- GENRE_CONTAINER_MUSIC - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents a music genre container.
- getActionRequest() - Method in class org.ocap.hn.NetActionEvent
-
Returns the ActionRequest which identifies the action instance.
- getActionStatus() - Method in class org.ocap.hn.NetActionEvent
-
Returns the status of the requested action.
- getActionStatus() - Method in interface org.ocap.hn.NetActionRequest
-
Gets the current status of the requested action.
- getBitrate() - Method in interface org.ocap.hn.content.StreamableContentResource
-
Gets the Bitrate this content is encoded with or -1 if not known.
- getBitsPerSample() - Method in interface org.ocap.hn.content.AudioResource
-
Returns the number of bits per sample or -1 if not known.
- getCapabilities() - Method in interface org.ocap.hn.Device
-
Returns capabilities of this device in Enumeration.
- getColorDepth() - Method in interface org.ocap.hn.content.VideoResource
-
Returns the color depth (in bits) of the video/still image.
- getComponentCount() - Method in interface org.ocap.hn.content.ContentContainer
-
Gets the number of ContentEntry objects in this ContentContainer.
- getContainerClass() - Method in interface org.ocap.hn.content.ContentContainer
-
Returns the container class of this container.
- getContent() - Method in class org.ocap.hn.ContentServerEvent
-
Returns the IDs associated with the ContentEntrys involved in this event.
- getContentClass() - Method in interface org.ocap.hn.content.ContentItem
-
Returns the content class of this content item.
- getContentFormat() - Method in interface org.ocap.hn.content.ContentResource
-
Returns the content format.
- getContentItem() - Method in interface org.ocap.hn.content.ContentResource
-
Gets the ContentItem this resource belongs to.
- getContentItem() - Method in interface org.ocap.hn.service.RemoteService
-
Returns the ContentItem associated with this remote service
- getContentServerNetModule() - Method in class org.ocap.hn.ContentServerEvent
-
Returns the ContentServerNetModule.
- getContentSize() - Method in interface org.ocap.hn.content.ContentContainer
-
Gets the size of the ContentContainer and all its content including
all its contained ContentContainer objects.
- getContentSize() - Method in interface org.ocap.hn.content.ContentEntry
-
Gets the size of the content associated with this ContentEntry..
- getContentSize() - Method in interface org.ocap.hn.content.ContentResource
-
Gets the size of the content in bytes or -1 if not known.
- getCreationDate() - Method in interface org.ocap.hn.content.ContentContainer
-
Returns the creation date of this ContentContainer.
- getCreationDate() - Method in interface org.ocap.hn.content.ContentEntry
-
Gets the creation date of the content associated with this ContentEntry.
- getCreationDate() - Method in interface org.ocap.hn.content.ContentResource
-
Gets the creation date of the content or NULL if not known.
- getDevice(String) - Method in class org.ocap.hn.NetManager
-
Returns device by name, for example, "BallRoom:DVD_PLAYER1".
- getDevice() - Method in interface org.ocap.hn.NetModule
-
Returns the device that provides this NetModule.
- getDeviceList(PropertyFilter) - Method in class org.ocap.hn.NetManager
-
Returns devices that match all properties set by a given filter.
- getDisplayName() - Method in class org.ocap.hn.NetworkInterface
-
Gets a humanly readable name for this interface, e.g.
- getDuration() - Method in interface org.ocap.hn.content.StreamableContentResource
-
Gets the duration of this content.
- getElement(int) - Method in interface org.ocap.hn.NetList
-
Returns the element indexed by a number.
- getElements() - Method in interface org.ocap.hn.NetList
-
Returns all elements in this NetList in Enumeration.
- getEntries() - Method in interface org.ocap.hn.content.ContentContainer
-
Gets an Enumeration over all entries in this ContentContainer, from local
cache only; does not cause network activity.
- getEntries(ContentDatabaseFilter, boolean) - Method in interface org.ocap.hn.content.ContentContainer
-
Returns a ContentList which contains the filtered ContentItems of this
ContentContainer.
- getEntry(String) - Method in interface org.ocap.hn.content.ContentContainer
-
Returns the ContentEntry associated with the given ID in this container,
or NULL if no entry is found.
- getEntry(int) - Method in interface org.ocap.hn.content.ContentContainer
-
Returns the nth ContentEntry in this container, from local
cache only; does not cause network activity.
- getEntryParent() - Method in interface org.ocap.hn.content.ContentEntry
-
- getError() - Method in class org.ocap.hn.NetActionEvent
-
Gets the error value when getActionStatus returns
NetActionEvent.ACTION_FAILED.
- getError() - Method in interface org.ocap.hn.NetActionRequest
-
Gets the error value when getActionStatus returns
NetActionEvent.ACTION_FAILED.
- getEventID() - Method in class org.ocap.hn.ContentServerEvent
-
Gets the event ID for this event.
- getExceptionNumber() - Method in exception org.ocap.hn.content.DatabaseException
-
Returns the unique exception code related to the database.
- getExtendedFileAccessPermissions() - Method in interface org.ocap.hn.content.ContentContainer
-
Gets the ExtendedFileAccessPermissions of this ContentContainer.
- getExtendedFileAccessPermissions() - Method in interface org.ocap.hn.content.ContentEntry
-
Gets the file permissions of this ContentEntry, or null if unknown.
- getExtendedFileAccessPermissions() - Method in interface org.ocap.hn.content.ContentResource
-
Returns the file permissions of a ContentResource.
- getExtendedFileAccessPermissions(String) - Method in class org.ocap.hn.content.MetadataNode
-
Gets the ExtendedFileAccessPermissions for the property
identified by the specified key.
- getID() - Method in interface org.ocap.hn.content.ContentEntry
-
Returns the ID of this ContentEntry.
- getIdentifiers() - Static method in class org.ocap.hn.content.MetadataIdentifiers
-
Gets all metadata identifiers for all HN profiles supported by this
Host device.
- getIndex(ContentEntry) - Method in interface org.ocap.hn.content.ContentContainer
-
Gets the index of the specified ContentEntry, from local
cache only; does not cause network activity.
- getInetAddress() - Method in interface org.ocap.hn.Device
-
Returns the IP address for this device.
- getInetAddress() - Method in class org.ocap.hn.NetworkInterface
-
Gets the InetAddress of this interface.
- getInstance() - Static method in class org.ocap.hn.NetManager
-
Returns the singleton NetManager.
- getInstance() - Static method in class org.ocap.hn.security.NetSecurityManager
-
Get the network security manager.
- getItemService() - Method in interface org.ocap.hn.content.ContentItem
-
If this ContentItem is presentable as a JavaTV Service than this method
returns a javax.tv.service.Service, or derivative of a Service, e.g.
- getKey() - Method in class org.ocap.hn.content.MetadataNode
-
Gets the key string, which can be utilized to retrieve this
MetadataNode from its parent.
- getKeys() - Method in class org.ocap.hn.content.MetadataNode
-
Gets the keys for all top-level metadata in this
MetadataNode.
- getKeys() - Method in interface org.ocap.hn.Device
-
Returns all property keys supported by this device in
Enumeration.
- getKeys() - Method in interface org.ocap.hn.NetModule
-
Returns the property keys supported by this NetModule.
- getLanguages() - Method in interface org.ocap.hn.content.AudioResource
-
Returns an array of languages associated with this audio content or a zero
length array if not known.
- getLocator() - Method in interface org.ocap.hn.content.ContentResource
-
Gets an OcapLocator to the content associated with this ContentResource
if the content can be located with that Locator type, otherwise
returns an implementation specific Locator to the content.
- getMacAddress() - Method in class org.ocap.hn.NetworkInterface
-
Gets the MAC address of this interface.
- getMetadata(String) - Method in class org.ocap.hn.content.MetadataNode
-
Gets a reference to the value associated with the specified key,
if any.
- getMetadata() - Method in class org.ocap.hn.content.MetadataNode
-
Gets an Enumeration of all top-level metadata in this
MetadataNode.
- getMetadata() - Method in class org.ocap.hn.recording.NetRecordingSpec
-
Retrieves the root metadata node for this recording spec.
- getName() - Method in interface org.ocap.hn.content.ContentContainer
-
Gets the name of this ContentContainer.
- getName() - Method in interface org.ocap.hn.Device
-
Returns the name of this device.
- getNetModule(String) - Method in interface org.ocap.hn.Device
-
Returns the NetModule by module id.
- getNetModule(String, String) - Method in class org.ocap.hn.NetManager
-
Returns NetModule by device and module ID.
- getNetModuleId() - Method in interface org.ocap.hn.NetModule
-
Returns the id of this NetModule, which is unique within the device.
- getNetModuleList() - Method in interface org.ocap.hn.Device
-
Returns the list of NetModules supported by this device.
- getNetModuleList(PropertyFilter) - Method in class org.ocap.hn.NetManager
-
Returns NetModules that match all properties set by a given filter.
- getNetModuleType() - Method in interface org.ocap.hn.NetModule
-
Returns the type of this NetModule.
- getNetwork() - Method in interface org.ocap.hn.content.ContentResource
-
Returns the network on which the content is available.
- getNetworkInterfaces() - Static method in class org.ocap.hn.NetworkInterface
-
Gets an array of NetworkInterface instances that represent
all of the network interfaces supported by the device.
- getNetworkPassword(NetworkInterface) - Method in class org.ocap.hn.security.NetSecurityManager
-
Gets a network interface password.
- getNumberOfChannels() - Method in interface org.ocap.hn.content.AudioResource
-
Returns the number of audio channels, for example, 1 for mono, 2 for stereo, 6 for DTS 5.1 and 7 for DTS 6.1
- getNumberOfIdentifiers() - Static method in class org.ocap.hn.content.MetadataIdentifiers
-
Gets the number of identifiers in the set of supported identifiers
returned by the #getIdentifiers method.
- getParentDevice() - Method in interface org.ocap.hn.Device
-
Returns the parent of this device.
- getParentID() - Method in interface org.ocap.hn.content.ContentEntry
-
- getParentNode() - Method in class org.ocap.hn.content.MetadataNode
-
Gets the parent MetadataNode of this
MetadataNode.
- getProgress() - Method in interface org.ocap.hn.NetActionRequest
-
Gets the progress of the action in percent (0.0 - 1.0).
- getProperty(String) - Method in interface org.ocap.hn.Device
-
Returns property of this device specified by a key.
- getProperty(String) - Method in interface org.ocap.hn.NetModule
-
Returns the property value for specified key.
- getProtocol() - Method in interface org.ocap.hn.content.ContentResource
-
Returns the protocol which can be used to retrieve the content.
- getRecordingContentItemIDs() - Method in interface org.ocap.hn.recording.NetRecordingEntry
-
Retrieves ObjectIDs of the individual RecordingContentItems that
make up this series recording.
- getRecordingContentItems() - Method in interface org.ocap.hn.recording.NetRecordingEntry
-
Retrieves the local individual RecordingContentItems that make up this
series recording.
- getRecordingEntry() - Method in interface org.ocap.hn.recording.RecordingContentItem
-
Returns the NetRecordingEntry which contains this recording content item
if the NetRecordingEntry is available.
- getRecordingEntryID() - Method in interface org.ocap.hn.recording.RecordingContentItem
-
Returns the ObjectID of the NetRecordingEntry which contains this recording content item.
- getRenderableResources() - Method in interface org.ocap.hn.content.ContentItem
-
Gets an array copy of renderable ContentResources which are part of this
ContentItem.
- getResolution() - Method in interface org.ocap.hn.content.VideoResource
-
Returns the resolution of the video/still image.
- getResource(int) - Method in interface org.ocap.hn.content.ContentItem
-
- getResourceCount() - Method in interface org.ocap.hn.content.ContentItem
-
Returns the number of
ContentResources which are associated with
this ContentItem.
- getResourceIndex(ContentResource) - Method in interface org.ocap.hn.content.ContentItem
-
Returns the index of the specified ContentResource or -1 if the
ContentResource does not exist in this ContentItem.
- getResourceProperty(String) - Method in interface org.ocap.hn.content.ContentResource
-
Returns properties of the resource.
- getResources() - Method in interface org.ocap.hn.content.ContentItem
-
Gets an array copy of ContentResources which are part of this
ContentItem.
- getResponse() - Method in class org.ocap.hn.NetActionEvent
-
Returns the response of the Action.
- getRootMetadataNode() - Method in interface org.ocap.hn.content.ContentEntry
-
Gets the metadata for this ContentEntry.
- getSampleFrequency() - Method in interface org.ocap.hn.content.AudioResource
-
Returns the sample frequency in Hz of this audio content or -1 if not known.
- getServer() - Method in interface org.ocap.hn.content.ContentEntry
-
Gets the server where this ContentEntry is located.
- getSortOrder() - Method in interface org.ocap.hn.content.navigation.ContentList
-
Gets the sort order set by the #setSortOrder method.
- getSource() - Method in class org.ocap.hn.DeviceEvent
-
Returns device event source, which is always a Device.
- getSource() - Method in class org.ocap.hn.NetModuleEvent
-
Returns module event source, which is always a NetModule.
- getSubDevices() - Method in interface org.ocap.hn.Device
-
Returns a list of sub devices hosted by this device.
- getTitle() - Method in interface org.ocap.hn.content.ContentItem
-
Gets the title for this ContentItem, or null if the title is unknown.
- getType() - Method in interface org.ocap.hn.Device
-
Returns the type of this device, for example, MediaRenderer, MediaServer,
etc.
- getType() - Method in class org.ocap.hn.DeviceEvent
-
Returns device event type, as defined in DeviceEvent.
- getType() - Method in class org.ocap.hn.NetModuleEvent
-
Returns module event type, as defined in NetModuleEvent.
- getType() - Method in class org.ocap.hn.NetworkInterface
-
Gets the type of this network interface.
- getVersion() - Method in interface org.ocap.hn.Device
-
Returns the version number associated with this Device's device type.
- GREATER_THAN - Static variable in class org.ocap.hn.content.navigation.DatabaseQuery
-
Operator to specify greater than .
- GREATER_THAN_OR_EQUALS - Static variable in class org.ocap.hn.content.navigation.DatabaseQuery
-
Operator to specify greater than or equals.
- negate() - Method in class org.ocap.hn.content.navigation.DatabaseQuery
-
Create a new DatabaseQuery, which is the logical NOT of this query.
- NetActionEvent - Class in org.ocap.hn
-
This class represents an event generated in response to an action.
- NetActionEvent(Object, Object, int, int) - Constructor for class org.ocap.hn.NetActionEvent
-
Two argument constructor.
- NetActionHandler - Interface in org.ocap.hn
-
This interface represents a handler passed to asynchronous methods
- NetActionRequest - Interface in org.ocap.hn
-
All asynchronous actions in the Home networking API return an NetActionRequest.
- NetAuthorizationHandler - Interface in org.ocap.hn.security
-
This interface represents a callback mechanism to a registered network
authorization handler application.
- NetList - Interface in org.ocap.hn
-
A list comprising of homenetwork elements such as Device or NetModule.
- NetManager - Class in org.ocap.hn
-
The NetManager is a singleton class that registers all the
Devices and NetModules within a home network.
- NetManager() - Constructor for class org.ocap.hn.NetManager
-
- NetModule - Interface in org.ocap.hn
-
NetModule is an abstraction of functionality that is provided by a
Device.
- NetModuleEvent - Class in org.ocap.hn
-
Entity for NetModule Event.
- NetModuleEvent(int, Object) - Constructor for class org.ocap.hn.NetModuleEvent
-
Constructs a NetModuleEvent by specifying type and source.
- NetModuleEventListener - Interface in org.ocap.hn
-
NetModuleEvent callback interface.
- NetRecordingEntry - Interface in org.ocap.hn.recording
-
This ContentEntry represents a series recording that has been scheduled on
the home network.
- NetRecordingRequestHandler - Interface in org.ocap.hn.recording
-
A class implementing this interface processes recording requests received
from devices on the home network.
- NetRecordingRequestManager - Interface in org.ocap.hn.recording
-
This interface represents a local RecordingNetModule.
- NetRecordingSpec - Class in org.ocap.hn.recording
-
This class represents a network recording specification.
- NetRecordingSpec() - Constructor for class org.ocap.hn.recording.NetRecordingSpec
-
Default constructor for the NetRecordingSpec.
- NetRecordingSpec(MetadataNode) - Constructor for class org.ocap.hn.recording.NetRecordingSpec
-
Metadata constructor for the NetRecordingSpec.
- NetSecurityManager - Class in org.ocap.hn.security
-
This class provides access to home network security capabilities including
password handling.
- NetSecurityManager() - Constructor for class org.ocap.hn.security.NetSecurityManager
-
Protected constructor.
- NetworkInterface - Class in org.ocap.hn
-
This class represents a home network interface including MoCA, wired
ethernet, and wireless ethernet.
- NetworkInterface() - Constructor for class org.ocap.hn.NetworkInterface
-
Protected constructor.
- newInstance(String, int, String) - Static method in class org.ocap.hn.content.navigation.DatabaseQuery
-
Make a new DatabaseQuery for a specific value in a specific field.
- NOT_EQUALS - Static variable in class org.ocap.hn.content.navigation.DatabaseQuery
-
Operator to check for in-equality.
- NotAuthorizedException - Exception in org.ocap.hn
-
Exception indicating that the application has no permission to perform
certain action.
- NotAuthorizedException() - Constructor for exception org.ocap.hn.NotAuthorizedException
-
Constructs a NotAuthorizedException object.
- NotAuthorizedException(String) - Constructor for exception org.ocap.hn.NotAuthorizedException
-
Constructs a NotAuthorizedException object with a reason.
- notify(DeviceEvent) - Method in interface org.ocap.hn.DeviceEventListener
-
Callback function for Device events.
- notify(NetActionEvent) - Method in interface org.ocap.hn.NetActionHandler
-
Notifies the application of an action event.
- notify(NetModuleEvent) - Method in interface org.ocap.hn.NetModuleEventListener
-
Callback function for NetModule event.
- notifyAction(String, InetAddress, String, int) - Method in interface org.ocap.hn.security.NetAuthorizationHandler
-
Notifies the authorization handler application that an action it
registered interest in has been received.
- notifyActivityEnd(int) - Method in interface org.ocap.hn.security.NetAuthorizationHandler
-
Notifies the registered authorization handler application that an
activity has ended.
- notifyActivityStart(InetAddress, String, URL, int) - Method in interface org.ocap.hn.security.NetAuthorizationHandler
-
Notifies the registered authorization handler application that an
activity to access cable services has been started.
- notifyDelete(InetAddress, ContentEntry) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that metadata associated with a recording be
deleted.
- notifyDeleteService(InetAddress, ContentEntry) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that content associated with a recorded service be
deleted.
- notifyDisable(InetAddress, ContentEntry) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that a recording be disabled.
- notifyPrioritization(InetAddress, NetRecordingEntry[]) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that a group of recordings be re-prioritized.
- notifyPrioritization(InetAddress, RecordingContentItem[]) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that a group of individual recordings be
re-prioritized.
- notifyReschedule(InetAddress, ContentEntry, NetRecordingEntry) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that a recording be rescheduled.
- notifySchedule(InetAddress, NetRecordingEntry) - Method in interface org.ocap.hn.recording.NetRecordingRequestHandler
-
Notifies this NetRecordingRequestHandler that a device on the home
network has requested that a recording be scheduled.
- PARENT_ID - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
An identifier for the parent of this object.
- PERSON_CONTAINER - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents an unordered collection of 'objects' that "belong"
to the people.
- PERSON_CONTAINER_MUSIC_ARTIST - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents a music artist person container.
- PLAYLIST - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of a playlist this object belongs to.
- PLAYLIST_CONTAINER - Static variable in interface org.ocap.hn.content.ContentContainer
-
Represents a collection of objects.
- PRODUCER - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of a producer.
- PROP_ACCESS_PERMISSIONS - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the file access permissions of this recording item
from this item's metadata.
- PROP_APP_ID - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the application ID of this recording item
from this item's metadata.
- PROP_CDS_REFERENCE - Static variable in interface org.ocap.hn.recording.NetRecordingEntry
-
Key constant for retrieving the CDS reference of this recording entry
from this entry's metadata.
- PROP_CONTENT_URI - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the location of content associated with this
recording item from this item's metadata.
- PROP_CONTROL_URL - Static variable in interface org.ocap.hn.NetModule
-
A constant providing URL for NetModule control.
- PROP_DESCRIPTION_URL - Static variable in interface org.ocap.hn.NetModule
-
A constant providing URL for NetModule description.
- PROP_DESTINATION - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the destination of this recording item
from this item's metadata.
- PROP_DEVICE_TYPE - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: device type
- PROP_DEVICE_VERSION - Static variable in interface org.ocap.hn.Device
-
A constant representing a device version number
- PROP_DURATION - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the duration in milliseconds of this recording
item from this item's metadata.
- PROP_EventSub_URL - Static variable in interface org.ocap.hn.NetModule
-
A constant providing URL for NetModule eventing.
- PROP_EXPIRATION_PERIOD - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the expiration period for this recording item
from this item's metadata.
- PROP_FRIENDLY_NAME - Static variable in interface org.ocap.hn.Device
-
A constant for a friendly name of the device.
- PROP_LOCATION - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: location of the device.
- PROP_MANUFACTURER - Static variable in interface org.ocap.hn.Device
-
A constant indicating the manufacturer of this device.
- PROP_MANUFACTURER_URL - Static variable in interface org.ocap.hn.Device
-
A constant providing URL to the manufacturer's web site.
- PROP_MEDIA_FIRST_TIME - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the media first time for this recording item
from this item's metadata.
- PROP_MIDDLEWARE_PROFILE - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: middleware profile.
- PROP_MIDDLEWARE_VERSION - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: middleware version.
- PROP_MODEL_DESCRIPTION - Static variable in interface org.ocap.hn.Device
-
A constant providing description of the device.
- PROP_MODEL_NAME - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: model name.
- PROP_MODEL_NUMBER - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: model number.
- PROP_MODEL_URL - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: model URL.
- PROP_MSO_CONTENT - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the MSO content indicator for this recording item
from this item's metadata.
- PROP_NET_RECORDING_ENTRY - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the ID of any NetRecordingEntry
containing this RecordingContentItem.
- PROP_NETMODULE_ID - Static variable in interface org.ocap.hn.NetModule
-
A constant indicating NetModuleID.
- PROP_NETMODULE_TYPE - Static variable in interface org.ocap.hn.NetModule
-
A constant providing this NetModule's type.
- PROP_ORGANIZATION - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the organization of this recording item
from this item's metadata.
- PROP_PRESENTATION_POINT - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the presentation point for this recording item
from this item's metadata.
- PROP_PRESENTATION_URL - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: presentation URL.
- PROP_PRIORITY_FLAG - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the priority flag of this recording item
from this item's metadata.
- PROP_RCI_LIST - Static variable in interface org.ocap.hn.recording.NetRecordingEntry
-
Key constant for retrieving the RCI list of this recording entry
from this entry's metadata.
- PROP_RECORDING_STATE - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the state of this recording item from this
item's metadata.
- PROP_RETENTION_PRIORITY - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the retention priority of this recording item
from this item's metadata.
- PROP_SCHEDULED_CDS_ENTRY_ID - Static variable in interface org.ocap.hn.recording.NetRecordingEntry
-
Key constant for retrieving the scheduled CDS entry ID of this recording entry
from this entry's metadata.
- PROP_SERIAL_NUMBER - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: serial number.
- PROP_SOURCE_ID - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the source ID of this recording item
from this item's metadata.
- PROP_SOURCE_ID_TYPE - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the source ID type of this recording item
from this item's metadata.
- PROP_SPACE_REQUIRED - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the estimated space required for this recording item
from this item's metadata.
- PROP_START_TIME - Static variable in interface org.ocap.hn.recording.RecordingContentItem
-
Key constant for retrieving the start time of this recording item from
this item's metadata.
- PROP_STORAGE_FREE - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Property indicating current storage space available on a storage container.
- PROP_STORAGE_TOTAL - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Property indicating total storage on a storage container.
- PROP_UDN - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: unique device name.
- PROP_UPC - Static variable in interface org.ocap.hn.Device
-
A constant indicates device property: universal product code.
- PropertyFilter - Class in org.ocap.hn
-
The filter for (key,value) pair filtering mechanism.
- PropertyFilter(Properties) - Constructor for class org.ocap.hn.PropertyFilter
-
Constructs a PropertyFilter object.
- PROPRIETARY_DATA - Static variable in class org.ocap.hn.content.MetadataIdentifiers
-
This identifies proprietary data.
- PUBLISHER - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Name of a publisher.
- RADIO_BAND - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Radio station frequency band.
- RADIO_CALL_SIGN - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Radio station call sign, e.g. "KSJO".
- RADIO_STATION_ID - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Some identification, e.g. "107.7", broadcast frequency of the
radio station.
- RATING - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Rating of the object's resource, for 'parental control' filtering purposes,
such as "R", "PG-13", "X".
- RecordingContentItem - Interface in org.ocap.hn.recording
-
This ContentItem represents a recording that has been scheduled
on the home network.
- RecordingNetModule - Interface in org.ocap.hn.recording
-
An interface representing a NetModule which provides DVR functionality.
- REGION - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Some identification of the region, associated with the 'source' of the object,
e.g. "US", "Latin America", "Seattle".
- RELATION - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Reference to related resources.
- REMOTE_QUERY_IS_INVALID - Static variable in exception org.ocap.hn.content.DatabaseException
-
- RemoteService - Interface in org.ocap.hn.service
-
A RemoteService is a service which is hosted or provided by another device on the home network.
- removeContentEntries(ContentEntry[]) - Method in interface org.ocap.hn.content.ContentContainer
-
Removes ContentEntry objects from this ContentContainer.
- removeContentEntry(ContentEntry) - Method in interface org.ocap.hn.content.ContentContainer
-
Removes a ContentEntry from this ContentContainer.
- removeContentServerListener(ContentServerListener) - Method in interface org.ocap.hn.ContentServerNetModule
-
Removes the specified ContentServerListener.
- removeDeviceEventListener(DeviceEventListener) - Method in interface org.ocap.hn.Device
-
Removes a DeviceEventListener instance from this Device.
- removeDeviceEventListener(DeviceEventListener) - Method in class org.ocap.hn.NetManager
-
Removes a Device event listener from NetManager.
- removeKey(String) - Method in class org.ocap.hn.PropertyFilter
-
Remove a key from the filter, if the key is not in the property
list, no action is taken.
- removeKeys(String[]) - Method in class org.ocap.hn.PropertyFilter
-
Remove keys from the filter, if a key is not in the property list,
it is disregarded; while others are processed as normal.
- removeNetModuleEventListener(NetModuleEventListener) - Method in class org.ocap.hn.NetManager
-
Removes a NetModule event listener from NetManager.
- removeNetModuleEventListener(NetModuleEventListener) - Method in interface org.ocap.hn.NetModule
-
Removes a NetModuleEventListener instance from this NetModule.
- removeRecordingContentItem(RecordingContentItem) - Method in interface org.ocap.hn.recording.NetRecordingEntry
-
Removes a local RecordingContentItem from this recording object.
- requestBrowseEntries(String, String, boolean, int, int, String, NetActionHandler) - Method in interface org.ocap.hn.ContentServerNetModule
-
Requests a browse of this ContentServer which results in the
creation of a ContentList.
- requestConflictingRecordings(NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingContentItem
-
Requests a list of recordings whose usage of resources conflict with
this recording content item.
- requestDelete(ContentEntry, NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that metadata associated with a scheduled recording be deleted
from storage.
- requestDeleteService(ContentEntry, NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that content associated with a scheduled recording be deleted
from storage.
- requestDisable(ContentEntry, NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that an in progress recording be disabled on this network
recording device.
- requestPrioritize(RecordingContentItem[], NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that a group of scheduled individual recordings be prioritized on this
network recording device.
- requestPrioritize(NetRecordingEntry[], NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that a group of scheduled recording request be prioritized on this
network recording device, where each recording request may represent one
or more individual recordings on the remote device.
- requestReschedule(ContentEntry, NetRecordingSpec, NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that a recording be rescheduled on this network recording
device.
- requestRootContainer(NetActionHandler) - Method in interface org.ocap.hn.ContentServerNetModule
-
returns the root ContentContainer for this ContentServerNetModule.
- requestSchedule(NetRecordingSpec, NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingNetModule
-
Requests that a recording be scheduled on this network recording device.
- requestSearchCapabilities(NetActionHandler) - Method in interface org.ocap.hn.ContentServerNetModule
-
- requestSearchEntries(String, String, int, int, String, String, NetActionHandler) - Method in interface org.ocap.hn.ContentServerNetModule
-
Requests a search of this ContentServer which results in the
creation of a ContentList.
- requestSetMediaTime(Time, NetActionHandler) - Method in interface org.ocap.hn.recording.RecordingContentItem
-
Requests that the presentation point of this recording be updated.
- revokeAuthorization(int) - Method in class org.ocap.hn.security.NetSecurityManager
-
Revokes a session authorization granted by the authorization handler.
- RIGHTS - Static variable in interface org.ocap.hn.profiles.upnp.UPnPConstants
-
Element Description: Information about rights held in and over the resource.