Messages sent by the media cataloger daemon
[Cataloger]

Detailed Description

Messages that you may want to handle.


Defines

#define ALP_MEDIASELECTOR_APP_ID   "mediacatd"
 App name used when the media cataloger daemon broadcasts notifications.
#define ALP_MS_EVENT_PREFIX   "/alp/" ALP_MEDIASELECTOR_APP_ID "/"
 Media Selector event prefix.
#define ALP_MS_REFRESH_CONTENT   ALP_MS_EVENT_PREFIX "refresh"
 Notification broadcast on volume mount, volume unmount, and when the media cataloger is done scanning: basically means that content will be changing / content has changed.
#define ALP_NOTIFY_EVENT_MS_FILE_DELETED   ALP_MS_EVENT_PREFIX "file_deleted"
 The message sent by mediacatd when it notices that a file has been deleted.
#define ALP_NOTIFY_EVENT_MS_INDEX_FILE   ALP_MS_EVENT_PREFIX "index_file"
 The message sent by mediacatd when alp_ms_cat_index_file completes.
#define ALP_NOTIFY_EVENT_MS_METADATA_READ_PROGRESS   ALP_MS_EVENT_PREFIX "reading_metadata"
 Notification broadcast periodically as the media cataloger daemon reads metadata.
#define ALP_NOTIFY_EVENT_MS_REFRESH   ALP_MS_REFRESH_CONTENT
 Standards-compliant synonym for ALP_MS_REFRESH_CONTENT.
#define ALP_NOTIFY_EVENT_MS_SCANNING_DIRECTORY   ALP_MS_EVENT_PREFIX "scanning_directory"
 Notification broadcast when the media cataloger daemon reads a directory.
#define ALP_NOTIFY_EVENT_MS_UNINDEX_FILE   ALP_MS_EVENT_PREFIX "unindex_file"
 The message sent by mediacatd when alp_ms_cat_unindex_file completes.
#define MS_READ_PROGRESS_PARTS   10000
 Metadata completion is expressed as parts per MS_READ_PROGRESS_PARTS.

Define Documentation

#define ALP_MEDIASELECTOR_APP_ID   "mediacatd"
 

App name used when the media cataloger daemon broadcasts notifications.

#define ALP_MS_EVENT_PREFIX   "/alp/" ALP_MEDIASELECTOR_APP_ID "/"
 

Media Selector event prefix.

#define ALP_MS_REFRESH_CONTENT   ALP_MS_EVENT_PREFIX "refresh"
 

Notification broadcast on volume mount, volume unmount, and when the media cataloger is done scanning: basically means that content will be changing / content has changed.

#define ALP_NOTIFY_EVENT_MS_FILE_DELETED   ALP_MS_EVENT_PREFIX "file_deleted"
 

The message sent by mediacatd when it notices that a file has been deleted.

Note:
The details pointer will point to a filename, as a normal, null-terminated C-string.

#define ALP_NOTIFY_EVENT_MS_INDEX_FILE   ALP_MS_EVENT_PREFIX "index_file"
 

The message sent by mediacatd when alp_ms_cat_index_file completes.

Note:
The details pointer will point to a AlpNotifyEventIndexFileResults structure. You will only get this message if you subscribe to ALP_NOTIFY_EVENT_MS_INDEX_FILE before calling alp_ms_cat_index_file; typically, you will unsubscribe as soon as you get the result message.

#define ALP_NOTIFY_EVENT_MS_METADATA_READ_PROGRESS   ALP_MS_EVENT_PREFIX "reading_metadata"
 

Notification broadcast periodically as the media cataloger daemon reads metadata.

Note:
The message contains an integer (0 to MS_READ_PROGRESS_PARTS) that represents the percent complete. Completion is signaled by a message containing MS_READ_PROGRESS_PARTS.

#define ALP_NOTIFY_EVENT_MS_REFRESH   ALP_MS_REFRESH_CONTENT
 

Standards-compliant synonym for ALP_MS_REFRESH_CONTENT.

#define ALP_NOTIFY_EVENT_MS_SCANNING_DIRECTORY   ALP_MS_EVENT_PREFIX "scanning_directory"
 

Notification broadcast when the media cataloger daemon reads a directory.

Note:
The message contains a string with the name of the directory

#define ALP_NOTIFY_EVENT_MS_UNINDEX_FILE   ALP_MS_EVENT_PREFIX "unindex_file"
 

The message sent by mediacatd when alp_ms_cat_unindex_file completes.

Note:
The details pointer will point to a AlpNotifyEventUnindexFileResults structure. You will only get this message if you subscribe to ALP_NOTIFY_EVENT_MS_UNINDEX_FILE before calling alp_ms_cat_unindex_file; typically, you will unsubscribe as soon as you get the result message. Note also that ALP_MS_CAT_UFS_FILE_DOES_NOT_EXIST is an asynchronous notification, and deregistration may still be in progress.

#define MS_READ_PROGRESS_PARTS   10000
 

Metadata completion is expressed as parts per MS_READ_PROGRESS_PARTS.

Note:
We don't use a simple percentage, as clients may wish to display a progress bar with more than 100 steps. (Using 10,000 means that we can convert to and from arbitrary bases (ie, to percentages or from (say) 275 of 652) using 32-bit (single-precision) integer operations.)

Generated on Wed Jul 30 07:06:42 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.