IToiAssetManagerService Interface Reference


Description

The IToiAssetManagerService interface provides access to locally stored media assets and metadata associated with these assets.

If no local media storage is available, then this service will not be available in the system.

import "IToiAssetManagerService.idl";

List of all members.

Public Member Functions

void GetAssetOperationManager (out string address)
void CreateDirectory (in TToiDirectoryId parentId, in string title, out TToiDirectoryId dirId) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void MoveDirectory (in TToiDirectoryId dirId, in TToiDirectoryId newParentId) raises (TToiInvalidArgumentException)
void SetDirectoryProperties (in TToiDirectoryId dirId, in TToiPropertySequence properties) raises (TToiInvalidArgumentException)
void RemoveDirectoryProperties (in TToiDirectoryId dirId, in TToiPropertyIdSequence properties) raises (TToiInvalidArgumentException)
void RemoveDirectory (in TToiDirectoryId dirId, in boolean recursiveFlag, in boolean removeAssetsFlag) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
void GetDirectoryInfo (in TToiDirectoryId dirId, out TToiDirectoryInfo info) raises (TToiInvalidArgumentException)
void GetDirectories (in TToiDirectoryId dirId, out TToiDirectoryIdSequence childDirIds) raises (TToiInvalidArgumentException)
void GetDefinedProperties (out TToiPropertyIdSequence properties)
void GetPropertyDefinition (in TToiPropertyId propertyId, out TToiPropertyDefinition definition) raises (TToiInvalidArgumentException)
void CreatePropertyDefinition (in TToiPropertyId propertyId, in TToiPropertyType type, in boolean hasMultipleValueSupport) raises (TToiInvalidArgumentException)
void RemovePropertyDefinition (in TToiPropertyId propertyId) raises (TToiInvalidArgumentException)
void CreateAsset (in TToiAssetType assetType, out TToiAssetId assetId) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void ImportAsset (in IToiOperationManager::TToiOperationId operationId, in TToiAssetId assetId, in string uri, in TToiImportPolicy importPolicy) raises (TToiInvalidArgumentException, TToiNoDataException)
void RemoveAsset (in IToiOperationManager::TToiOperationId operationId, in TToiAssetId assetId) raises (TToiInvalidArgumentException, TToiNoDataException, TToiPermissionDeniedException)
void CopyAsset (in IToiOperationManager::TToiOperationId operationId, in TToiAssetId sourceAssetId, in unsigned long startOffset, in unsigned long duration, in TToiAssetId destinationAssetId) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
void LinkAssets (in TToiDirectoryId dirId, in TToiAssetIdSequence assetIds) raises (TToiInvalidArgumentException)
void UnlinkAssets (in TToiDirectoryId dirId, in TToiAssetIdSequence assetIds) raises (TToiInvalidArgumentException)
void RunQuery (in IToiOperationManager::TToiOperationId operationId, in TToiQueryConditionSequence queryConditions, in TToiPropertyIdSequence requestedProperties, in TToiSortConditionSequence sortConditions) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void RunQueryForDirectory (in IToiOperationManager::TToiOperationId operationId, in TToiDirectoryId directoryId, in TToiQueryConditionSequence queryConditions, in TToiPropertyIdSequence requestedProperties, in TToiSortConditionSequence sortConditions) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void RunCountQuery (in IToiOperationManager::TToiOperationId operationId, in TToiQueryConditionSequence queryConditions) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void GetAssetInfoResult (in IToiOperationManager::TToiOperationId operationId, in unsigned long maxCount, out TToiAssetInfoSequence objects, out boolean hasMore) raises (TToiInvalidArgumentException, TToiNoDataException)
void GetLongResult (in IToiOperationManager::TToiOperationId operationId, out unsigned long value) raises (TToiInvalidArgumentException, TToiNoDataException)
void GetProperties (in TToiAssetId assetId, in TToiPropertyIdSequence requestedProperties, out TToiPropertySequence properties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void GetAllProperties (in TToiAssetId assetId, out TToiPropertySequence properties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void SetProperties (in TToiAssetId id, in TToiPropertySequence properties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void RemoveProperties (in TToiAssetId id, in TToiPropertyIdSequence properties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void RemoveMultiValuedPropertyValue (in TToiAssetId id, in TToiProperty property) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException)
void ReleaseObserver (in string address) raises (TToiInvalidArgumentException)

Public Attributes

const TToiDirectoryId ROOT_DIRECTORY = -1
Operation results

The result types defined for the Asset Manager operations. See IToiOperationManager for generic result types.

const
IToiOperationManager::TToiOperationResult 
OP_RESULT_ASSET_INFO = 1

const
IToiOperationManager::TToiOperationResult 
OP_RESULT_LONG = 2
Property constants

Constants for standard and recommended asset property identifiers. Properties named system.* are set by the platform while info.* properties can be set by applications.

const string PROPERTY_SYSTEM_DURATION = "system.duration"

const string PROPERTY_SYSTEM_FILESIZE = "system.filesize"

const string PROPERTY_SYSTEM_PLAYBACKURI = "system.playbackuri"

const string PROPERTY_SYSTEM_FILENAME = "system.filename"

const string PROPERTY_SYSTEM_TYPE = "system.type"

const string PROPERTY_SYSTEM_INTEGRITY_STATUS = "system.integritystatus"

const string PROPERTY_INFO_TITLE = "info.title"

const string PROPERTY_INFO_DATE = "info.date"

const string PROPERTY_INFO_DESCRIPTION = "info.description"

const string PROPERTY_INFO_LONGDESCRIPTION = "info.longdescription"

const string PROPERTY_INFO_CHANNELNAME = "info.channelname"

const string PROPERTY_INFO_RECORDINGSTATUS = "info.recordingstatus"

const string PROPERTY_INFO_MATURITYRATING = "info.maturityrating"

const string PROPERTY_INFO_SHARED = "info.shared"

const string PROPERTY_INFO_COVER = "info.cover"

const string PROPERTY_INFO_CHILDREN = "info.children"

const string PROPERTY_INFO_LOST_AND_FOUND = "info.lostandfound"

Classes

struct  TToiAssetInfo
struct  TToiDirectoryInfo
struct  TToiProperty
struct  TToiPropertyDefinition
struct  TToiQueryCondition
struct  TToiSortCondition

Public Types

enum  TToiConditionOperation {
  EQUALS, NOT_EQUAL, GREATER, LESS,
  GREATER_OR_EQUAL, LESS_OR_EQUAL, CONTAINS
}
enum  TToiPropertyType {
  TYPE_BOOLEAN, TYPE_STRING, TYPE_INTEGER, TYPE_DATE,
  TYPE_ASSETLINK
}
enum  TToiAssetType { ASSET_PVR, ASSET_IMAGE, ASSET_AUDIO, ASSET_VIDEO }
enum  TToiAssetIntegrityStatus { INTEGRITY_UNKNOWN, INTEGRITY_OK, INTEGRITY_COULD_NOT_UPGRADE, INTEGRITY_COULD_NOT_REPAIR }
enum  TToiImportPolicy { IMPORT_POLICY_COPY, IMPORT_POLICY_MOVE }
typedef long TToiQueryId
typedef string TToiAssetId
typedef sequence< TToiAssetIdTToiAssetIdSequence
typedef string TToiPropertyId
typedef sequence< TToiPropertyIdTToiPropertyIdSequence
typedef sequence< string > TToiPropertyValueSequence
typedef sequence< TToiPropertyTToiPropertySequence
typedef sequence< TToiAssetInfoTToiAssetInfoSequence
typedef long TToiDirectoryId
typedef sequence< TToiDirectoryIdTToiDirectoryIdSequence
typedef sequence
< TToiSortCondition
TToiSortConditionSequence
typedef sequence
< TToiQueryCondition
TToiQueryConditionSequence

Member Typedef Documentation

Identifier that uniquely identifies an asset.

Sequence of asset identifiers.

Identifer that uniquely identifies a directory.

Sequence of directory identifiers.

Identifier for a metadata property.

Sequence of property identifiers.

Sequence of properties.

Sequence of property values.

Sequence of query conditions.

Query identifier.

List of sort conditions. The list is used for sorting asset results and the sort conditions are applied in order.


Member Enumeration Documentation

Identifies integrity status of an asset.

Enumerator:
INTEGRITY_UNKNOWN 

Integrity is unknown.

INTEGRITY_OK 

Integrity is ok.

INTEGRITY_COULD_NOT_UPGRADE 

Asset seems to be of an old version but could not be upgraded. The asset can not be played.

INTEGRITY_COULD_NOT_REPAIR 

Asset has been damaged and could not be repaired. The asset can not be played.

Identifies different types of asset. This asset type is provided by the application while creating the asset.

Enumerator:
ASSET_PVR 

Identifier for recording asset type

ASSET_IMAGE 

Identifier for image asset type

ASSET_AUDIO 

Identifier for audio asset type, NOT YET SUPPORTED.

ASSET_VIDEO 

Identifier for video (non-recording) asset type, NOT YET SUPPORTED.

The TToiConditionOperation enumerates possible operations that can be used to define a query condition.

Enumerator:
EQUALS 

Equal operation, ==

NOT_EQUAL 

Not equal operation, !=

GREATER 

Greater operation, >

LESS 

Less operation, <

GREATER_OR_EQUAL 

Greater than or equal operation, >=

LESS_OR_EQUAL 

Less than or equal operation, <=

CONTAINS 

Contains specified value or matching pattern

Policy to be applied when importing an asset. Note that not all policies may be valid for all URIs which are imported.

Enumerator:
IMPORT_POLICY_COPY 

Import asset by copying the source. The source is kept.

IMPORT_POLICY_MOVE 

Import asset by moving the source. The source is deleted.

Different kind of property value types.

Enumerator:
TYPE_BOOLEAN 

Value of true/false.

TYPE_STRING 

Any string value.

TYPE_INTEGER 

A signed integer value.

TYPE_DATE 

A positive integer value, seconds since the epoch.

TYPE_ASSETLINK 

An asset identifier.


Member Function Documentation

void IToiAssetManagerService::CopyAsset ( in IToiOperationManager::TToiOperationId  operationId,
in TToiAssetId  sourceAssetId,
in unsigned long  startOffset,
in unsigned long  duration,
in TToiAssetId  destinationAssetId 
) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
Technical Preview:
This method is a TECHNICAL PREVIEW, it may change. Copies data from an existing source asset to a destination asset.
Parameters:
operationId The operation identifier created by IToiOperationManager
sourceAssetId The asset identifier for the source asset.
startOffset Offset (in milliseconds) relative to the source asset beginning to start the copy operation from.
duration The duration (in milliseconds) to be copied.
destinationAssetId The asset identifier for the destination asset.
Exceptions:
TToiInvalidArgumentException Raised if

  • the operation identifier is invalid
  • one or more of the asset identifiers are invalid
  • one or more of the asset types are not ASSET_PVR
  • the destination asset is not empty
  • duration is equal to zero or startOffset is not less than the source asset duration
TToiPermissionDeniedException Raised if the destination asset is locked.
void IToiAssetManagerService::CreateAsset ( in TToiAssetType  assetType,
out TToiAssetId  assetId 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Creates an asset. If the type is ASSET_PVR, the identifier of the asset can be used with a media recorder to save a media stream to disk.

Parameters:
assetType The type of asset
Return values:
assetId The identifier of the created asset.
Exceptions:
TToiInvalidArgumentException Raised if the type is not supported.
TToiNotEnoughResourcesException Raised if the asset could not be created due to missing system resources.
See also:
IToiMediaRecorder::Open()
void IToiAssetManagerService::CreateDirectory ( in TToiDirectoryId  parentId,
in string  title,
out TToiDirectoryId  dirId 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Creates a new directory.

Parameters:
parentId The identifier of the parent directory. Use ROOT_DIRECTORY to create the top directories.
title The title to use for the directory.
Return values:
dirId The identifier of the created directory.
Exceptions:
TToiInvalidArgumentException Raised if the title is invalid or already taken, or if the parent identifier is invalid.
TToiNotEnoughResourcesException Raised if the directory could not be created due to missing system resources.
void IToiAssetManagerService::CreatePropertyDefinition ( in TToiPropertyId  propertyId,
in TToiPropertyType  type,
in boolean  hasMultipleValueSupport 
) raises (TToiInvalidArgumentException)

Creates a new property definition. This method is needed for creating properties that can have multiple values.

Parameters:
propertyId The identifier of the new property, a unique name.
type The property type.
hasMultipleValueSupport Whether the property can have multiple values.
Exceptions:
TToiInvalidArgumentException Raised if the name is already in use by a property.
void IToiAssetManagerService::GetAllProperties ( in TToiAssetId  assetId,
out TToiPropertySequence  properties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Returns all metadata properties for an asset.

Parameters:
assetId The asset identifier.
Return values:
properties The id/value pairs of all the asset's properties.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
TToiNoDataException Raised if no data can be read for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void IToiAssetManagerService::GetAssetInfoResult ( in IToiOperationManager::TToiOperationId  operationId,
in unsigned long  maxCount,
out TToiAssetInfoSequence  objects,
out boolean  hasMore 
) raises (TToiInvalidArgumentException, TToiNoDataException)

Used to get the query results once the applications recieve IToiOperationObserver::OnOperationResult().

Parameters:
operationId The operation identifier of RunQuery().
maxCount The maximum number of objects the user are interested in, 0 if as many as possible shall be returned.
Return values:
objects The resulting asset information.
hasMore When true, there are some assets info in the cache of asset manager. Additional call to this method required.
Exceptions:
TToiInvalidArgumentException Raised if operation is unknown or does not support capability results.
TToiNoDataException Raised if no result is available.
void IToiAssetManagerService::GetAssetOperationManager ( out string  address  ) 

Returns the operation manager that handles asynchronous operations for this asset manager. 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 a 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:
address The address to the IToiOperationManager.
void IToiAssetManagerService::GetDefinedProperties ( out TToiPropertyIdSequence  properties  ) 

Returns the property identifiers for all defined properties also including all properties that are currently used in the database. This lists usually more properties than only those that have been created by CreatePropertyDefinition().

Return values:
properties All defined property identifiers.
See also:
CreatePropertyDefinition()
void IToiAssetManagerService::GetDirectories ( in TToiDirectoryId  dirId,
out TToiDirectoryIdSequence  childDirIds 
) raises (TToiInvalidArgumentException)

Returns all direct directory children of given directory.

Parameters:
dirId The directory identifier. If it equals to ROOT all top level directory identifiers will be returned.
Return values:
childDirIds The list of directory identifiers.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
void IToiAssetManagerService::GetDirectoryInfo ( in TToiDirectoryId  dirId,
out TToiDirectoryInfo  info 
) raises (TToiInvalidArgumentException)

Returns directory information.

Parameters:
dirId The directory identifier.
Return values:
info The directory and its properties.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
void IToiAssetManagerService::GetLongResult ( in IToiOperationManager::TToiOperationId  operationId,
out unsigned long  value 
) raises (TToiInvalidArgumentException, TToiNoDataException)

Used to get the count result once the applications recieve IToiOperationObserver::OnOperationResult().

Parameters:
operationId The operation identifier.
Return values:
value The resulting long value from the operation.
Exceptions:
TToiInvalidArgumentException Raised if operation is unknown or does not have a long value as result.
TToiNoDataException Raised if no result is available.
void IToiAssetManagerService::GetProperties ( in TToiAssetId  assetId,
in TToiPropertyIdSequence  requestedProperties,
out TToiPropertySequence  properties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Returns metadata property values for an asset.

Parameters:
assetId The asset identifier.
requestedProperties The identifiers of the wanted properties.
Return values:
properties The id/value pairs of the requested properties.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
TToiNoDataException Raised if no data can be read for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void IToiAssetManagerService::GetPropertyDefinition ( in TToiPropertyId  propertyId,
out TToiPropertyDefinition  definition 
) raises (TToiInvalidArgumentException)

Returns the property definition for a given property identifier.

Parameters:
propertyId The property identifier.
Return values:
definition The property definition.
Exceptions:
TToiInvalidArgumentException Raised if the property identifier is invalid.
void IToiAssetManagerService::ImportAsset ( in IToiOperationManager::TToiOperationId  operationId,
in TToiAssetId  assetId,
in string  uri,
in TToiImportPolicy  importPolicy 
) raises (TToiInvalidArgumentException, TToiNoDataException)

Import an asset from an external source. This is an asynchronous operation and completion of the operation will not provide any result values, i.e. the result will always be IToiOperationManager::OP_RESULT_NONE.

Parameters:
operationId The operation identifier created by IToiOperationManager.
assetId The identifier of the asset. Currently, only assets of type ASSET_IMAGE are supported.
uri URI to the source to be imported. Currently, only file:// URIs are supported.
importPolicy Policy to be applied when importing source. For file URIs only IMPORT_POLICY_COPY and IMPORT_POLICY_MOVE are valid.
Exceptions:
TToiInvalidArgumentException Raised if the asset type, uri, or import policy is invalid.
TToiNoDataException Raised if there is a problem reading from uri or updating the new asset.
void IToiAssetManagerService::LinkAssets ( in TToiDirectoryId  dirId,
in TToiAssetIdSequence  assetIds 
) raises (TToiInvalidArgumentException)

Links some assets to a directory, i.e. makes the assets visible as a member of the directory.

Parameters:
dirId The directory to link the assets to.
assetIds The assets to link.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier or one of the asset ids is invalid.
void IToiAssetManagerService::MoveDirectory ( in TToiDirectoryId  dirId,
in TToiDirectoryId  newParentId 
) raises (TToiInvalidArgumentException)

Moves the directory to a new parent directory.

Parameters:
dirId The directory identifier.
newParentId The new parent directory identifier.
Exceptions:
TToiInvalidArgumentException Raised if either the directory identifier or the parent identifier is invalid.
void IToiAssetManagerService::RegisterObserver ( in IToiApplicationService::TToiApplicationId  applicationId,
in string  address 
) raises (TToiInvalidArgumentException)

Register an observer of type IToiAssetManagerObserver. The observer will receive events sent by this IToiAssetManagerService instance.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiAssetManagerService can find an IToiAssetManagerObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address.
See also:
IToiAssetManagerObserver
void IToiAssetManagerService::ReleaseObserver ( in string  address  )  raises (TToiInvalidArgumentException)

Release an observer previously registered with RegisterObserver.

Parameters:
address The address where the IToiAssetManagerService can find the registered IToiAssetManagerObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiAssetManagerObserver
void IToiAssetManagerService::RemoveAsset ( in IToiOperationManager::TToiOperationId  operationId,
in TToiAssetId  assetId 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiPermissionDeniedException)

Removes an asset. An asset can only be erased if the asset is not locked for playback or recording. This is an asynchronous operation and completion of the operation will not provide any result values, i.e. the result will always be IToiOperationManager::OP_RESULT_NONE.

Parameters:
operationId The operation identifier created by IToiOperationManager
assetId The asset identifier.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
TToiNoDataException Raised if there is no data to remove.
TToiPermissionDeniedException Raised if the asset is locked.
void IToiAssetManagerService::RemoveDirectory ( in TToiDirectoryId  dirId,
in boolean  recursiveFlag,
in boolean  removeAssetsFlag 
) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)

Remove a directory. The directory can only be removed if it is empty and does not contain any assets or directories. If the recursive flag is set all assets and directories will also be removed.

Parameters:
dirId The directory identifier.
recursiveFlag If true all child directories are also removed.
removeAssetsFlag If true all assets in the directories are also removed. This completely removes the asset and thus it will be removed from all directories it is linked to.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
TToiPermissionDeniedException Raised if the directory contains directories/assets and the corresponding override flag (recursive/remove) is not set.
void IToiAssetManagerService::RemoveDirectoryProperties ( in TToiDirectoryId  dirId,
in TToiPropertyIdSequence  properties 
) raises (TToiInvalidArgumentException)

Unsets the properties for a directory.

Parameters:
dirId The directory identifier.
properties The list of properties.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
void IToiAssetManagerService::RemoveMultiValuedPropertyValue ( in TToiAssetId  id,
in TToiProperty  property 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Removes a value from a property that is multi-valued.

Parameters:
id The asset identifier.
property The id/value pair of the property from which the corresponding value should be removed.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid, or if a property identifier is invalid.
TToiNoDataException Raised if no data can be accessed for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void IToiAssetManagerService::RemoveProperties ( in TToiAssetId  id,
in TToiPropertyIdSequence  properties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Removes metadata properties for an asset. All values are erased whether a property has a single or multiple values, i.e., the property is completely removed.

Parameters:
id The asset identifier.
properties The properties to unset.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid, or if a property identifier is invalid.
TToiNoDataException Raised if no data can be accessed for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void IToiAssetManagerService::RemovePropertyDefinition ( in TToiPropertyId  propertyId  )  raises (TToiInvalidArgumentException)

Removes a user defined property, created using CreatePropertyDefinition().

Parameters:
propertyId The identifier of the property to remove.
Exceptions:
TToiInvalidArgumentException Raised if the property identifier is invalid or not a user defined property.
void IToiAssetManagerService::RunCountQuery ( in IToiOperationManager::TToiOperationId  operationId,
in TToiQueryConditionSequence  queryConditions 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Starts a query that finds the number of assets that match given conditions. This is an asynchronous operation. When application gets the IToiOperationObserver::OnOperationResult() with the operation result OP_RESULT_LONG, then the application should get the result by calling the GetLongResult() function.

Parameters:
operationId The operation identifier created by IToiOperationManager
queryConditions The conditions that define the query to be executed. Only assets with matching properties will be counted.
Exceptions:
TToiInvalidArgumentException Raised if any of the conditions are invalid, or raised if the operation identifier is illegal.
TToiNotEnoughResourcesException Raised if it was not enough system resources to perform the query.
void IToiAssetManagerService::RunQuery ( in IToiOperationManager::TToiOperationId  operationId,
in TToiQueryConditionSequence  queryConditions,
in TToiPropertyIdSequence  requestedProperties,
in TToiSortConditionSequence  sortConditions 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Starts a query that finds assets that match given conditions. This is an asynchronous operation. When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result OP_RESULT_ASSET_INFO, then the application should get the results by calling the GetAssetInfoResult() function. The resulting TToiAssetInfo will only include property values for the requested properties.

Parameters:
operationId The operation identifier created by IToiOperationManager
queryConditions The conditions that define the query to be executed. Only assets with matching properties will be in the result.
requestedProperties The properties that will be part of the result.
sortConditions Defines the sorting order for the result.
Exceptions:
TToiInvalidArgumentException Raised if any of the conditions are invalid, or raised if the operation identifier is illegal.
TToiNotEnoughResourcesException Raised if it was not enough system resources to perform the query.
void IToiAssetManagerService::RunQueryForDirectory ( in IToiOperationManager::TToiOperationId  operationId,
in TToiDirectoryId  directoryId,
in TToiQueryConditionSequence  queryConditions,
in TToiPropertyIdSequence  requestedProperties,
in TToiSortConditionSequence  sortConditions 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Starts a query that finds assets in the specified directory that match given conditions. This is an asynchronous operation. When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result OP_RESULT_ASSET_INFO, then the application should get the results by calling the GetAssetInfoResult() function. The resulting TToiAssetInfo will only include property values for the requested properties.

Parameters:
operationId The operation identifier created by IToiOperationManager
directoryId The directory which assets will be matched.
queryConditions The conditions that define the query to be executed. Only assets with matching properties will be in the result.
requestedProperties The properties that will be part of the result.
sortConditions Defines the sorting order for the result.
Exceptions:
TToiInvalidArgumentException Raised if any of the conditions are invalid, or raised if the operation identifier is illegal.
TToiNotEnoughResourcesException Raised if it was not enough system resources to perform the query.
void IToiAssetManagerService::SetDirectoryProperties ( in TToiDirectoryId  dirId,
in TToiPropertySequence  properties 
) raises (TToiInvalidArgumentException)

Sets the properties for a directory.

Parameters:
dirId The directory identifier.
properties The list of properties.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
void IToiAssetManagerService::SetProperties ( in TToiAssetId  id,
in TToiPropertySequence  properties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Sets metadata property values for an asset. For properties that supports multiple values, any values set with this method are added to existing values.

Parameters:
id The asset identifier.
properties The properties to set data for.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid, or if a property identifier is invalid.
TToiNoDataException Raised if no data can be read for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void IToiAssetManagerService::UnlinkAssets ( in TToiDirectoryId  dirId,
in TToiAssetIdSequence  assetIds 
) raises (TToiInvalidArgumentException)

Removes the links from some assets to a directory.

Parameters:
dirId The directory to unlink the assets from.
assetIds The assets to unlink.
Exceptions:
TToiInvalidArgumentException Raised if the directory is identifier.

Member Data Documentation

The asynchronous operation has asset info as result. See GetAssetInfoResult().

This constant can also be accessed from toi.consts.IToiAssetManagerService.OP_RESULT_ASSET_INFO.

The asynchronous operation has a long value as result. See GetLongResult().

This constant can also be accessed from toi.consts.IToiAssetManagerService.OP_RESULT_LONG.

const string IToiAssetManagerService::PROPERTY_INFO_CHANNELNAME = "info.channelname"

Property name for the channel name of a recorded asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_CHANNELNAME.

const string IToiAssetManagerService::PROPERTY_INFO_CHILDREN = "info.children"

Property name for a list of assets which will be removed automatically when the asset is removed. Relevant for all asset types.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_CHILDREN.

const string IToiAssetManagerService::PROPERTY_INFO_COVER = "info.cover"

Property name for the cover image associated with an asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_COVER.

const string IToiAssetManagerService::PROPERTY_INFO_DATE = "info.date"

Property name for the start time of an asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_DATE.

const string IToiAssetManagerService::PROPERTY_INFO_DESCRIPTION = "info.description"

Property name for the description of an asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_DESCRIPTION.

const string IToiAssetManagerService::PROPERTY_INFO_LONGDESCRIPTION = "info.longdescription"

Property name for an even more detailed description of an asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_LONGDESCRIPTION.

const string IToiAssetManagerService::PROPERTY_INFO_LOST_AND_FOUND = "info.lostandfound"

Property name for the lost and found flag. If this flag is set the asset has been created from a lost asset by the platform. This can happen if the asset has been updated from a legacy version or if the database has been damaged. Relevant for all asset types.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_LOST_AND_FOUND.

const string IToiAssetManagerService::PROPERTY_INFO_MATURITYRATING = "info.maturityrating"

Property name for the maturity rating of an asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_MATURITYRATING.

const string IToiAssetManagerService::PROPERTY_INFO_RECORDINGSTATUS = "info.recordingstatus"

Property name for the status of a recorded asset. Recommended values are: recording|completed|failed

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_RECORDINGSTATUS.

const string IToiAssetManagerService::PROPERTY_INFO_SHARED = "info.shared"

Property name for the flag indicating that the asset or directory shall be exposed and shared with other devices in the home network if DMS support is activated.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_SHARED.

const string IToiAssetManagerService::PROPERTY_INFO_TITLE = "info.title"

Property name for the title of an asset.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_INFO_TITLE.

const string IToiAssetManagerService::PROPERTY_SYSTEM_DURATION = "system.duration"

Property name for the time duration of an asset in seconds. Supported by all asset types except ASSET_IMAGE.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_SYSTEM_DURATION.

const string IToiAssetManagerService::PROPERTY_SYSTEM_FILENAME = "system.filename"

Property name for the file name for imported assets (e.g. images). Supported by all asset types execpt ASSET_PVR.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_SYSTEM_FILENAME.

const string IToiAssetManagerService::PROPERTY_SYSTEM_FILESIZE = "system.filesize"

Property name for the file size of an asset. Supported by all asset types.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_SYSTEM_FILESIZE.

const string IToiAssetManagerService::PROPERTY_SYSTEM_INTEGRITY_STATUS = "system.integritystatus"

Property name for the integrity status of an asset. Supported by all asset types. See TToiAssetIntegrityStatus for possible values.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_SYSTEM_INTEGRITY_STATUS.

const string IToiAssetManagerService::PROPERTY_SYSTEM_PLAYBACKURI = "system.playbackuri"

Property name for the URI to use when starting playback of an asset. Supported by all asset types except ASSET_IMAGE.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_SYSTEM_PLAYBACKURI.

const string IToiAssetManagerService::PROPERTY_SYSTEM_TYPE = "system.type"

Property name for the type of an asset. Supported by all asset types. See TToiAssetType for possible values.

This constant can also be accessed from toi.consts.IToiAssetManagerService.PROPERTY_SYSTEM_TYPE.

Identifier for the root directory.

This constant can also be accessed from toi.consts.IToiAssetManagerService.ROOT_DIRECTORY.