> 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 事件中继组件参考，包括可用事件、载荷字段以及用于场景逻辑的订阅模式。

Convai SDK 通过一组中继组件来传达会话期间发生的情况——连接、角色语音、转录、情绪等。将这些 MonoBehaviour 之一添加到场景中的某个 GameObject， 在 Inspector 中绑定 UnityEvent，或在代码中订阅，场景逻辑就会对 SDK 广播的内容作出响应。

***

### 两种接线方式

{% tabs %}
{% tab title="Inspector（UnityEvent）" %}

1. 通过以下路径将中继组件添加到场景中的任意 GameObject： **Add Component → Convai → Events**.
2. 在 Inspector 中分配所需引用（`ConvaiManager` 或 `ConvaiCharacter`），或启用 **Auto Resolve** 让组件自动查找它。
3. 在 Inspector 中将处理器连接到 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 %}

***

### 中继组件速查表

| 组件                           | Inspector 菜单路径                              | 使用场景                      |
| ---------------------------- | ------------------------------------------- | ------------------------- |
| `ConvaiSessionEventRelay`    | Convai/Events/Convai Session Event Relay    | 跟踪会话连接状态、处理错误、驱动连接 UI     |
| `ConvaiCharacterEventRelay`  | Convai/Events/Convai Character Event Relay  | 响应特定角色的语音、转录、轮次和情绪        |
| `ConvaiTranscriptEventRelay` | Convai/Events/Convai Transcript Event Relay | 全场景转录流，可按角色或是否为最终结果进行可选过滤 |

***

### `ConvaiSessionEventRelay`

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

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

**检视器字段：**

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

**事件：**

| 事件                                | 载荷                                | 触发时机                                                                                                                          |
| --------------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `OnConnected`                     | —                                 | 初始连接已建立（`连接中` → `已连接`）。不会在重新连接时触发——参见 `OnReconnected`.                                                                        |
| `OnDisconnected`                  | —                                 | 会话进入 `Disconnected` 状态。                                                                                                       |
| `OnReconnecting`                  | —                                 | 重新连接尝试开始（会话已 `已连接`，连接已断开）。                                                                                                    |
| `OnReconnected`                   | —                                 | 重新连接尝试成功。会话再次处于 `已连接` 状态。                                                                                                     |
| `OnUsageLimitReached`             | —                                 | 账户的 API 使用配额已超出。                                                                                                              |
| `OnUserIdleWarning`               | `UserIdleWarningRelayData`        | 已达到用户空闲警告阈值。请参见 [会话生命周期](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/session-lifecycle.md) 了解触发此警告的超时策略。 |
| `OnUserIdleTimeout`               | `UserIdleTimeoutRelayData`        | 在收到警告后，若没有任何 `ExtendIdleTimeout`/`ResetIdleTimer` 调用。                                                                         |
| `OnRuntimeBackgroundStateChanged` | `RuntimeBackgroundStateRelayData` | 应用进入或离开后台，或者其实际后台策略发生变化。                                                                                                      |
| `OnSessionStateChanged`           | `SessionStateChangedRelayData`    | 任何会话状态转换。每次状态变化都会触发。                                                                                                          |
| `OnSessionError`                  | `SessionErrorRelayData`           | 从会话接收到一个错误事件。                                                                                                                 |

#### `SessionStateChangedRelayData`

| 属性                         | 类型             | 说明                                                         |
| -------------------------- | -------------- | ---------------------------------------------------------- |
| `OldState`                 | `SessionState` | 转换前的状态。                                                    |
| `NewState`                 | `SessionState` | 转换后的状态。                                                    |
| `SessionId`                | `string`       | 当前会话标识符。如果没有活动会话，则为空。                                      |
| `ErrorCode`                | `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`

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

`SessionErrorStage` 值： `未知`, `配置`, `ConnectApi`, `Transport`, `SessionRecovery`, `运行时`.

#### `UserIdleWarningRelayData`

| 属性                 | 类型       | 说明                    |
| ------------------ | -------- | --------------------- |
| `RemainingSeconds` | `int`    | 在本地推导的空闲截止时间到期前剩余的秒数。 |
| `Message`          | `string` | 人类可读的空闲警告消息。          |

#### `UserIdleTimeoutRelayData`

| 属性                     | 类型       | 说明                         |
| ---------------------- | -------- | -------------------------- |
| `WarningReceivedAtUtc` | `string` | 收到空闲警告时的 ISO 8601 时间戳。     |
| `DeadlineUtc`          | `string` | 本地推导的空闲截止时间的 ISO 8601 时间戳。 |

#### `RuntimeBackgroundStateRelayData`

