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

# FxLightingAPI_v3

An API you use to get information about lights in a scene in a Motion project.

```
protocol FxLightingAPI_v3
```

## Overview

This API provides a plug-in with the number of lights in a scene, as well as information about each light at a given time. A plug-in only has access to lights that are in the same group as the plug-in or a subgroup of such a group.

## Topics

### Getting Lighting Information

[`func lightInfo(UnsafeMutablePointer<FxLight>!, forLight: Int, at: CMTime) throws`](/documentation/professional_video_applications/FxLightingAPI_v3/lightInfo(_:forLight:at:))

Provides information about a light at a particular time.

[`func numberOfLights(at: CMTime) -> Int`](/documentation/professional_video_applications/FxLightingAPI_v3/numberOfLights(at:))

Retrieves the number of lights at the passed-in time.

[`struct FxLight`](/documentation/professional_video_applications/FxLight)

A structure that contains lighting information.

### Constants

[`var kFxLight_V3: Int32`](/documentation/professional_video_applications/kFxLight_V3)

The version number of the lighting information.

[`var FxLight_CurrentVersion: Int32`](/documentation/professional_video_applications/FxLight_CurrentVersion)

A property used to define a lighting information structure as being the most current version.

[`struct FxLight`](/documentation/professional_video_applications/FxLight)

A structure that contains lighting information.

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

The type of lighting.



---

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)