Contents

setRedValue(_:greenValue:blueValue:toParameter:at:)

Set the values of an RGB color parameter.

Declaration

func setRedValue(_ red: Double, greenValue green: Double, blueValue blue: Double, toParameter parameterID: UInt32, at time: CMTime) -> Bool

Parameters

  • red:

    The specified red value for the parameter.

  • green:

    The specified green value for the parameter.

  • blue:

    The specified blue value for the parameter.

  • parameterID:

    The unique identifier for the parameter.

  • time:

    The specified time to set the values.

Return Value

Returns YES if the values are set successfully; otherwise NO.

Discussion

The color is assumed to be in the project working color space and is converted to sRGB, unless the parameter has the kFxParameterFlag_DONT_REMAP_COLORS set. If this flag is set, the host copies the color values verbatim into the parameter with no conversion.

Depending on the host application, the time value may be relative to the start of the timeline or to the start of the clip. See Understanding time in FxPlug.

See Also

Instance Methods