> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/event-system.md).

# 事件系统

Convai SDK 通过一组中继组件来传递会话期间发生的事件——连接、角色语音、转录文本、情绪等。将这些 MonoBehaviour 之一添加到场景中的 GameObject 上，在检查器中绑定 UnityEvent，或者在代码中订阅，场景逻辑就能响应 SDK 广播的任何内容。

***

### 两种接线方式

{% tabs %}
{% tab title="检查器（UnityEvent）" %}

1. 通过以下方式将中继组件添加到场景中的任意 GameObject： **添加组件 → Convai → 事件**.
2. 在检查器中分配所需引用（`ConvaiManager` 或 `ConvaiCharacter`），或者启用 **自动解析** ，让组件自动找到它。
3. 在检查器中的 UnityEvent 字段上连接处理器——无需代码。

最适合：连接指示器、动画触发器、UI 可见性切换——任何由单个事件驱动且不需要条件逻辑的场景。
{% endtab %}

{% tab title="C# 脚本" %}
从代码中订阅中继组件事件：

```csharp
public class MyHandler : MonoBehaviour
{
    [SerializeField] private ConvaiCharacterEventRelay _relay;

    private void OnEnable()
    {
        _relay.OnEmotionChanged.AddListener(HandleEmotion);
        _relay.OnSpeechStarted.AddListener(HandleSpeechStarted);
    }

    private void OnDisable()
    {
        _relay.OnEmotionChanged.RemoveListener(HandleEmotion);
        _relay.OnSpeechStarted.RemoveListener(HandleSpeechStarted);
    }

    private void HandleEmotion(CharacterEmotionRelayData data) { /* … */ }
    private void HandleSpeechStarted() { /* … */ }
}
```

最适合：条件逻辑、多事件协调、跨多个系统的数据路由。
{% endtab %}
{% endtabs %}

***

### 中继组件速查表

| 组件                           | 检查器菜单路径                 | 适用场景                       |
| ---------------------------- | ----------------------- | -------------------------- |
| `ConvaiSessionEventRelay`    | Convai/事件/Convai 会话事件中继 | 跟踪会话连接状态、处理错误、驱动连接 UI      |
| `ConvaiCharacterEventRelay`  | Convai/事件/Convai 角色事件中继 | 响应特定角色的语音、转录、轮次和情绪         |
| `ConvaiTranscriptEventRelay` | Convai/事件/Convai 转录事件中继 | 整个场景范围的转录流，可按角色或最终状态进行可选过滤 |

***

### `ConvaiSessionEventRelay`

跟踪整个场景的会话生命周期。每个场景添加一个——它会监控由 `ConvaiManager`.

{% hint style="info" %}
如果 `ConvaiManager` 在中继的 `OnEnable` 之后初始化（例如，由于脚本执行顺序），中继会自动在 `LateUpdate()` 处于启用状态时重试订阅。无需手动重试逻辑。
{% endhint %}

**检查器字段：**

| 字段                   | 说明                                                                 |
| -------------------- | ------------------------------------------------------------------ |
| `管理器`                | 对 `ConvaiManager` 在场景中的引用。                                         |
| `AutoResolveManager` | 启用后，组件会在运行时查找 `ConvaiManager.ActiveManager` 。如果你有多个管理器或需要显式绑定，请禁用。 |

**事件：**

| 事件                      | 负载                             | 触发时机                                                  |
| ----------------------- | ------------------------------ | ----------------------------------------------------- |
| `OnConnected`           | —                              | 建立初始连接（`正在连接` → `已连接`）。不会在重连时触发——请参见 `OnReconnected`. |
| `OnDisconnected`        | —                              | 会话进入 `已断开连接` 状态。                                      |
| `OnReconnecting`        | —                              | 开始重连尝试（会话已 `已连接`，连接已断开）。                              |
| `OnReconnected`         | —                              | 重连尝试成功。会话再次 `已连接` 。                                   |
| `OnUsageLimitReached`   | —                              | 该账户的 API 使用配额已超出。                                     |
| `OnSessionStateChanged` | `SessionStateChangedRelayData` | 任何会话状态转换。每次状态变化都会触发。                                  |
| `OnSessionError`        | `SessionErrorRelayData`        | 从会话收到错误事件。                                            |