| 属性                     | 类型                        | 说明                                                            |
| ---------------------- | ------------------------- | ------------------------------------------------------------- |
| `IsBackgrounded`       | `bool`                    | 应用当前是否处于后台。                                                   |
| `RequestedPolicy`      | `RuntimeBackgroundPolicy` | 项目配置的后台策略。                                                    |
| `EffectivePolicy`      | `RuntimeBackgroundPolicy` | 实际生效的后台策略。在强制回退的平台上，可能与 `RequestedPolicy` 不同。                 |
| `原因`                   | `RuntimePauseReason`      | 状态更改的原因——例如 `ApplicationBackground` 或 `ApplicationFocusLost`. |
| `UsedPlatformFallback` | `bool`                    | 计算结果： `true` 当 `RequestedPolicy != EffectivePolicy`.          |

`RuntimeBackgroundPolicy` 以及完整的暂停/恢复/重连 API 都在 [会话生命周期](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/session-lifecycle.md)中介绍；本页仅记录事件载荷。

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

```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 收到新的情绪信号。         |

#### 多角色房间中的事件

在多角色会话处于活动状态时， `ConvaiCharacterEventRelay` 以及上 `ConvaiEvents` 的每角色事件，会通过房间成员关系而不是仅通过 `CharacterId` 来解析传入消息。一个名册中可能存在两个具有相同 `CharacterId`的成员，而只有成员资格才能将它们区分开来——仅按 `CharacterId` 进行过滤的代码无法区分二者。请参见 [处理房间事件](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/multi-character-sessions/handle-roster-events.md) 了解 `MultiCharacterRoomSession`.

#### `CharacterTranscriptRelayData`

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

#### `CharacterTurnCompletedRelayData`

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

#### `CharacterEmotionRelayData`

| 属性              | 类型       | 说明                                                 |
| --------------- | -------- | -------------------------------------------------- |
| `CharacterId`   | `string` | 角色的 ID。                                            |
| `CharacterName` | `string` | 角色的显示名称。                                           |
| `情绪`            | `string` | 情绪名称（例如 `“joy”`, `"fear"`, `"sadness"`）。请参阅情绪功能参考。 |
| `强度`            | `int`    | 情绪强度，按 `1`–`3` 的量表计算，其中 `1` 表示较轻微， `3` 表示较强烈。      |

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

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

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

    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("EmotionIntensity", data.Intensity / 3f);
    }
}
```

***

### `ConvaiTranscriptEventRelay`

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

**检视器字段：**

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

**事件：**

| 事件                                   | 载荷                             | 触发时机                                                   |
| ------------------------------------ | ------------------------------ | ------------------------------------------------------ |
| `OnTranscriptReceived`               | `TranscriptUpdateRelayData`    | 任何角色或玩家的转录更新，使用统一的数据结构（受过滤条件和 `IgnoreInterimUpdates`). |
| `OnCharacterTranscriptReceived`      | `CharacterTranscriptRelayData` | 任何角色转录（受过滤条件和 `IgnoreInterimUpdates`).                 |
| `OnPlayerTranscriptReceived`         | `PlayerTranscriptRelayData`    | 任何玩家转录。                                                |
| `OnFinalCharacterTranscriptReceived` | `CharacterTranscriptRelayData` | 仅最终角色转录，不论 `FinalOnly` 设置，否则角色会把结果说出来。                 |
| `OnFinalPlayerTranscriptReceived`    | `PlayerTranscriptRelayData`    | 仅最终玩家转录。                                               |

#### `TranscriptUpdateRelayData`

当场景需要一个事件和一种数据结构同时处理角色与玩家的转录更新，而不是分别订阅角色和玩家事件时，请使用此载荷。

| 属性                    | 类型                            | 说明                                      |
| --------------------- | ----------------------------- | --------------------------------------- |
| `MessageId`           | `string`                      | 此转录消息的唯一标识符。                            |
| `TurnId`              | `string`                      | 标识此更新所属的轮次。                             |
| `ResponseId`          | `string`                      | 标识该轮次所属的角色回复。                           |
| `SpeakerType`         | `SpeakerType`                 | `Character` 或 `Player`.                 |
| `PlayerOrCharacterId` | `string`                      | 正在说话的角色或玩家的 ID。                         |
| `DisplayName`         | `string`                      | 说话者的显示名称。                               |
| `ParticipantId`       | `string`                      | 房间参与者标识符。                               |
| `文本`                  | `string`                      | 转录文本。如果 `IsFinal` 为 false，则可能是部分内容。     |
| `Lifecycle`           | `TranscriptLifecycle`         | `流式传输中`, `Stable`，或 `已完成` ——此更新文本的稳定程度。 |
| `IsFinal`             | `bool`                        | 计算结果： `Lifecycle != Streaming`.         |
| `SourceKind`          | `TranscriptSegmentSourceKind` | 文本来源——例如 `PlayerAsr` 或 `BotOutput`.     |

