mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-02-06 08:16:11 +00:00
docs: complete XML documentation for all projects with inheritdoc tags
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
@@ -11,15 +11,24 @@ using Serilog.Events;
|
||||
|
||||
namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a BlueJeansPc
|
||||
/// </summary>
|
||||
public class BlueJeansPc : InRoomPc, IRunRouteAction, IRoutingSink
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the AnyVideoIn
|
||||
/// </summary>
|
||||
public RoutingInputPort AnyVideoIn { get; private set; }
|
||||
|
||||
public RoutingInputPort CurrentInputPort => AnyVideoIn;
|
||||
|
||||
#region IRoutingInputs Members
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the InputPorts
|
||||
/// </summary>
|
||||
public RoutingPortCollection<RoutingInputPort> InputPorts { get; private set; }
|
||||
|
||||
#endregion
|
||||
@@ -35,11 +44,17 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
|
||||
#region IRunRouteAction Members
|
||||
|
||||
/// <summary>
|
||||
/// RunRouteAction method
|
||||
/// </summary>
|
||||
public void RunRouteAction(string routeKey, string sourceListKey)
|
||||
{
|
||||
RunRouteAction(routeKey, sourceListKey, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// RunRouteAction method
|
||||
/// </summary>
|
||||
public void RunRouteAction(string routeKey, string sourceListKey, Action successCallback)
|
||||
{
|
||||
CrestronInvoke.BeginInvoke(o =>
|
||||
@@ -128,6 +143,9 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
|
||||
#region IHasCurrentSourceInfoChange Members
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the CurrentSourceInfoKey
|
||||
/// </summary>
|
||||
public string CurrentSourceInfoKey { get; set; }
|
||||
|
||||
/// <summary>
|
||||
@@ -164,6 +182,9 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
#endregion
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a BlueJeansPcFactory
|
||||
/// </summary>
|
||||
public class BlueJeansPcFactory : EssentialsDeviceFactory<BlueJeansPc>
|
||||
{
|
||||
public BlueJeansPcFactory()
|
||||
@@ -171,6 +192,10 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
TypeNames = new List<string>() { "bluejeanspc" };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// BuildDevice method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override EssentialsDevice BuildDevice(DeviceConfig dc)
|
||||
{
|
||||
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new BlueJeansPc Device");
|
||||
|
||||
@@ -8,10 +8,16 @@ using System.Linq;
|
||||
|
||||
namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a GenericSoftCodec
|
||||
/// </summary>
|
||||
public class GenericSoftCodec : EssentialsDevice, IRoutingSource, IRoutingSinkWithSwitchingWithInputPort
|
||||
{
|
||||
private RoutingInputPort _currentInputPort;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the CurrentInputPort
|
||||
/// </summary>
|
||||
public RoutingInputPort CurrentInputPort {
|
||||
get => _currentInputPort;
|
||||
set
|
||||
@@ -54,9 +60,18 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the InputPorts
|
||||
/// </summary>
|
||||
public RoutingPortCollection<RoutingInputPort> InputPorts { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the OutputPorts
|
||||
/// </summary>
|
||||
public RoutingPortCollection<RoutingOutputPort> OutputPorts { get; private set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the CurrentSourceInfoKey
|
||||
/// </summary>
|
||||
public string CurrentSourceInfoKey { get ; set; }
|
||||
public SourceListItem CurrentSourceInfo
|
||||
{
|
||||
@@ -85,6 +100,9 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
public event SourceInfoChangeHandler CurrentSourceChange;
|
||||
public event InputChangedEventHandler InputChanged;
|
||||
|
||||
/// <summary>
|
||||
/// ExecuteSwitch method
|
||||
/// </summary>
|
||||
public void ExecuteSwitch(object inputSelector)
|
||||
{
|
||||
var inputPort = InputPorts.FirstOrDefault(p => p.Selector == inputSelector);
|
||||
@@ -99,21 +117,39 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a GenericSoftCodecProperties
|
||||
/// </summary>
|
||||
public class GenericSoftCodecProperties
|
||||
{
|
||||
[JsonProperty("hasCameraInputs")]
|
||||
/// <summary>
|
||||
/// Gets or sets the HasCameraInputs
|
||||
/// </summary>
|
||||
public bool HasCameraInputs { get; set; }
|
||||
|
||||
[JsonProperty("cameraInputCount")]
|
||||
/// <summary>
|
||||
/// Gets or sets the CameraInputCount
|
||||
/// </summary>
|
||||
public int CameraInputCount { get; set; }
|
||||
|
||||
[JsonProperty("contentInputCount")]
|
||||
/// <summary>
|
||||
/// Gets or sets the ContentInputCount
|
||||
/// </summary>
|
||||
public int ContentInputCount { get; set; }
|
||||
|
||||
[JsonProperty("contentOutputCount")]
|
||||
/// <summary>
|
||||
/// Gets or sets the OutputCount
|
||||
/// </summary>
|
||||
public int OutputCount { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a GenericSoftCodecFactory
|
||||
/// </summary>
|
||||
public class GenericSoftCodecFactory: EssentialsDeviceFactory<GenericSoftCodec>
|
||||
{
|
||||
public GenericSoftCodecFactory()
|
||||
@@ -121,6 +157,10 @@ namespace PepperDash.Essentials.Devices.Common.SoftCodec
|
||||
TypeNames = new List<string> { "genericsoftcodec" };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// BuildDevice method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override EssentialsDevice BuildDevice(DeviceConfig dc)
|
||||
{
|
||||
Debug.LogMessage(LogEventLevel.Debug, "Attempting to create new Generic SoftCodec Device");
|
||||
|
||||
Reference in New Issue
Block a user