#### `SessionStateChangedRelayData`

| 属性                         | 类型             | 说明                                                         |
| -------------------------- | -------------- | ---------------------------------------------------------- |
| `旧状态`                      | `SessionState` | 转换前的状态。                                                    |
| `新状态`                      | `SessionState` | 转换后的状态。                                                    |
| `会话 ID`                    | `string`       | 当前会话标识符。如果没有活动会话，则为空。                                      |
| `错误代码`                     | `string`       | 如果转换是由错误引起的，则为错误代码；否则为空。                                   |
| `IsError`                  | `bool`         | 计算结果： `NewState == Error`.                                 |
| `IsReconnecting`           | `bool`         | 计算结果： `OldState == Connected && NewState == Reconnecting`. |
| `IsConnectionEstablished`  | `bool`         | 计算结果： `OldState == Connecting && NewState == Connected`.   |
| `IsReconnectionSuccessful` | `bool`         | 计算结果： `OldState == Reconnecting && NewState == Connected`. |
| `IsDisconnected`           | `bool`         | 计算结果： `NewState == Disconnected`.                          |

#### `SessionErrorRelayData`

| 属性                  | 类型                  | 说明                         |
| ------------------- | ------------------- | -------------------------- |
| `错误代码`              | `string`            | 机器可读的错误代码。                 |
| `消息`                | `string`            | 人类可读的错误描述。                 |
| `会话 ID`             | `string`            | 发生错误时的会话标识符。               |
| `是否可恢复`             | `bool`              | SDK 是否会尝试自动恢复。             |
| `阶段`                | `SessionErrorStage` | 错误在连接生命周期中的哪个阶段发生。         |
| `HTTP 状态码`          | `int`               | 如果错误源自 API 调用，则为 HTTP 状态码。 |
| `HasHttpStatusCode` | `bool`              | 是否 `HTTP 状态码` 包含有意义的值。     |

`SessionErrorStage` 值： `未知`, `配置`, `ConnectApi`, `传输`, `会话恢复`, `运行时`.

**代码示例——显示连接状态指示器：**

```csharp
public class ConnectionIndicator : MonoBehaviour
{
    [SerializeField] private ConvaiSessionEventRelay _relay;
    [SerializeField] private GameObject _connectingOverlay;

    private void OnEnable()
    {
        _relay.OnConnected.AddListener(OnConnected);
        _relay.OnDisconnected.AddListener(OnDisconnected);
        _relay.OnReconnecting.AddListener(OnReconnecting);
    }

    private void OnDisable()
    {
        _relay.OnConnected.RemoveListener(OnConnected);
        _relay.OnDisconnected.RemoveListener(OnDisconnected);
        _relay.OnReconnecting.RemoveListener(OnReconnecting);
    }

    private void OnConnected()    => _connectingOverlay.SetActive(false);
    private void OnDisconnected() => _connectingOverlay.SetActive(true);
    private void OnReconnecting() => _connectingOverlay.SetActive(true);
}
```

***

### `ConvaiCharacterEventRelay`

跟踪单个 `ConvaiCharacter`的事件。每个需要驱动场景响应的角色添加一个。

**检查器字段：**

| 字段                     | 说明                                                  |
| ---------------------- | --------------------------------------------------- |
| `Character`            | 对 `ConvaiCharacter` 此中继监控。                          |
| `AutoResolveCharacter` | 启用后，组件会搜索 `ConvaiCharacter` ，位于与中继相同的 GameObject 上。 |

**事件：**

| 事件                     | 负载                                | 触发时机                     |
| ---------------------- | --------------------------------- | ------------------------ |
| `OnTranscriptReceived` | `CharacterTranscriptRelayData`    | 每个转录片段到达——包括中间（部分）和最终内容。 |
| `OnSpeechStarted`      | —                                 | 角色开始说话（音频开始播放）。          |
| `OnSpeechStopped`      | —                                 | 角色停止说话（音频结束）。            |
| `OnTurnCompleted`      | `CharacterTurnCompletedRelayData` | 角色某一轮的完整回复已结束。           |
| `OnCharacterReady`     | —                                 | 角色已完全初始化并连接到会话。          |
| `OnEmotionChanged`     | `CharacterEmotionRelayData`       | 从 Convai 收到新的情绪信号。       |

