ccdscontrolpoint.h File Reference

#include <cybergarage/upnp/cdevice.h>
#include <cybergarage/contentdirectory/ccdsactionarguments.h>

Go to the source code of this file.

Defines
#define	cg_upnp_av_cds_control_getsearchcaps(upnpDevice, errorString, searchCaps)
#define	cg_upnp_av_cds_control_getsortcaps(upnpDevice, errorString, sortCaps)
#define	cg_upnp_av_cds_control_getsystemupdateid(upnpDevice, errorString, id)
#define	cg_upnp_av_cds_control_browse(upnpDevice, errorString, objectID, browseFlag, filter, startingIndex, requestedCount, sortCriteria, result, numberReturned, totalMatches, updateID)
#define	cg_upnp_av_cds_control_search(upnpDevice, errorString, containerID, searchCriteria, filter, startingIndex, requestedCount, sortCriteria, result, numberReturned, totalMatches, updateID)
#define	cg_upnp_av_cds_control_createobject(upnpDevice, errorString, containerID, elements, objectID, result)
#define	cg_upnp_av_cds_control_destroyobject(upnpDevice, errorString, objectID)
#define	cg_upnp_av_cds_control_updateobject(upnpDevice, errorString, objectID, currentTagValue, newTagValue)
#define	cg_upnp_av_cds_control_importresource(upnpDevice, errorString, sourceURI, destinationURI, transferID)
#define	cg_upnp_av_cds_control_exportresource(upnpDevice, sourceURI, destinationURI, transferID)
#define	cg_upnp_av_cds_control_stoptransferresource(upnpDevice, errorString, transferID)
#define	cg_upnp_av_cds_control_gettransferprogress(upnpDevice, errorString, transferID, transferStatus, transferLength, transferTotal)
#define	cg_upnp_av_cds_control_deleteresource(upnpDevice, errorString, resourceURI)
#define	cg_upnp_av_cds_control_createreference(upnpDevice, errorString, containerID, objectID, newID)
Functions
int	cg_upnp_av_cds_control_invokeaction (CgUpnpDevice *upnpDevice, char *actionName, char **errorString,...)
BOOL	cg_upnp_av_cds_create_cg_xml (char *xmldoc, CgXmlNodeList *nodelist)

---

Define Documentation

