---
title: FxParameterCreationAPI_v5
framework: Professional Video Applications
role: symbol
role_heading: Protocol
platforms: [fxplug 3.1.1+]
path: professional_video_applications/fxparametercreationapi_v5
---

# FxParameterCreationAPI_v5

Defines the methods provided by the host application to create parameters.

## Declaration

```swift
protocol FxParameterCreationAPI_v5
```

## Mentioned in

Adding parameters to plug-ins Managing color space and gamut in plug-ins Using FxPlug APIs

## Overview

Overview A plug-in uses the methods defined in this protocol (along with those defined in FxOptionalParameterAPI.h) to populate its parameter list. Each parameter is created with a unique numeric parameter ID. The host application uses this parameter ID to identify a parameter, and stores the parameter ID in a saved project file. If a new version of a plug-in removes a parameter, the host application will then ignore any saved parameter data for that obsolete parameter in a project that was saved while using the old version of the plug-in. This implies that a new version plug-in should never change the ID of a given parameter unless it intentionally wants to obsolesce old value data in saved projects. Similarly, it should not introduce a new parameter with an ID that has already been obsolesced. This is version 5 of the Parameter Creation API. This version 5 protocol is not a superset of version 4. important: Parameter IDs must be in the range of [1, 9998]. IDs outside of this range are invalid.

## Topics

### Instance Methods

- [addAngleSlider(withName:parameterID:defaultDegrees:parameterMinDegrees:parameterMaxDegrees:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addangleslider(withname:parameterid:defaultdegrees:parametermindegrees:parametermaxdegrees:parameterflags:).md)
- [addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addcolorparameter(withname:parameterid:defaultred:defaultgreen:defaultblue:defaultalpha:parameterflags:).md)
- [addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addcolorparameter(withname:parameterid:defaultred:defaultgreen:defaultblue:parameterflags:).md)
- [addCustomParameter(withName:parameterID:defaultValue:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addcustomparameter(withname:parameterid:defaultvalue:parameterflags:).md)
- [addFloatSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addfloatslider(withname:parameterid:defaultvalue:parametermin:parametermax:slidermin:slidermax:delta:parameterflags:).md)
- [addFontMenu(withName:parameterID:fontName:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addfontmenu(withname:parameterid:fontname:parameterflags:).md)
- [addGradient(withName:parameterID:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addgradient(withname:parameterid:parameterflags:).md)
- [addHelpButton(withName:parameterID:selector:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addhelpbutton(withname:parameterid:selector:parameterflags:).md)
- [addHistogram(withName:parameterID:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addhistogram(withname:parameterid:parameterflags:).md)
- [addImageReference(withName:parameterID:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addimagereference(withname:parameterid:parameterflags:).md)
- [addIntSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addintslider(withname:parameterid:defaultvalue:parametermin:parametermax:slidermin:slidermax:delta:parameterflags:).md)
- [addPathPicker(withName:parameterID:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addpathpicker(withname:parameterid:parameterflags:).md)
- [addPercentSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addpercentslider(withname:parameterid:defaultvalue:parametermin:parametermax:slidermin:slidermax:delta:parameterflags:).md)
- [addPointParameter(withName:parameterID:defaultX:defaultY:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addpointparameter(withname:parameterid:defaultx:defaulty:parameterflags:).md)
- [addPopupMenu(withName:parameterID:defaultValue:menuEntries:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addpopupmenu(withname:parameterid:defaultvalue:menuentries:parameterflags:).md)
- [addPushButton(withName:parameterID:selector:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addpushbutton(withname:parameterid:selector:parameterflags:).md)
- [addStringParameter(withName:parameterID:defaultValue:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addstringparameter(withname:parameterid:defaultvalue:parameterflags:).md)
- [addToggleButton(withName:parameterID:defaultValue:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/addtogglebutton(withname:parameterid:defaultvalue:parameterflags:).md)
- [endParameterSubGroup()](professional_video_applications/fxparametercreationapi_v5/endparametersubgroup().md)
- [startParameterSubGroup(_:parameterID:parameterFlags:)](professional_video_applications/fxparametercreationapi_v5/startparametersubgroup(_:parameterid:parameterflags:).md)

## See Also

### Parameter APIs

- [FxParameterRetrievalAPI_v6](professional_video_applications/fxparameterretrievalapi_v6.md)
- [FxParameterRetrievalAPI_v7](professional_video_applications/fxparameterretrievalapi_v7.md)
- [FxParameterSettingAPI_v5](professional_video_applications/fxparametersettingapi_v5.md)
- [FxParameterSettingAPI_v6](professional_video_applications/fxparametersettingapi_v6.md)
- [FxDynamicParameterAPI_v3](professional_video_applications/fxdynamicparameterapi_v3.md)