Streamer.bot Scripting API
Official Scripting API Reference
Loading...
Searching...
No Matches
FaustBot.CPH Class Reference

CPH (C# Plugin Host) - Main interface for C# scripts. More...

Static Public Member Functions

static void LogInfo (string message)
static void LogWarn (string message)
static void LogError (string message)
static void LogDebug (string message)
static void LogVerbose (string message)
static void SendMessage (string message, bool useBot=true)
static void SendAction (string action, bool useBot=true)
static bool SendWhisper (string userName, string message)
static void SetGlobalVar (string name, object value, bool persisted=true)
static object GetGlobalVar (string name, bool persisted=true)
static void UnsetGlobalVar (string name, bool persisted=true)
static T GetGlobalVar< T > (string name, bool persisted=true)
static void SetArgument (string name, object value)
static bool TryGetArg (string name, out object value)
static T GetArg< T > (string name)
static bool TryGetArg< T > (string name, out T value)
static bool RunAction (string actionName, bool runImmediately=true)
static bool RunActionById (string actionId, bool runImmediately=true)
static void Wait (int milliseconds)
static int Between (int min, int max)
static double NextDouble ()
static bool ObsIsConnected ()
static bool ObsIsStreaming ()
static bool ObsIsRecording ()
static void ObsSetCurrentScene (string sceneName)
static string ObsGetCurrentScene ()
static void ObsSetSourceVisibility (string scene, string source, bool visible)
static void ObsShowSource (string scene, string source)
static void ObsHideSource (string scene, string source)
static void ObsSetMediaSourceFile (string scene, string source, string file)
static void PlaySound (string filePath, float volume=1.0f, bool finishBeforeContinuing=false)
static string HttpGet (string url)
 Perform an HTTP GET request and return the response body.
static string HttpPost (string url, string body, string contentType="application/json")
 Perform an HTTP POST request.
static string HttpPut (string url, string body, string contentType="application/json")
 Perform an HTTP PUT request.
static string HttpDelete (string url)
 Perform an HTTP DELETE request.
static bool HttpDownload (string url, string savePath)
 Download a file from a URL.
static string GetUrlContent (string url)
 Get URL content.
static bool PostToUrl (string url, string body, string contentType="application/json")
 Post to a URL.
static string FileReadAllText (string path)
 Read all text from a file.
static string[] FileReadAllLines (string path)
 Read all lines from a file.
static bool FileWriteAllText (string path, string content)
 Write text to a file (overwrites existing content).
static bool FileAppendAllText (string path, string content)
 Append text to a file.
static bool FileExists (string path)
 Check if a file exists.
static bool FileDelete (string path)
 Delete a file.
static bool FileCopy (string source, string dest, bool overwrite=false)
 Copy a file.
static bool FileMove (string source, string dest)
 Move/rename a file.
static bool DirectoryExists (string path)
 Check if a directory exists.
static bool DirectoryCreate (string path)
 Create a directory.
static bool DirectoryDelete (string path, bool recursive=false)
 Delete a directory.
static string[] DirectoryGetFiles (string path, string pattern="*")
 Get files in a directory.
static string[] DirectoryGetDirectories (string path)
 Get subdirectories in a directory.
static string GetDataPath ()
 Get the data directory path.
static string GetScriptsPath ()
 Get the scripts directory path.
static bool TwitchIsConnected ()
static string TwitchGetBroadcasterId ()
static string TwitchGetBroadcasterName ()
static bool SendTwitchMessage (string message, string replyToId=null)
static void TwitchAnnounce (string message, string color="primary")
static bool TwitchSendWhisper (string userId, string message)
static bool TwitchDeleteMessage (string messageId)
static bool TwitchClearChat ()
static bool TwitchBanUser (string userId, string reason=null)
static bool TwitchUnbanUser (string userId)
static bool TwitchTimeoutUser (string userId, int seconds, string reason=null)
static bool TwitchAddModerator (string userId)
static bool TwitchRemoveModerator (string userId)
static bool TwitchAddVip (string userId)
static bool TwitchRemoveVip (string userId)
static string TwitchGetUserInfoById (string userId)
static string TwitchGetUserInfoByLogin (string username)
static string TwitchGetExtendedUserInfoById (string userId)
static string TwitchGetExtendedUserInfoByLogin (string username)
static bool TwitchIsUserFollowing (string userId)
static bool TwitchSetTitle (string title)
static bool TwitchSetGame (string gameNameOrId)
static string TwitchGetChannelInfo ()
static string TwitchGetGameIdByName (string gameName)
static string TwitchPollCreate (string title, string[] choices, int durationSeconds=60)
static bool TwitchPollTerminate (string pollId)
static bool TwitchPollArchive (string pollId)
static string TwitchGetPolls ()
static string TwitchPredictionCreate (string title, string[] outcomes, int windowSeconds=60)
static bool TwitchPredictionLock (string predictionId)
static bool TwitchPredictionResolve (string predictionId, string winningOutcomeId)
static bool TwitchPredictionCancel (string predictionId)
static string TwitchGetPredictions ()
static string TwitchGetRewards ()
static bool TwitchCreateReward (string title, int cost, string optionsJson=null)
static bool TwitchUpdateReward (string rewardId, string updatesJson)
static bool TwitchDeleteReward (string rewardId)
static bool TwitchEnableReward (string rewardId)
static bool TwitchDisableReward (string rewardId)
static bool TwitchPauseReward (string rewardId)
static bool TwitchUnpauseReward (string rewardId)
static bool TwitchFulfillRedemption (string rewardId, string redemptionId)
static bool TwitchCancelRedemption (string rewardId, string redemptionId)
static int TwitchGetRewardCounter (string rewardId)
static int TwitchGetRewardUserCounter (string rewardId, string username)
static int TwitchGetRewardUserCounterById (string rewardId, string userId)
static bool TwitchResetRewardCounter (string rewardId)
static bool TwitchResetUserRewardCounter (string rewardId, string username)
static bool TwitchRewardGroupEnable (string groupName)
static bool TwitchRewardGroupDisable (string groupName)
static bool TwitchRewardGroupPause (string groupName)
static bool TwitchRewardGroupUnpause (string groupName)
static bool TwitchRewardGroupToggleEnable (string groupName)
static bool TwitchRewardGroupTogglePause (string groupName)
static bool TwitchUpdateRewardTitle (string rewardId, string title)
static bool TwitchUpdateRewardPrompt (string rewardId, string prompt)
static bool TwitchUpdateRewardCost (string rewardId, int cost)
static bool TwitchUpdateRewardBackgroundColor (string rewardId, string color)
static bool TwitchUpdateRewardCooldown (string rewardId, int seconds)
static string TwitchCreateClip (bool hasDelay=false)
static string TwitchCreateMarker (string description=null)
static string TwitchGetClips ()
static bool TwitchStartRaid (string toChannelId)
static bool TwitchCancelRaid ()
static bool TwitchStartCommercial (int lengthSeconds=30)
static string TwitchGetAdSchedule ()
static string TwitchGetChatSettings ()
static bool TwitchSetEmoteOnlyMode (bool enabled)
static bool TwitchSetFollowerOnlyMode (bool enabled, int durationMinutes=0)
static bool TwitchSetSubscriberOnlyMode (bool enabled)
static bool TwitchSetSlowMode (bool enabled, int waitTimeSeconds=30)
static bool TwitchSendShoutout (string toUserId)
static bool TwitchSendShoutoutByLogin (string toUserLogin)
static bool TwitchBlockUser (string userId)
static bool TwitchBlockUserByName (string username)
static bool TwitchUnblockUser (string userId)
static bool TwitchUnblockUserByName (string username)
static bool TwitchAddChannelTag (string tag)
static bool TwitchRemoveChannelTag (string tag)
static bool TwitchSetChannelTags (string[] tags)
static bool TwitchClearChannelTags ()
static string[] TwitchGetChannelTags ()
static bool TwitchShieldModeOn ()
static bool TwitchShieldModeOff ()
static bool TwitchIsShieldModeActive ()
static long TwitchGetBitsDonatedByUserId (string userId)
static long TwitchGetChannelPointsUsedByUserId (string userId)
static string TwitchGetUserVar (string username, string varName, string defaultValue=null)
static string TwitchGetUserVarById (string userId, string varName, string defaultValue=null)
static bool TwitchSetUserVar (string username, string varName, string value, bool persist=false)
static bool TwitchSetUserVarById (string userId, string varName, string value, bool persist=false)
static bool TwitchUnsetUserVar (string username, string varName)
static bool TwitchUnsetUserVarById (string userId, string varName)
static bool TwitchUnsetUser (string username)
static bool TwitchUnsetUserById (string userId)
static bool YouTubeIsConnected ()
static string YouTubeGetChannelId ()
static string YouTubeGetChannelName ()
static bool SendYouTubeMessage (string message)
static bool SendYouTubeMessageToLatestMonitored (string message)
static bool YouTubeDeleteMessage (string messageId)
static bool YouTubeBanUser (string userId)
static bool YouTubeBanUserByName (string username)
static bool YouTubeUnbanUser (string banId)
static bool YouTubeTimeoutUser (string userId, int seconds)
static bool YouTubeTimeoutUserByName (string username, int seconds)
static bool YouTubeSetTitle (string title)
static bool YouTubeSetDescription (string description)
static bool YouTubeSetCategory (string categoryId)
static bool YouTubeSetPrivacy (string privacy)
static bool YouTubeSetMetaData (string title, string description, string categoryId)
static int YouTubeGetViewerCount ()
static string YouTubeGetUserVar (string username, string varName, string defaultValue=null)
static string YouTubeGetUserVarById (string userId, string varName, string defaultValue=null)
static bool YouTubeSetUserVar (string username, string varName, string value, bool persist=false)
static bool YouTubeSetUserVarById (string userId, string varName, string value, bool persist=false)
static bool YouTubeUnsetUserVar (string username, string varName)
static bool YouTubeUnsetUserVarById (string userId, string varName)
static bool YouTubeUnsetUser (string username)
static bool YouTubeUnsetUserById (string userId)
static string ObsSendRaw (string requestType, string requestDataJson)
static bool ObsTakeScreenshot (string sourceName=null, string filePath=null)
static bool ObsSetBrowserSource (string sourceName, string url)
static string ObsGetScenes ()
static string ObsGetSources (string sceneName=null)
static bool ObsShowFilter (string sourceName, string filterName)
static bool ObsHideFilter (string sourceName, string filterName)
static bool ObsToggleFilter (string sourceName, string filterName)
static bool ObsSetSourceFilterEnabled (string sourceName, string filterName, bool enabled)
static bool ObsIsFilterEnabled (string sourceName, string filterName)
static bool ObsSourceMute (string sourceName)
static bool ObsSourceUnMute (string sourceName)
static bool ObsSourceMuteToggle (string sourceName)
static bool ObsSetSourceMuteState (string sourceName, int state)
static bool ObsSetVolume (string sourceName, double volume)
static bool ObsStartRecording ()
static bool ObsStopRecording ()
static bool ObsPauseRecording ()
static bool ObsResumeRecording ()
static bool ObsStartStreaming ()
static bool ObsStopStreaming ()
static bool ObsStartReplayBuffer ()
static bool ObsStopReplayBuffer ()
static bool ObsSaveReplayBuffer ()
static bool ObsSetTextSource (string sourceName, string text)
static bool ObsSetGdiText (string sourceName, string text)
static bool ObsSetImageSource (string sourceName, string filePath)
static bool ObsSetMediaSource (string sourceName, string filePath, bool autoPlay=true)
static bool ObsMediaPlay (string sourceName)
static bool ObsMediaPause (string sourceName)
static bool ObsMediaStop (string sourceName)
static bool ObsMediaRestart (string sourceName)
static bool ObsMediaNext (string sourceName)
static bool ObsMediaPrevious (string sourceName)
static bool ObsHideGroupsSources (string sceneName, string groupName)
static bool ObsSetRandomGroupSourceVisible (string sceneName, string groupName)
static string ObsGetGroupSources (string sceneName, string groupName)
static bool ObsSetColorSourceColor (string sourceName, string hexColor)
static bool ObsSetColorSourceRandomColor (string sourceName)
static void SetUserVar (string userName, string name, object value, bool persisted=true)
static T GetUserVar< T > (string userName, string name, bool persisted=true)
static void UnsetUserVar (string userName, string name, bool persisted=true)

Detailed Description

CPH (C# Plugin Host) - Main interface for C# scripts.

Provides access to chat, OBS, Twitch, actions, variables, and more.

Usage in scripts: public class CPHInline { public bool Execute() { CPH.LogInfo("Hello from C#!"); return true; } }

Member Function Documentation

◆ Between()

int FaustBot.CPH.Between ( int min,
int max )
static

◆ DirectoryCreate()

bool FaustBot.CPH.DirectoryCreate ( string path)
static

Create a directory.

◆ DirectoryDelete()

bool FaustBot.CPH.DirectoryDelete ( string path,
bool recursive = false )
static

Delete a directory.

◆ DirectoryExists()

bool FaustBot.CPH.DirectoryExists ( string path)
static

Check if a directory exists.

◆ DirectoryGetDirectories()

string[] FaustBot.CPH.DirectoryGetDirectories ( string path)
static

Get subdirectories in a directory.

◆ DirectoryGetFiles()

string[] FaustBot.CPH.DirectoryGetFiles ( string path,
string pattern = "*" )
static

Get files in a directory.

◆ FileAppendAllText()

bool FaustBot.CPH.FileAppendAllText ( string path,
string content )
static

Append text to a file.

◆ FileCopy()

bool FaustBot.CPH.FileCopy ( string source,
string dest,
bool overwrite = false )
static

Copy a file.

◆ FileDelete()

bool FaustBot.CPH.FileDelete ( string path)
static

Delete a file.

◆ FileExists()

bool FaustBot.CPH.FileExists ( string path)
static

Check if a file exists.

◆ FileMove()

bool FaustBot.CPH.FileMove ( string source,
string dest )
static

Move/rename a file.

◆ FileReadAllLines()

string[] FaustBot.CPH.FileReadAllLines ( string path)
static

Read all lines from a file.

◆ FileReadAllText()

string FaustBot.CPH.FileReadAllText ( string path)
static

Read all text from a file.

◆ FileWriteAllText()

bool FaustBot.CPH.FileWriteAllText ( string path,
string content )
static

Write text to a file (overwrites existing content).

◆ GetArg< T >()

T FaustBot.CPH.GetArg< T > ( string name)
inlinestatic

◆ GetDataPath()

string FaustBot.CPH.GetDataPath ( )
static

Get the data directory path.

◆ GetGlobalVar()

object FaustBot.CPH.GetGlobalVar ( string name,
bool persisted = true )
static

◆ GetGlobalVar< T >()

T FaustBot.CPH.GetGlobalVar< T > ( string name,
bool persisted = true )
inlinestatic

◆ GetScriptsPath()

string FaustBot.CPH.GetScriptsPath ( )
static

Get the scripts directory path.

◆ GetUrlContent()

string FaustBot.CPH.GetUrlContent ( string url)
static

Get URL content.

◆ GetUserVar< T >()

T FaustBot.CPH.GetUserVar< T > ( string userName,
string name,
bool persisted = true )
inlinestatic

◆ HttpDelete()

string FaustBot.CPH.HttpDelete ( string url)
static

Perform an HTTP DELETE request.

◆ HttpDownload()

bool FaustBot.CPH.HttpDownload ( string url,
string savePath )
static

Download a file from a URL.

◆ HttpGet()

string FaustBot.CPH.HttpGet ( string url)
static

Perform an HTTP GET request and return the response body.

◆ HttpPost()

string FaustBot.CPH.HttpPost ( string url,
string body,
string contentType = "application/json" )
static

Perform an HTTP POST request.

◆ HttpPut()

string FaustBot.CPH.HttpPut ( string url,
string body,
string contentType = "application/json" )
static

Perform an HTTP PUT request.

◆ LogDebug()

void FaustBot.CPH.LogDebug ( string message)
static

◆ LogError()

void FaustBot.CPH.LogError ( string message)
static

◆ LogInfo()

void FaustBot.CPH.LogInfo ( string message)
static

◆ LogVerbose()

void FaustBot.CPH.LogVerbose ( string message)
static

◆ LogWarn()

void FaustBot.CPH.LogWarn ( string message)
static

◆ NextDouble()

double FaustBot.CPH.NextDouble ( )
static

◆ ObsGetCurrentScene()

string FaustBot.CPH.ObsGetCurrentScene ( )
static

◆ ObsGetGroupSources()

string FaustBot.CPH.ObsGetGroupSources ( string sceneName,
string groupName )
static

◆ ObsGetScenes()

string FaustBot.CPH.ObsGetScenes ( )
static

◆ ObsGetSources()

string FaustBot.CPH.ObsGetSources ( string sceneName = null)
static

◆ ObsHideFilter()

bool FaustBot.CPH.ObsHideFilter ( string sourceName,
string filterName )
static

◆ ObsHideGroupsSources()

bool FaustBot.CPH.ObsHideGroupsSources ( string sceneName,
string groupName )
static

◆ ObsHideSource()

void FaustBot.CPH.ObsHideSource ( string scene,
string source )
static

◆ ObsIsConnected()

bool FaustBot.CPH.ObsIsConnected ( )
static

◆ ObsIsFilterEnabled()

bool FaustBot.CPH.ObsIsFilterEnabled ( string sourceName,
string filterName )
static

◆ ObsIsRecording()

bool FaustBot.CPH.ObsIsRecording ( )
static

◆ ObsIsStreaming()

bool FaustBot.CPH.ObsIsStreaming ( )
static

◆ ObsMediaNext()

bool FaustBot.CPH.ObsMediaNext ( string sourceName)
static

◆ ObsMediaPause()

bool FaustBot.CPH.ObsMediaPause ( string sourceName)
static

◆ ObsMediaPlay()

bool FaustBot.CPH.ObsMediaPlay ( string sourceName)
static

◆ ObsMediaPrevious()

bool FaustBot.CPH.ObsMediaPrevious ( string sourceName)
static

◆ ObsMediaRestart()

bool FaustBot.CPH.ObsMediaRestart ( string sourceName)
static

◆ ObsMediaStop()

bool FaustBot.CPH.ObsMediaStop ( string sourceName)
static

◆ ObsPauseRecording()

bool FaustBot.CPH.ObsPauseRecording ( )
static

◆ ObsResumeRecording()

bool FaustBot.CPH.ObsResumeRecording ( )
static

◆ ObsSaveReplayBuffer()

bool FaustBot.CPH.ObsSaveReplayBuffer ( )
static

◆ ObsSendRaw()

string FaustBot.CPH.ObsSendRaw ( string requestType,
string requestDataJson )
static

◆ ObsSetBrowserSource()

bool FaustBot.CPH.ObsSetBrowserSource ( string sourceName,
string url )
static

◆ ObsSetColorSourceColor()

bool FaustBot.CPH.ObsSetColorSourceColor ( string sourceName,
string hexColor )
static

◆ ObsSetColorSourceRandomColor()

bool FaustBot.CPH.ObsSetColorSourceRandomColor ( string sourceName)
static

◆ ObsSetCurrentScene()

void FaustBot.CPH.ObsSetCurrentScene ( string sceneName)
static

◆ ObsSetGdiText()

bool FaustBot.CPH.ObsSetGdiText ( string sourceName,
string text )
static

◆ ObsSetImageSource()

bool FaustBot.CPH.ObsSetImageSource ( string sourceName,
string filePath )
static

◆ ObsSetMediaSource()

bool FaustBot.CPH.ObsSetMediaSource ( string sourceName,
string filePath,
bool autoPlay = true )
static

◆ ObsSetMediaSourceFile()

void FaustBot.CPH.ObsSetMediaSourceFile ( string scene,
string source,
string file )
static

◆ ObsSetRandomGroupSourceVisible()

bool FaustBot.CPH.ObsSetRandomGroupSourceVisible ( string sceneName,
string groupName )
static

◆ ObsSetSourceFilterEnabled()

bool FaustBot.CPH.ObsSetSourceFilterEnabled ( string sourceName,
string filterName,
bool enabled )
static

◆ ObsSetSourceMuteState()

bool FaustBot.CPH.ObsSetSourceMuteState ( string sourceName,
int state )
static

◆ ObsSetSourceVisibility()

void FaustBot.CPH.ObsSetSourceVisibility ( string scene,
string source,
bool visible )
static

◆ ObsSetTextSource()

bool FaustBot.CPH.ObsSetTextSource ( string sourceName,
string text )
static

◆ ObsSetVolume()

bool FaustBot.CPH.ObsSetVolume ( string sourceName,
double volume )
static

◆ ObsShowFilter()

bool FaustBot.CPH.ObsShowFilter ( string sourceName,
string filterName )
static

◆ ObsShowSource()

void FaustBot.CPH.ObsShowSource ( string scene,
string source )
static

◆ ObsSourceMute()

bool FaustBot.CPH.ObsSourceMute ( string sourceName)
static

◆ ObsSourceMuteToggle()

bool FaustBot.CPH.ObsSourceMuteToggle ( string sourceName)
static

◆ ObsSourceUnMute()

bool FaustBot.CPH.ObsSourceUnMute ( string sourceName)
static

◆ ObsStartRecording()

bool FaustBot.CPH.ObsStartRecording ( )
static

◆ ObsStartReplayBuffer()

bool FaustBot.CPH.ObsStartReplayBuffer ( )
static

◆ ObsStartStreaming()

bool FaustBot.CPH.ObsStartStreaming ( )
static

◆ ObsStopRecording()

bool FaustBot.CPH.ObsStopRecording ( )
static

◆ ObsStopReplayBuffer()

bool FaustBot.CPH.ObsStopReplayBuffer ( )
static

◆ ObsStopStreaming()

bool FaustBot.CPH.ObsStopStreaming ( )
static

◆ ObsTakeScreenshot()

bool FaustBot.CPH.ObsTakeScreenshot ( string sourceName = null,
string filePath = null )
static

◆ ObsToggleFilter()

bool FaustBot.CPH.ObsToggleFilter ( string sourceName,
string filterName )
static

◆ PlaySound()

void FaustBot.CPH.PlaySound ( string filePath,
float volume = 1.0f,
bool finishBeforeContinuing = false )
static

◆ PostToUrl()

bool FaustBot.CPH.PostToUrl ( string url,
string body,
string contentType = "application/json" )
static

Post to a URL.

◆ RunAction()

bool FaustBot.CPH.RunAction ( string actionName,
bool runImmediately = true )
static

◆ RunActionById()

bool FaustBot.CPH.RunActionById ( string actionId,
bool runImmediately = true )
static

◆ SendAction()

void FaustBot.CPH.SendAction ( string action,
bool useBot = true )
static

◆ SendMessage()

void FaustBot.CPH.SendMessage ( string message,
bool useBot = true )
static

◆ SendTwitchMessage()

bool FaustBot.CPH.SendTwitchMessage ( string message,
string replyToId = null )
static

◆ SendWhisper()

bool FaustBot.CPH.SendWhisper ( string userName,
string message )
static

◆ SendYouTubeMessage()

bool FaustBot.CPH.SendYouTubeMessage ( string message)
static

◆ SendYouTubeMessageToLatestMonitored()

bool FaustBot.CPH.SendYouTubeMessageToLatestMonitored ( string message)
static

◆ SetArgument()

void FaustBot.CPH.SetArgument ( string name,
object value )
static

◆ SetGlobalVar()

void FaustBot.CPH.SetGlobalVar ( string name,
object value,
bool persisted = true )
static

◆ SetUserVar()

void FaustBot.CPH.SetUserVar ( string userName,
string name,
object value,
bool persisted = true )
inlinestatic

◆ TryGetArg()

bool FaustBot.CPH.TryGetArg ( string name,
out object value )
static

◆ TryGetArg< T >()

bool FaustBot.CPH.TryGetArg< T > ( string name,
out T value )
inlinestatic

◆ TwitchAddChannelTag()

bool FaustBot.CPH.TwitchAddChannelTag ( string tag)
static

◆ TwitchAddModerator()

bool FaustBot.CPH.TwitchAddModerator ( string userId)
static

◆ TwitchAddVip()

bool FaustBot.CPH.TwitchAddVip ( string userId)
static

◆ TwitchAnnounce()

void FaustBot.CPH.TwitchAnnounce ( string message,
string color = "primary" )
static

◆ TwitchBanUser()

bool FaustBot.CPH.TwitchBanUser ( string userId,
string reason = null )
static

◆ TwitchBlockUser()

bool FaustBot.CPH.TwitchBlockUser ( string userId)
static

◆ TwitchBlockUserByName()

bool FaustBot.CPH.TwitchBlockUserByName ( string username)
static

◆ TwitchCancelRaid()

bool FaustBot.CPH.TwitchCancelRaid ( )
static

◆ TwitchCancelRedemption()

bool FaustBot.CPH.TwitchCancelRedemption ( string rewardId,
string redemptionId )
static

◆ TwitchClearChannelTags()

bool FaustBot.CPH.TwitchClearChannelTags ( )
static

◆ TwitchClearChat()

bool FaustBot.CPH.TwitchClearChat ( )
static

◆ TwitchCreateClip()

string FaustBot.CPH.TwitchCreateClip ( bool hasDelay = false)
static

◆ TwitchCreateMarker()

string FaustBot.CPH.TwitchCreateMarker ( string description = null)
static

◆ TwitchCreateReward()

bool FaustBot.CPH.TwitchCreateReward ( string title,
int cost,
string optionsJson = null )
static

◆ TwitchDeleteMessage()

bool FaustBot.CPH.TwitchDeleteMessage ( string messageId)
static

◆ TwitchDeleteReward()

bool FaustBot.CPH.TwitchDeleteReward ( string rewardId)
static

◆ TwitchDisableReward()

bool FaustBot.CPH.TwitchDisableReward ( string rewardId)
static

◆ TwitchEnableReward()

bool FaustBot.CPH.TwitchEnableReward ( string rewardId)
static

◆ TwitchFulfillRedemption()

bool FaustBot.CPH.TwitchFulfillRedemption ( string rewardId,
string redemptionId )
static

◆ TwitchGetAdSchedule()

string FaustBot.CPH.TwitchGetAdSchedule ( )
static

◆ TwitchGetBitsDonatedByUserId()

long FaustBot.CPH.TwitchGetBitsDonatedByUserId ( string userId)
static

◆ TwitchGetBroadcasterId()

string FaustBot.CPH.TwitchGetBroadcasterId ( )
static

◆ TwitchGetBroadcasterName()

string FaustBot.CPH.TwitchGetBroadcasterName ( )
static

◆ TwitchGetChannelInfo()

string FaustBot.CPH.TwitchGetChannelInfo ( )
static

◆ TwitchGetChannelPointsUsedByUserId()

long FaustBot.CPH.TwitchGetChannelPointsUsedByUserId ( string userId)
static

◆ TwitchGetChannelTags()

string[] FaustBot.CPH.TwitchGetChannelTags ( )
static

◆ TwitchGetChatSettings()

string FaustBot.CPH.TwitchGetChatSettings ( )
static

◆ TwitchGetClips()

string FaustBot.CPH.TwitchGetClips ( )
static

◆ TwitchGetExtendedUserInfoById()

string FaustBot.CPH.TwitchGetExtendedUserInfoById ( string userId)
static

◆ TwitchGetExtendedUserInfoByLogin()

string FaustBot.CPH.TwitchGetExtendedUserInfoByLogin ( string username)
static

◆ TwitchGetGameIdByName()

string FaustBot.CPH.TwitchGetGameIdByName ( string gameName)
static

◆ TwitchGetPolls()

string FaustBot.CPH.TwitchGetPolls ( )
static

◆ TwitchGetPredictions()

string FaustBot.CPH.TwitchGetPredictions ( )
static

◆ TwitchGetRewardCounter()

int FaustBot.CPH.TwitchGetRewardCounter ( string rewardId)
static

◆ TwitchGetRewards()

string FaustBot.CPH.TwitchGetRewards ( )
static

◆ TwitchGetRewardUserCounter()

int FaustBot.CPH.TwitchGetRewardUserCounter ( string rewardId,
string username )
static

◆ TwitchGetRewardUserCounterById()

int FaustBot.CPH.TwitchGetRewardUserCounterById ( string rewardId,
string userId )
static

◆ TwitchGetUserInfoById()

string FaustBot.CPH.TwitchGetUserInfoById ( string userId)
static

◆ TwitchGetUserInfoByLogin()

string FaustBot.CPH.TwitchGetUserInfoByLogin ( string username)
static

◆ TwitchGetUserVar()

string FaustBot.CPH.TwitchGetUserVar ( string username,
string varName,
string defaultValue = null )
static

◆ TwitchGetUserVarById()

string FaustBot.CPH.TwitchGetUserVarById ( string userId,
string varName,
string defaultValue = null )
static

◆ TwitchIsConnected()

bool FaustBot.CPH.TwitchIsConnected ( )
static

◆ TwitchIsShieldModeActive()

bool FaustBot.CPH.TwitchIsShieldModeActive ( )
static

◆ TwitchIsUserFollowing()

bool FaustBot.CPH.TwitchIsUserFollowing ( string userId)
static

◆ TwitchPauseReward()

bool FaustBot.CPH.TwitchPauseReward ( string rewardId)
static

◆ TwitchPollArchive()

bool FaustBot.CPH.TwitchPollArchive ( string pollId)
static

◆ TwitchPollCreate()

string FaustBot.CPH.TwitchPollCreate ( string title,
string[] choices,
int durationSeconds = 60 )
static

◆ TwitchPollTerminate()

bool FaustBot.CPH.TwitchPollTerminate ( string pollId)
static

◆ TwitchPredictionCancel()

bool FaustBot.CPH.TwitchPredictionCancel ( string predictionId)
static

◆ TwitchPredictionCreate()

string FaustBot.CPH.TwitchPredictionCreate ( string title,
string[] outcomes,
int windowSeconds = 60 )
static

◆ TwitchPredictionLock()

bool FaustBot.CPH.TwitchPredictionLock ( string predictionId)
static

◆ TwitchPredictionResolve()

bool FaustBot.CPH.TwitchPredictionResolve ( string predictionId,
string winningOutcomeId )
static

◆ TwitchRemoveChannelTag()

bool FaustBot.CPH.TwitchRemoveChannelTag ( string tag)
static

◆ TwitchRemoveModerator()

bool FaustBot.CPH.TwitchRemoveModerator ( string userId)
static

◆ TwitchRemoveVip()

bool FaustBot.CPH.TwitchRemoveVip ( string userId)
static

◆ TwitchResetRewardCounter()

bool FaustBot.CPH.TwitchResetRewardCounter ( string rewardId)
static

◆ TwitchResetUserRewardCounter()

bool FaustBot.CPH.TwitchResetUserRewardCounter ( string rewardId,
string username )
static

◆ TwitchRewardGroupDisable()

bool FaustBot.CPH.TwitchRewardGroupDisable ( string groupName)
static

◆ TwitchRewardGroupEnable()

bool FaustBot.CPH.TwitchRewardGroupEnable ( string groupName)
static

◆ TwitchRewardGroupPause()

bool FaustBot.CPH.TwitchRewardGroupPause ( string groupName)
static

◆ TwitchRewardGroupToggleEnable()

bool FaustBot.CPH.TwitchRewardGroupToggleEnable ( string groupName)
static

◆ TwitchRewardGroupTogglePause()

bool FaustBot.CPH.TwitchRewardGroupTogglePause ( string groupName)
static

◆ TwitchRewardGroupUnpause()

bool FaustBot.CPH.TwitchRewardGroupUnpause ( string groupName)
static

◆ TwitchSendShoutout()

bool FaustBot.CPH.TwitchSendShoutout ( string toUserId)
static

◆ TwitchSendShoutoutByLogin()

bool FaustBot.CPH.TwitchSendShoutoutByLogin ( string toUserLogin)
static

◆ TwitchSendWhisper()

bool FaustBot.CPH.TwitchSendWhisper ( string userId,
string message )
static

◆ TwitchSetChannelTags()

bool FaustBot.CPH.TwitchSetChannelTags ( string[] tags)
static

◆ TwitchSetEmoteOnlyMode()

bool FaustBot.CPH.TwitchSetEmoteOnlyMode ( bool enabled)
static

◆ TwitchSetFollowerOnlyMode()

bool FaustBot.CPH.TwitchSetFollowerOnlyMode ( bool enabled,
int durationMinutes = 0 )
static

◆ TwitchSetGame()

bool FaustBot.CPH.TwitchSetGame ( string gameNameOrId)
static

◆ TwitchSetSlowMode()

bool FaustBot.CPH.TwitchSetSlowMode ( bool enabled,
int waitTimeSeconds = 30 )
static

◆ TwitchSetSubscriberOnlyMode()

bool FaustBot.CPH.TwitchSetSubscriberOnlyMode ( bool enabled)
static

◆ TwitchSetTitle()

bool FaustBot.CPH.TwitchSetTitle ( string title)
static

◆ TwitchSetUserVar()

bool FaustBot.CPH.TwitchSetUserVar ( string username,
string varName,
string value,
bool persist = false )
static

◆ TwitchSetUserVarById()

bool FaustBot.CPH.TwitchSetUserVarById ( string userId,
string varName,
string value,
bool persist = false )
static

◆ TwitchShieldModeOff()

bool FaustBot.CPH.TwitchShieldModeOff ( )
static

◆ TwitchShieldModeOn()

bool FaustBot.CPH.TwitchShieldModeOn ( )
static

◆ TwitchStartCommercial()

bool FaustBot.CPH.TwitchStartCommercial ( int lengthSeconds = 30)
static

◆ TwitchStartRaid()

bool FaustBot.CPH.TwitchStartRaid ( string toChannelId)
static

◆ TwitchTimeoutUser()

bool FaustBot.CPH.TwitchTimeoutUser ( string userId,
int seconds,
string reason = null )
static

◆ TwitchUnbanUser()

bool FaustBot.CPH.TwitchUnbanUser ( string userId)
static

◆ TwitchUnblockUser()

bool FaustBot.CPH.TwitchUnblockUser ( string userId)
static

◆ TwitchUnblockUserByName()

bool FaustBot.CPH.TwitchUnblockUserByName ( string username)
static

◆ TwitchUnpauseReward()

bool FaustBot.CPH.TwitchUnpauseReward ( string rewardId)
static

◆ TwitchUnsetUser()

bool FaustBot.CPH.TwitchUnsetUser ( string username)
static

◆ TwitchUnsetUserById()

bool FaustBot.CPH.TwitchUnsetUserById ( string userId)
static

◆ TwitchUnsetUserVar()

bool FaustBot.CPH.TwitchUnsetUserVar ( string username,
string varName )
static

◆ TwitchUnsetUserVarById()

bool FaustBot.CPH.TwitchUnsetUserVarById ( string userId,
string varName )
static

◆ TwitchUpdateReward()

bool FaustBot.CPH.TwitchUpdateReward ( string rewardId,
string updatesJson )
static

◆ TwitchUpdateRewardBackgroundColor()

bool FaustBot.CPH.TwitchUpdateRewardBackgroundColor ( string rewardId,
string color )
static

◆ TwitchUpdateRewardCooldown()

bool FaustBot.CPH.TwitchUpdateRewardCooldown ( string rewardId,
int seconds )
static

◆ TwitchUpdateRewardCost()

bool FaustBot.CPH.TwitchUpdateRewardCost ( string rewardId,
int cost )
static

◆ TwitchUpdateRewardPrompt()

bool FaustBot.CPH.TwitchUpdateRewardPrompt ( string rewardId,
string prompt )
static

◆ TwitchUpdateRewardTitle()

bool FaustBot.CPH.TwitchUpdateRewardTitle ( string rewardId,
string title )
static

◆ UnsetGlobalVar()

void FaustBot.CPH.UnsetGlobalVar ( string name,
bool persisted = true )
static

◆ UnsetUserVar()

void FaustBot.CPH.UnsetUserVar ( string userName,
string name,
bool persisted = true )
inlinestatic

◆ Wait()

void FaustBot.CPH.Wait ( int milliseconds)
static

◆ YouTubeBanUser()

bool FaustBot.CPH.YouTubeBanUser ( string userId)
static

◆ YouTubeBanUserByName()

bool FaustBot.CPH.YouTubeBanUserByName ( string username)
static

◆ YouTubeDeleteMessage()

bool FaustBot.CPH.YouTubeDeleteMessage ( string messageId)
static

◆ YouTubeGetChannelId()

string FaustBot.CPH.YouTubeGetChannelId ( )
static

◆ YouTubeGetChannelName()

string FaustBot.CPH.YouTubeGetChannelName ( )
static

◆ YouTubeGetUserVar()

string FaustBot.CPH.YouTubeGetUserVar ( string username,
string varName,
string defaultValue = null )
static

◆ YouTubeGetUserVarById()

string FaustBot.CPH.YouTubeGetUserVarById ( string userId,
string varName,
string defaultValue = null )
static

◆ YouTubeGetViewerCount()

int FaustBot.CPH.YouTubeGetViewerCount ( )
static

◆ YouTubeIsConnected()

bool FaustBot.CPH.YouTubeIsConnected ( )
static

◆ YouTubeSetCategory()

bool FaustBot.CPH.YouTubeSetCategory ( string categoryId)
static

◆ YouTubeSetDescription()

bool FaustBot.CPH.YouTubeSetDescription ( string description)
static

◆ YouTubeSetMetaData()

bool FaustBot.CPH.YouTubeSetMetaData ( string title,
string description,
string categoryId )
static

◆ YouTubeSetPrivacy()

bool FaustBot.CPH.YouTubeSetPrivacy ( string privacy)
static

◆ YouTubeSetTitle()

bool FaustBot.CPH.YouTubeSetTitle ( string title)
static

◆ YouTubeSetUserVar()

bool FaustBot.CPH.YouTubeSetUserVar ( string username,
string varName,
string value,
bool persist = false )
static

◆ YouTubeSetUserVarById()

bool FaustBot.CPH.YouTubeSetUserVarById ( string userId,
string varName,
string value,
bool persist = false )
static

◆ YouTubeTimeoutUser()

bool FaustBot.CPH.YouTubeTimeoutUser ( string userId,
int seconds )
static

◆ YouTubeTimeoutUserByName()

bool FaustBot.CPH.YouTubeTimeoutUserByName ( string username,
int seconds )
static

◆ YouTubeUnbanUser()

bool FaustBot.CPH.YouTubeUnbanUser ( string banId)
static

◆ YouTubeUnsetUser()

bool FaustBot.CPH.YouTubeUnsetUser ( string username)
static

◆ YouTubeUnsetUserById()

bool FaustBot.CPH.YouTubeUnsetUserById ( string userId)
static

◆ YouTubeUnsetUserVar()

bool FaustBot.CPH.YouTubeUnsetUserVar ( string username,
string varName )
static

◆ YouTubeUnsetUserVarById()

bool FaustBot.CPH.YouTubeUnsetUserVarById ( string userId,
string varName )
static