PixelStreamer()

Leverage the Pixel Streamer component to seamlessly integrate Unreal Engine streaming capabilities into your web applications.

Usage

To incorporate live streaming functionalities in your web applications, utilize the ApplicationStreamer component. This component is designed to manage video streaming with various configurable options:

<script setup lang="ts">
import { PixelStreamer } from "@heyokajs/nuxt"
</script>

<template>
    <div class="h-screen">
      <PixelStreamer 
        :AutoPlayVideo="true"
        :AutoConnect="true" 
        :StartVideoMuted="true"
        :WaitForStreamer="true" 
        ss="ws://localhost:4000" 
      />
    </div>
</template>

Options

AutoPlayVideo

Boolean that automatically plays the video stream upon loading. This is useful for applications where immediate playback is desirable, such as live event streaming.

AutoConnect

Boolean that determines whether the streamer should automatically attempt to connect to the streaming server upon initialization.

StartVideoMuted

Boolean that starts the video in a muted state. This can be crucial for user experience, especially in environments where autoplay audio is not ideal.

WaitForStreamer

Boolean that delays video playback until the streamer is ready, ensuring a smooth start without buffering issues.

ss

String that specifies the WebSocket URL to connect for streaming, essential for establishing a connection to the streaming server.