# 転送フィルター機能

## 概要

ここでは Sora Unity SDK のサンプル集を使って転送フィルターの設定を試す方法を説明します。

[Sora Unity SDK サンプル集](https://github.com/shiguredo/sora-unity-sdk/tree/master/SoraUnitySdkExamples)

## 転送フィルターの注意点

- Inspector で転送フィルターを設定する場合 Unity 2022 LTS 以前のバージョンでは表示に問題があります。

## 転送フィルター

転送フィルターは Sora がクライアントへ転送する音声や映像のパケットをフィルターする機能です。

転送フィルターを設定することで特定の映像や音声を受信しなくなります。

詳細は [Sora のドキュメント](https://sora-doc.shiguredo.jp/FORWARDING_FILTER) をご確認ください。

## マルチ転送フィルターの設定方法

マルチ転送フィルター機能は、転送フィルターに名前 (name) と優先度 (priority) を指定することで、 1 チャネルや 1 コネクションに複数の転送フィルターを設定できる機能です。

転送フィルターよりも複雑な条件でフィルターを設定できます。

詳細は [Sora のドキュメント](https://sora-doc.shiguredo.jp/MULTI_FORWARDING_FILTER) をご確認ください。

## 転送フィルターの設定方法

Inspector の ForwardingFilters の設定を変更することで転送フィルターを設定できます。

ForwardingFilters はリストなので、1 件だけ設定すれば単独の転送フィルターと同じ挙動になります。

1 チャネル、1 コネクションに対して複数の転送フィルターを設定したい場合は name や priority を設定します。

それぞれに Action などの設定を行うことができます。

![image](https://i.gyazo.com/c07c4dd44626bd5f44a89a7c542fa03a.png)

以下に設定方法を記載します。

### Action

EnableAction を有効にすることで action 項目を有効にできます。

Forwarding Filter Action を指定することで allow と block のどちらかを設定できます。

![image](https://i.gyazo.com/de2123337129929ba5c31bda81d099dc.png)

### Name

EnableName を有効にすることで name 項目を有効にできます。

Forwarding Filter Name を指定することでフィルターに名前を設定できます。

![image](https://i.gyazo.com/cdc7cb7340ac1c13016855a7a52d65f2.png)

### Priority

EnablePriority を有効にすることで priority 項目を有効にできます。

Forwarding Filter Priority を指定することでフィルターの優先度を設定できます。

![image](https://i.gyazo.com/500ce287d9d3f5b3ec030f86597dc5c0.png)

### Rule Lists

### Data

Data の数を増やすことで一つの転送フィルターにかける条件を増やすことができます。

Data には Field / Op / Values があり、そこに条件を設定します。

![image](https://i.gyazo.com/c59d1feb4aaf6c7483f0f48f4342ea4b.png)

### Field

Field には以下の値を設定できます。

- connection_id : フィルターをかける connection_id を指定します。
- client_id : フィルターをかける client_id を指定します。
- kind : フィルターをかける kind を指定します。 音声や映像を指定できます。

### Op

Op には以下の値を設定できます。

- is_in : 指定した値が Values に含まれている場合にフィルターをかけます。
- is_not_in : 指定した値が Values に含まれていない場合にフィルターをかけます。

### Values

Values には文字列を設定します。複数設定することができます。例： audio, video

kind の場合には audio または video を設定します。

### Forwarding Filter Version

Enable Forwarding Filter Version を設定することで version 項目を有効にできます。

Forwarding Filter Version を指定することで転送フィルターのバージョンを設定できます。

![image](https://i.gyazo.com/13a272a300d9732fff0c1687b766292f.png)

### Forwarding Filter Metadata

Enable Forwarding Filter Metadata を設定することで metadata 項目を有効にできます。

Forwarding Filter Metadata を指定することで metadata を設定できます。

![image](https://i.gyazo.com/feadbbefcd2e2b67a87518d50ead35d3.png)