<!--
{
  "availability" : [
    "FxPlug: 3.1.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "professional_video_applications",
  "identifier" : "/documentation/professional_video_applications/FxError",
  "metadataVersion" : "0.1.0",
  "role" : "Type Alias",
  "symbol" : {
    "kind" : "Type Alias",
    "modules" : [
      "Professional Video Applications"
    ],
    "preciseIdentifier" : "c:@T@FxError"
  },
  "title" : "FxError"
}
-->

# FxError

Errors returned by plug-in hosts applications.

```
typealias FxError = Int
```

## Topics

### Constants

[`var kFxError_AnalysisError: Int`](/documentation/professional_video_applications/kFxError_AnalysisError)

An error with analysis occurred.

[`var kFxError_AnalysisExtensionNotFound: Int`](/documentation/professional_video_applications/kFxError_AnalysisExtensionNotFound)

An error that indicates Analysis extension is not found.

[`var kFxError_APIUnavailable: Int`](/documentation/professional_video_applications/kFxError_APIUnavailable)

An error that indicates that the requested API cannot be used by the plug-in at this time.

[`var kFxError_CommandNotProcessed: Int`](/documentation/professional_video_applications/kFxError_CommandNotProcessed)

An error that indicates that the command sent to the `FxCommandAPI` is unable to complete.

[`var kFxError_HostUnreachable: Int`](/documentation/professional_video_applications/kFxError_HostUnreachable)

An error that indicates that the host application cannot be reached to complete an operation.

[`var kFxError_InvalidColorGamut: Int`](/documentation/professional_video_applications/kFxError_InvalidColorGamut)

An Error that indicates that an attempt to get color gamut info from the host failed.

[`var kFxError_InvalidDataLength: Int`](/documentation/professional_video_applications/kFxError_InvalidDataLength)

An error that indicates an invalid data length was found by the plug-in while the host or framework was decoding data.

[`var kFxError_InvalidKeyframeIndex: Int`](/documentation/professional_video_applications/kFxError_InvalidKeyframeIndex)

An error that indicates that the plug-in passed an invalid keyframe index to the host.

[`var kFxError_InvalidLightAccess: Int`](/documentation/professional_video_applications/kFxError_InvalidLightAccess)

An error that indicates that an attempt was made by the plug-in to access lights without first requesting light access.

[`var kFxError_InvalidParameter: Int`](/documentation/professional_video_applications/kFxError_InvalidParameter)

An error that indicates that a parameter sent by the caller to an API method was invalid.

[`var kFxError_InvalidParameterChannelIndex: Int`](/documentation/professional_video_applications/kFxError_InvalidParameterChannelIndex)

An error that indicates that the plug-in passed an invalid channel number for a parameter to the host.

[`var kFxError_InvalidParameterID: Int`](/documentation/professional_video_applications/kFxError_InvalidParameterID)

An error that indicates that the plug-in passed an invalid parameter to the host.

[`var kFxError_InvalidPathID: Int`](/documentation/professional_video_applications/kFxError_InvalidPathID)

An error that indicates that no path with that ID exists.

[`var kFxError_InvalidPathIndex: Int`](/documentation/professional_video_applications/kFxError_InvalidPathIndex)

An error that indicates that the index is greater than the number of paths.

[`var kFxError_InvalidPaths: Int`](/documentation/professional_video_applications/kFxError_InvalidPaths)

An error that indicates that an attempt to get path info from the host failed.

[`var kFxError_InvalidPathStyle: Int`](/documentation/professional_video_applications/kFxError_InvalidPathStyle)

An error that indicates that an invalid path style was used by the plug-in.

[`var kFxError_InvalidSegmentIndex: Int`](/documentation/professional_video_applications/kFxError_InvalidSegmentIndex)

An error that indicates that the index of the segment of the path is greater than the number of segments in the path.

[`var kFxError_InvalidTime: Int`](/documentation/professional_video_applications/kFxError_InvalidTime)

An error that indicates that the plug-in passed an invalid time to the host.

[`var kFxError_InvalidTiming: Int`](/documentation/professional_video_applications/kFxError_InvalidTiming)

An error that indicates that an attempt to get timing info from the host failed.

[`var kFxError_LostConnectionToPlugin: Int`](/documentation/professional_video_applications/kFxError_LostConnectionToPlugin)

An error that indicates that the connection between the host and the plug-in was lost.

[`var kFxError_MemoryNotAllocated: Int`](/documentation/professional_video_applications/kFxError_MemoryNotAllocated)

An error that indicates unable to free a memory resource because it is not allocated.

[`var kFxError_NoDocumentFound: Int`](/documentation/professional_video_applications/kFxError_NoDocumentFound)

An error that indicates that the FxPlug is not in a project.

[`var kFxError_NoMediaFolder: Int`](/documentation/professional_video_applications/kFxError_NoMediaFolder)

An error that indicates that the project has no media folder.

[`var kFxError_NotYetImplemented: Int`](/documentation/professional_video_applications/kFxError_NotYetImplemented)

An error that indicates that the host application has not yet implemented the API.

[`var kFxError_NoViewFound: Int`](/documentation/professional_video_applications/kFxError_NoViewFound)

An error that indicates that a constant that indicates the remote window view wasn’t retrieved by the host.

[`var kFxError_OpenGLError: Int`](/documentation/professional_video_applications/kFxError_OpenGLError)

An error that indicates that OpenGL returned an error.

[`var kFxError_OutOfMemory: Int`](/documentation/professional_video_applications/kFxError_OutOfMemory)

An error that indicates unable to allocate memory.

[`var kFxError_PluginNotFound: Int`](/documentation/professional_video_applications/kFxError_PluginNotFound)

An error that indicates that the host couldn’t find the plug-in.

[`var kFxError_Success: Int`](/documentation/professional_video_applications/kFxError_Success)

No error occurred.

[`var kFxError_ThirdPartyDeveloperStart: Int`](/documentation/professional_video_applications/kFxError_ThirdPartyDeveloperStart)

All third-party error values must be greater than or equal to this value.

[`var kFxError_UnableToCreateDynamicRegistrationEndpoint: Int`](/documentation/professional_video_applications/kFxError_UnableToCreateDynamicRegistrationEndpoint)

An error that indicates that the XPC service was unable to create a new XPC Listener Endpoint for communication with the host application.

[`var kFxError_UnableToInstantiateDynamicRegistrar: Int`](/documentation/professional_video_applications/kFxError_UnableToInstantiateDynamicRegistrar)

An error that indicates that the XPC service was unable to instantiate a dynamic registrar object.

[`var kFxError_UnableToMovePlayhead: Int`](/documentation/professional_video_applications/kFxError_UnableToMovePlayhead)

An error that indicates that an attempt by the host to move the playhead failed.

[`var kFxError_UserCancelled: Int`](/documentation/professional_video_applications/kFxError_UserCancelled)

An error that indicates that an analysis operation was canceled by the user.

[`var kFxError_UnableToObtainProjectAspectRatio: Int`](/documentation/professional_video_applications/kFxError_UnableToObtainProjectAspectRatio)

An error that indicates that the host couldn’t obtain the project’s aspect ratio.


---

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)