mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-02-14 04:04:58 +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:
@@ -18,11 +18,20 @@ using Serilog.Events;
|
||||
namespace PepperDash.Essentials.Devices.Common
|
||||
{
|
||||
[Description("Wrapper class for an IR-Controlled AppleTV")]
|
||||
/// <summary>
|
||||
/// Represents a AppleTV
|
||||
/// </summary>
|
||||
public class AppleTV : EssentialsBridgeableDevice, IDPad, ITransport, IUiDisplayInfo, IRoutingSource, IRoutingOutputs
|
||||
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the IrPort
|
||||
/// </summary>
|
||||
public IrOutputPortController IrPort { get; private set; }
|
||||
public const string StandardDriverName = "Apple_AppleTV_4th_Gen_Essentials.ir";
|
||||
/// <summary>
|
||||
/// Gets or sets the DisplayUiType
|
||||
/// </summary>
|
||||
public uint DisplayUiType { get { return DisplayUiConstants.TypeAppleTv; } }
|
||||
|
||||
public AppleTV(string key, string name, IrOutputPortController portCont)
|
||||
@@ -40,6 +49,9 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
PrintExpectedIrCommands();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// PrintExpectedIrCommands method
|
||||
/// </summary>
|
||||
public void PrintExpectedIrCommands()
|
||||
{
|
||||
var cmds = typeof (AppleTvIrCommands).GetFields(BindingFlags.Public | BindingFlags.Static);
|
||||
@@ -52,36 +64,57 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
|
||||
#region IDPad Members
|
||||
|
||||
/// <summary>
|
||||
/// Up method
|
||||
/// </summary>
|
||||
public void Up(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.Up, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Down method
|
||||
/// </summary>
|
||||
public void Down(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.Down, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Left method
|
||||
/// </summary>
|
||||
public void Left(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.Left, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Right method
|
||||
/// </summary>
|
||||
public void Right(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.Right, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Select method
|
||||
/// </summary>
|
||||
public void Select(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.Enter, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Menu method
|
||||
/// </summary>
|
||||
public void Menu(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.Menu, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Exit method
|
||||
/// </summary>
|
||||
public void Exit(bool pressRelease)
|
||||
{
|
||||
|
||||
@@ -91,11 +124,17 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
|
||||
#region ITransport Members
|
||||
|
||||
/// <summary>
|
||||
/// Play method
|
||||
/// </summary>
|
||||
public void Play(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.PlayPause, pressRelease);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Pause method
|
||||
/// </summary>
|
||||
public void Pause(bool pressRelease)
|
||||
{
|
||||
IrPort.PressRelease(AppleTvIrCommands.PlayPause, pressRelease);
|
||||
@@ -105,6 +144,9 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
/// Not implemented
|
||||
/// </summary>
|
||||
/// <param name="pressRelease"></param>
|
||||
/// <summary>
|
||||
/// Rewind method
|
||||
/// </summary>
|
||||
public void Rewind(bool pressRelease)
|
||||
{
|
||||
}
|
||||
@@ -155,10 +197,16 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
|
||||
public RoutingOutputPort HdmiOut { get; private set; }
|
||||
public RoutingOutputPort AnyAudioOut { get; private set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the OutputPorts
|
||||
/// </summary>
|
||||
public RoutingPortCollection<RoutingOutputPort> OutputPorts { get; private set; }
|
||||
|
||||
#endregion
|
||||
|
||||
/// <summary>
|
||||
/// LinkToApi method
|
||||
/// </summary>
|
||||
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
|
||||
{
|
||||
var joinMap = new AppleTvJoinMap(joinStart);
|
||||
@@ -190,6 +238,9 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a AppleTVFactory
|
||||
/// </summary>
|
||||
public class AppleTVFactory : EssentialsDeviceFactory<AppleTV>
|
||||
{
|
||||
public AppleTVFactory()
|
||||
@@ -197,6 +248,10 @@ namespace PepperDash.Essentials.Devices.Common
|
||||
TypeNames = new List<string>() { "appletv" };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// BuildDevice method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override EssentialsDevice BuildDevice(DeviceConfig dc)
|
||||
{
|
||||
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new AppleTV Device");
|
||||
|
||||
Reference in New Issue
Block a user