s&box docs
API ReferenceSandbox

Streamerclass

object→Streamer
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public static abstract sealed class Sandbox.Streamer

Methods2

Showing 2 methods

public static string GetThumbnailUrl(int width, int height)PUBLICSTATIC

Thumbnail URL of the current stream.

ParameterTypeDescription
widthint—
heightint—
Returns:string—

public static System.Threading.Tasks.Task`1<Sandbox.Streamer.User> GetUser(string username = null)PUBLICSTATIC

Get user information. If no username is specified, the user returned is ourself

ParameterTypeDescription
username = nullstring—
Returns:Task<User>—

Properties13

Showing 13 properties

public static int Sandbox.Streamer.Delay { get; set; }PUBLICSTATICGETSET

Set the delay of your stream

Returns:int—

public static string Sandbox.Streamer.Game { get; set; }PUBLICSTATICGETSET

The game/category the stream is currently set to. Read-only.

Returns:string—

public static bool Sandbox.Streamer.IsActive { get; set; }PUBLICSTATICGETSET

Are we connected to a service

Returns:bool—

public static bool Sandbox.Streamer.IsMature { get; set; }PUBLICSTATICGETSET

Whether the current stream is flagged as mature.

Returns:bool—

public static string Sandbox.Streamer.Language { get; set; }PUBLICSTATICGETSET

Set the language of your stream

Returns:string—

public static System.DateTimeOffset Sandbox.Streamer.StartedAt { get; set; }PUBLICSTATICGETSET

When the current stream started. Default if you're not live.

Returns:DateTimeOffset—

public static string[] Sandbox.Streamer.Tags { get; set; }PUBLICSTATICGETSET

Tags on the current stream.

Returns:string[]—

public static string Sandbox.Streamer.Title { get; set; }PUBLICSTATICGETSET

The title of the stream. Read-only.

Returns:string—

public static string Sandbox.Streamer.UserId { get; set; }PUBLICSTATICGETSET

Your own user id

Returns:string—

public static string Sandbox.Streamer.Username { get; set; }PUBLICSTATICGETSET

Your own username

Returns:string—

public static int Sandbox.Streamer.ViewerCount { get; set; }PUBLICSTATICGETSET

Amount of concurrent viewer your stream has.

Returns:int—

public static System.Collections.Generic.IReadOnlyList`1<Sandbox.Streamer.Viewer> Sandbox.Streamer.Viewers { get; set; }PUBLICSTATICGETSET

Everyone we currently think is in chat, tracked from join, leave and message events. This is a best-effort list of active chatters, not silent viewers.

Returns:IReadOnlyList<Viewer>—

GetAll()

Previous Page

Delay

Next Page

On this page

Methodspublic static System.String GetThumbnailUrl(System.Int32 width, System.Int32 height)public static System.Threading.Tasks.Task`1<Sandbox.Streamer.User> GetUser(System.String username = null)Propertiespublic static System.Int32 Sandbox.Streamer.Delay { get; set; }public static System.String Sandbox.Streamer.Game { get; set; }public static System.Boolean Sandbox.Streamer.IsActive { get; set; }public static System.Boolean Sandbox.Streamer.IsMature { get; set; }public static System.String Sandbox.Streamer.Language { get; set; }public static Sandbox.StreamService Sandbox.Streamer.Service { get; set; }public static System.DateTimeOffset Sandbox.Streamer.StartedAt { get; set; }public static System.String[] Sandbox.Streamer.Tags { get; set; }public static System.String Sandbox.Streamer.Title { get; set; }public static System.String Sandbox.Streamer.UserId { get; set; }public static System.String Sandbox.Streamer.Username { get; set; }public static System.Int32 Sandbox.Streamer.ViewerCount { get; set; }public static System.Collections.Generic.IReadOnlyList`1<Sandbox.Streamer.Viewer> Sandbox.Streamer.Viewers { get; set; }Metadata