#### `CharacterTranscriptRelayData`

| 属性        | 类型       | 说明                                  |
| --------- | -------- | ----------------------------------- |
| `角色 ID`   | `string` | 角色的 ID。                             |
| `角色名称`    | `string` | 角色的显示名称。                            |
| `文本`      | `string` | 转录文本。如果 `IsFinal` 为 false，则可能是部分内容。 |
| `IsFinal` | `bool`   | 底层转录轮次是已提交、中断还是已更正。                 |
| `TurnId`  | `string` | 标识此转录片段所属的轮次。                       |
| `消息 ID`   | `string` | 此转录消息的唯一标识符。                        |
| `响应 ID`   | `string` | 标识此轮次所属的角色响应。                       |

#### `CharacterTurnCompletedRelayData`

| 属性               | 类型       | 说明                 |
| ---------------- | -------- | ------------------ |
| `角色 ID`          | `string` | 角色的 ID。            |
| `角色名称`           | `string` | 角色的显示名称。           |
| `WasInterrupted` | `bool`   | 该轮次是否因为用户中断了角色而结束。 |

#### `CharacterEmotionRelayData`

| 属性      | 类型       | 说明                                                         |
| ------- | -------- | ---------------------------------------------------------- |
| `角色 ID` | `string` | 角色的 ID。                                                    |
| `角色名称`  | `string` | 角色的显示名称。                                                   |
| `情绪`    | `string` | 情绪名称（例如， `“joy”`, `“fear”`, `“sadness”`）。请参见 Emotion 功能参考。 |
| `强度`    | `int`    | 情绪强度（0–100）。                                               |

**代码示例——在情绪变化时触发动画：**

```csharp
public class CharacterEmotionAnimator : MonoBehaviour
{
    [SerializeField] private ConvaiCharacterEventRelay _relay;
    [SerializeField] private Animator _animator;

    private static readonly int EmotionHash = Animator.StringToHash("情绪");

    private void OnEnable() => _relay.OnEmotionChanged.AddListener(HandleEmotion);
    private void OnDisable() => _relay.OnEmotionChanged.RemoveListener(HandleEmotion);

    private void HandleEmotion(CharacterEmotionRelayData data)
    {
        _animator.SetTrigger(data.Emotion);
        _animator.SetFloat("情绪强度", data.Intensity / 100f);
    }
}
```

***

### `ConvaiTranscriptEventRelay`

提供整个场景范围的转录流。不同于 `ConvaiCharacterEventRelay`，此中继通过单个组件监控所有角色和玩家。可用于驱动字幕 UI、会话日志或评估系统。

**检查器字段：**

| 字段                   | 类型              | 默认      | 说明                                                                                 |
| -------------------- | --------------- | ------- | ---------------------------------------------------------------------------------- |
| `管理器`                | `ConvaiManager` | —       | 该 `ConvaiManager` 进行监控。                                                            |
| `AutoResolveManager` | `bool`          | —       | 查找 `ActiveManager` 自动。                                                             |
| `仅最终`                | `bool`          | `false` | 启用后，只有最终转录（已提交、中断或已更正）才会触发事件。中间的部分转录将被抑制。                                          |
| `忽略中间更新`             | `bool`          | `true`  | 丢弃仍处于 `Listening` 或 `Streaming` 状态的轮次。稳定且已提交的轮次仍会通过。如果你的 UI 需要在角色说话时显示部分文本，请禁用此字段。 |
| `角色 ID 过滤器`          | `string`        | `""`    | 如果设置，则只有来自此 ID 的角色转录才会触发事件。留空则表示所有角色。                                              |

**事件：**

| 事件                                   | 负载                             | 触发时机                    |
| ------------------------------------ | ------------------------------ | ----------------------- |
| `OnCharacterTranscriptReceived`      | `CharacterTranscriptRelayData` | 任意角色转录（受过滤器和 `忽略中间更新`). |
| `OnPlayerTranscriptReceived`         | `PlayerTranscriptRelayData`    | 任意玩家转录。                 |
| `OnFinalCharacterTranscriptReceived` | `CharacterTranscriptRelayData` | 仅最终角色转录，不受 `仅最终` 设置影响。  |
| `OnFinalPlayerTranscriptReceived`    | `PlayerTranscriptRelayData`    | 仅最终玩家转录。                |