#define cg_upnp_av_cds_control_browse (  upnpDevice, errorString, objectID, browseFlag, filter, startingIndex, requestedCount, sortCriteria, result, numberReturned, totalMatches, updateID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_BROWSE, \ errorString, \ CG_UPNP_CDS_ARG_OBJECTID, \ objectID, \ CG_UPNP_CDS_ARG_BROWSEFLAG, \ browseFlag, \ CG_UPNP_CDS_ARG_FILTER, \ filter, \ CG_UPNP_CDS_ARG_STARTINGINDEX, \ startingIndex, \ CG_UPNP_CDS_ARG_REQUESTEDCOUNT, \ requestedCount, \ CG_UPNP_CDS_ARG_SORTCRITERIA, \ sortCriteria, \ CG_UPNP_CDS_ARG_RESULT, \ result, \ CG_UPNP_CDS_ARG_NUMBERRETURNED, \ numberReturned, \ CG_UPNP_CDS_ARG_TOTALMATCHES, \ totalMatches, \ CG_UPNP_CDS_ARG_UPDATEID, \ updateID, \ NULL) Invoke an action on a UPnP device to get the contents of an object. See ccdsactionarguments.h for some common values. Parameters: upnpDevice  The UPnP device objectID  The object ID to browse filter  Browse filter startingIndex  Return results starting from the given index requestedCount  Maximum number of results to return sortCriteria  Sort results according to the given criteria result  The raw DIDL-Lite result from the device numberReturned  Number of objects returned totalMatches  Total number of objects in the container updateID  Indicates, whether there have been changes in the container Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_createobject (  upnpDevice, errorString, containerID, elements, objectID, result   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_CREATEOBJECT, \ errorString, \ CG_UPNP_CDS_ARG_CONTAINERID, \ containerID, \ CG_UPNP_CDS_ARG_ELEMENTS, \ elements, \ CG_UPNP_CDS_ARG_OBJECTID, \ objectID, \ CG_UPNP_CDS_ARG_RESULT, \ result, \ NULL) Invoke an action on a UPnP device to create an object to the server Parameters: upnpDevice  The UPnP device containerID  The container, under which to create the object elements  Initial object properties as a DIDL-Lite document objectID  The server-assigned object ID of the created object result  The created object's , <container> or <desc> hierarchy Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_createreference (  upnpDevice, errorString, containerID, objectID, newID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_CREATEREFERENCE, \ errorString, \ CG_UPNP_CDS_ARG_CONTAINERID, \ containerID, \ CG_UPNP_CDS_ARG_OBJECTID, \ objectID, \ CG_UPNP_CDS_ARG_NEWID, \ newID, \ NULL) Invoke an action on a UPnP device to create a reference for an object Parameters: upnpDevice  The UPnP device transferID  An ID from a call to import/export resource Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_deleteresource (  upnpDevice, errorString, resourceURI   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_DELETERESOURCE, \ errorString, \ CG_UPNP_CDS_ARG_RESOURCEURI, \ resourceURI, \ NULL) Invoke an action on a UPnP device to delete a resource from an object NOTE: This does not delete an object. If you need to do that, use cg_upnp_av_cds_control_destroyobject() Parameters: upnpDevice  The UPnP device resourceURI  The <res> element to delete Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_destroyobject (  upnpDevice, errorString, objectID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_DESTROYOBJECT, \ errorString, \ CG_UPNP_CDS_ARG_OBJECTID, \ objectID, \ NULL) Invoke an action on a UPnP device to destroy an object from the server Parameters: upnpDevice  The UPnP device objectID  The ID of the object to destroy Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_exportresource (  upnpDevice, sourceURI, destinationURI, transferID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_EXPORTRESOURCE, \ errorString, \ CG_UPNP_CDS_ARG_SOURCEURI, \ sourceURI, \ CG_UPNP_CDS_ARG_DESTINATIONURI, \ destinationURI, \ CG_UPNP_CDS_ARG_TRANSFERID, \ transferID, \ NULL) Invoke an action on a UPnP device to export a resource from a server Parameters: upnpDevice  The UPnP device sourceURI  The URI of the file to export from the server destinationURI  The destination URI for the file transferID  A server-assigned ID for the data transfer Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_getsearchcaps (  upnpDevice, errorString, searchCaps   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_GETSEARCHCAPABILITIES, \ errorString, \ CG_UPNP_CDS_ARG_SEARCHCAPS, searchCaps, \ NULL) Invoke an action on a UPnP device to get the device's CDS (if any) search capabilities. Parameters: upnDevice  The UPnP device searchCaps  The device's search capabilities Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_getsortcaps (  upnpDevice, errorString, sortCaps   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_GETSORTCAPABILITIES, \ errorString, \ CG_UPNP_CDS_ARG_SORTCAPS, sortCaps, \ NULL) Invoke an action on an AV device to get the device's CDS (if any) sort capabilities. Parameters: upnpDevice  The UPnP device sortCaps  The device's sort capabilities Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_getsystemupdateid (  upnpDevice, errorString, id   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_GETSYSTEMUPDATEID, \ errorString, \ CG_UPNP_CDS_ARG_ID, id, \ NULL) Invoke an action on a UPnP device to get the device's CDS (if any) system update ID. Parameters: upnpDevice  The UPnP device id  The device's update ID Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_gettransferprogress (  upnpDevice, errorString, transferID, transferStatus, transferLength, transferTotal   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_GETTRANSFERPROGRESS, \ errorString, \ CG_UPNP_CDS_ARG_TRANSFERID, \ transferID, \ CG_UPNP_CDS_ARG_TRANSFERSTATUS, \ transferStatus, \ CG_UPNP_CDS_ARG_TRANSFERLENGTH, \ transferLength, \ CG_UPNP_CDS_ARG_TRANSFERTOTAL, \ transferTotal, \ NULL) Invoke an action on a UPnP device to get the progress of a file transfer (import/export) Parameters: upnpDevice  The UPnP device @return  TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_importresource (  upnpDevice, errorString, sourceURI, destinationURI, transferID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_IMPORTRESOURCE, \ CG_UPNP_CDS_ARG_SOURCEURI, \ sourceURI, \ CG_UPNP_CDS_ARG_DESTINATIONURI, \ destinationURI, \ CG_UPNP_CDS_ARG_TRANSFERID, \ transferID, \ NULL) Invoke an action on a UPnP device to import a resource to a server Parameters: upnpDevice  The UPnP device sourceURI  The URI of the file to import destinationURI  The destination URI for the file transferURI  A server-assigned ID for the data transfer Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_search (  upnpDevice, errorString, containerID, searchCriteria, filter, startingIndex, requestedCount, sortCriteria, result, numberReturned, totalMatches, updateID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_SEARCH, \ errorString, \ CG_UPNP_CDS_ARG_CONTAINERID, \ containerID, \ CG_UPNP_CDS_ARG_SEARCHCRITERIA, \ searchCriteria, \ CG_UPNP_CDS_ARG_FILTER, \ filter, \ CG_UPNP_CDS_ARG_STARTINGINDEX, \ startingIndex, \ CG_UPNP_CDS_ARG_REQUESTEDCOUNT, \ requestedCount, \ CG_UPNP_CDS_ARG_SORTCRITERIA, \ sortCriteria, \ CG_UPNP_CDS_ARG_RESULT, \ result, \ CG_UPNP_CDS_ARG_NUMBERRETURNED, \ numberReturned, \ CG_UPNP_CDS_ARG_TOTALMATCHES, \ totalMatches, \ CG_UPNP_CDS_ARG_UPDATEID, \ updateID, \ NULL) Invoke an action on a UPnP device to search the contents for objects Parameters: upnpDevice  The UPnP device containerID  The container to start searching from searchCriteria  The search pattern filter  Browse filter startingIndex  Return results starting from the given index requestedCount  Number of results to return; use "0" to get everything sortCriteria  Sort results according to the given criteria result  The raw XML result from the upnpDevice numberReturned  Number of results returned (numberReturned <= totalMatches) totalMatches  Total number of matches (numberReturned <= totalMatches) updateID  The device's update ID Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_stoptransferresource (  upnpDevice, errorString, transferID   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_STOPTRANSFERRESOURCE, \ errorString, \ CG_UPNP_CDS_ARG_TRANSFERID, \ transferID, \ NULL) Invoke an action on a UPnP device to stop a file transfer (import/export) Parameters: upnpDevice  The UPnP device transferID  An ID from a call to import/export resource Returns: TRUE if successful; otherwise FALSE

