mirror of
https://github.com/ppy/osu.git
synced 2024-11-18 08:12:55 +08:00
47 lines
1.6 KiB
C#
47 lines
1.6 KiB
C#
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
#nullable disable
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
namespace osu.Game.Online.Spectator
|
|
{
|
|
/// <summary>
|
|
/// An interface defining the spectator server instance.
|
|
/// </summary>
|
|
public interface ISpectatorServer
|
|
{
|
|
/// <summary>
|
|
/// Signal the start of a new play session.
|
|
/// </summary>
|
|
/// <param name="state">The state of gameplay.</param>
|
|
Task BeginPlaySession(SpectatorState state);
|
|
|
|
/// <summary>
|
|
/// Send a bundle of frame data for the current play session.
|
|
/// </summary>
|
|
/// <param name="data">The frame data.</param>
|
|
Task SendFrameData(FrameDataBundle data);
|
|
|
|
/// <summary>
|
|
/// Signal the end of a play session.
|
|
/// </summary>
|
|
/// <param name="state">The state of gameplay.</param>
|
|
Task EndPlaySession(SpectatorState state);
|
|
|
|
/// <summary>
|
|
/// Request spectating data for the specified user. May be called on multiple users and offline users.
|
|
/// For offline users, a subscription will be created and data will begin streaming on next play.
|
|
/// </summary>
|
|
/// <param name="userId">The user to subscribe to.</param>
|
|
Task StartWatchingUser(int userId);
|
|
|
|
/// <summary>
|
|
/// Stop requesting spectating data for the specified user. Unsubscribes from receiving further data.
|
|
/// </summary>
|
|
/// <param name="userId">The user to unsubscribe from.</param>
|
|
Task EndWatchingUser(int userId);
|
|
}
|
|
}
|