CyberLink for Objective-C

CGUpnpService Class Reference

#import <CGUpnpService.h>

Public Member Functions

(id) - initWithCObject:
(BOOL) - parseXMLDescription:
(NSString *) - serviceId
(NSString *) - serviceType
(NSArray *) - actions
(NSArray *) - stateVariables
(CGUpnpAction *) - getActionForName:
(CGUpnpStateVariable *) - getStateVariableForName:
(BOOL) - isStateVariableImpemented:

Properties

CgUpnpService * cObject

Detailed Description

The CGUpnpService class is a wrapper class for CgUpnpService of CyberLink for C.


Member Function Documentation

- (NSArray *) actions

Get all actions in the service as a NSArray object. The array has the actions as instances of CGUpnpAction.

Returns:
NSArray of CGUpnpAction.
- (CGUpnpAction *) getActionForName: (NSString *)  name

Get a action in the service by the specified name.

Parameters:
nameA name string of the action.
Returns:
The CGUpnpAction if the specified action is found; otherwise nil.
- (CGUpnpStateVariable *) getStateVariableForName: (NSString *)  name

Get a state variables in the service by the specified name.

Parameters:
nameA name string of the state variable.
Returns:
The CGUpnpStateVariable if the specified state variable is found; otherwise nil.
- (id) initWithCObject: (CgUpnpService *)  cobj

Create a new UPnP service with the C instance.

Returns:
New instance if successfull; otherwise nil.
- (BOOL) isStateVariableImpemented: (NSString*)  name

Checks whether state variable is implemented

Parameters:
nameA name string of the state variable.
Returns:
YES if implemented
- (BOOL) parseXMLDescription: (NSString *)  xmlDesc

Parse the specified XML description.

Returns:
YES if successfull; otherwise nui.
- (NSString *) serviceId

Get the service ID of the service.

Returns:
The service ID.
- (NSString *) serviceType

Get the service type of the service.

Returns:
The service type.
- (NSArray *) stateVariables

Get all state variables in the service as a NSArray object. The array has the state variables as instances of CGUpnpStateVariable.

Returns:
NSArray of CGUpnpStateVariable.

Property Documentation

- (CgUpnpService *) cObject [read, assign]

The documentation for this class was generated from the following files: