> This page is for NVIDIA Background Noise Removal on Holoscan for Media, version 2.0.0 (Latest) (default).
> For other versions, use one of these documentation indexes:
> - 2.0.0 (Latest) (default): https://docs.nvidia.com/nim/maxine/bnr-h4m/2.0.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nim/maxine/llms.txt.

# Operator Custom Resource

The `nvidia-bnr-h4m-operator` chart installs the `NvidiaBnrMediaFunction` CRD in API group `nvidia.com/v1alpha1`.

## Top-Level Spec

| Field | Description |
|-------|-------------|
| `spec.schedulerName` | Scheduler assigned to the reconciled BNR NIM pod. |
| `spec.nodeSelector` | Kubernetes node selector map. |
| `spec.parameters` | BNR runtime, image, secret, storage, resource, and security settings. |
| `spec.inputs.audio_input` | Audio input port configuration. |
| `spec.outputs.audio_output` | Audio output port configuration. |

## Parameters

| Field | Description |
|-------|-------------|
| `parameters.highSpeedNetwork[].name` | Multus `NetworkAttachmentDefinition` used for media traffic. |
| `parameters.highSpeedNetwork[].ip` | Optional static IP/CIDR requested from the network attachment. |
| `parameters.resources` | Resource requests and limits for the BNR NIM pod. |
| `parameters.ngcSecret.secretName` | Generic secret containing the NGC API key. |
| `parameters.ngcSecret.secretKey` | Secret key name. Default examples use `NGC_API_KEY`. |
| `parameters.nimModelCache` | PVC configuration for downloaded model artifacts. |
| `parameters.nimLogs` | PVC configuration for NIM logs. |
| `parameters.securityContext` | Container security context. |
| `parameters.podSecurityContext` | Pod security context. |
| `parameters.label` | NMOS label. |
| `parameters.description` | NMOS description. |
| `parameters.modelType` | BNR model variant: `v2-48k` or `v2-16k` recommended. |
| `parameters.intensityRatio` | Denoising strength as a string from `"0.0"` to `"1.0"`. |
| `parameters.nmosEnabled` | Enables NMOS runtime behavior. |
| `parameters.nimEnabled` | Enables NIM runtime behavior. |
| `parameters.cpuAffinity` | CPU affinity string passed to the runtime. |
| `parameters.loggingLevel` | Runtime logging level from `0` to `5`. |
| `parameters.gstDebug` | Optional `GST_DEBUG` override. |

## Input and Output Ports

Each BNR media function has one audio input and one audio output:

```yaml
inputs:
  audio_input:
    control: { nmos: {} }
    transport:
      rtp:
        packet_time: 1
    format:
      audio:
        sample_rate: 48000
        channel_count: 1
        sample_depth: 24
        media_type: "audio/L24"
    sessionName: audio_in
    localInterfaceName: net1

outputs:
  audio_output:
    control: { nmos: {} }
    transport:
      rtp:
        packet_time: 1
    format:
      audio:
        sample_rate: 48000
        channel_count: 1
        sample_depth: 24
        media_type: "audio/L24"
    sessionName: audio_out
    localInterfaceName: net1
```

## Control Modes

Use exactly one control variant per input/output:

```yaml
control: { nmos: {} }
```

Alternatively:

```yaml
control:
  sdp:
    data: |
      v=0
      ...
```

For NMOS deployments, use `nmos`. For fixed ST 2110 deployments, either use static host fields (`hostIP`, `hostPort`, `hostNumSubnetBits`) or inline SDP, depending on the operator workflow used by your cluster.

## Model and Sample Rate

| `parameters.modelType` | `format.audio.sample_rate` |
|------------------------|----------------------------|
| `v2-48k` | `48000` |
| `v2-16k` | `16000` |

The input and output sample rates must match the selected model variant.