# fuchsia.ultrasound

<br />

Added: 7

## **PROTOCOLS**

## Factory

*Defined in [fuchsia.ultrasound/factory.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.ultrasound/factory.fidl;l=11)*

### CreateCapturer

Creates a new `fuchsia.media.AudioCapturer` that is capable of capturing audio in
the ultrasonic frequency range.

The capturer will be suitible for capturing audio at ultrasound frequencies. The
channelization and sample rate of the capturer will be fixed to whatever the underlying
device is configured for. The `fuchsia.media.AudioSampleFormat` will be `FLOAT`.

See `fuchsia.media.AudioCore` for more information on the operation of a
`fuchsia.media.AudioCapturer`, with the following differences:

- `SetUsage` is disallowed. Ultrasound capturers do not have an associated
  `fuchsia.media.AudioCaptureUsage`.

- `BindGainControl` is disallowed. Ultrasound capturers will always have unity gain.

- `SetPcmStreamType` is disallowed. The stream type of an ultrasound capturer is not
  configurable, but instead returned from `CreateCapturer`.

- `SetReferenceClock` is disallowed. The reference clock of an ultrasound capturer is not
  configurable, but instead returned from `CreateCapturer`.

#### Request

| Name | Type |
|---|---|
| `request` | `server_end:https://fuchsia.dev/reference/fuchsia.media//https://fuchsia.dev/reference/fuchsia.media#AudioCapturer` |

#### Response

| Name | Type |
|---|---|
| `reference_clock` | `handle<clock>` |
| `stream_type` | `https://fuchsia.dev/reference/fuchsia.media//https://fuchsia.dev/reference/fuchsia.media#AudioStreamType` |

### CreateRenderer

Creates a new `fuchsia.media.AudioRenderer` that is capable of producing audio in
the ultrasonic frequency range.

The renderer will be suitible for producing audio at ultrasound frequencies. The
channelization and sample rate of the renderer will be fixed to whatever the underlying
device is configured for. The `fuchsia.media.AudioSampleFormat` will be `FLOAT`.

See `fuchsia.media.AudioCore` for more information on the operation of a
`fuchsia.media.AudioRenderer`, with the following differences:

- `SetUsage` is disallowed. Ultrasound renderers do not have an associated
  `fuchsia.media.AudioRenderUsage2`.

- `BindGainControl` is disallowed. Ultrasound renderers will always have unity gain.

- `SetPcmStreamType` is disallowed. The stream type of an ultrasound renderer is not
  configurable, but instead returned from `CreateRenderer`.

- `SetReferenceClock` is disallowed. The reference clock of an ultrasound renderer is not
  configurable, but instead returned from `CreateRenderer`.

#### Request

| Name | Type |
|---|---|
| `renderer` | `server_end:https://fuchsia.dev/reference/fuchsia.media//https://fuchsia.dev/reference/fuchsia.media#AudioRenderer` |

#### Response

| Name | Type |
|---|---|
| `reference_clock` | `handle<clock>` |
| `stream_type` | `https://fuchsia.dev/reference/fuchsia.media//https://fuchsia.dev/reference/fuchsia.media#AudioStreamType` |