Description

Service:: This is a service and can be accessed through toi.dlnaService

This is the main interface which the DLNA service registers with the system's name service. The interface is used by applications to access the DLNA network and create their own DLNA service control point instances.

The typical procedure to set up a control point session and communicate with a service in another DLNA device looks like this:

Interface	Procedure
ToiDlnaService	List media servers on the network (ToiDlnaService::getMediaServers()). Get an instance for one of the media servers (ToiDlnaService::createContentDirectoryInstance()).
ToiDlnaContentDirectoryService	Get root container identifier (ToiDlnaContentDirectoryService::getRootContainerId()). Create an operation identifier (ToiOperationManager::createOperation()). Start a browse object operation for root container (ToiDlnaContentDirectoryService::browse()).
ToiOperationManager	Receive events that operation results are available (ToiOperationOperationResultEvent). Read objects (operation results) (ToiDlnaContentDirectoryService::getOperationObjectResult()). When done, release operation or reuse it in next browse/search. (ToiOperationManager::releaseOperation()).
ToiDlnaContentDirectoryServiceCdsObject	Read object data and properties.

See also:: ToiDlnaContentDirectoryService; ToiOperationManager; ToiOperationOperationResultEvent; ToiDlnaContentDirectoryContainerChangedEvent; ToiDlnaMediaServerAppearedEvent; ToiDlnaMediaServerDisappearedEvent

import "ToiDlnaService.idl";

Inheritance diagram for ToiDlnaService:

List of all members.

Public Member Functions
TToiMediaServerUuidSequence	getMediaServers ()
ToiDlnaServiceMediaServerInfo	getMediaServerInfo (in TToiMediaServerUuid uuid) raises (TToiInvalidArgumentException)
ToiOperationManager	getDlnaOperationManager ()
ToiDlnaContentDirectoryService	createContentDirectoryInstance (in TToiMediaServerUuid uuid) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException, TToiOperationNotSupportedException)
ToiDlnaRendererManager	createRendererInstance () raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException, TToiOperationNotSupportedException)
Public Attributes
Events
const long	ON_MEDIA_SERVER_APPEARED = 600
const long	ON_MEDIA_SERVER_DISAPPEARED = 601
TToiServiceType
const TToiServiceType	SERVICE_TYPE_CONTENT_DIRECTORY = 0
TToiMediaFormatProfile
const TToiMediaFormatProfile	MEDIA_FORMAT_PROFILE_JPEG_LRG_ICO = 0
const TToiMediaFormatProfile	MEDIA_FORMAT_PROFILE_JPEG_SM_ICO = 1
const TToiMediaFormatProfile	MEDIA_FORMAT_PROFILE_PNG_LRG_ICO = 2
const TToiMediaFormatProfile	MEDIA_FORMAT_PROFILE_PNG_SM_ICO = 3
Public Types
typedef string	TToiMediaServerUuid
typedef sequence < TToiMediaServerUuid >	TToiMediaServerUuidSequence
typedef long	TToiServiceType
typedef sequence< TToiServiceType >	TToiServiceTypeSequence
typedef long	TToiMediaFormatProfile
typedef sequence < ToiDlnaServiceMediaServerIconInfo >	TToiMediaServerIconInfoSequence

Member Typedef Documentation

typedef long ToiDlnaService::TToiMediaFormatProfile

Supported media format profiles of media server icons.

typedef sequence< ToiDlnaServiceMediaServerIconInfo > ToiDlnaService::TToiMediaServerIconInfoSequence

A sequence of DLNA icons.

typedef string ToiDlnaService::TToiMediaServerUuid

Universally unique identifier of a DLNA media server.

typedef sequence< TToiMediaServerUuid > ToiDlnaService::TToiMediaServerUuidSequence

Sequence of unique DLNA media server identifiers.

typedef long ToiDlnaService::TToiServiceType

The different kinds of DLNA services exposed by DLNA media servers.

typedef sequence< TToiServiceType > ToiDlnaService::TToiServiceTypeSequence

A sequence of DLNA service types.

Member Function Documentation

ToiDlnaContentDirectoryService ToiDlnaService::createContentDirectoryInstance ( in TToiMediaServerUuid uuid ) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException, TToiOperationNotSupportedException)

This function creates a new Content Directory Service control point for a specific DLNA media server and associates it with the calling application.

When the application no longer needs the service, it should release it by calling ToiDlnaContentDirectoryService::releaseInstance().

Parameters:

uuid	The DLNA media server identifier.

Return values:

IToiDlnaContentDirectoryService

Exceptions:

