s&
newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
inputLog in with Steam chevron_leftChange Language
简体中文EnglishРусскийEspañolPortuguês-BrasilDeutsch日本語FrançaisPolskiTürkçe한국어PirateItalianoไทย繁體中文УкраїнськаČeštinaNederlandsMagyarDanskSuomiSvenskaNorskΕλληνικάRomânăБългарскиTiếng ViệtBahasa IndonesiaEspañol-Latinoaméricaالعربية
Api
Classes
Streamer
chevron_left Classes
class
Streamer

Static Properties

data_objectDelaydata_objectGamedata_objectIsActivedata_objectLanguagedata_objectServicedata_objectTitledata_objectUserIddata_objectUsernamedata_objectViewerCount

Static Methods

functionsBanUserfunctionsClearChatfunctionsGetUserfunctionsSendMessagefunctionsUnbanUser
Streamer
class Sandbox .
staticsealedabstractSandbox.Engine

data_object Static Properties 9

Delay
int
Set the delay of your stream
Game
string
Set the game you're playing by game id
IsActive
bool
Are we connected to a service
Language
string
Set the language of your stream
Service
StreamService
The service type (ie "Twitch")
Title
string
Set the title of your stream
UserId
string
Your own user id
Username
string
Your own username
ViewerCount
int
Amount of concurrent viewer your stream has.

functions Static Methods 5

BanUser (username, reason, duration)
Ban user from your chat by username, the user will no longer be able to chat. Optionally specify the duration, a duration of zero means perm ban (Note: You have to be in your chat for this to work)
ClearChat ()
Clear your own chat
GetUser (username)
Task`1
Get user information. If no username is specified, the user returned is ourself
SendMessage (message)
Send a message to chat, optionally specify channel you want to send the message, otherwise it is sent to your own chat
UnbanUser (username)
Unban user from your chat by username (Note: You have to be in your chat for this to work)
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.
  • News
  • Docs
  • Metrics
  • FAQ
  • Forum
  • Discord
  • Twitter