Skip to content

LostBeard/SpawnDev.BlazorJS.MessagePack

Repository files navigation

SpawnDev.BlazorJS.MessagePack

MessagePack binary Javascript encoder and decoder for Blazor WebAssembly.

NuGet version

SpawnDev.BlazorJS.MessagePack brings the amazing MessagePack library to Blazor WebAssembly.

SpawnDev.BlazorJS.MessagePack uses SpawnDev.BlazorJS for Javascript interop allowing strongly typed, full usage of the MessagePack Javascript library. Voice, video and data channels are all fully supported in Blazor WebAssembly. The SpawnDev.BlazorJS.MessagePack API is a strongly typed version of the API found at the MessagePack repo.

Demo

Basic Demo

Getting started

Add the Nuget package SpawnDev.BlazorJS.MessagePack to your project using your package manager of choice.

dotnet add package SpawnDev.BlazorJS.MessagePack

Add MessagePack Javascript Library
Add to index.html

<script src="_content/SpawnDev.BlazorJS.MessagePack/msgpack.min.js"></script>

Modify the Blazor WebAssembly Program.cs to initialize SpawnDev.BlazorJS for Javascript interop.
Example Program.cs

using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using SpawnDev.BlazorJS;
using SpawnDev.BlazorJS.MessagePack.Demo;

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");

// Add SpawnDev.BlazorJS interop
builder.Services.AddBlazorJSRuntime();

// Run app using BlazorJSRunAsync
await builder.Build().BlazorJSRunAsync();

Example Home.razor

@page "/"

<PageTitle>SpawnDev.BlazorJS.MessagePack</PageTitle>

<h1>SpawnDev.BlazorJS.MessagePack</h1>

<p>
    This demo converts text to binary using MessagePack Javascript library and SpawnDev.BlazorJS.MessagePack
</p>
<div>
    <textarea style="width: 600px; word-wrap: break-word; white-space: normal;" @bind=@incoming></textarea>
    <button @onclick=@Submit>Pack</button>
</div>
<div>
    <pre style="width: 600px; word-wrap: break-word; white-space: normal;">@((MarkupString)outgoing)</pre>
</div>
<div>
    <pre style="width: 600px; word-wrap: break-word; white-space: normal;">@((MarkupString)readback)</pre>
</div>

Example Home.razor.cs

using SpawnDev.BlazorJS.JSObjects;
using SpawnDev.BlazorJS.MessagePack;

namespace SpawnDev.BlazorJS.MessagePack.Demo.Pages
{
    public partial class Home
    {
        string outgoing = "";
        string incoming = "";
        string readback = "";

        void Submit()
        {
            // encode to a Uint8Array using MessagePack
            using Uint8Array uint8Array = MessagePackSerializer.Encode(incoming);
            // the Uint8Array could now be sent over WebRTC, saved to file, etc.
            // for this demo we are converting to hex and displaying it
            var bytes = uint8Array.ReadBytes();
            outgoing = Convert.ToHexString(bytes);
            // decode to a string using MessagePack
            readback = MessagePackSerializer.Decode<string>(uint8Array);
        }
    }
}