Instance Method

setCustomParameterValue:toParm:

Sets an opaque value object for a custom parameter.

Required.

Declaration

- (BOOL)setCustomParameterValue:(id<NSCoding>)value toParm:(UInt32)parmId;

Parameters

value

The opaque value object.

parmId

The unique ID of the parameter to set the value for.

Return Value

YES if the value is set successfully; otherwise NO.

Discussion

When the plug-in supports complex parameter types that the host application doesn't natively understand, types that are not integers, floats, or strings, the plug-in developer must write code to handle creating, storing, and manipulating those types of objects.

The value object is an opaque object containing the custom data that the plug-in needs the host application’s document to store.

See Also

Setting Parameter Values

- setBoolValue:toParm:atTime:

Sets a Boolean value for a parameter.

Required.

- setFloatValue:toParm:atTime:

Sets an float value for a parameter.

Required.

- setIntValue:toParm:atTime:

Sets an integer value for a parameter.

Required.

- setParameterFlags:toParm:

Sets the current state of the parameter.

Required.

- setRedValue:greenValue:blueValue:alphaValue:toParm:atTime:

Sets RGBA color value (in 0.0 - 1.0 floating point) for a parameter.

Required.

- setRedValue:GreenValue:BlueValue:AlphaValue:toParm:atTime:

Sets RGBA color value (in 0.0 - 1.0 floating point) for a parameter.

- setRedValue:greenValue:blueValue:toParm:atTime:

Sets RGB color value (in 0.0 - 1.0 floating point) for a parameter.

Required.

- setRedValue:GreenValue:BlueValue:toParm:atTime:

Sets RGB color value (in 0.0 - 1.0 floating point) for a parameter.

- setXValue:YValue:toParm:atTime:

Sets the x,y position value (in 0.0 - 1.0 floating point) for a parameter.

Required.