GameRTCChannel RTC通道

这是一个服务端API

该API仅在服务端脚本使用

Arena独有

该API仅在Arena编辑器使用

实验性警告

该API仍处于实验性阶段，可能会造成很多不确定因素，轻则卡顿、崩溃，重则地图无法进入、数据损坏
目前建议在独立的新地图中测试

若地图无法进入，可以先尝试等待容器重启（3~5min）；若仍无效，则需寻求官方帮助

编者注：为了测试RTC损失一张空白地图，等了一天都没用

查阅社区文档
是Box3中的RTC（实时语言通信）通道。
无法（很难）被实例化，但可以通过.createChannel获取其实例化对象
add(entity: ): <>

向该RTC通道中添加玩家

此处与社区API不符

社区文档中，entity是类型
其他方法同理

经2024/7/29测试，该文档内容无问题

world.onPlayerJoin(async ({ entity }) => {
    var channel = await rtc.createChannel();

    await channel.add(entity);
    await channel.getMicrophonePermission(entity);
    await channel.publishMicrophone(entity);
});
示例 
world.onPlayerJoin(async ({ entity }) => {
    var channel = await rtc.createChannel();
    await channel.add(entity);
});
remove(entity: ): <>

向该RTC通道移除玩家

示例 
world.onPlayerJoin(async ({ entity }) => {
    var channel = await rtc.createChannel();
    await channel.add(entity);
    entity.player.directMessage('你已被加入rtc频道，按鼠标右键/B键退出');
    await entity.player.nextPress(({button}) => button === GameButtonType.ACTION1);
    await channel.remove(entity);
});
destroy(): <>
销毁该RTC通道
getMicrophonePermission(entity: ): <>

申请玩家的麦克风权限

提示

未加入RTC通道的玩家，也可以使用该方法申请权限，但不会被publishMicrophone打开麦克风

参数 类型 说明
entity 要申请麦克风权限的玩家
返回值 类型 说明
<> 是否成功申请到玩家的麦克风权限
示例 
world.onPlayerJoin(async ({ entity }) => {
    var channel = await rtc.createChannel();

    await channel.add(entity);
    var permission = await channel.getMicrophonePermission(entity);
    console.log(entity.player.userId, permission);
});
publishMicrophone(entity: ): <>

开启该RTC通道玩家的麦克风

Bug

若开启麦克风之后，没有通过unpublish关闭麦克风，地图停止运行后麦克风是不会关闭的（并且除非取消权限，否则永远也关不掉了）

unpublish(entity: ): <>
关闭该RTC通道玩家的麦克风
getPlayers(entity: ): <[]>
获取该RTC通道的所有玩家
getVolume(entity: ): <>
获取该RTC通道的音量，范围\([0, 100]\)
setVolume(entity: , volume: ): <>

设置该RTC通道的音量，范围\([0, 100]\)

示例 
world.onPlayerJoin(async ({ entity }) => {
    var channel = await rtc.createChannel();

    await channel.add(entity);
    await channel.getMicrophonePermission(entity);
    await channel.publishMicrophone(entity);
    await channel.setVolume(entity, 50);
});

评论区