Vivox Unity SDK 快速入门指南

在 Unity 项目中启用 Vivox 服务

1. 在 Unity Dashboard https://cloud.unity3d.com 上创建帐户和项目。
2. 在左侧面板中，选择 Products。在 Communication & Safety 下，选择 Vivox Voice and Text Chat。
3. 遵循入门步骤。在入门过程中，您将获得 Vivox API 凭据以在项目中使用。

将您的 Unity 项目连接到 Vivox

1. 创建或打开本地 Unity 项目。
2. 在编辑器中，选择 Window > Package Manager > Search Unity Registry。
3. 搜索 Vivox。选择 Install。
4. 选择 Edit > Project Settings > Services，确保项目有与之关联的正确 Project ID。
5. 在 Service 下，选择 Vivox，并确保已将正确的凭据拉入项目中。
   注意

   您可以通过编辑 manifest.json 文件或使用 Package Manager（选择 Window > Package Manager > + > Add package by name，使用

   com.unity.services.vivox

   作为名称）直接添加所需要的包。

   要了解更多信息，请参阅 Unity 文档中的项目清单。

生命周期操作

Initialize

using System;using UnityEngine;using Unity.Services.Authentication;using Unity.Services.Core;using Unity.Services.Vivox;async void InitializeAsync(){    await UnityServices.InitializeAsync();    await AuthenticationService.Instance.SignInAnonymouslyAsync();    await VivoxService.Instance.InitializeAsync();}

登录

LoginOptions

VivoxService.Instance.LoginAsync(LoginOptions options = null)

 using Unity.Services.Vivox;public async void LoginToVivoxAsync(){    LoginOptions options = new LoginOptions();    options.DisplayName = UserDisplayName;    options.EnableTTS = true;    await VivoxService.Instance.LoginAsync(options);}

加入回声频道

VivoxService.Instance.JoinEchoChannelAsync(string channelName, ChatCapability chatCapability, ChannelOptions channelOptions = null)

 using Unity.Services.Vivox;public async void JoinEchoChannelAsync(){    string channelToJoin = "Lobby";    await VivoxService.Instance.JoinEchoChannelAsync(channelToJoin, ChatCapability.TextAndAudio);}

VivoxService.Instance.JoinGroupChannelAsync((string channelName, ChatCapability chatCapability, ChannelOptions channelOptions = null))

VivoxService.Instance.JoinPositionalChannelAsync(string channelName, ChatCapability chatCapability, Channel3DProperties positionalChannelProperties, ChannelOptions channelOptions = null)

离开语音和文本频道

VivoxService.Instance.LeaveChannelAsync(string channelName)

VivoxService.Instance.LeaveAllChannels()

 using Unity.Services.Vivox;public async void LeaveEchoChannelAsync(){    string channelToLeave = "Lobby";    await VivoxService.Instance.LeaveChannelAsync(channelToLeave);}

注销用户

VivoxService.Instance.LogoutAsync()

using Unity.Services.Vivox;public async void LogoutOfVivoxAsync (){    VivoxService.Instance.LogoutAsync;}

频道内操作

处理参与者事件

• VivoxService.Instance.ParticipantAddedToChannel

• VivoxService.Instance.ParticipantRemovedFromChannel

VivoxParticipant

DisplayName

PlayerId

AudioEnergy

SpeechDetected, IsMuted

udioEnergy

• VivoxParticipant.ParticipantMuteStateChanged

• VivoxParticipant.ParticipantSpeechDetected

• VivoxParticipant.ParticipantAudioEnergyChanged

using Unity.Service.Vivox;List<RosterItem> rosterList = new List<RosterItem>();private void BindSessionEvents(bool doBind){    if(doBind)    {        VivoxService.Instance.ParticipantAddedToChannel += onParticipantAddedToChannel;        VivoxService.Instance.ParticipantRemovedFromChannel += onParticipantRemovedFromChannel;    }    else    {        VivoxService.Instance.ParticipantAddedToChannel -= onParticipantAddedToChannel;        VivoxService.Instance.ParticipantRemovedFromChannel -= onParticipantRemovedFromChannel;    }}private void onParticipantAddedToChannel(VivoxParticipant participant){    ///RosterItem is a class intended to store the participant object, and reflect events relating to it into the game's UI.    ///It is a sample of one way to use these events, and is detailed just below this snippet.    RosterItem newRosterItem = new RosterItem();    newRosterItem.SetupRosterItem(participant);    rosterList.Add(newRosterItem);}private void onParticipantRemovedFromChannel(VivoxParticipant participant){    RosterItem rosterItemToRemove = rosterList.FirstOrDefault(p => p.Participant.PlayerId == participant.PlayerId);    rosterList.Remove(rosterItemToRemove);}

RosterItem

 using Unity.Service.Vivox;using UnityEngine;public class RosterItem : MonoBehaviour{    public VivoxParticipant Participant;    public Text PlayerNameText;    public Image ChatStateImage;    public Sprite MutedImage;    public Sprite SpeakingImage;    public Sprite NotSpeakingImage;    public SetupRosterItem(VivoxParticipant participant)    {        Participant = participant;        PlayerNameText.text = Participant.DisplayName;        UpdateChatStateImage();        Participant.ParticipantMuteStateChanged += UpdateChatStateImage;        Participant.ParticipantSpeechDetected += UpdateChatStateImage;    }    private void UpdateChatStateImage()    {        /// Update the UI of the game to the state of the participant        if (Participant.IsMuted)        {            ChatStateImage.sprite = MutedImage;            ChatStateImage.gameObject.transform.localScale = Vector3.one;        }        else        {            if (Participant.SpeechDetected)            {                ChatStateImage.sprite = SpeakingImage;                ChatStateImage.gameObject.transform.localScale = Vector3.one;            }            else            {                ChatStateImage.sprite = NotSpeakingImage;            }        }    }}

向频道发送文本消息

VivoxService.Instance.SendChannelTextMessageAsync(string channelName, string message)

ChannelMessageReceived

VivoxMessage

using Unity.Service.Vivox;private async void SendMessageAsync(string channelName, string message){    VivoxService.Instance.SendChannelTextMessageAsync(channelName, message);}private void BindSessionEvents(bool doBind){    VivoxService.Instance.ChannelMessageReceived += onChannelMessageReceived;}private void onChannelMessageReceived(VivoxMessage message){    string messageText = message.MessageText;    string senderID = message.SenderPlayerId;    string senderDisplayName = message.SenderDisplayName;    string messageChannel = message.ChannelName;}

使其他参与者静音

VivoxParticipant.MutePlayerLocally()

VivoxParticipant.UnmutePlayerLocally()

{if (participant.InAudio && setMute){    participant.MutePlayerLocally}else if (participant.InAudio){    participant.UnmutePlayerLocally}else{    //Tell player to try again    Debug.Log("Try Again");}}

使自己静音

AudioInputDevices

SetTransmissionMode()

Transmission.None

await VivoxService.Instance.SetChannelTransmissionModeAsync(Transmission.None, channelName)

后续步骤

• 添加功能以丰富文本聊天。
• 考虑语音转文本等辅助功能。
• 查看开发者指南以了解更多主题和功能。