---
title: FxOnScreenControlAPI_v2
framework: Professional Video Applications
role: symbol
role_heading: Protocol
platforms: [fxplug 3.1+]
path: professional_video_applications/fxonscreencontrolapi_v2
---

# FxOnScreenControlAPI_v2

The FxOnScreenControlAPI_v2 protocol specifies additions to the FxOnScreenControlAPI protocol which defines the methods the host application provides to manage conversions between various on-screen coordinate spaces.

## Declaration

```swift
protocol FxOnScreenControlAPI_v2 : FxOnScreenControlAPI
```

## Overview

Overview This protocol inherits from, and expands on, the FxOnScreenControlAPI protocol It can retrieve information about the canvas, such as its pixel aspect ratio or its zoom level so that a plug-in can draw its controls at the appropriate scale. As with the FxOnScreenControlAPI protocol, this aids in allowing the user to directly manipulate a plug-in’s parameters.

## Topics

### Canvas Information

- [canvasZoom()](professional_video_applications/fxonscreencontrolapi_v2/canvaszoom().md)
- [canvasPixelAspectRatio()](professional_video_applications/fxonscreencontrolapi_v2/canvaspixelaspectratio().md)
- [pixelAspectRatio()](professional_video_applications/fxonscreencontrolapi_v2/pixelaspectratio().md)
- [objectBounds()](professional_video_applications/fxonscreencontrolapi_v2/objectbounds().md)
- [objectToScreenTransform()](professional_video_applications/fxonscreencontrolapi_v2/objecttoscreentransform().md)

### Input and Output Item Geometry

- [objectWidth(_:height:pixelAspectRatio:)](professional_video_applications/fxonscreencontrolapi_v2/objectwidth(_:height:pixelaspectratio:).md)
- [inputWidth(_:height:pixelAspectRatio:)](professional_video_applications/fxonscreencontrolapi_v2/inputwidth(_:height:pixelaspectratio:).md)
- [inputBounds()](professional_video_applications/fxonscreencontrolapi_v2/inputbounds().md)

## Relationships

### Inherits From

- [FxOnScreenControlAPI](professional_video_applications/fxonscreencontrolapi.md)

### Inherited By

- [FxOnScreenControlAPI_v3](professional_video_applications/fxonscreencontrolapi_v3.md)
- [FxOnScreenControlAPI_v4](professional_video_applications/fxonscreencontrolapi_v4.md)

## See Also

### Onscreen Control APIs

- [FxOnScreenControl_v4](professional_video_applications/fxonscreencontrol_v4.md)
- [FxOnScreenControlAPI](professional_video_applications/fxonscreencontrolapi.md)
- [FxOnScreenControlAPI_v3](professional_video_applications/fxonscreencontrolapi_v3.md)
- [FxOnScreenControlAPI_v4](professional_video_applications/fxonscreencontrolapi_v4.md)