#### `PlayerTranscriptRelayData`

| 属性              | 类型       | 说明                                  |
| --------------- | -------- | ----------------------------------- |
| `PlayerId`      | `string` | 本地玩家的标识符。                           |
| `PlayerName`    | `string` | 玩家的显示名称。                            |
| `SpeakerId`     | `string` | 说话者标识符（在多参与者房间中可能与 `PlayerId` 不同）。  |
| `SpeakerName`   | `string` | 说话者的显示名称。                           |
| `ParticipantId` | `string` | 房间参与者标识符。                           |
| `TurnId`        | `string` | 标识此转录片段所属的轮次。                       |
| `MessageId`     | `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($"[Learner]: {data.Text}");
        _logText.text = _log.ToString();
    }
}
```

***

### 订阅生命周期

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

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

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

{% hint style="warning" %}
不要在 `Start()` 中订阅，而不在 `OnDestroy()`中配套取消订阅。中继组件可以被禁用后再次启用；若 `Start()` 中的订阅未清理，在中继被禁用后会导致重复处理器或空引用错误。
{% endhint %}

***

### 对话目标和可用性事件

这些事件没有中继组件。请通过 `ConvaiManager.ActiveManager.Events` 上的强类型 hub 进行订阅，而不是向场景中添加组件。

**事件：**

| 事件                                  | 载荷                                | 触发时机                                                        |
| ----------------------------------- | --------------------------------- | ----------------------------------------------------------- |
| `OnConversationTargetChanged`       | `ConversationTargetChanged`       | 当多角色房间中的对话从一个角色切换到另一个角色时——在请求切换时触发一次，在服务确认时触发一次，若被拒绝则再触发一次。 |
| `OnConversationAvailabilityChanged` | `ConversationAvailabilityChanged` | “玩家现在能否发言”的答案会针对当前被交谈的角色发生变化。                               |
| `OnRoomRosterChanged`               | `RoomRosterChanged`               | 连接的房间名册在运行时被编辑——角色加入、离开，或者编辑被拒绝。                            |

**代码示例——对目标切换和名册变更作出响应：**

```csharp
using Convai.Domain.DomainEvents.Runtime;
using Convai.Runtime.Facades;
using UnityEngine;

public class ConversationTargetingMonitor : MonoBehaviour
{
    private void OnEnable()
    {
        var manager = ConvaiManager.ActiveManager;
        if (manager == null) return;

        manager.Events.OnConversationTargetChanged += HandleTargetChanged;
        manager.Events.OnRoomRosterChanged += HandleRosterChanged;
    }

    private void OnDisable()
    {
        var manager = ConvaiManager.ActiveManager;
        if (manager == null) return;

        manager.Events.OnConversationTargetChanged -= HandleTargetChanged;
        manager.Events.OnRoomRosterChanged -= HandleRosterChanged;
    }

    private void HandleTargetChanged(ConversationTargetChanged e)
    {
        if (e.Phase == ConversationTargetChangePhase.Confirmed)
            Debug.Log($"现在正在与 {e.CharacterName} 交谈。");
    }

    private void HandleRosterChanged(RoomRosterChanged e)
    {
        if (e.Change == RoomRosterChange.Joined)
            Debug.Log($"{e.CharacterName} 加入了房间。");
    }
}
```

#### `ConversationTargetChanged`

| 属性              | 类型                              | 说明                                             |
| --------------- | ------------------------------- | ---------------------------------------------- |
| `阶段`            | `ConversationTargetChangePhase` | 这个移动已进行到： `Requested`, `Confirmed`，或 `Failed`. |
| `CharacterId`   | `string`                        | 会话要转向的角色的 Convai Character ID。                 |
| `CharacterName` | `string`                        | 该角色的显示名称。                                      |
| `MembershipId`  | `string`                        | 该移动所针对的房间成员资格。                                 |
| `原因`            | `string`                        | 该移动被拒绝的原因。除非……否则为空 `阶段` 是 `Failed`.            |
| `时间戳`           | `DateTime`                      | 到达该阶段的 UTC 时间。                                 |

`ConversationTargetChangePhase` 值： `Requested` （管理器已占用路由窗口，正要发送该移动）， `Confirmed` （服务响应已校正权威路由）， `Failed` （请求的移动被拒绝）。

#### `ConversationAvailabilityChanged`

