EOSPropertyObject Class Reference
| Inherits from | EOSObject : NSObject |
| Declared in | EOSPropertyObject.h EOSPropertyObject.m |
Overview
EOSPropertyObject is the underlying class of EOSCamera and EOSImage. It provides methods for getting and setting properties. It is a subclass of EOSObject.
Tasks
Getting Properties
-
– numberValueForProperty:withParameter:error: -
– numberValueForProperty:error: -
– stringValueForProperty:withParameter:error: -
– stringValueForProperty:error:
Setting Properties
-
– setNumberValue:forProperty:withParameter:error: -
– setNumberValue:forProperty:error: -
– setStringValue:forProperty:withParameter:error: -
– setStringValue:forProperty:error:
Advanced Methods
Instance Methods
getValue:ofSize:forProperty:withParameter:error:
Gets the value (of unknown type) of a property.
- (BOOL)getValue:(void *)value ofSize:(NSUInteger)size forProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- value
The value that will be retrieved.
- size
The amount of bytes to retreive.
- property
The property of the value that is being retrieved.
- parameter
A parameter for the property (use 0 if not required).
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Discussion
See the EDSDK documentation for the type of value that will be returned.
Warning: Using this method is not recommended. Use getNumericValue:forProperty:error: or getStringValue:forProperty:error: instead.
Declared In
EOSPropertyObject.hgetValueSize:dataType:forProperty:withParameter:error:
Gets the size and data type of a property value.
- (BOOL)getValueSize:(NSUInteger *)size dataType:(EdsDataType *)dataType forProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- size
The size of the property value in bytes.
- dataType
The data type of the property value.
- property
The property.
- parameter
A parameter for the property (use 0 if not required).
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Declared In
EOSPropertyObject.hnumberValueForProperty:error:
Gets the numeric value of a property.
- (NSNumber *)numberValueForProperty:(EOSProperty)property error:(NSError *__autoreleasing *)errorParameters
- property
The property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
A numeric value if successful, otherwise nil.
Declared In
EOSPropertyObject.hnumberValueForProperty:withParameter:error:
Gets the numeric value of a property with a parameter.
- (NSNumber *)numberValueForProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- property
The property.
- parameter
A parameter for the property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
A numeric value if successful, otherwise nil.
Declared In
EOSPropertyObject.hsetNumberValue:forProperty:error:
Sets the numeric value of a property.
- (BOOL)setNumberValue:(NSNumber *)value forProperty:(EOSProperty)property error:(NSError *__autoreleasing *)errorParameters
- value
The numeric value to set.
- property
The property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Declared In
EOSPropertyObject.hsetNumberValue:forProperty:withParameter:error:
Sets the numeric value of a property with a parameter.
- (BOOL)setNumberValue:(NSNumber *)value forProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- value
The numeric value to set.
- property
The property.
- parameter
A parameter for the property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Declared In
EOSPropertyObject.hsetStringValue:forProperty:error:
Sets the string value of a property.
- (BOOL)setStringValue:(NSString *)value forProperty:(EOSProperty)property error:(NSError *__autoreleasing *)errorParameters
- value
The string value to set.
- property
The property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Declared In
EOSPropertyObject.hsetStringValue:forProperty:withParameter:error:
Sets the string value of a property with a parameter.
- (BOOL)setStringValue:(NSString *)value forProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- value
The string value to set.
- property
The property.
- parameter
A parameter for the property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Declared In
EOSPropertyObject.hsetValue:ofSize:forProperty:withParameter:error:
Sets the value (of unknown type) of a property
- (BOOL)setValue:(const void *)value ofSize:(NSUInteger)size forProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- value
The new value to set.
- size
The size of the value in bytes.
- property
The property.
- parameter
A parameter for the property (use 0 if not required).
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Discussion
See the EDSDK documentation for the type of value that should be provided.
Warning: Using this method is not recommended. Use setNumericValue:forProperty:error: or setStringValue:forProperty:error: instead.
Declared In
EOSPropertyObject.hstringValueForProperty:error:
Gets the string value of a property.
- (NSString *)stringValueForProperty:(EOSProperty)property error:(NSError *__autoreleasing *)errorParameters
- property
The property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
A string value if successful, otherwise nil.
Declared In
EOSPropertyObject.hstringValueForProperty:withParameter:error:
Gets the string value of a property with a parameter.
- (NSString *)stringValueForProperty:(EOSProperty)property withParameter:(NSUInteger)parameter error:(NSError *__autoreleasing *)errorParameters
- property
The property.
- parameter
A parameter for the property.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
A string value if successful, otherwise nil.
Declared In
EOSPropertyObject.h