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";
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 | |
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< TToiAssetId > | TToiAssetIdSequence |
typedef string | TToiPropertyId |
typedef sequence< TToiPropertyId > | TToiPropertyIdSequence |
typedef sequence< string > | TToiPropertyValueSequence |
typedef sequence< TToiProperty > | TToiPropertySequence |
typedef sequence< TToiAssetInfo > | TToiAssetInfoSequence |
typedef long | TToiDirectoryId |
typedef sequence< TToiDirectoryId > | TToiDirectoryIdSequence |
typedef sequence < TToiSortCondition > | TToiSortConditionSequence |
typedef sequence < TToiQueryCondition > | TToiQueryConditionSequence |
typedef string IToiAssetManagerService::TToiAssetId |
Identifier that uniquely identifies an asset.
typedef sequence< TToiAssetId > IToiAssetManagerService::TToiAssetIdSequence |
Sequence of asset identifiers.
typedef sequence< TToiAssetInfo > IToiAssetManagerService::TToiAssetInfoSequence |
List of TToiAssetInfo structures
typedef long IToiAssetManagerService::TToiDirectoryId |
Identifer that uniquely identifies a directory.
typedef sequence< TToiDirectoryId > IToiAssetManagerService::TToiDirectoryIdSequence |
Sequence of directory identifiers.
typedef string IToiAssetManagerService::TToiPropertyId |
Identifier for a metadata property.
typedef sequence< TToiPropertyId > IToiAssetManagerService::TToiPropertyIdSequence |
Sequence of property identifiers.
typedef sequence< TToiProperty > IToiAssetManagerService::TToiPropertySequence |
Sequence of properties.
typedef sequence< string > IToiAssetManagerService::TToiPropertyValueSequence |
Sequence of property values.
typedef sequence< TToiQueryCondition > IToiAssetManagerService::TToiQueryConditionSequence |
Sequence of query conditions.
typedef long IToiAssetManagerService::TToiQueryId |
Query identifier.
typedef sequence< TToiSortCondition > IToiAssetManagerService::TToiSortConditionSequence |
List of sort conditions. The list is used for sorting asset results and the sort conditions are applied in order.
Identifies integrity status of an asset.
Identifies different types of asset. This asset type is provided by the application while creating the asset.
The TToiConditionOperation enumerates possible operations that can be used to define a query condition.
void IToiAssetManagerService::CopyAsset | ( | in IToiOperationManager::TToiOperationId | operationId, | |
in TToiAssetId | sourceAssetId, | |||
in unsigned long | startOffset, | |||
in unsigned long | duration, | |||
in TToiAssetId | destinationAssetId | |||
) | raises (TToiInvalidArgumentException, TToiPermissionDeniedException) |
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. |
TToiInvalidArgumentException | Raised if
| |
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.
assetType | The type of asset |
assetId | The identifier of the created asset. |
TToiInvalidArgumentException | Raised if the type is not supported. | |
TToiNotEnoughResourcesException | Raised if the asset could not be created due to missing system resources. |
void IToiAssetManagerService::CreateDirectory | ( | in TToiDirectoryId | parentId, | |
in string | title, | |||
out TToiDirectoryId | dirId | |||
) | raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException) |
Creates a new directory.
parentId | The identifier of the parent directory. Use ROOT_DIRECTORY to create the top directories. | |
title | The title to use for the directory. |
dirId | The identifier of the created directory. |
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.
propertyId | The identifier of the new property, a unique name. | |
type | The property type. | |
hasMultipleValueSupport | Whether the property can have multiple values. |
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.
assetId | The asset identifier. |
properties | The id/value pairs of all the asset's properties. |
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().
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. |
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. |
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:
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().
properties | All defined property identifiers. |
void IToiAssetManagerService::GetDirectories | ( | in TToiDirectoryId | dirId, | |
out TToiDirectoryIdSequence | childDirIds | |||
) | raises (TToiInvalidArgumentException) |
Returns all direct directory children of given directory.
dirId | The directory identifier. If it equals to ROOT all top level directory identifiers will be returned. |
childDirIds | The list of directory identifiers. |
TToiInvalidArgumentException | Raised if the directory identifier is invalid. |
void IToiAssetManagerService::GetDirectoryInfo | ( | in TToiDirectoryId | dirId, | |
out TToiDirectoryInfo | info | |||
) | raises (TToiInvalidArgumentException) |
Returns directory information.
dirId | The directory identifier. |
info | The directory and its properties. |
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().
operationId | The operation identifier. |
value | The resulting long value from the operation. |
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.
assetId | The asset identifier. | |
requestedProperties | The identifiers of the wanted properties. |
properties | The id/value pairs of the requested properties. |
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.
propertyId | The property identifier. |
definition | The property definition. |
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.
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. |
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.
dirId | The directory to link the assets to. | |
assetIds | The assets to link. |
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.
dirId | The directory identifier. | |
newParentId | The new parent directory identifier. |
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.
applicationId | The identifier of the observing application. | |
address | The address where the IToiAssetManagerService can find an IToiAssetManagerObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address. |
void IToiAssetManagerService::ReleaseObserver | ( | in string | address | ) | raises (TToiInvalidArgumentException) |
Release an observer previously registered with RegisterObserver.
address | The address where the IToiAssetManagerService can find the registered IToiAssetManagerObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid. |
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.
operationId | The operation identifier created by IToiOperationManager | |
assetId | The asset identifier. |
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.
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. |
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.
dirId | The directory identifier. | |
properties | The list of properties. |
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.
id | The asset identifier. | |
property | The id/value pair of the property from which the corresponding value should be removed. |
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.
id | The asset identifier. | |
properties | The properties to unset. |
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().
propertyId | The identifier of the property to remove. |
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.
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. |
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.
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. |
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.
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. |
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.
dirId | The directory identifier. | |
properties | The list of properties. |
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.
id | The asset identifier. | |
properties | The properties to set data for. |
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.
dirId | The directory to unlink the assets from. | |
assetIds | The assets to unlink. |
TToiInvalidArgumentException | Raised if the directory is identifier. |
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.