---
title: "getGradientSamples(_:numSamples:depth:fromParameter:at:)"
framework: Professional Video Applications
role: symbol
role_heading: Instance Method
platforms: [fxplug 4.0+]
path: "professional_video_applications/fxparameterretrievalapi_v6/getgradientsamples(_:numsamples:depth:fromparameter:at:)"
---

# getGradientSamples(_:numSamples:depth:fromParameter:at:)

Gets the Gradient parameter settings.

## Declaration

```swift
func getGradientSamples(_ samples: UnsafeMutableRawPointer, numSamples: Int, depth sampleDepth: FxDepth, fromParameter parameterID: UInt32, at time: CMTime) -> Bool
```

## Parameters

- `samples`: Pointer to a buffer of size (4 * numSamples * sampleDepth). It is populated with samples of RGBA values across the gradient. The number of samples is set by numSamples.
- `numSamples`: Number of samples from the gradient. More samples provide a more accurate representation, but require more time.
- `sampleDepth`: Number of bytes per channel (kFxDepth_FLOAT32, for example).
- `parameterID`: Unique identifier for the parameter.
- `time`: Specified time to get the values.

## Return Value

Return Value Returns YES if the values are retrieved successfully; NO otherwise.

## Discussion

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:)](professional_video_applications/fxparameterretrievalapi_v6/getboolvalue(_:fromparameter:at:).md)
- [getCustomParameterValue(_:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getcustomparametervalue(_:fromparameter:at:).md)
- [getFloatValue(_:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getfloatvalue(_:fromparameter:at:).md)
- [getFontName(_:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getfontname(_:fromparameter:at:).md)
- [getHistogramBlack(in:blackOut:whiteIn:whiteOut:gamma:forChannel:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/gethistogramblack(in:blackout:whitein:whiteout:gamma:forchannel:fromparameter:at:).md)
- [getIntValue(_:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getintvalue(_:fromparameter:at:).md)
- [getParameterFlags(_:fromParameter:)](professional_video_applications/fxparameterretrievalapi_v6/getparameterflags(_:fromparameter:).md)
- [getPathID(_:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getpathid(_:fromparameter:at:).md)
- [getRedValue(_:greenValue:blueValue:alphaValue:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getredvalue(_:greenvalue:bluevalue:alphavalue:fromparameter:at:).md)
- [getRedValue(_:greenValue:blueValue:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getredvalue(_:greenvalue:bluevalue:fromparameter:at:).md)
- [getStringParameterValue(_:fromParameter:)](professional_video_applications/fxparameterretrievalapi_v6/getstringparametervalue(_:fromparameter:).md)
- [getXValue(_:yValue:fromParameter:at:)](professional_video_applications/fxparameterretrievalapi_v6/getxvalue(_:yvalue:fromparameter:at:).md)