readme.md

rtmp-sharp

A fast, lightweight library RTMP(S) client library for .NET. It's used in astralfoxy's Wintermint client, as well as in many other high-traffic websites.

Example usage

Simple server connection + make a call

var client = new RtmpClient(
	new Uri("rtmps://sandbox.astralfoxy.com"),
	new SerializationContext(),
	ObjectEncoding.Amf3);

// connect to the server
await client.ConnectAsync();

// call a remote service
var songs = await client.InvokeAsync<string[]>("musicalService", "findSongs");

Serialization domains

This section is only relevant if you are serializing and deserializing typed objects.

The SerializationContext isolates different serialization domains to prevent attacks from untrusted servers. It also negates issues that occur when there is only a single global context: if two different domains (eg, twitch.tv and astralfoxy.com) both have ServiceStatus objects, then it would be impossible to tell which one to use. The SerializationContext allows us to specify different objects for each context.

// method one: specify the types in the constructor
var context = new SerializationContext(types);

// method two: add types in a method call
context.Register(type);

By default, the serialization context will deserialize unregistered objects to anonymous types; if you have an empty context, all objects will be deserialized to anonymous types.

If you don't need statically typed objects, you can use dynamic objects for all objects instead:

dynamic d = await client.InvokeAsync<dynamic>(...)

Object annotations

By default, rtmp-sharp uses an CLR type and field names for serialization. If you need to use a different type name on the network, you can annotate your code with the SerializedName attribute.

namespace Client
{
    // Without annotation: `Client.WintermintServiceStatus`
    // With annotation: `org.astralfoxy.ServiceStatus`
    [Serializable]
    [SerializedName("org.astralfoxy.ServiceStatus")]
    public class WintermintServiceStatus
    {
        // Without annotation: `Difficulty`
        // With annotation: `hardness`
        [SerializedName("hardness")]
        public string Difficulty;

        [SerializedName("gameId")]
        public int MatchId;
    }
}

Issues

When time allows, I'll fix these.

• rtmp-sharp spawns two threads per RtmpClient - a reader and writer thread
• flash shared objects aren't implemented
• video and audio decoding isn't implemented

License

• rtmp-sharp MIT licensed
• Feel free to use it however you want
• But I'd love to hear about how you're using it! Email me at foxy::astralfoxy:com
• Please contribute any improvements you make back to this repository