aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/FSE/Tango.FSE.Common/RemoteDesktop/IRemoteDesktopProvider.cs
blob: dda544db4484db4cecc6acd65e8993f161aa719c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Input;
using System.Windows.Media.Imaging;
using Tango.RemoteDesktop.Network;

namespace Tango.FSE.Common.RemoteDesktop
{
    /// <summary>
    /// Represents a machine PPC remote desktop provider.
    /// </summary>
    public interface IRemoteDesktopProvider
    {
        /// <summary>
        /// Occurs when a new remote desktop screen frame is available.
        /// </summary>
        event EventHandler<DesktopFrameReceivedEventArgs> FrameReceived;

        /// <summary>
        /// Gets a value indicating whether the WebRTC channel is available.
        /// </summary>
        bool IsWebRtcActive { get; }

        /// <summary>
        /// Gets or sets a value indicating whether enable the WebRTC channel.
        /// </summary>
        bool EnableWebRtc { get; set; }

        /// <summary>
        /// Gets a value indicating whether a remote desktop session is active.
        /// </summary>
        bool InSession { get; }

        /// <summary>
        /// Gets a value indicating whether a remote desktop session can be started.
        /// </summary>
        bool CanStartSession { get; }

        /// <summary>
        /// Gets or sets the mouse move send interval.
        /// </summary>
        TimeSpan MouseMoveInterval { get; set; }

        /// <summary>
        /// Starts a remote desktop session.
        /// </summary>
        /// <returns></returns>
        Task StartSession();

        /// <summary>
        /// Ends the current remote desktop session.
        /// </summary>
        /// <returns></returns>
        Task EndSession();

        /// <summary>
        /// Sends a mouse down command to the remote PPC.
        /// </summary>
        /// <param name="button">The button.</param>
        /// <param name="location">The location.</param>
        /// <param name="viewSize">Size of the view.</param>
        void MouseDown(MouseButton button, Point location, Size viewSize);

        /// <summary>
        /// Sends a mouse up command to the remote PPC.
        /// </summary>
        /// <param name="button">The button.</param>
        /// <param name="location">The location.</param>
        /// <param name="viewSize">Size of the view.</param>
        void MouseUp(MouseButton button, Point location, Size viewSize);

        /// <summary>
        /// Sends a mouse move command to the remote PPC.
        /// </summary>
        /// <param name="location">The location.</param>
        /// <param name="viewSize">Size of the view.</param>
        void MouseMove(Point location, Size viewSize);

        /// <summary>
        /// Sends a mouse double click command to the remote PPC.
        /// </summary>
        /// <param name="button">The button.</param>
        /// <param name="location">The location.</param>
        /// <param name="viewSize">Size of the view.</param>
        void MouseDoubleClick(MouseButton button, Point location, Size viewSize);

        /// <summary>
        /// Sends a key down command to the remote PPC.
        /// </summary>
        /// <param name="key">The key.</param>
        /// <param name="ctrlDown">if set to <c>true</c> [control down].</param>
        /// <param name="shitDown">if set to <c>true</c> [shit down].</param>
        /// <param name="altDown">if set to <c>true</c> [alt down].</param>
        void KeyboardDown(Key key, bool ctrlDown, bool shitDown, bool altDown);

        /// <summary>
        /// Sends a key up command to the remote PPC.
        /// </summary>
        /// <param name="key">The key.</param>
        /// <param name="ctrlDown">if set to <c>true</c> [control down].</param>
        /// <param name="shitDown">if set to <c>true</c> [shit down].</param>
        /// <param name="altDown">if set to <c>true</c> [alt down].</param>
        void KeyboardUp(Key key, bool ctrlDown, bool shitDown, bool altDown);

        /// <summary>
        /// Sends the specified predefined remote desktop command.
        /// </summary>
        /// <param name="command">The command.</param>
        void SendCommand(RemoteDesktopCommand command);
    }
}