#define cg_upnp_av_cds_control_updateobject (  upnpDevice, errorString, objectID, currentTagValue, newTagValue   )

Value: \ cg_upnp_av_cds_control_invokeaction(upnpDevice, \ CG_UPNP_CDS_ACTION_UPDATEOBJECT, \ errorString, \ CG_UPNP_CDS_ARG_OBJECTID, \ objectID, \ CG_UPNP_CDS_ARG_CURRENTTAGVALUE, \ currentTagValue, \ CG_UPNP_CDS_ARG_NEWTAGVALUE, \ NULL) Invoke an action on a UPnP device to modify, insert or delete an object's metadata Parameters: upnpDevice  The UPnP device objectID  The ID of the object to update currentTagValue  newTagValue  Returns: TRUE if successful; otherwise FALSE

---

Function Documentation

int cg_upnp_av_cds_control_invokeaction (  CgUpnpDevice *  upnpDevice, char *  actionName, char **  errorString,   ... )

Invoke an action on the upnp device Parameters: upnpDevice  The UPnP device actionName  The name of the action to invoke errorString  A newly-created error string if the action fails. Pass NULL if you don't want to use it. ...  A list of action-specific arguments Returns: An integer containing the UPnP status code The list of action-specific arguments is a comma-separated list, that is organised as pairs of char* ARG_NAME and CgString* ARG_VALUE. ARG_NAME contains the name of the argument, while ARG_VALUE contains the value of the argument. You don't need to put anything inside OUT arguments, as they are not sent along with the action; their contents are set when the action post returns with OUT values that were received from the peer.

BOOL cg_upnp_av_cds_create_cg_xml (  char *  xmldoc, CgXmlNodeList *  nodelist )

Parse an XML document into a CgXmlNodeList* Parameters: xmldoc  The raw XML document to parse nodelist  An XML node list to save the parsed nodes Returns: TRUE if successful; otherwise FALSE

---