#### `PlayerTranscriptRelayData`

| 属性              | 类型       | 说明                                  |
| --------------- | -------- | ----------------------------------- |
| `玩家 ID`         | `string` | 本地玩家的标识符。                           |
| `玩家名称`          | `string` | 玩家的显示名称。                            |
| `SpeakerId`     | `string` | 说话者标识符（在多人房间中可能与 `玩家 ID` 不同）。       |
| `说话者名称`         | `string` | 说话者的显示名称。                           |
| `ParticipantId` | `string` | 房间参与者标识符。                           |
| `TurnId`        | `string` | 标识此转录片段所属的轮次。                       |
| `消息 ID`         | `string` | 此转录消息的唯一标识符。                        |
| `文本`            | `string` | 转录文本。如果 `IsFinal` 为 false，则可能是部分内容。 |
| `IsFinal`       | `bool`   | 底层转录轮次是已提交、中断还是已更正。                 |

**代码示例——用于培训日志的多角色转录流：**

```csharp
public class TrainingTranscriptLog : MonoBehaviour
{
    [SerializeField] private ConvaiTranscriptEventRelay _relay;
    [SerializeField] private TMP_Text _logText;

    private readonly System.Text.StringBuilder _log = new();

    private void OnEnable()
    {
        _relay.OnFinalCharacterTranscriptReceived.AddListener(OnCharacterLine);
        _relay.OnFinalPlayerTranscriptReceived.AddListener(OnPlayerLine);
    }

    private void OnDisable()
    {
        _relay.OnFinalCharacterTranscriptReceived.RemoveListener(OnCharacterLine);
        _relay.OnFinalPlayerTranscriptReceived.RemoveListener(OnPlayerLine);
    }

    private void OnCharacterLine(CharacterTranscriptRelayData data)
    {
        _log.AppendLine($"[{data.CharacterName}]: {data.Text}");
        _logText.text = _log.ToString();
    }

    private void OnPlayerLine(PlayerTranscriptRelayData data)
    {
        _log.AppendLine($"[学习者]: {data.Text}");
        _logText.text = _log.ToString();
    }
}
```

***

### 订阅生命周期

Relay MonoBehaviour 组件会自动管理自己的订阅。它们在 `OnEnable` 运行时订阅，在 `OnDisable` 运行时取消订阅。

通过 C# 订阅时，请遵循相同模式：

```csharp
private void OnEnable()  => _relay.OnConnected.AddListener(MyHandler);
private void OnDisable() => _relay.OnConnected.RemoveListener(MyHandler);
```

{% hint style="warning" %}
不要在 `Start()` 中订阅而不在 `OnDestroy()`中进行匹配的取消订阅。Relay 组件可以被禁用并重新启用；如果在 `Start()` 后没有清理，等中继被禁用后，就会导致重复处理器或空引用错误。
{% endhint %}

***

### `ConvaiNotificationEventBridge`

`ConvaiNotificationEventBridge` 不是中继组件。它是一个内部服务，用于将会话错误域事件桥接到通知 UI 系统，并通过冷却去重来防止同一错误通知反复出现。

| 属性     | 类型      | 默认   | 说明                 |
| ------ | ------- | ---- | ------------------ |
| `冷却秒数` | `float` | `10` | 显示相同通知类型之间的最少间隔秒数。 |

大多数项目不会直接与此类交互。它由 SDK 启动流程实例化并管理。如果你正在使用 `IConvaiNotificationService`构建自定义通知系统，你可以使用 `ConvaiNotificationEventBridge` 将会话错误事件集成到你的系统中。

{% hint style="info" %}
`ConvaiNotificationEventBridge` 不是通过 **添加组件**添加到场景中的。它是在 SDK 启动期间以编程方式实例化的。
{% endhint %}

***

### 用法示例

#### 示例 1：训练模拟——连接遮罩

在会话尚未建立时显示“Connecting…”遮罩。

