Enkadia.Synexsis.ComponentFramework 1.0.2-CI-20191211-232754

Enkadia Synexsis

Enkadia Synexsis AV control software targets .NET Standard 2.0. This enables software development for both .NET Framework and .NET Core. Android and iOS applications can be developed using Synexsis components with Xamarin.

Getting Started

Using Synexsis is as easy as

1. Find your component type from our NuGet packages.
2. Build your appsettings.json file
3. Use your component!

Configuring your components

Synexsis builds your components by reading values from an appsettings.json file, located at the root of your program's runtime directory.

This example demonstrates registering a projector which supports the PJLink protocol.

Sample appsettings.json

{
	"PJLinkProjector": {
		"IPAddress": "192.168.1.100",
		"Port": 4352,
		"Password": "default"
	},
	"License": {
		"Key": "license_key_value"
	}
}

Offline Activation

{
	"PJLinkProjector": {
		"IPAddress": "192.168.1.100",
		"Port": 4352,
		"Password": "default"
	},
	"License": {
		"OfflineActivation": "true",
		"LicenseFileName": "MyLicense.skm"
	}
}

A best practice is to name section keys (in this case PJLinkProjector) the same as the component's class name. The default section key can be double checked with intellisense on the class's constructor.

Sample Code

using Microsoft.Extensions.DependencyInjection;
using Enkadia.Synexsis.ComponentFramework.Extensions;

var serviceProvider = new ServiceCollection()
	.AddSynexsis()
	.AddTransient<PJLinkProjector>()
	.AddTransient<Roboshot>()
	.AddTransient<SharpDisplay>()
	.AddTransient<DXPSwitcher>()
	.BuildServiceProvider();

// Retrieve your components
var projector = serviceProvider.GetService<PJLinkProjector>();
var camera = serviceProvider.GetService<Roboshot>();
var frontDisplay = serviceProvider.GetService<SharpDisplay>();
var swt = serviceProvider.GetService<DXPSwitcher>();

Multiple components of the same type

It is possible to specify a section key other than the default. This is useful if you need to control several components of the same type with different information. This can be done with the ResolveWith extension method.

appsettings.json (multiple components of the same type)

{
	"PJLinkLeftProjector": {
		"IPAddress": "192.168.1.100",
		"Port": 4352,
		"Password": "default"
	},
	
	"PJLinkRightProjector": {
		"IPAddress": "192.168.1.101",
		"Port": 4352,
		"Password": "default"
	},
	
	"License": {
		"Key": "license_key_value"
	}
}

Initialize devices

using Microsoft.Extensions.DependencyInjection;
using Enkadia.Synexsis.ComponentFramework.Extensions;

var serviceProvider = new ServiceCollection()
	.AddSynexsis()
	.AddTransient<PJLinkProjector>
	.BuildServiceProvider();

var leftProjector = serviceProvider.ResolveWith<PJLinkProjector>("PJLinkLeftProjector");
var rightProjector = serviceProvider.ResolveWith<PJLinkProjector>("PJLinkRightProjector");