---
title: "setPreferredPolarPattern(_:)"
framework: avfaudio
role: symbol
role_heading: Instance Method
path: "avfaudio/avaudiosessiondatasourcedescription/setpreferredpolarpattern(_:)"
---

# setPreferredPolarPattern(_:)

Selects the preferred directivity configuration for the data source.

## Declaration

```swift
func setPreferredPolarPattern(_ pattern: AVAudioSession.PolarPattern?) throws
```

## Parameters

- `pattern`: The directivity configuration to use.

## Discussion

Discussion Calling this method requests a change to the selected polar pattern. To determine whether the change has taken effect, inspect the selectedPolarPattern property. If the data source and its owning port are in use, using this method to change the directivity configuration is likely to result in a route reconfiguration. Set a preferred polar pattern only after setting the audio session’s category and mode, and activating the session.

## See Also

### Configuring Microphone Directivity

- [selectedPolarPattern](avfaudio/avaudiosessiondatasourcedescription/selectedpolarpattern.md)
- [supportedPolarPatterns](avfaudio/avaudiosessiondatasourcedescription/supportedpolarpatterns.md)
- [preferredPolarPattern](avfaudio/avaudiosessiondatasourcedescription/preferredpolarpattern.md)
- [AVAudioSession.PolarPattern](avfaudio/avaudiosession/polarpattern.md)