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

# CompressorExtensionSettings

A set of methods you use to manage the extension UI that displays the current encoder settings for users to view and customize.

```
protocol CompressorExtensionSettings
```

## Overview

Encoder extensions provide a default settings template with audio and video settings for the extension’s custom output format. To allow users to view and customize these settings, implement the [`edit(_:completionHandler:)`](/documentation/professional_video_applications/CompressorExtensionSettings/edit(_:completionHandler:)) method.

Encoder extension sessions are stateless and cannot persist data across different sessions. To save the encoder settings values, and make them persistent across different sessions, implement the [`settingsString()`](/documentation/professional_video_applications/CompressorExtensionSettings/settingsString()) method.  When a user updates the encoder settings from the UI, the Compressor app calls this method to retrieve and save those settings as XML at the compressor end. When an extension restarts, or during an encoding process, the Compressor app provides these settings back to the extension.

Implement the methods in this interface to send other extension details, such as extension name and description, to the Compressor app to display them on its interface.

## Topics

### Displaying the Extension View

[`func edit(NSViewController!, completionHandler: ((NSApplication.ModalResponse) -> Void)!)`](/documentation/professional_video_applications/CompressorExtensionSettings/edit(_:completionHandler:))

Displays a view that enables users to edit the current encoder settings, and then calls a handler upon completion.

### Configuring Extension Settings

[`func setSettingsString(String!)`](/documentation/professional_video_applications/CompressorExtensionSettings/setSettingsString(_:))

Sets the encoder settings based on the string value supplied.

[`var audioEnabled: Bool`](/documentation/professional_video_applications/CompressorExtensionSettings/audioEnabled)

A Boolean value that indicates whether audio is enabled for the source media.

[`var videoEnabled: Bool`](/documentation/professional_video_applications/CompressorExtensionSettings/videoEnabled)

A Boolean value that indicates whether video is enabled for the source media.

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

The type alias for referencing the `CompressorExtensionSettings`  object.

### Getting Extension Settings and Details

[`func settingsString() -> String!`](/documentation/professional_video_applications/CompressorExtensionSettings/settingsString())

Returns the current encoder settings string.

[`func settingsAttributes() -> [AnyHashable : Any]!`](/documentation/professional_video_applications/CompressorExtensionSettings/settingsAttributes())

Returns a set of audio and video encoding attributes to display on the Compressor app interface.

[`func settingsDescription() -> String!`](/documentation/professional_video_applications/CompressorExtensionSettings/settingsDescription())

Returns a description of the current encoder settings to display in the Compressor app interface.

[`func encoderName() -> String!`](/documentation/professional_video_applications/CompressorExtensionSettings/encoderName())

Returns the encoder extension name to display in the Compressor app interface.



---

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)