chushi-player

A Pixel Streaming client library for Unreal Engine (UE4/UE5).
像素流客户端库，用于 Unreal Engine 像素流媒体播放。

Installation

npm install chushi-player

Usage

Basic Example

import chushiApi from "chushi-player";

const { rtcPlayer, RTCEvent } = chushiApi;

// 设置配置（可选） rtcPlayer.setPlayerConfig({ scaleMultiple: 1, // 页面缩放倍数，针对大屏 printLog: false, // 是否打印日志 interceptMouseAndKeyBoard: false // 是否拦截鼠标键盘事件 });

// 连接到像素流服务 rtcPlayer.start('container-id', 'ws://your-signaling-server:port');

// 监听连接事件 rtcPlayer.on(RTCEvent.Connecting, () => { console.log('正在连接...'); });

rtcPlayer.on(RTCEvent.Connected, () => { console.log('连接成功'); // iOS 设备需要在连接成功后调用 play() // rtcPlayer.play(); });

rtcPlayer.on(RTCEvent.Disconnected, () => { console.log('连接断开'); });

// 接收 UE 客户端发送的数据 rtcPlayer.on(RTCEvent.ReceivedMsg, (msg) => { console.log('收到消息:', msg); });

// 发送消息到 UE 客户端 rtcPlayer.sendMSG({ type: 'your-message-type', data: 'your-data' });

// 断开连接 rtcPlayer.closeConnect();

### HTML Structure

```html
<div id="container-id" style="width: 100%; height: 100vh;"></div>

API Reference

rtcPlayer

Methods

• start(elementId: string, websocketUrl: string)
  开始连接像素流服务

  • elementId: 容器元素的 ID
  • websocketUrl: 信令服务器的 WebSocket 地址

• play()
  播放视频（主要用于 iOS 设备，需要在用户交互后调用）

• closeConnect()
  断开像素流连接

• setPlayerConfig(config: PlayerOption)
  设置播放器配置

  interface PlayerOption {
    scaleMultiple: number; // 页面缩放倍数
    printLog: boolean; // 是否打印日志
    interceptMouseAndKeyBoard: boolean; // 是否拦截鼠标键盘事件
  }

• sendMSG(msg: Object)
  发送消息到 UE 客户端

• on(event: string, callback: Function)
  监听事件

• once(event: string, callback: Function)
  监听一次性事件

• off(event: string, callback: Function)
  取消监听

Events

• RTCEvent.Connecting - 正在连接
• RTCEvent.Connected - 连接成功
• RTCEvent.Disconnected - 连接断开
• RTCEvent.ReceivedMsg - 接收到 UE 客户端发送的数据

Browser Support

• Chrome (recommended)
• Firefox
• Safari
• Edge

Requires WebRTC support.

License

MIT