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