Objective-C API Library Reference  4.3.0-42-g45f162a
 All Classes Functions Typedefs Properties Pages
Public Functions | Public Static Functions | Properties | List of all members
PWMutableEncoderFormat Class Reference

The mutable instance of PWEncoderFormat.

Constructors

(id) - initWithMimeType:quality:
 
(id) - initWithMimeType:parameters:
 
(id) - initWithMimeType:quality:parameters:
 

Public Functions

(NSArray *) - getParameters
 
(NSString *) - getParameterWithName:
 
(id) - initWithEncoderFormat:
 
(id) - initWithMimeType:
 
(BOOL) - isEqual:
 
(void) - removeParameterWithName:
 
(void) - setParameterWithName:value:
 

Public Static Functions

(PWMutableEncoderFormat *) + formatWithEncoderFormat:
 
(PWMutableEncoderFormat *) + formatWithMimeType:
 
(PWMutableEncoderFormat *) + formatWithMimeType:parameters:
 
(PWMutableEncoderFormat *) + formatWithMimeType:quality:
 
(PWMutableEncoderFormat *) + formatWithMimeType:quality:parameters:
 

Properties

PWEventPublisher * changed
 
BOOL isQualitySet
 
NSString * mimeType
 
NSInteger quality
 

Methods Descriptions

+ (PWMutableEncoderFormat *) formatWithEncoderFormat: (PWEncoderFormat *)  format

Creates a new mutable format using the data from another format.

+ (PWMutableEncoderFormat *) formatWithMimeType: (NSString *)  mimeType

Creates a new mutable format using only mime type. Quality will be not set and parameters will be empty.

Implements PWEncoderFormat.

+ (PWMutableEncoderFormat *) formatWithMimeType: (NSString *)  mimeType
parameters: (NSDictionary *)  parameters 

Creates a new mutable format using mime type and parameters. Quality will be not set.

Implements PWEncoderFormat.

+ (PWMutableEncoderFormat *) formatWithMimeType: (NSString *)  mimeType
quality: (NSInteger)  quality 

Creates a new mutable format using mime type and quality. The value for isQualitySet is YES and parameters will be empty.

Implements PWEncoderFormat.

+ (PWMutableEncoderFormat *) formatWithMimeType: (NSString *)  mimeType
quality: (NSInteger)  quality
parameters: (NSDictionary *)  parameters 

Creates a new mutable format using mime type, quality and parameters. The value for isQualitySet will be YES.

Implements PWEncoderFormat.

- (NSArray *) getParameters

Returns an array of PWEncoderParameter objects indicating all set parameters.

- (NSString *) getParameterWithName: (NSString *)  key

Returns the value of a single parameter based on the given name. Returns nil if the parameter is not set.

- (id) initWithEncoderFormat: (PWEncoderFormat *)  format

Initializes a mutable format with the values from another format.

- (id) initWithMimeType: (NSString *)  mimeType

Initialize a format with only a mimeType. Quality is not set and parameters are empty

- (id) initWithMimeType: (NSString *)  mimeType
parameters: (NSDictionary *)  parameters 

Initializes a format with mime type and parameters. Quality will not be set.

- (id) initWithMimeType: (NSString *)  mimeType
quality: (NSInteger)  quality 

Initializes a format with mime type and quality. The value for isQualitySet will be true and parameters will be empty.

- (id) initWithMimeType: (NSString *)  mimeType
quality: (NSInteger)  quality
parameters: (NSDictionary *)  parameters 

Initializes a format with mime type, quality, and parameters. The value for isQualitySet will be true.

- (BOOL) isEqual: (id)  other

Compares this encoder format against the specified object. Returns true if they are equal, otherwise returns false.

- (void) removeParameterWithName: (NSString *)  name

Removes the parameter with the given name.

- (void) setParameterWithName: (NSString *)  name
value: (NSString *)  value 

Sets a parameter with the given name and value.

Properties Descriptions

- (PWEventPublisher*) changed
readnonatomicstrong

The event that gets dispatched when a value or parameter on this format changes.

- (BOOL) isQualitySet
readwritenonatomicassign

A Boolean value that indicates whether the value for quality is set. If this property is set to NO, the quality property is ignored.

- (NSString*) mimeType
readwritenonatomiccopy

The mime type defining this format.

- (NSInteger) quality
readwritenonatomicassign

An integer value between 0 and 100 that represents the quality of this format.