#include <CGUpnpDevice.h>
The CGUpnpDevice class is a wrapper class for mUpnpDevice of mUPnP for C.
◆ absoluteIconUrl:
| - (NSString *) absoluteIconUrl: |
|
(CGUpnpIcon*) | anIcon |
|
Return a absolute url of the specified icon.
- Parameters
-
- Returns
- Absolute url of the specified icon.
◆ announce
Announce the device.
- Returns
- YES if the device is started normally, otherwise NO.
◆ descriptionURL
| - (NSString *) descriptionURL |
|
|
|
Return a descrition URL
- Returns
- Descripton URL of the device.
◆ deviceType
| - (NSString *) deviceType |
|
|
|
Get the device type of the device.
- Returns
- Device Type.
◆ friendlyName
| - (NSString *) friendlyName |
|
|
|
Get the friendly name of the device.
- Returns
- Friendly name.
◆ getServiceForID:
Get a service in the device by the specified service ID.
- Parameters
-
| serviceId | A service ID string of the service. |
- Returns
- The CGUpnpService if the specified service is found; otherwise nil.
◆ getServiceForType:
Get a service in the device by the specified service type.
- Parameters
-
| serviceType | A service type string of the service. |
- Returns
- The CGUpnpService if the specified service is found; otherwise nil.
◆ icons
Get all icons in the device as a NSArray object. The array has the services as instances of CGUpnpIconIcon.
- Returns
- NSArray of CGUpnpIcon.
◆ init
Create a new UPnP device.
- Returns
- New instance if successful; otherwise nil (the partially initialized instance is released).
◆ initWithCObject:
Create a new UPnP device with the C instance.
- Returns
- New instance if successfull; otherwise nil.
◆ initWithDeviceSnapshot:
Copy discovery metadata and SCPDs while the caller holds the cache lock. The returned device is an independent snapshot, safe after cache removal.
◆ initWithXMLDescription:
| - (id) initWithXMLDescription: |
|
(NSString*) | xmlDesc |
|
Create a new UPnP device with the XML description.
- Parameters
-
| xmlDesc | The device description. See parseXMLDescription:. |
- Returns
- New instance if successful; otherwise nil. On failure the instance and its native device are released exactly once.
◆ ipaddress
Return a IP address.
- Returns
- IP address of the device.
◆ isDeviceType:
| - (BOOL) isDeviceType: |
|
(NSString*) | aType |
|
Check whether the device type is the specified type.
- Parameters
-
| aType | A type string of the device. |
- Returns
- YES if the specified type is same as the device type; otherwise NO.
◆ isFriendlyName:
| - (BOOL) isFriendlyName: |
|
(NSString*) | aFriendlyName |
|
Check whether the device's friendly name is the specified name.
- Parameters
-
| aFriendlyName | A friendly name string of the device. |
- Returns
- YES if the specified friendly name is same as the device' friendly name; otherwise NO.
◆ isRunning
Check if the controll point is running.
- Returns
- YES if the device is started normally, otherwise NO.
◆ isUDN:
| - (BOOL) isUDN: |
|
(NSString*) | aUDN |
|
Check whether the device's UDN is the specified UDN.
- Parameters
-
| aUDN | A UDN string of the device. |
- Returns
- YES if the specified UDN is same as the device' UDN; otherwise NO.
◆ locationURL
| - (NSString *) locationURL |
|
|
|
Return a location URL
- Returns
- Location URL of the device.
◆ manufacturer
| - (NSString *) manufacturer |
|
|
|
Return a manufacture.
- Returns
- Manufacture of the device.
◆ modelName
Return a model name.
- Returns
- Model name of the device.
◆ modelNumber
| - (NSString *) modelNumber |
|
|
|
Return a model number.
- Returns
- Model number of the device.
◆ parseXMLDescription:
| - (BOOL) parseXMLDescription: |
|
(NSString*) | xmlDesc |
|
Parse the specified XML description.
The description is passed to the native parser as UTF-8 bytes, so non-ASCII text such as Japanese or emoji is preserved.
Returns NO without touching the receiver when xmlDesc is nil, empty, not an NSString or not convertible to UTF-8. When the native parser rejects the XML, it returns NO after the native device has been cleared: the receiver then has no description, and service, action, state variable and icon wrappers previously obtained from it must not be used.
- Parameters
-
| xmlDesc | The device description |
- Returns
- YES if successful; otherwise NO.
◆ presentationURL
| - (NSString *) presentationURL |
|
|
|
Return a presentationURL
- Returns
- presentationURL of the device.
◆ services
Get all services in the device as a NSArray object. The array has the services as instances of CGUpnpService.
- Returns
- NSArray of CGUpnpService.
◆ setDeviceType:
| - (void) setDeviceType: |
|
(NSString*) | aType |
|
Set a device type of the device.
- Parameters
-
◆ setFriendlyName:
| - (void) setFriendlyName: |
|
(NSString*) | aName |
|
Set a friendly name of the device.
- Parameters
-
| aName | Friendly name to set. |
◆ setUdn:
| - (void) setUdn: |
|
(NSString*) | aUdn |
|
Set a udn of the device.
- Parameters
-
◆ setUserData:
| - (void) setUserData: |
|
(void*) | aUserData |
|
Set a user data.
- Parameters
-
| aUserData | A user data to set. |
- Returns
- The CGUpnpService if the specified service is found; otherwise nil.
◆ smallestIcon
Return a most smallest icon.
- Returns
- Smallest Icon.
◆ smallestIconWithMimeType:
| - (CGUpnpIcon *) smallestIconWithMimeType: |
|
(NSString*) | mimeType |
|
Return a most smallest icon with a specified mime type.
- Returns
- Smallest Icon.
◆ start
Start the device.
- Returns
- YES if the device is started normally, otherwise NO.
◆ stop
Stop the device.
- Returns
- YES if the device is started normally, otherwise NO.
◆ udn
Get the UDN of the device.
- Returns
- UDN of the specified device.
◆ urlBase
Return a urlBase
- Returns
- URLBase of the device.
◆ userData
Get a stored user data.
- Returns
- A stored user data.
◆ isCObjectCreated
| - (BOOL) isCObjectCreated |
|
protected |
◆ cObject
◆ delegate
The documentation for this class was generated from the following files:
