# FxParameterRetrievalAPI_v6 Defines the functions the application provides to retrieve parameter values. ``` protocol FxParameterRetrievalAPI_v6 : NSObjectProtocol ``` ## Topics ### Instance Methods [`func getBoolValue(UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getBoolValue(_:fromParameter:at:)) Gets a Boolean value from a parameter. [`func getCustomParameterValue(AutoreleasingUnsafeMutablePointer<(any NSCopying & NSSecureCoding & NSObjectProtocol)?>, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getCustomParameterValue(_:fromParameter:at:)) Retrieves the (possibly keyframed) value of a custom parameter at a given time. [`func getFloatValue(UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getFloatValue(_:fromParameter:at:)) Gets a floating point value from a parameter. [`func getFontName(AutoreleasingUnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getFontName(_:fromParameter:at:)) Retrieves the family and typeface of a given font. [`func getGradientSamples(UnsafeMutableRawPointer, numSamples: Int, depth: FxDepth, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getGradientSamples(_:numSamples:depth:fromParameter:at:)) Gets the Gradient parameter settings. [`func getHistogramBlack(in: UnsafeMutablePointer, blackOut: UnsafeMutablePointer, whiteIn: UnsafeMutablePointer, whiteOut: UnsafeMutablePointer, gamma: UnsafeMutablePointer, forChannel: FxHistogramChannel, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getHistogramBlack(in:blackOut:whiteIn:whiteOut:gamma:forChannel:fromParameter:at:)) Gets the Histogram parameter settings. [`func getIntValue(UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getIntValue(_:fromParameter:at:)) Gets an integer value from a parameter. [`func getParameterFlags(UnsafeMutablePointer, fromParameter: UInt32) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getParameterFlags(_:fromParameter:)) Gets current state of a parameter. [`func getPathID(UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getPathID(_:fromParameter:at:)) Retrieves the (possibly keyframed) value of a pathID parameter at a given time. [`func getRedValue(UnsafeMutablePointer, greenValue: UnsafeMutablePointer, blueValue: UnsafeMutablePointer, alphaValue: UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getRedValue(_:greenValue:blueValue:alphaValue:fromParameter:at:)) Gets RGBA color value (in 0.0 - 1.0 floating point) from a parameter. [`func getRedValue(UnsafeMutablePointer, greenValue: UnsafeMutablePointer, blueValue: UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getRedValue(_:greenValue:blueValue:fromParameter:at:)) Gets RGB color values (in 0.0 - 1.0 floating point) from a parameter. [`func getStringParameterValue(AutoreleasingUnsafeMutablePointer?, fromParameter: UInt32) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getStringParameterValue(_:fromParameter:)) Gets a string value from a string parameter. [`func getXValue(UnsafeMutablePointer, yValue: UnsafeMutablePointer, fromParameter: UInt32, at: CMTime) -> Bool`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v6/getXValue(_:yValue:fromParameter:at:)) Gets the xy position value (in 0.0 - 1.0 floating point) from a parameter. ## Relationships ### Inherited By [`FxParameterRetrievalAPI_v7`](/documentation/professional_video_applications/FxParameterRetrievalAPI_v7) ### Inherits From [`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol) --- Copyright © 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)