```csharp
[SerializeField] private ConvaiSessionEventRelay _sessionRelay;
[SerializeField] private CanvasGroup _loadingOverlay;

private void OnEnable()
{
    _sessionRelay.OnConnected.AddListener(OnConnected);
    _sessionRelay.OnDisconnected.AddListener(OnDisconnected);
    _sessionRelay.OnReconnecting.AddListener(OnReconnecting);
}

private void OnDisable()
{
    _sessionRelay.OnConnected.RemoveListener(OnConnected);
    _sessionRelay.OnDisconnected.RemoveListener(OnDisconnected);
    _sessionRelay.OnReconnecting.RemoveListener(OnReconnecting);
}

private void OnConnected()    => _loadingOverlay.alpha = 0f;
private void OnDisconnected() => _loadingOverlay.alpha = 1f;
private void OnReconnecting() => _loadingOverlay.alpha = 0.5f;
```

**预期效果：** 当会话未连接时，遮罩淡入；当连接建立时，遮罩淡出。

***

#### 示例 2：医疗培训师——由情绪触发的角色反应

患者角色的面部表情和姿态会根据 Convai 检测到的情绪发生变化。

```csharp
[SerializeField] private ConvaiCharacterEventRelay _patientRelay;
[SerializeField] private PatientExpressionController _expressionController;

private void OnEnable() => _patientRelay.OnEmotionChanged.AddListener(ApplyEmotion);
private void OnDisable() => _patientRelay.OnEmotionChanged.RemoveListener(ApplyEmotion);

private void ApplyEmotion(CharacterEmotionRelayData data)
{
    _expressionController.SetExpression(data.Emotion, data.Intensity / 100f);
}
```

**预期效果：** 当来自 Convai 的情绪信号到达时，患者角色的视觉表情会实时更新。

***

#### 示例 3：筛选到单个角色的共享转录流

企业入职模拟中有多个 NPC 角色，但字幕面板中只显示主讲者的台词。

在 `ConvaiTranscriptEventRelay` 检查器中的组件：

* 将 `角色 ID 过滤器` 设置为讲师角色的 ID（例如， `"abc123"`).
* 启用 `仅最终` 以仅显示已提交的转录行。
* 将 `OnFinalCharacterTranscriptReceived` 连接到你的字幕 UI。

**预期效果：** 只有讲师完成的句子会出现在字幕面板中。场景中的其他角色不会影响 UI。

***

### 故障排查

| 症状                                        | 可能原因                                   | 修复方法                                                                                                              |
| ----------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| 场景开始后中继不触发任何事件                            | `ConvaiManager` 在中继的 `OnEnable` 运行时    | 无需采取任何操作——中继会在 `LateUpdate()` 处于启用状态时重试。请验证 `ConvaiManager` 已存在并在场景中处于活动状态。                                       |
| `ConvaiCharacterEventRelay` 不触发任何事件       | `ConvaiCharacter` 在分配的 GameObject 上未找到 | 验证 `ConvaiCharacter` 位于 **相同** GameObject 上，而不是中继器，或者显式分配该引用。 `AutoResolveCharacter` 仅搜索同一个 GameObject —— 不包括父对象。 |
| 中间转录更新未到达                                 | `忽略中间更新` 为 `true` 默认情况下                | 将 `IgnoreInterimUpdates = false` 上 `ConvaiTranscriptEventRelay` 以接收部分转录更新。                                        |
| 单个事件的事件处理器触发多次                            | 处理器订阅于 `Start()` 未清理；中继器已禁用并重新启用       | 将订阅移至 `OnEnable()` 并在 `OnDisable()`.                                                                              |
| `OnCharacterTranscriptReceived` 未针对预期角色触发 | `角色 ID 过滤器` 设置为不同的角色 ID                | 清除 `角色 ID 过滤器` 或者将其设置为正确的角色 ID。                                                                                   |

***

### 下一步

你现在已经获得了所有中继器组件、事件负载和订阅模式的完整参考。请继续前往“功能”部分，了解各项 SDK 功能。

{% content-ref url="/pages/8c561f7c198c46628ed5818040fdaa9af3397caf" %}
[功能](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/event-system.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.