---
title: FxPathAPI_v3
framework: Professional Video Applications
role: symbol
role_heading: Protocol
platforms: [fxplug 4.0+]
path: professional_video_applications/fxpathapi_v3
---

# FxPathAPI_v3

An API that defines the methods to retrieve information about paths, shapes, and masks the user has drawn on an object.

## Declaration

```swift
protocol FxPathAPI_v3
```

## Overview

Overview This API is used to get information about a path that the user has drawn on an object in the canvas. You can get the number of paths applied to the object, and then enumerate through them, or pick a specific one. You can use this API to retrieve the control points along the path and use that information to guide the rendering of your plug-in. note: This API does not inherit from the FxPathAPI. It is a new API for FxPlug 4 that uses CMTime and handles NSErrors consistently with other familiar APIs.

## Topics

### Getting Path Information

- [numberOfPaths(at:)](professional_video_applications/fxpathapi_v3/numberofpaths(at:).md)
- [pathID(_:for:)](professional_video_applications/fxpathapi_v3/pathid(_:for:).md)
- [name(_:ofPath:)](professional_video_applications/fxpathapi_v3/name(_:ofpath:).md)
- [isPath(_:open:at:)](professional_video_applications/fxpathapi_v3/ispath(_:open:at:).md)
- [isPath(_:inverted:at:)](professional_video_applications/fxpathapi_v3/ispath(_:inverted:at:).md)
- [style(_:ofPath:)](professional_video_applications/fxpathapi_v3/style(_:ofpath:).md)
- [length(_:ofPath:at:)](professional_video_applications/fxpathapi_v3/length(_:ofpath:at:).md)
- [length(_:ofSegment:ofPath:at:)](professional_video_applications/fxpathapi_v3/length(_:ofsegment:ofpath:at:).md)
- [number(ofVertices:inPath:at:)](professional_video_applications/fxpathapi_v3/number(ofvertices:inpath:at:).md)
- [vertex(_:at:ofPath:at:)](professional_video_applications/fxpathapi_v3/vertex(_:at:ofpath:at:).md)
- [point(_:atPercentageOfDistance:alongPath:at:)](professional_video_applications/fxpathapi_v3/point(_:atpercentageofdistance:alongpath:at:).md)
- [point(_:atPercentageOfParameter:alongPath:at:)](professional_video_applications/fxpathapi_v3/point(_:atpercentageofparameter:alongpath:at:).md)
- [blendMode(_:ofPath:)](professional_video_applications/fxpathapi_v3/blendmode(_:ofpath:).md)
- [pathGeometryInfo(_:forPath:at:)](professional_video_applications/fxpathapi_v3/pathgeometryinfo(_:forpath:at:).md)

### Setting Path Information

- [setPath(_:toColor:)](professional_video_applications/fxpathapi_v3/setpath(_:tocolor:).md)

### Structuring Path Information

- [FxPathGeometryInfo](professional_video_applications/fxpathgeometryinfo.md)
- [FxVertex](professional_video_applications/fxvertex.md)

### Constants

- [FxPathBlendMode](professional_video_applications/fxpathblendmode.md)
- [FxPathColor](professional_video_applications/fxpathcolor.md)
- [FxPathID](professional_video_applications/fxpathid.md)
- [FxPathStyle](professional_video_applications/fxpathstyle.md)

## See Also

### User interface

- [Adding parameters to plug-ins](professional-video-applications/adding-parameters-to-plug-ins.md)
- [Adding onscreen controls to plug-ins](professional-video-applications/adding-onscreen-controls-to-plug-ins.md)
- [FxUndoAPI](professional_video_applications/fxundoapi.md)
- [FxCommandAPI](professional_video_applications/fxcommandapi.md)
- [FxCommandAPI_v2](professional_video_applications/fxcommandapi_v2.md)
- [FxRemoteWindowAPI](professional_video_applications/fxremotewindowapi.md)
- [FxRemoteWindowAPI_v2](professional_video_applications/fxremotewindowapi_v2.md)