jellyfin-server/MediaBrowser.Controller/Session/ISessionController.cs

125 lines
5.1 KiB
C#
Raw Normal View History

2013-10-03 01:22:50 +00:00
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Session;
2014-05-18 19:58:42 +00:00
using MediaBrowser.Model.System;
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Session
{
2013-10-02 19:08:58 +00:00
public interface ISessionController
{
2013-10-03 01:22:50 +00:00
/// <summary>
/// Gets a value indicating whether this instance is session active.
/// </summary>
/// <value><c>true</c> if this instance is session active; otherwise, <c>false</c>.</value>
bool IsSessionActive { get; }
2014-05-17 18:37:40 +00:00
/// <summary>
/// Gets a value indicating whether [supports media remote control].
/// </summary>
/// <value><c>true</c> if [supports media remote control]; otherwise, <c>false</c>.</value>
bool SupportsMediaControl { get; }
/// <summary>
/// Sends the play command.
/// </summary>
/// <param name="command">The command.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2013-10-03 01:22:50 +00:00
Task SendPlayCommand(PlayRequest command, CancellationToken cancellationToken);
/// <summary>
/// Sends the playstate command.
/// </summary>
/// <param name="command">The command.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2013-10-03 01:22:50 +00:00
Task SendPlaystateCommand(PlaystateRequest command, CancellationToken cancellationToken);
2014-03-28 19:58:18 +00:00
/// <summary>
/// Sends the generic command.
/// </summary>
/// <param name="command">The command.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-03-31 21:04:22 +00:00
Task SendGeneralCommand(GeneralCommand command, CancellationToken cancellationToken);
2014-03-28 19:58:18 +00:00
2013-10-03 01:22:50 +00:00
/// <summary>
/// Sends the library update info.
/// </summary>
/// <param name="info">The info.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendLibraryUpdateInfo(LibraryUpdateInfo info, CancellationToken cancellationToken);
/// <summary>
/// Sends the restart required message.
/// </summary>
2014-05-18 19:58:42 +00:00
/// <param name="info">The information.</param>
2013-10-03 01:22:50 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-05-18 19:58:42 +00:00
Task SendRestartRequiredNotification(SystemInfo info, CancellationToken cancellationToken);
/// <summary>
/// Sends the user data change info.
/// </summary>
/// <param name="info">The info.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendUserDataChangeInfo(UserDataChangeInfo info, CancellationToken cancellationToken);
/// <summary>
/// Sends the server shutdown notification.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendServerShutdownNotification(CancellationToken cancellationToken);
2014-04-06 17:53:23 +00:00
/// <summary>
/// Sends the session ended notification.
/// </summary>
/// <param name="sessionInfo">The session information.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendSessionEndedNotification(SessionInfoDto sessionInfo, CancellationToken cancellationToken);
/// <summary>
/// Sends the playback start notification.
/// </summary>
/// <param name="sessionInfo">The session information.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendPlaybackStartNotification(SessionInfoDto sessionInfo, CancellationToken cancellationToken);
/// <summary>
/// Sends the playback start notification.
/// </summary>
/// <param name="sessionInfo">The session information.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendPlaybackStoppedNotification(SessionInfoDto sessionInfo, CancellationToken cancellationToken);
2014-04-06 17:53:23 +00:00
/// <summary>
/// Sends the server restart notification.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendServerRestartNotification(CancellationToken cancellationToken);
/// <summary>
/// Sends the message.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="name">The name.</param>
/// <param name="data">The data.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendMessage<T>(string name, T data, CancellationToken cancellationToken);
2015-03-21 16:10:02 +00:00
/// <summary>
/// Called when [activity].
/// </summary>
void OnActivity();
}
}