cavdevice.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/upnp/cdevice.h>
#include <cybergarage/contentdirectory/ccontentdirectory.h>

Go to the source code of this file.

Data Structures
struct	_CgUpnpAVDevice
Defines
#define	cg_upnp_av_devicelist_gets(devicelist)   (CgUpnpAVDevice*) cg_list_next((CgList*) devicelist)
#define	cg_upnp_av_devicelist_clear(devicelist)
#define	cg_upnp_av_devicelist_add(devicelist, device)   cg_list_add((CgList*) devicelist, (CgList*) device)
#define	cg_upnp_av_devicelist_size(devicelist)   cg_list_size((CgList*) devicelist)
#define	cg_upnp_av_device_next(avDevice)   (CgUpnpAVDevice*) cg_list_next((CgList*) avDevice)
#define	cg_upnp_av_device_setudn(avDevice, udn)   cg_string_setvalue(avDevice->udn, udn)
#define	cg_upnp_av_device_getudn(avDevice)   cg_string_getvalue(avDevice->udn)
#define	cg_upnp_av_device_getcds(avDevice)   (avDevice->contentDirectoryService)
Typedefs
typedef _CgUpnpAVDevice	CgUpnpAVDevice
typedef _CgUpnpAVDevice	CgUpnpAVDeviceList
Functions
CgUpnpAVDeviceList *	cg_upnp_av_devicelist_new ()
void	cg_upnp_av_devicelist_delete (CgUpnpAVDeviceList *nodelist)
CgUpnpAVDevice *	cg_upnp_av_devicelist_find (CgUpnpAVDeviceList *avDeviceList, const char *udn)
CgUpnpAVDevice *	cg_upnp_av_device_new ()
void	cg_upnp_av_device_delete (CgUpnpAVDevice *avDevice)
void	cg_upnp_av_device_clear (CgUpnpAVDevice *avDevice)
BOOL	cg_upnp_av_device_isavcapable (CgUpnpAVDevice *avDevice)
CgUpnpDevice *	cg_upnp_av_device_getupnpdevice (CgUpnpAVDevice *avDevice)

---

Define Documentation

#define cg_upnp_av_device_getcds (  avDevice   )     (avDevice->contentDirectoryService)

Get the Content Directory Service from an AV device Parameters: avDevice  The AV device

#define cg_upnp_av_device_getudn (  avDevice   )     cg_string_getvalue(avDevice->udn)

Get the AV device's UDN Parameters: avDevice  The AV device Returns: char* UDN

#define cg_upnp_av_device_next (  avDevice   )     (CgUpnpAVDevice*) cg_list_next((CgList*) avDevice)

Get the next AV device in the list. Use as an iterator. Parameters: avDevice  Current AV device

#define cg_upnp_av_device_setudn (  avDevice, udn   )     cg_string_setvalue(avDevice->udn, udn)

Set the UDN for the AV device Parameters: avDevice  The AV device udn  UPnP Device UDN

#define cg_upnp_av_devicelist_add (  devicelist, device   )     cg_list_add((CgList*) devicelist, (CgList*) device)

Add an AV device to a list of AV devices Parameters: devicelist  Start of an AV device list

#define cg_upnp_av_devicelist_clear (  devicelist   )

Value: cg_list_clear((CgList*) devicelist, \ (CG_LIST_DESTRUCTORFUNC) cg_upnp_av_device_delete) Completely clear an AV device list Parameters: nodelist  Start of AV device list

#define cg_upnp_av_devicelist_gets (  devicelist   )     (CgUpnpAVDevice*) cg_list_next((CgList*) devicelist)

Get the first item of an AV device list for iteration Parameters: devicelist  Start of AV device list

#define cg_upnp_av_devicelist_size (  devicelist   )     cg_list_size((CgList*) devicelist)

Get the size of an AV device list Parameters: devicelist  The AV device list header (CgUpnpAVDeviceList*)

---

Typedef Documentation

typedef struct _CgUpnpAVDevice CgUpnpAVDevice

CyberLinkC AV API cavdevice.h Copyright 2005 Nokia Corporation

typedef struct _CgUpnpAVDevice CgUpnpAVDeviceList

CyberLinkC AV API cavdevice.h Copyright 2005 Nokia Corporation

---

Function Documentation

void cg_upnp_av_device_clear (  CgUpnpAVDevice *  device  )

Clear the contents of an AV device Parameters: node  The AV device to clear

void cg_upnp_av_device_delete (  CgUpnpAVDevice *  device  )

Destroy an AV device and its sub-structure Parameters: device  The AV device to destroy

CgUpnpDevice* cg_upnp_av_device_getupnpdevice (  CgUpnpAVDevice *  avDevice  )

Get the UPnP device associated with the AV device Parameters: avDevice  The AV device, whose UPnP device to get Returns: CgUPnPDevice* or NULL

BOOL cg_upnp_av_device_isavcapable (  CgUpnpAVDevice *  avDevice  )

Check, whether the given AV device has any of the AV services implemented. Parameters: avDevice  The AV device to check

CgUpnpAVDevice* cg_upnp_av_device_new (   )

Create a new AV device Parameters: upnpDevice  The UPnP device that this AV device is associated with Returns: The newly created AV device

void cg_upnp_av_devicelist_delete (  CgUpnpAVDeviceList *  devicelist  )

Delete the contents of an av device list and free its memory

CgUpnpAVDevice* cg_upnp_av_devicelist_find (  CgUpnpAVDeviceList *  avDeviceList, const char *  udn )

Find an AV device from a device list by the device's UDN Parameters: avDeviceList  A list of AV devices udn  Device UDN to search for Returns: CgUpnpAVDevice* or NULL

CgUpnpAVDeviceList* cg_upnp_av_devicelist_new (   )

Create a new AV device list

---