getCustomParameterValue(_:fromParameter:at:)
Retrieves the (possibly keyframed) value of a custom parameter at a given time.
Declaration
func getCustomParameterValue(_ value: AutoreleasingUnsafeMutablePointer<(any NSCopying & NSSecureCoding & NSObjectProtocol)?>, fromParameter parameterID: UInt32, at time: CMTime) -> BoolParameters
- value:
Receives the value of the parameter at the given time.
- parameterID:
Unique identifier for the parameter.
- time:
Specified time to get the value.
Mentioned in
Return Value
Returns YES if the value is retrieved successfully; NO otherwise.
Discussion
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
getBoolValue(_:fromParameter:at:)getFloatValue(_:fromParameter:at:)getFontName(_:fromParameter:at:)getGradientSamples(_:numSamples:depth:fromParameter:at:)getHistogramBlack(in:blackOut:whiteIn:whiteOut:gamma:forChannel:fromParameter:at:)getIntValue(_:fromParameter:at:)getParameterFlags(_:fromParameter:)getPathID(_:fromParameter:at:)getRedValue(_:greenValue:blueValue:alphaValue:fromParameter:at:)getRedValue(_:greenValue:blueValue:fromParameter:at:)getStringParameterValue(_:fromParameter:)getXValue(_:yValue:fromParameter:at:)