<!--
{
  "availability" : [
    "FxPlug: 4.1.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "professional_video_applications",
  "identifier" : "/documentation/professional_video_applications/FxAnalysisAPI",
  "metadataVersion" : "0.1.0",
  "role" : "Protocol",
  "symbol" : {
    "kind" : "Protocol",
    "modules" : [
      "Professional Video Applications"
    ],
    "preciseIdentifier" : "c:objc(pl)FxAnalysisAPI"
  },
  "title" : "FxAnalysisAPI"
}
-->

# FxAnalysisAPI

A protocol that host applications implement to provide information to plug-ins that support the FxAnalyzer protocol.

```
protocol FxAnalysisAPI
```

## Overview

Host applications implement this protocol to provide frame analysis information to plug-ins that support the FxAnalyzer protocol.

## Topics

### Providing Frame Analysis Information

[`func analysisStateForEffect() -> FxAnalysisState`](/documentation/professional_video_applications/FxAnalysisAPI/analysisStateForEffect())

Fetches the state of frame analysis for your plug-in.

[`func startForwardAnalysis(FxAnalysisLocation) throws`](/documentation/professional_video_applications/FxAnalysisAPI/startForwardAnalysis(_:))

Requests that the application begin a forwards analysis of a clip from start to end.

[`func startBackwardAnalysis(FxAnalysisLocation) throws`](/documentation/professional_video_applications/FxAnalysisAPI/startBackwardAnalysis(_:))

Requests that the application begin a backwards analysis of a clip from end to start.

[`typealias FxAnalysisLocation`](/documentation/professional_video_applications/FxAnalysisLocation)

Indicates the type of hardware to use for analysis, either CPU or GPU.

## Relationships

### Inherited By

[`FxAnalysisAPI_v2`](/documentation/professional_video_applications/FxAnalysisAPI_v2)

---

Copyright &copy; 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)