| 属性                     | 类型                               | 说明                                 |
| ---------------------- | -------------------------------- | ---------------------------------- |
| `可用性`                  | `ConvaiConversationAvailability` | 当前判定。                              |
| `PreviousAvailability` | `ConvaiConversationAvailability` | 被替换掉的判定。                           |
| `CharacterId`          | `string`                         | 正在被对话的角色的 Convai Character ID（如有）。 |
| `CharacterName`        | `string`                         | 该角色的显示名称。                          |
| `时间戳`                  | `DateTime`                       | 裁定变更时的 UTC 时间。                     |
| `CanAcceptPlayerInput` | `bool`                           | 玩家当前是否可以发送语音或文本。                   |

`ConvaiConversationAvailability` 按生命周期顺序的值： `无角色`, `离线`, `连接中`, `Preparing`, `Ready`, `Answering`, `Unavailable`。仅 `Ready` 和 `Answering` 接受玩家输入。

#### `RoomRosterChanged`

| 属性              | 类型                 | 说明                              |
| --------------- | ------------------ | ------------------------------- |
| `更改`            | `RoomRosterChange` | 发生了什么： `已加入`, `已离开`，或 `拒绝`.     |
| `MembershipId`  | `string`           | 受影响的房间成员资格。对于从未获得成员资格的加入，留空。    |
| `CharacterId`   | `string`           | 此事件涉及的 Convai Character ID。     |
| `CharacterName` | `string`           | 该角色的显示名称。                       |
| `名册大小`          | `int`              | 此次更改后房间容纳了多少角色。                 |
| `原因`            | `string`           | 该编辑被拒绝的原因。除非……否则为空 `更改` 是 `拒绝`. |
| `时间戳`           | `DateTime`         | 名册变更时的 UTC 时间。                  |

#### `LocalPlayerActivityChanged`

SDK 对玩家是否开始说话的本地判断——只是一个提示，不是服务自己的裁定。它在……上没有对应属性 `ConvaiEvents`；请改为通过原始 hub 订阅：

```csharp
using Convai.Domain.DomainEvents.Runtime;
using Convai.Domain.EventSystem;
using UnityEngine;

public class LocalPlayerActivityMonitor : MonoBehaviour
{
    private SubscriptionToken _token;

    private void OnEnable()
    {
        var hub = ConvaiManager.ActiveManager?.Events?.Raw;
        if (hub == null) return;
        _token = hub.Subscribe<LocalPlayerActivityChanged>(HandleActivity);
    }

    private void OnDisable() => ConvaiManager.ActiveManager?.Events?.Raw?.Unsubscribe(_token);

    private void HandleActivity(LocalPlayerActivityChanged e) =>
        Debug.Log(e.IsActive ? "玩家开始说话。" : "玩家停止说话。");
}
```

| 属性         | 类型                          | 说明                                          |
| ---------- | --------------------------- | ------------------------------------------- |
| `IsActive` | `bool`                      | 是否 `来源` 当前能看到玩家。                            |
| `来源`       | `LocalPlayerActivitySource` | 哪项本地证据触发了这一点： `麦克风` 或 `PushToTalk`.         |
| `级别`       | `float`                     | 麦克风音量相对于其测得噪声底的大小。零表示…… `PushToTalk` 以及下降沿。 |
| `时间戳`      | `DateTime`                  | 本地证据变更时的 UTC 时间。                            |

请将其视为“有人开始和我说话”，仅此而已——绝不要据此路由消息、提交轮次或进行任何计费。服务自己的裁定是 `PlayerSpeakingStateChanged`.

***

### `ConvaiNotificationEventBridge`

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

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

大多数项目都不会直接与此类交互。它由 SDK 引导程序实例化并管理。如果你正在使用……构建自定义通知系统 `IConvaiNotificationService`，你可以使用 `ConvaiNotificationEventBridge` 将会话错误事件集成到你的系统中。与上面的中继组件不同， `ConvaiNotificationEventBridge` 不会通过……添加到场景中 **添加组件** ——它会在 SDK 启动期间通过程序实例化。

***

### 使用示例

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

在会话尚未建立时显示“正在连接……”遮罩层。

```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 / 3f);
}
```

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

***

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

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

在 `ConvaiTranscriptEventRelay` 在 Inspector 中的组件：

* 设置 `CharacterIdFilter` 将其指向导师角色的 ID（例如， `"abc123"`).
* 启用 `FinalOnly` 仅显示已提交的转写行。
* 连接 `OnFinalCharacterTranscriptReceived` 到你的字幕 UI。

**预期结果：** 只有导师完成的句子会显示在字幕面板中。场景中的其他角色不会影响 UI。

***

### 故障排除

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

***

### 下一步

现在你已经拥有所有中继组件、事件负载和订阅模式的完整参考。请继续查看 Features 部分，以探索各个 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.