TToiInvalidArgumentException	Raised if the application identifier is invalid.
TToiNotEnoughResourcesException	Raised if the system cannot create a new instance of the service.
TToiOperationNotSupportedException	Raised if the DLNA server does not support the Content Directory Service.

ToiDlnaRendererManager ToiDlnaService::createRendererInstance ( ) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException, TToiOperationNotSupportedException)

Technical Preview:: method CreateRendererInstance is a TECHNICAL PREVIEW, it may change. This function creates a new DLNA Media Renderer Manager for control via an external DMC. This also notifies the internal DLNA stack there is a renderer available. When the application no longer needs the service, it should release it by calling ToiDlnaRendererManager::releaseInstance()

Return values:

IToiDlnaRendererManager

Exceptions:

TToiInvalidArgumentException	Raised if the application identifier is invalid.
TToiNotEnoughResourcesException	Raised if the system cannot create a new instance of the manager.
TToiOperationNotSupportedException	Raised if the platform does not support the Dlna Renderer manager.

ToiOperationManager ToiDlnaService::getDlnaOperationManager ( )

Returns the operation manager that handles asynchronous operations. The procedure of executing asynchronous operations is generic and looks like this:

Get a handle to the operation manager.
Register an observer to get operation events from the operation manager.
Create an operation in order to get an operation identifier.
Call an asynchronous operation using the operation identifier.
Receive progress events for the asynchronous operation.
When the operation is completed, get result data (if any).
Release the operation or reuse the identifier for another asynchronous call.

Return values:

IToiOperationManager

ToiDlnaServiceMediaServerInfo ToiDlnaService::getMediaServerInfo ( in TToiMediaServerUuid uuid ) raises (TToiInvalidArgumentException)

Returns a list with device identifiers for the DLNA devices present in the network.

Parameters:

uuid	The DLNA media server identifier.

Return values:

info	The DLNA media server information.

Exceptions:

TToiInvalidArgumentException Raised if the uuid does not match any DLNA server.

TToiMediaServerUuidSequence ToiDlnaService::getMediaServers ( )

Returns a list with device identifiers for the DLNA devices present in the network.

Return values:

uuids The DLNA media server uuid identifiers.

Member Data Documentation

const TToiMediaFormatProfile ToiDlnaService::MEDIA_FORMAT_PROFILE_JPEG_LRG_ICO = 0

Large JPEG icon: size 120x120 pixels, MIME type "image/jpeg".

This constant can also be accessed from toi.consts.ToiDlnaService.MEDIA_FORMAT_PROFILE_JPEG_LRG_ICO.

const TToiMediaFormatProfile ToiDlnaService::MEDIA_FORMAT_PROFILE_JPEG_SM_ICO = 1

Small JPEG icon: size 48x48 pixels, MIME type "image/jpeg".

This constant can also be accessed from toi.consts.ToiDlnaService.MEDIA_FORMAT_PROFILE_JPEG_SM_ICO.

const TToiMediaFormatProfile ToiDlnaService::MEDIA_FORMAT_PROFILE_PNG_LRG_ICO = 2

Large PNG icon: size 120x120 pixels, MIME type "image/png".

This constant can also be accessed from toi.consts.ToiDlnaService.MEDIA_FORMAT_PROFILE_PNG_LRG_ICO.

const TToiMediaFormatProfile ToiDlnaService::MEDIA_FORMAT_PROFILE_PNG_SM_ICO = 3

Small PNG icon: size 48x48 pixels, MIME type "image/png".

This constant can also be accessed from toi.consts.ToiDlnaService.MEDIA_FORMAT_PROFILE_PNG_SM_ICO.

const long ToiDlnaService::ON_MEDIA_SERVER_APPEARED = 600

This is an Event identifier for ToiDlnaMediaServerAppearedEvent.

This constant can also be accessed from toi.consts.ToiDlnaService.ON_MEDIA_SERVER_APPEARED.

const long ToiDlnaService::ON_MEDIA_SERVER_DISAPPEARED = 601

This is an Event identifier for ToiDlnaMediaServerDisappearedEvent.

This constant can also be accessed from toi.consts.ToiDlnaService.ON_MEDIA_SERVER_DISAPPEARED.

const TToiServiceType ToiDlnaService::SERVICE_TYPE_CONTENT_DIRECTORY = 0

The Content Directory Service used to browse and search for media files.

This constant can also be accessed from toi.consts.ToiDlnaService.SERVICE_TYPE_CONTENT_DIRECTORY.

Description

Public Member Functions

Public Attributes

Public Types

Member Typedef Documentation

Member Function Documentation

Member Data Documentation