C# Methods
ObsStopStreaming
C# Method Reference
YouTubeTimeoutUserById(userId, duration, broadcastId)
Signature
public bool YouTubeTimeoutUserById(string userId, int duration, string broadcastId)Parameters
userIdrequired
string
default:
durationrequired
int
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeTimeoutUserById(userId, duration, broadcastId)YouTubeTimeoutUserByName(userName, duration, broadcastId)
Signature
public bool YouTubeTimeoutUserByName(string userName, int duration, string broadcastId)Parameters
userNamerequired
string
default:
durationrequired
int
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeTimeoutUserByName(userName, duration, broadcastId)YouTubeBanUserById(userId, broadcastId)
Signature
public bool YouTubeBanUserById(string userId, string broadcastId)Parameters
userIdrequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeBanUserById(userId, broadcastId)YouTubeBanUserByName(userName, broadcastId)
Signature
public bool YouTubeBanUserByName(string userName, string broadcastId)Parameters
userNamerequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeBanUserByName(userName, broadcastId)MeldStudioGetConnectionByName(name)
Signature
public int MeldStudioGetConnectionByName(string name)Parameters
namerequired
string
default:
CPH Code
CPH.MeldStudioGetConnectionByName(name)MeldStudioIsConnected(connectionIdx)
Signature
public bool MeldStudioIsConnected(int connectionIdx)Parameters
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioIsConnected(connectionIdx)MeldStudioConnect(connectionIdx)
Signature
public bool MeldStudioConnect(int connectionIdx)Parameters
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioConnect(connectionIdx)MeldStudioDisconnect(connectionIdx)
Signature
public void MeldStudioDisconnect(int connectionIdx)Parameters
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioDisconnect(connectionIdx)MeldStudioShowScene(sceneId, connectionIdx)
Signature
public bool MeldStudioShowScene(string sceneId, int connectionIdx)Parameters
sceneIdrequired
string
default:
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioShowScene(sceneId, connectionIdx)MeldStudioShowSceneByName(sceneName, connectionIdx)
Signature
public bool MeldStudioShowSceneByName(string sceneName, int connectionIdx)Parameters
sceneNamerequired
string
default:
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioShowSceneByName(sceneName, connectionIdx)MeldStudioShowLayerByName(sceneName, layerName, connectionIdx)
Signature
public bool MeldStudioShowLayerByName(string sceneName, string layerName, int connectionIdx)Parameters
sceneNamerequired
string
default:
layerNamerequired
string
default:
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioShowLayerByName(sceneName, layerName, connectionIdx)MeldStudioHideLayerByName(sceneName, layerName, connectionIdx)
Signature
public bool MeldStudioHideLayerByName(string sceneName, string layerName, int connectionIdx)Parameters
sceneNamerequired
string
default:
layerNamerequired
string
default:
connectionIdx
int
default:
-1CPH Code
CPH.MeldStudioHideLayerByName(sceneName, layerName, connectionIdx)KeyboardPress(keyPress)
Signature
public void KeyboardPress(string keyPress)Parameters
keyPressrequired
string
default:
CPH Code
CPH.KeyboardPress(keyPress)SendYouTubeMessage(message, bot, broadcastId)
Signature
public void SendYouTubeMessage(string message, bool bot, string broadcastId)Parameters
messagerequired
string
default:
bot
bool
default:
TruebroadcastId
string
default:
CPH Code
CPH.SendYouTubeMessage(message, bot, broadcastId)SendYouTubeMessageToLatestMonitored(message, bot)
Signature
public void SendYouTubeMessageToLatestMonitored(string message, bool bot)Parameters
messagerequired
string
default:
bot
bool
default:
TrueCPH Code
CPH.SendYouTubeMessageToLatestMonitored(message, bot)SendTrovoMessage(message, bot)
Signature
public void SendTrovoMessage(string message, bool bot)Parameters
messagerequired
string
default:
bot
bool
default:
TrueCPH Code
CPH.SendTrovoMessage(message, bot)VoiceModSelectVoice(voiceId)
Signature
public void VoiceModSelectVoice(string voiceId)Parameters
voiceIdrequired
string
default:
CPH Code
CPH.VoiceModSelectVoice(voiceId)VoiceModGetCurrentVoice()
Signature
public string VoiceModGetCurrentVoice()Parameters
No parametersCPH Code
CPH.VoiceModGetCurrentVoice()VoiceModGetHearMyselfStatus()
Signature
public bool VoiceModGetHearMyselfStatus()Parameters
No parametersCPH Code
CPH.VoiceModGetHearMyselfStatus()VoiceModHearMyVoiceOn()
Signature
public void VoiceModHearMyVoiceOn()Parameters
No parametersCPH Code
CPH.VoiceModHearMyVoiceOn()VoiceModHearMyVoiceOff()
Signature
public void VoiceModHearMyVoiceOff()Parameters
No parametersCPH Code
CPH.VoiceModHearMyVoiceOff()VoiceModGetVoiceChangerStatus()
Signature
public bool VoiceModGetVoiceChangerStatus()Parameters
No parametersCPH Code
CPH.VoiceModGetVoiceChangerStatus()VoiceModVoiceChangerOn()
Signature
public void VoiceModVoiceChangerOn()Parameters
No parametersCPH Code
CPH.VoiceModVoiceChangerOn()VoiceModVoiceChangerOff()
Signature
public void VoiceModVoiceChangerOff()Parameters
No parametersCPH Code
CPH.VoiceModVoiceChangerOff()VoiceModCensorOn()
Signature
public void VoiceModCensorOn()Parameters
No parametersCPH Code
CPH.VoiceModCensorOn()VoiceModCensorOff()
Signature
public void VoiceModCensorOff()Parameters
No parametersCPH Code
CPH.VoiceModCensorOff()VoiceModGetBackgroundEffectStatus()
Signature
public bool VoiceModGetBackgroundEffectStatus()Parameters
No parametersCPH Code
CPH.VoiceModGetBackgroundEffectStatus()VoiceModBackgroundEffectOn()
Signature
public void VoiceModBackgroundEffectOn()Parameters
No parametersCPH Code
CPH.VoiceModBackgroundEffectOn()VoiceModBackgroundEffectOff()
Signature
public void VoiceModBackgroundEffectOff()Parameters
No parametersCPH Code
CPH.VoiceModBackgroundEffectOff()LumiaSendCommand(command)
Signature
public void LumiaSendCommand(string command)Parameters
commandrequired
string
default:
CPH Code
CPH.LumiaSendCommand(command)LumiaSetToDefault()
Signature
public void LumiaSetToDefault()Parameters
No parametersCPH Code
CPH.LumiaSetToDefault()DiscordPostTextToWebhook(webhookUrl, content, username, avatarUrl, textToSpeech)
Signature
public string DiscordPostTextToWebhook(string webhookUrl, string content, string username, string avatarUrl, bool textToSpeech)Parameters
webhookUrlrequired
string
default:
contentrequired
string
default:
username
string
default:
avatarUrl
string
default:
textToSpeech
bool
default:
FalseCPH Code
CPH.DiscordPostTextToWebhook(webhookUrl, content, username, avatarUrl, textToSpeech)StreamDeckSetBackgroundColor(buttonId, color)
Signature
public void StreamDeckSetBackgroundColor(string buttonId, string color)Parameters
buttonIdrequired
string
default:
colorrequired
string
default:
CPH Code
CPH.StreamDeckSetBackgroundColor(buttonId, color)StreamDeckSetBackgroundColor(buttonId, color, state)
Signature
public void StreamDeckSetBackgroundColor(string buttonId, string color, int state)Parameters
buttonIdrequired
string
default:
colorrequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetBackgroundColor(buttonId, color, state)StreamDeckSetBackgroundUrl(buttonId, imageUrl)
Signature
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl)Parameters
buttonIdrequired
string
default:
imageUrlrequired
string
default:
CPH Code
CPH.StreamDeckSetBackgroundUrl(buttonId, imageUrl)StreamDeckSetBackgroundUrl(buttonId, imageUrl, color)
Signature
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, string color)Parameters
buttonIdrequired
string
default:
imageUrlrequired
string
default:
colorrequired
string
default:
CPH Code
CPH.StreamDeckSetBackgroundUrl(buttonId, imageUrl, color)StreamDeckSetBackgroundUrl(buttonId, imageUrl, state)
Signature
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, int state)Parameters
buttonIdrequired
string
default:
imageUrlrequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetBackgroundUrl(buttonId, imageUrl, state)StreamDeckSetBackgroundUrl(buttonId, imageUrl, color, state)
Signature
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, string color, int state)Parameters
buttonIdrequired
string
default:
imageUrlrequired
string
default:
colorrequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetBackgroundUrl(buttonId, imageUrl, color, state)StreamDeckSetBackgroundLocal(buttonId, imageFile)
Signature
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile)Parameters
buttonIdrequired
string
default:
imageFilerequired
string
default:
CPH Code
CPH.StreamDeckSetBackgroundLocal(buttonId, imageFile)StreamDeckSetBackgroundLocal(buttonId, imageFile, color)
Signature
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, string color)Parameters
buttonIdrequired
string
default:
imageFilerequired
string
default:
colorrequired
string
default:
CPH Code
CPH.StreamDeckSetBackgroundLocal(buttonId, imageFile, color)StreamDeckSetBackgroundLocal(buttonId, imageFile, state)
Signature
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, int state)Parameters
buttonIdrequired
string
default:
imageFilerequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetBackgroundLocal(buttonId, imageFile, state)StreamDeckSetBackgroundLocal(buttonId, imageFile, color, state)
Signature
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, string color, int state)Parameters
buttonIdrequired
string
default:
imageFilerequired
string
default:
colorrequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetBackgroundLocal(buttonId, imageFile, color, state)StreamDeckSetTitle(buttonId, title)
Signature
public void StreamDeckSetTitle(string buttonId, string title)Parameters
buttonIdrequired
string
default:
titlerequired
string
default:
CPH Code
CPH.StreamDeckSetTitle(buttonId, title)StreamDeckSetTitle(buttonId, title, state)
Signature
public void StreamDeckSetTitle(string buttonId, string title, int state)Parameters
buttonIdrequired
string
default:
titlerequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetTitle(buttonId, title, state)StreamDeckSetState(buttonId, state)
Signature
public void StreamDeckSetState(string buttonId, int state)Parameters
buttonIdrequired
string
default:
staterequired
int
default:
CPH Code
CPH.StreamDeckSetState(buttonId, state)StreamDeckSetValue(buttonId, value)
Signature
public void StreamDeckSetValue(string buttonId, string value)Parameters
buttonIdrequired
string
default:
valuerequired
string
default:
CPH Code
CPH.StreamDeckSetValue(buttonId, value)StreamDeckShowAlert(buttonId)
Signature
public void StreamDeckShowAlert(string buttonId)Parameters
buttonIdrequired
string
default:
CPH Code
CPH.StreamDeckShowAlert(buttonId)StreamDeckShowOk(buttonId)
Signature
public void StreamDeckShowOk(string buttonId)Parameters
buttonIdrequired
string
default:
CPH Code
CPH.StreamDeckShowOk(buttonId)StreamDeckToggleState(buttonId)
Signature
public void StreamDeckToggleState(string buttonId)Parameters
buttonIdrequired
string
default:
CPH Code
CPH.StreamDeckToggleState(buttonId)TwitchGetChannelGuestStarSettings()
Signature
public Twitch.Common.Models.Api.GuestStarSettings TwitchGetChannelGuestStarSettings()Parameters
No parametersCPH Code
CPH.TwitchGetChannelGuestStarSettings()TwitchUpdateChannelGuestStarSettings(isModeratorSendLiveEnabled, slotCount, isBrowserSourceAudioEnabled, groupLayout, regeneratgeBrowserSource)
Signature
public bool TwitchUpdateChannelGuestStarSettings(Boolean? isModeratorSendLiveEnabled, Int32? slotCount, Boolean? isBrowserSourceAudioEnabled, string groupLayout, Boolean? regeneratgeBrowserSource)Parameters
isModeratorSendLiveEnabled
Boolean?
default:
slotCount
Int32?
default:
isBrowserSourceAudioEnabled
Boolean?
default:
groupLayout
string
default:
regeneratgeBrowserSource
Boolean?
default:
CPH Code
CPH.TwitchUpdateChannelGuestStarSettings(isModeratorSendLiveEnabled, slotCount, isBrowserSourceAudioEnabled, groupLayout, regeneratgeBrowserSource)TwitchGetGuestStarSession()
Signature
public Twitch.Common.Models.Api.GuestSession TwitchGetGuestStarSession()Parameters
No parametersCPH Code
CPH.TwitchGetGuestStarSession()TwitchCreateGuestStarSession()
Signature
public Twitch.Common.Models.Api.GuestSession TwitchCreateGuestStarSession()Parameters
No parametersCPH Code
CPH.TwitchCreateGuestStarSession()TwitchEndGuestStarSession()
Signature
public Twitch.Common.Models.Api.GuestSession TwitchEndGuestStarSession()Parameters
No parametersCPH Code
CPH.TwitchEndGuestStarSession()TwitchGetGuestStarInvites()
Signature
public List<Twitch.Common.Models.Api.GuestStarInvite> TwitchGetGuestStarInvites()Parameters
No parametersCPH Code
CPH.TwitchGetGuestStarInvites()TwitchSendGuestStarInvite(userLogin)
Signature
public bool TwitchSendGuestStarInvite(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.TwitchSendGuestStarInvite(userLogin)TwitchDeleteGuestStarInvite(userLogin)
Signature
public bool TwitchDeleteGuestStarInvite(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.TwitchDeleteGuestStarInvite(userLogin)TwitchAssignGuestStarSlot(userLogin, slot)
Signature
public bool TwitchAssignGuestStarSlot(string userLogin, int slot)Parameters
userLoginrequired
string
default:
slotrequired
int
default:
CPH Code
CPH.TwitchAssignGuestStarSlot(userLogin, slot)TwitchUpdateGuestStarSlot(sourceSlot, destinationSlot)
Signature
public bool TwitchUpdateGuestStarSlot(int sourceSlot, int destinationSlot)Parameters
sourceSlotrequired
int
default:
destinationSlotrequired
int
default:
CPH Code
CPH.TwitchUpdateGuestStarSlot(sourceSlot, destinationSlot)TwitchDeleteGuestStarSlot(userLogin, slot)
Signature
public bool TwitchDeleteGuestStarSlot(string userLogin, int slot)Parameters
userLoginrequired
string
default:
slotrequired
int
default:
CPH Code
CPH.TwitchDeleteGuestStarSlot(userLogin, slot)TwitchUpdateGuestStarSlotSettings(slotId, isAudioEnabled, isVideoEnabled, isLive, volume)
Signature
public bool TwitchUpdateGuestStarSlotSettings(int slotId, Boolean? isAudioEnabled, Boolean? isVideoEnabled, Boolean? isLive, Int32? volume)Parameters
slotIdrequired
int
default:
isAudioEnabled
Boolean?
default:
isVideoEnabled
Boolean?
default:
isLive
Boolean?
default:
volume
Int32?
default:
CPH Code
CPH.TwitchUpdateGuestStarSlotSettings(slotId, isAudioEnabled, isVideoEnabled, isLive, volume)TwitchGetPrerollFreeTime()
Signature
public int TwitchGetPrerollFreeTime()Parameters
No parametersCPH Code
CPH.TwitchGetPrerollFreeTime()RegisterCustomTrigger(triggerName, eventName, categories)
Signature
public bool RegisterCustomTrigger(string triggerName, string eventName, System.String[] categories)Parameters
triggerNamerequired
string
default:
eventNamerequired
string
default:
categoriesrequired
System.String[]
default:
CPH Code
CPH.RegisterCustomTrigger(triggerName, eventName, categories)TriggerEvent(eventName, useArgs)
Signature
public void TriggerEvent(string eventName, bool useArgs)Parameters
eventNamerequired
string
default:
useArgs
bool
default:
TrueCPH Code
CPH.TriggerEvent(eventName, useArgs)TriggerCodeEvent(eventName, useArgs)
Signature
public void TriggerCodeEvent(string eventName, bool useArgs)Parameters
eventNamerequired
string
default:
useArgs
bool
default:
TrueCPH Code
CPH.TriggerCodeEvent(eventName, useArgs)TriggerCodeEvent(eventName, args)
Signature
public void TriggerCodeEvent(string eventName, Dictionary<string,object> args)Parameters
eventNamerequired
string
default:
argsrequired
Dictionary<string,object>
default:
CPH Code
CPH.TriggerCodeEvent(eventName, args)TriggerCodeEvent(eventName, json)
Signature
public void TriggerCodeEvent(string eventName, string json)Parameters
eventNamerequired
string
default:
jsonrequired
string
default:
CPH Code
CPH.TriggerCodeEvent(eventName, json)VTubeStudioLoadModelById(modelId)
Signature
public bool VTubeStudioLoadModelById(string modelId)Parameters
modelIdrequired
string
default:
CPH Code
CPH.VTubeStudioLoadModelById(modelId)VTubeStudioLoadModelByName(modelName)
Signature
public bool VTubeStudioLoadModelByName(string modelName)Parameters
modelNamerequired
string
default:
CPH Code
CPH.VTubeStudioLoadModelByName(modelName)VTubeStudioTriggerHotkeyById(hotkeyId)
Signature
public bool VTubeStudioTriggerHotkeyById(string hotkeyId)Parameters
hotkeyIdrequired
string
default:
CPH Code
CPH.VTubeStudioTriggerHotkeyById(hotkeyId)VTubeStudioTriggerHotkeyByName(hotkeyName)
Signature
public bool VTubeStudioTriggerHotkeyByName(string hotkeyName)Parameters
hotkeyNamerequired
string
default:
CPH Code
CPH.VTubeStudioTriggerHotkeyByName(hotkeyName)VTubeStudioMoveModel(seconds, relative, posX, posY, rotation, size)
Signature
public bool VTubeStudioMoveModel(double seconds, bool relative, Double? posX, Double? posY, Double? rotation, Double? size)Parameters
secondsrequired
double
default:
relativerequired
bool
default:
posX
Double?
default:
posY
Double?
default:
rotation
Double?
default:
size
Double?
default:
CPH Code
CPH.VTubeStudioMoveModel(seconds, relative, posX, posY, rotation, size)VTubeStudioRandomColorTint()
Signature
public bool VTubeStudioRandomColorTint()Parameters
No parametersCPH Code
CPH.VTubeStudioRandomColorTint()VTubeStudioResetAllColorTints()
Signature
public bool VTubeStudioResetAllColorTints()Parameters
No parametersCPH Code
CPH.VTubeStudioResetAllColorTints()VTubeStudioColorTintAll(hexColor, mixWithSceneLighting)
Signature
public bool VTubeStudioColorTintAll(string hexColor, double mixWithSceneLighting)Parameters
hexColorrequired
string
default:
mixWithSceneLighting
double
default:
0CPH Code
CPH.VTubeStudioColorTintAll(hexColor, mixWithSceneLighting)VTubeStudioColorTintByNumber(hexColor, mixWithSceneLighting, artMeshNumbers)
Signature
public bool VTubeStudioColorTintByNumber(string hexColor, double mixWithSceneLighting, List<int> artMeshNumbers)Parameters
hexColorrequired
string
default:
mixWithSceneLightingrequired
double
default:
artMeshNumbersrequired
List<int>
default:
CPH Code
CPH.VTubeStudioColorTintByNumber(hexColor, mixWithSceneLighting, artMeshNumbers)VTubeStudioColorTintByNames(hexColor, mixWithSceneLighting, filterValues)
Signature
public bool VTubeStudioColorTintByNames(string hexColor, double mixWithSceneLighting, List<string> filterValues)Parameters
hexColorrequired
string
default:
mixWithSceneLightingrequired
double
default:
filterValuesrequired
List<string>
default:
CPH Code
CPH.VTubeStudioColorTintByNames(hexColor, mixWithSceneLighting, filterValues)VTubeStudioColorTintByNameContains(hexColor, mixWithSceneLighting, filterValues)
Signature
public bool VTubeStudioColorTintByNameContains(string hexColor, double mixWithSceneLighting, List<string> filterValues)Parameters
hexColorrequired
string
default:
mixWithSceneLightingrequired
double
default:
filterValuesrequired
List<string>
default:
CPH Code
CPH.VTubeStudioColorTintByNameContains(hexColor, mixWithSceneLighting, filterValues)VTubeStudioColorTintByTags(hexColor, mixWithSceneLighting, filterValues)
Signature
public bool VTubeStudioColorTintByTags(string hexColor, double mixWithSceneLighting, List<string> filterValues)Parameters
hexColorrequired
string
default:
mixWithSceneLightingrequired
double
default:
filterValuesrequired
List<string>
default:
CPH Code
CPH.VTubeStudioColorTintByTags(hexColor, mixWithSceneLighting, filterValues)VTubeStudioColorTintByTagContains(hexColor, mixWithSceneLighting, filterValues)
Signature
public bool VTubeStudioColorTintByTagContains(string hexColor, double mixWithSceneLighting, List<string> filterValues)Parameters
hexColorrequired
string
default:
mixWithSceneLightingrequired
double
default:
filterValuesrequired
List<string>
default:
CPH Code
CPH.VTubeStudioColorTintByTagContains(hexColor, mixWithSceneLighting, filterValues)VTubeStudioActivateExpression(expressionFile, fadeTime)
Signature
public bool VTubeStudioActivateExpression(string expressionFile, System.Single fadeTime)Parameters
expressionFilerequired
string
default:
fadeTime
System.Single
default:
0.25CPH Code
CPH.VTubeStudioActivateExpression(expressionFile, fadeTime)VTubeStudioDeactivateExpression(expressionFile)
Signature
public bool VTubeStudioDeactivateExpression(string expressionFile)Parameters
expressionFilerequired
string
default:
CPH Code
CPH.VTubeStudioDeactivateExpression(expressionFile)VTubeStudioSendRawRequest(requestType, data)
Signature
public string VTubeStudioSendRawRequest(string requestType, string data)Parameters
requestTyperequired
string
default:
datarequired
string
default:
CPH Code
CPH.VTubeStudioSendRawRequest(requestType, data)VTubeStudioGetModelPosition()
Signature
public Streamer.bot.Plugin.Interface.VTSModelPosition VTubeStudioGetModelPosition()Parameters
No parametersCPH Code
CPH.VTubeStudioGetModelPosition()ShowToastNotification(title, message, attribution, iconPath)
Signature
public void ShowToastNotification(string title, string message, string attribution, string iconPath)Parameters
titlerequired
string
default:
messagerequired
string
default:
attribution
string
default:
iconPath
string
default:
CPH Code
CPH.ShowToastNotification(title, message, attribution, iconPath)ShowToastNotification(id, title, message, attribution, iconPath)
Signature
public void ShowToastNotification(string id, string title, string message, string attribution, string iconPath)Parameters
idrequired
string
default:
titlerequired
string
default:
messagerequired
string
default:
attribution
string
default:
iconPath
string
default:
CPH Code
CPH.ShowToastNotification(id, title, message, attribution, iconPath)WaveLinkOutputMute(mixer)
Signature
public void WaveLinkOutputMute(string mixer)Parameters
mixerrequired
string
default:
CPH Code
CPH.WaveLinkOutputMute(mixer)WaveLinkOutputUnmute(mixer)
Signature
public void WaveLinkOutputUnmute(string mixer)Parameters
mixerrequired
string
default:
CPH Code
CPH.WaveLinkOutputUnmute(mixer)WaveLinkOutputToggleMute(mixer)
Signature
public void WaveLinkOutputToggleMute(string mixer)Parameters
mixerrequired
string
default:
CPH Code
CPH.WaveLinkOutputToggleMute(mixer)WaveLinkSetOutputVolume(mixer, volume)
Signature
public void WaveLinkSetOutputVolume(string mixer, int volume)Parameters
mixerrequired
string
default:
volumerequired
int
default:
CPH Code
CPH.WaveLinkSetOutputVolume(mixer, volume)WaveLinkGetMicrophoneIdentifier(microphoneName)
Signature
public string WaveLinkGetMicrophoneIdentifier(string microphoneName)Parameters
microphoneNamerequired
string
default:
CPH Code
CPH.WaveLinkGetMicrophoneIdentifier(microphoneName)WaveLinkMicrophoneMute(microphoneIdentifier)
Signature
public void WaveLinkMicrophoneMute(string microphoneIdentifier)Parameters
microphoneIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkMicrophoneMute(microphoneIdentifier)WaveLinkMicrophoneUnmute(microphoneIdentifier)
Signature
public void WaveLinkMicrophoneUnmute(string microphoneIdentifier)Parameters
microphoneIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkMicrophoneUnmute(microphoneIdentifier)WaveLinkMicrophoneToggleMute(microphoneIdentifier)
Signature
public void WaveLinkMicrophoneToggleMute(string microphoneIdentifier)Parameters
microphoneIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkMicrophoneToggleMute(microphoneIdentifier)WaveLinkMicrophoneSetVolume(microphoneIdentifier, volume)
Signature
public void WaveLinkMicrophoneSetVolume(string microphoneIdentifier, double volume)Parameters
microphoneIdentifierrequired
string
default:
volumerequired
double
default:
CPH Code
CPH.WaveLinkMicrophoneSetVolume(microphoneIdentifier, volume)WaveLinkMicrophoneGetVolume(microphoneIdentifier)
Signature
public double WaveLinkMicrophoneGetVolume(string microphoneIdentifier)Parameters
microphoneIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkMicrophoneGetVolume(microphoneIdentifier)WaveLinkGetInputIdentifier(inputName)
Signature
public string WaveLinkGetInputIdentifier(string inputName)Parameters
inputNamerequired
string
default:
CPH Code
CPH.WaveLinkGetInputIdentifier(inputName)WaveLinkInputMute(identifier, mixer)
Signature
public void WaveLinkInputMute(string identifier, string mixer)Parameters
identifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputMute(identifier, mixer)WaveLinkInputUnmute(identifier, mixer)
Signature
public void WaveLinkInputUnmute(string identifier, string mixer)Parameters
identifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputUnmute(identifier, mixer)WaveLinkInputToggleMute(identifier, mixer)
Signature
public void WaveLinkInputToggleMute(string identifier, string mixer)Parameters
identifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputToggleMute(identifier, mixer)WaveLinkInputSetVolume(inputIdentifier, mixer, volume)
Signature
public void WaveLinkInputSetVolume(string inputIdentifier, string mixer, int volume)Parameters
inputIdentifierrequired
string
default:
mixerrequired
string
default:
volumerequired
int
default:
CPH Code
CPH.WaveLinkInputSetVolume(inputIdentifier, mixer, volume)WaveLinkInputGetVolume(inputIdentifier, mixer)
Signature
public long WaveLinkInputGetVolume(string inputIdentifier, string mixer)Parameters
inputIdentifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputGetVolume(inputIdentifier, mixer)WaveLinkInputFilterBypassBypassed(inputIdentifier, mixer)
Signature
public void WaveLinkInputFilterBypassBypassed(string inputIdentifier, string mixer)Parameters
inputIdentifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputFilterBypassBypassed(inputIdentifier, mixer)WaveLinkInputFilterBypassEnabled(inputIdentifier, mixer)
Signature
public void WaveLinkInputFilterBypassEnabled(string inputIdentifier, string mixer)Parameters
inputIdentifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputFilterBypassEnabled(inputIdentifier, mixer)WaveLinkInputFilterBypassToggle(inputIdentifier, mixer)
Signature
public void WaveLinkInputFilterBypassToggle(string inputIdentifier, string mixer)Parameters
inputIdentifierrequired
string
default:
mixerrequired
string
default:
CPH Code
CPH.WaveLinkInputFilterBypassToggle(inputIdentifier, mixer)WaveLinkInputGetFilterIdentifier(inputIdentifier, filterName)
Signature
public string WaveLinkInputGetFilterIdentifier(string inputIdentifier, string filterName)Parameters
inputIdentifierrequired
string
default:
filterNamerequired
string
default:
CPH Code
CPH.WaveLinkInputGetFilterIdentifier(inputIdentifier, filterName)WaveLinkInputFilterEnable(inputIdentifier, filterIdentifier)
Signature
public void WaveLinkInputFilterEnable(string inputIdentifier, string filterIdentifier)Parameters
inputIdentifierrequired
string
default:
filterIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkInputFilterEnable(inputIdentifier, filterIdentifier)WaveLinkInputFilterDisable(inputIdentifier, filterIdentifier)
Signature
public void WaveLinkInputFilterDisable(string inputIdentifier, string filterIdentifier)Parameters
inputIdentifierrequired
string
default:
filterIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkInputFilterDisable(inputIdentifier, filterIdentifier)WaveLinkInputFilterToggle(inputIdentifier, filterIdentifier)
Signature
public void WaveLinkInputFilterToggle(string inputIdentifier, string filterIdentifier)Parameters
inputIdentifierrequired
string
default:
filterIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkInputFilterToggle(inputIdentifier, filterIdentifier)WaveLinkInputGetFilterState(inputIdentifier, filterIdentifier)
Signature
public bool WaveLinkInputGetFilterState(string inputIdentifier, string filterIdentifier)Parameters
inputIdentifierrequired
string
default:
filterIdentifierrequired
string
default:
CPH Code
CPH.WaveLinkInputGetFilterState(inputIdentifier, filterIdentifier)GetQuote(quoteId)
Signature
public Streamer.bot.Plugin.Interface.Model.QuoteData GetQuote(int quoteId)Parameters
quoteIdrequired
int
default:
CPH Code
CPH.GetQuote(quoteId)GetQuoteCount()
Signature
public int GetQuoteCount()Parameters
No parametersCPH Code
CPH.GetQuoteCount()AddQuoteForTwitch(userId, quote, captureGame)
Signature
public int AddQuoteForTwitch(string userId, string quote, bool captureGame)Parameters
userIdrequired
string
default:
quoterequired
string
default:
captureGame
bool
default:
FalseCPH Code
CPH.AddQuoteForTwitch(userId, quote, captureGame)AddQuoteForYouTube(userId, quote)
Signature
public int AddQuoteForYouTube(string userId, string quote)Parameters
userIdrequired
string
default:
quoterequired
string
default:
CPH Code
CPH.AddQuoteForYouTube(userId, quote)AddQuoteForTrovo(userId, quote, captureGame)
Signature
public int AddQuoteForTrovo(string userId, string quote, bool captureGame)Parameters
userIdrequired
string
default:
quoterequired
string
default:
captureGame
bool
default:
FalseCPH Code
CPH.AddQuoteForTrovo(userId, quote, captureGame)DeleteQuote(quoteId)
Signature
public bool DeleteQuote(int quoteId)Parameters
quoteIdrequired
int
default:
CPH Code
CPH.DeleteQuote(quoteId)ThrowingSystemThrowItemByName(itemName, delay, amount)
Signature
public bool ThrowingSystemThrowItemByName(string itemName, double delay, int amount)Parameters
itemNamerequired
string
default:
delay
double
default:
0.05amount
int
default:
1CPH Code
CPH.ThrowingSystemThrowItemByName(itemName, delay, amount)ThrowingSystemActivateTriggerByName(triggerName)
Signature
public bool ThrowingSystemActivateTriggerByName(string triggerName)Parameters
triggerNamerequired
string
default:
CPH Code
CPH.ThrowingSystemActivateTriggerByName(triggerName)PronounLookup(userLogin)
Signature
public Dictionary<string,object> PronounLookup(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.PronounLookup(userLogin)PronounClearForUserlogin(userLogin)
Signature
public void PronounClearForUserlogin(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.PronounClearForUserlogin(userLogin)MidiSendRawByName(name, command, channel, data1, data2)
Signature
public void MidiSendRawByName(string name, int command, int channel, int data1, int data2)Parameters
namerequired
string
default:
commandrequired
int
default:
channelrequired
int
default:
data1required
int
default:
data2required
int
default:
CPH Code
CPH.MidiSendRawByName(name, command, channel, data1, data2)MidiSendRaw(deviceId, command, channel, data1, data2)
Signature
public void MidiSendRaw(Guid deviceId, int command, int channel, int data1, int data2)Parameters
deviceIdrequired
Guid
default:
commandrequired
int
default:
channelrequired
int
default:
data1required
int
default:
data2required
int
default:
CPH Code
CPH.MidiSendRaw(deviceId, command, channel, data1, data2)MidiSendNoteOnByName(name, channel, note, velocity, duration, sendNoteOff)
Signature
public void MidiSendNoteOnByName(string name, int channel, int note, int velocity, int duration, bool sendNoteOff)Parameters
namerequired
string
default:
channelrequired
int
default:
noterequired
int
default:
velocityrequired
int
default:
duration
int
default:
0sendNoteOff
bool
default:
FalseCPH Code
CPH.MidiSendNoteOnByName(name, channel, note, velocity, duration, sendNoteOff)MidiSendNoteOn(deviceId, channel, note, velocity, duration, sendNoteOff)
Signature
public void MidiSendNoteOn(Guid deviceId, int channel, int note, int velocity, int duration, bool sendNoteOff)Parameters
deviceIdrequired
Guid
default:
channelrequired
int
default:
noterequired
int
default:
velocityrequired
int
default:
duration
int
default:
0sendNoteOff
bool
default:
FalseCPH Code
CPH.MidiSendNoteOn(deviceId, channel, note, velocity, duration, sendNoteOff)MidiSendControlChangeByName(name, channel, controller, value)
Signature
public void MidiSendControlChangeByName(string name, int channel, int controller, int value)Parameters
namerequired
string
default:
channelrequired
int
default:
controllerrequired
int
default:
valuerequired
int
default:
CPH Code
CPH.MidiSendControlChangeByName(name, channel, controller, value)MidiSendControlChange(deviceId, channel, controller, value)
Signature
public void MidiSendControlChange(Guid deviceId, int channel, int controller, int value)Parameters
deviceIdrequired
Guid
default:
channelrequired
int
default:
controllerrequired
int
default:
valuerequired
int
default:
CPH Code
CPH.MidiSendControlChange(deviceId, channel, controller, value)SetTimerInterval(timerId, interval)
Signature
public void SetTimerInterval(string timerId, int interval)Parameters
timerIdrequired
string
default:
intervalrequired
int
default:
CPH Code
CPH.SetTimerInterval(timerId, interval)GetTimerState(timerId)
Signature
public bool GetTimerState(string timerId)Parameters
timerIdrequired
string
default:
CPH Code
CPH.GetTimerState(timerId)YouTubeGetBroadcaster()
Signature
public Streamer.bot.Plugin.Interface.Model.YouTubeUserInfo YouTubeGetBroadcaster()Parameters
No parametersCPH Code
CPH.YouTubeGetBroadcaster()YouTubeGetBot()
Signature
public Streamer.bot.Plugin.Interface.Model.YouTubeUserInfo YouTubeGetBot()Parameters
No parametersCPH Code
CPH.YouTubeGetBot()YouTubeGetLatestMonitoredBroadcast()
Signature
public Streamer.bot.Plugin.Interface.Model.YouTubeBroadcastInfo YouTubeGetLatestMonitoredBroadcast()Parameters
No parametersCPH Code
CPH.YouTubeGetLatestMonitoredBroadcast()YouTubeGetMonitoredBroadcasts()
Signature
public List<Streamer.bot.Plugin.Interface.Model.YouTubeBroadcastInfo> YouTubeGetMonitoredBroadcasts()Parameters
No parametersCPH Code
CPH.YouTubeGetMonitoredBroadcasts()YouTubeSetTitle(title, broadcastId)
Signature
public bool YouTubeSetTitle(string title, string broadcastId)Parameters
titlerequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeSetTitle(title, broadcastId)YouTubeSetDescription(description, broadcastId)
Signature
public bool YouTubeSetDescription(string description, string broadcastId)Parameters
descriptionrequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeSetDescription(description, broadcastId)YouTubeSetPrivacy(privacy, broadcastId)
Signature
public bool YouTubeSetPrivacy(string privacy, string broadcastId)Parameters
privacyrequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeSetPrivacy(privacy, broadcastId)YouTubeSetCategory(categoryName, broadcastId)
Signature
public bool YouTubeSetCategory(string categoryName, string broadcastId)Parameters
categoryNamerequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeSetCategory(categoryName, broadcastId)YouTubeSetMetaData(title, description, privacy, categoryName, broadcastId)
Signature
public bool YouTubeSetMetaData(string title, string description, string privacy, string categoryName, string broadcastId)Parameters
titlerequired
string
default:
descriptionrequired
string
default:
privacyrequired
string
default:
categoryNamerequired
string
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeSetMetaData(title, description, privacy, categoryName, broadcastId)YouTubeClearTags(broadcastId)
Signature
public bool YouTubeClearTags(string broadcastId)Parameters
broadcastId
string
default:
CPH Code
CPH.YouTubeClearTags(broadcastId)YouTubeAddTags(tags, broadcastId)
Signature
public bool YouTubeAddTags(List<string> tags, string broadcastId)Parameters
tagsrequired
List<string>
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeAddTags(tags, broadcastId)YouTubeRemoveTags(tags, broadcastId)
Signature
public bool YouTubeRemoveTags(List<string> tags, string broadcastId)Parameters
tagsrequired
List<string>
default:
broadcastId
string
default:
CPH Code
CPH.YouTubeRemoveTags(tags, broadcastId)ClearNonPersistedUserGlobals()
Signature
public void ClearNonPersistedUserGlobals()Parameters
No parametersCPH Code
CPH.ClearNonPersistedUserGlobals()GetGlobalVar(varName, persisted)
Signature
public T GetGlobalVar<T>(string varName, bool persisted)Parameters
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetGlobalVar(varName, persisted)GetGlobalVarValues(persisted)
Signature
public List<Streamer.bot.Plugin.Interface.Model.GlobalVariableValue> GetGlobalVarValues(bool persisted)Parameters
persisted
bool
default:
TrueCPH Code
CPH.GetGlobalVarValues(persisted)SetGlobalVar(varName, value, persisted)
Signature
public void SetGlobalVar(string varName, object value, bool persisted)Parameters
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetGlobalVar(varName, value, persisted)UnsetGlobalVar(varName, persisted)
Signature
public void UnsetGlobalVar(string varName, bool persisted)Parameters
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetGlobalVar(varName, persisted)GetUserVar(userName, varName, persisted)
Signature
public T GetUserVar<T>(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetUserVar(userName, varName, persisted)SetUserVar(userName, varName, value, persisted)
Signature
public void SetUserVar(string userName, string varName, object value, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetUserVar(userName, varName, value, persisted)UnsetUserVar(userName, varName, persisted)
Signature
public void UnsetUserVar(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetUserVar(userName, varName, persisted)UnsetUser(userName, persisted)
Signature
public void UnsetUser(string userName, bool persisted)Parameters
userNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetUser(userName, persisted)UnsetAllUsersVar(varName, persisted)
Signature
public void UnsetAllUsersVar(string varName, bool persisted)Parameters
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetAllUsersVar(varName, persisted)GetTwitchUsersVar(varName, persisted)
Signature
public List<UserVariableValue<T>> GetTwitchUsersVar<T>(string varName, bool persisted)Parameters
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetTwitchUsersVar(varName, persisted)GetTwitchUserVarById(userId, varName, persisted)
Signature
public T GetTwitchUserVarById<T>(string userId, string varName, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetTwitchUserVarById(userId, varName, persisted)GetTwitchUserVar(userName, varName, persisted)
Signature
public T GetTwitchUserVar<T>(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetTwitchUserVar(userName, varName, persisted)SetTwitchUserVarById(userId, varName, value, persisted)
Signature
public void SetTwitchUserVarById(string userId, string varName, object value, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetTwitchUserVarById(userId, varName, value, persisted)SetTwitchUsersVarById(userIds, varName, value, persisted)
Signature
public void SetTwitchUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetTwitchUsersVarById(userIds, varName, value, persisted)IncrementAllTwitchUsersVar(varName, value, persisted)
Signature
public void IncrementAllTwitchUsersVar(string varName, object value, bool persisted)Parameters
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementAllTwitchUsersVar(varName, value, persisted)IncrementTwitchUsersVarById(userIds, varName, value, persisted)
Signature
public void IncrementTwitchUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementTwitchUsersVarById(userIds, varName, value, persisted)IncrementOrCreateTwitchUsersVarById(userIds, varName, value, persisted)
Signature
public void IncrementOrCreateTwitchUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementOrCreateTwitchUsersVarById(userIds, varName, value, persisted)SetTwitchUserVar(userName, varName, value, persisted)
Signature
public void SetTwitchUserVar(string userName, string varName, object value, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetTwitchUserVar(userName, varName, value, persisted)UnsetTwitchUserVarById(userId, varName, persisted)
Signature
public void UnsetTwitchUserVarById(string userId, string varName, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTwitchUserVarById(userId, varName, persisted)UnsetTwitchUserVar(userName, varName, persisted)
Signature
public void UnsetTwitchUserVar(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTwitchUserVar(userName, varName, persisted)UnsetTwitchUserById(userId, persisted)
Signature
public void UnsetTwitchUserById(string userId, bool persisted)Parameters
userIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTwitchUserById(userId, persisted)UnsetTwitchUser(userName, persisted)
Signature
public void UnsetTwitchUser(string userName, bool persisted)Parameters
userNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTwitchUser(userName, persisted)GetYouTubeUsersVar(varName, persisted)
Signature
public List<UserVariableValue<T>> GetYouTubeUsersVar<T>(string varName, bool persisted)Parameters
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetYouTubeUsersVar(varName, persisted)GetYouTubeUserVarById(userId, varName, persisted)
Signature
public T GetYouTubeUserVarById<T>(string userId, string varName, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetYouTubeUserVarById(userId, varName, persisted)GetYouTubeUserVar(userName, varName, persisted)
Signature
public T GetYouTubeUserVar<T>(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetYouTubeUserVar(userName, varName, persisted)SetYouTubeUserVarById(userId, varName, value, persisted)
Signature
public void SetYouTubeUserVarById(string userId, string varName, object value, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetYouTubeUserVarById(userId, varName, value, persisted)SetYouTubeUsersVarById(userIds, varName, value, persisted)
Signature
public void SetYouTubeUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetYouTubeUsersVarById(userIds, varName, value, persisted)IncrementAllYouTubeUsersVar(varName, value, persisted)
Signature
public void IncrementAllYouTubeUsersVar(string varName, object value, bool persisted)Parameters
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementAllYouTubeUsersVar(varName, value, persisted)IncrementYouTubeUsersVarById(userIds, varName, value, persisted)
Signature
public void IncrementYouTubeUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementYouTubeUsersVarById(userIds, varName, value, persisted)IncrementOrCreateYouTubeUsersVarById(userIds, varName, value, persisted)
Signature
public void IncrementOrCreateYouTubeUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementOrCreateYouTubeUsersVarById(userIds, varName, value, persisted)SetYouTubeUserVar(userName, varName, value, persisted)
Signature
public void SetYouTubeUserVar(string userName, string varName, object value, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetYouTubeUserVar(userName, varName, value, persisted)UnsetYouTubeUserVarById(userId, varName, persisted)
Signature
public void UnsetYouTubeUserVarById(string userId, string varName, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetYouTubeUserVarById(userId, varName, persisted)UnsetYouTubeUserVar(userName, varName, persisted)
Signature
public void UnsetYouTubeUserVar(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetYouTubeUserVar(userName, varName, persisted)UnsetYouTubeUserById(userId, persisted)
Signature
public void UnsetYouTubeUserById(string userId, bool persisted)Parameters
userIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetYouTubeUserById(userId, persisted)UnsetYouTubeUser(userName, persisted)
Signature
public void UnsetYouTubeUser(string userName, bool persisted)Parameters
userNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetYouTubeUser(userName, persisted)GetTrovoUsersVar(varName, persisted)
Signature
public List<UserVariableValue<T>> GetTrovoUsersVar<T>(string varName, bool persisted)Parameters
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetTrovoUsersVar(varName, persisted)GetTrovoUserVarById(userId, varName, persisted)
Signature
public T GetTrovoUserVarById<T>(string userId, string varName, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetTrovoUserVarById(userId, varName, persisted)GetTrovoUserVar(userName, varName, persisted)
Signature
public T GetTrovoUserVar<T>(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.GetTrovoUserVar(userName, varName, persisted)SetTrovoUserVarById(userId, varName, value, persisted)
Signature
public void SetTrovoUserVarById(string userId, string varName, object value, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetTrovoUserVarById(userId, varName, value, persisted)SetTrovoUsersVarById(userIds, varName, value, persisted)
Signature
public void SetTrovoUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetTrovoUsersVarById(userIds, varName, value, persisted)IncrementAllTrovoUsersVar(varName, value, persisted)
Signature
public void IncrementAllTrovoUsersVar(string varName, object value, bool persisted)Parameters
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementAllTrovoUsersVar(varName, value, persisted)IncrementTrovoUsersVarById(userIds, varName, value, persisted)
Signature
public void IncrementTrovoUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementTrovoUsersVarById(userIds, varName, value, persisted)IncrementOrCreateTrovoUsersVarById(userIds, varName, value, persisted)
Signature
public void IncrementOrCreateTrovoUsersVarById(List<string> userIds, string varName, object value, bool persisted)Parameters
userIdsrequired
List<string>
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.IncrementOrCreateTrovoUsersVarById(userIds, varName, value, persisted)SetTrovoUserVar(userName, varName, value, persisted)
Signature
public void SetTrovoUserVar(string userName, string varName, object value, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
valuerequired
object
default:
persisted
bool
default:
TrueCPH Code
CPH.SetTrovoUserVar(userName, varName, value, persisted)UnsetTrovoUserVarById(userId, varName, persisted)
Signature
public void UnsetTrovoUserVarById(string userId, string varName, bool persisted)Parameters
userIdrequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTrovoUserVarById(userId, varName, persisted)UnsetTrovoUserVar(userName, varName, persisted)
Signature
public void UnsetTrovoUserVar(string userName, string varName, bool persisted)Parameters
userNamerequired
string
default:
varNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTrovoUserVar(userName, varName, persisted)UnsetTrovoUserById(userId, persisted)
Signature
public void UnsetTrovoUserById(string userId, bool persisted)Parameters
userIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTrovoUserById(userId, persisted)UnsetTrovoUser(userName, persisted)
Signature
public void UnsetTrovoUser(string userName, bool persisted)Parameters
userNamerequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.UnsetTrovoUser(userName, persisted)WebsocketConnect(connection)
Signature
public void WebsocketConnect(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketConnect(connection)WebsocketDisconnect(connection)
Signature
public void WebsocketDisconnect(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketDisconnect(connection)WebsocketIsConnected(connection)
Signature
public bool WebsocketIsConnected(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketIsConnected(connection)WebsocketSend(data, connection)
Signature
public void WebsocketSend(string data, int connection)Parameters
datarequired
string
default:
connection
int
default:
0CPH Code
CPH.WebsocketSend(data, connection)WebsocketSend(data, connection)
Signature
public void WebsocketSend(System.Byte[] data, int connection)Parameters
datarequired
System.Byte[]
default:
connection
int
default:
0CPH Code
CPH.WebsocketSend(data, connection)WebsocketBroadcastString(data)
Signature
public void WebsocketBroadcastString(string data)Parameters
datarequired
string
default:
CPH Code
CPH.WebsocketBroadcastString(data)WebsocketBroadcastJson(data)
Signature
public void WebsocketBroadcastJson(string data)Parameters
datarequired
string
default:
CPH Code
CPH.WebsocketBroadcastJson(data)AddToCredits(section, value, json)
Signature
public void AddToCredits(string section, string value, bool json)Parameters
sectionrequired
string
default:
valuerequired
string
default:
json
bool
default:
TrueCPH Code
CPH.AddToCredits(section, value, json)ResetCredits()
Signature
public void ResetCredits()Parameters
No parametersCPH Code
CPH.ResetCredits()ExecuteMethod(executeCode, methodName)
Signature
public bool ExecuteMethod(string executeCode, string methodName)Parameters
executeCoderequired
string
default:
methodNamerequired
string
default:
CPH Code
CPH.ExecuteMethod(executeCode, methodName)PauseActionQueue(name)
Signature
public void PauseActionQueue(string name)Parameters
namerequired
string
default:
CPH Code
CPH.PauseActionQueue(name)PauseAllActionQueues()
Signature
public void PauseAllActionQueues()Parameters
No parametersCPH Code
CPH.PauseAllActionQueues()ResumeActionQueue(name, clear)
Signature
public void ResumeActionQueue(string name, bool clear)Parameters
namerequired
string
default:
clear
bool
default:
FalseCPH Code
CPH.ResumeActionQueue(name, clear)ResumeAllActionQueues(clear)
Signature
public void ResumeAllActionQueues(bool clear)Parameters
clear
bool
default:
FalseCPH Code
CPH.ResumeAllActionQueues(clear)ResetFirstWords()
Signature
public void ResetFirstWords()Parameters
No parametersCPH Code
CPH.ResetFirstWords()WebsocketCustomServerGetConnectionByName(name)
Signature
public int WebsocketCustomServerGetConnectionByName(string name)Parameters
namerequired
string
default:
CPH Code
CPH.WebsocketCustomServerGetConnectionByName(name)WebsocketCustomServerStart(connection)
Signature
public void WebsocketCustomServerStart(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketCustomServerStart(connection)WebsocketCustomServerStop(connection)
Signature
public void WebsocketCustomServerStop(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketCustomServerStop(connection)WebsocketCustomServerIsListening(connection)
Signature
public bool WebsocketCustomServerIsListening(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketCustomServerIsListening(connection)WebsocketCustomServerCloseAllSessions(connection)
Signature
public void WebsocketCustomServerCloseAllSessions(int connection)Parameters
connection
int
default:
0CPH Code
CPH.WebsocketCustomServerCloseAllSessions(connection)WebsocketCustomServerCloseSession(sessionId, connection)
Signature
public void WebsocketCustomServerCloseSession(string sessionId, int connection)Parameters
sessionIdrequired
string
default:
connection
int
default:
0CPH Code
CPH.WebsocketCustomServerCloseSession(sessionId, connection)WebsocketCustomServerBroadcast(data, sessionId, connection)
Signature
public void WebsocketCustomServerBroadcast(string data, string sessionId, int connection)Parameters
datarequired
string
default:
sessionIdrequired
string
default:
connection
int
default:
0CPH Code
CPH.WebsocketCustomServerBroadcast(data, sessionId, connection)TwitchPollCreate(title, choices, duration, channelPointsPerVote)
Signature
public bool TwitchPollCreate(string title, List<string> choices, int duration, int channelPointsPerVote)Parameters
titlerequired
string
default:
choicesrequired
List<string>
default:
durationrequired
int
default:
channelPointsPerVote
int
default:
0CPH Code
CPH.TwitchPollCreate(title, choices, duration, channelPointsPerVote)TwitchPollTerminate(pollId)
Signature
public void TwitchPollTerminate(string pollId)Parameters
pollIdrequired
string
default:
CPH Code
CPH.TwitchPollTerminate(pollId)TwitchPollArchive(pollId)
Signature
public void TwitchPollArchive(string pollId)Parameters
pollIdrequired
string
default:
CPH Code
CPH.TwitchPollArchive(pollId)TwitchSubscriberOnly(enabled)
Signature
public void TwitchSubscriberOnly(bool enabled)Parameters
enabled
bool
default:
TrueCPH Code
CPH.TwitchSubscriberOnly(enabled)TwitchEmoteOnly(enabled)
Signature
public void TwitchEmoteOnly(bool enabled)Parameters
enabled
bool
default:
TrueCPH Code
CPH.TwitchEmoteOnly(enabled)TwitchSlowMode(enabled, duration)
Signature
public void TwitchSlowMode(bool enabled, int duration)Parameters
enabled
bool
default:
Trueduration
int
default:
0CPH Code
CPH.TwitchSlowMode(enabled, duration)TwitchFollowMode(enabled, duration)
Signature
public void TwitchFollowMode(bool enabled, int duration)Parameters
enabled
bool
default:
Trueduration
int
default:
0CPH Code
CPH.TwitchFollowMode(enabled, duration)TwitchPredictionCreate(title, firstOption, secondOption, duration)
Signature
public string TwitchPredictionCreate(string title, string firstOption, string secondOption, int duration)Parameters
titlerequired
string
default:
firstOptionrequired
string
default:
secondOptionrequired
string
default:
durationrequired
int
default:
CPH Code
CPH.TwitchPredictionCreate(title, firstOption, secondOption, duration)TwitchPredictionCreate(title, options, duration)
Signature
public string TwitchPredictionCreate(string title, List<string> options, int duration)Parameters
titlerequired
string
default:
optionsrequired
List<string>
default:
durationrequired
int
default:
CPH Code
CPH.TwitchPredictionCreate(title, options, duration)TwitchPredictionCancel(predictionId)
Signature
public void TwitchPredictionCancel(string predictionId)Parameters
predictionIdrequired
string
default:
CPH Code
CPH.TwitchPredictionCancel(predictionId)TwitchPredictionLock(predictionId)
Signature
public void TwitchPredictionLock(string predictionId)Parameters
predictionIdrequired
string
default:
CPH Code
CPH.TwitchPredictionLock(predictionId)TwitchPredictionResolve(predictionId, winningId)
Signature
public void TwitchPredictionResolve(string predictionId, string winningId)Parameters
predictionIdrequired
string
default:
winningIdrequired
string
default:
CPH Code
CPH.TwitchPredictionResolve(predictionId, winningId)TwitchRunCommercial(duration)
Signature
public bool TwitchRunCommercial(int duration)Parameters
durationrequired
int
default:
CPH Code
CPH.TwitchRunCommercial(duration)TwitchAnnounce(message, bot, color, fallback)
Signature
public void TwitchAnnounce(string message, bool bot, string color, bool fallback)Parameters
messagerequired
string
default:
bot
bool
default:
Falsecolor
string
default:
fallback
bool
default:
FalseCPH Code
CPH.TwitchAnnounce(message, bot, color, fallback)TwitchStartRaidById(userId)
Signature
public bool TwitchStartRaidById(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchStartRaidById(userId)TwitchStartRaidByName(userName)
Signature
public bool TwitchStartRaidByName(string userName)Parameters
userNamerequired
string
default:
CPH Code
CPH.TwitchStartRaidByName(userName)TwitchCancelRaid()
Signature
public bool TwitchCancelRaid()Parameters
No parametersCPH Code
CPH.TwitchCancelRaid()TwitchSendShoutoutById(userId)
Signature
public bool TwitchSendShoutoutById(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchSendShoutoutById(userId)TwitchSendShoutoutByLogin(userLogin)
Signature
public bool TwitchSendShoutoutByLogin(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.TwitchSendShoutoutByLogin(userLogin)TwitchShieldModeOn()
Signature
public bool TwitchShieldModeOn()Parameters
No parametersCPH Code
CPH.TwitchShieldModeOn()TwitchShieldModeOff()
Signature
public bool TwitchShieldModeOff()Parameters
No parametersCPH Code
CPH.TwitchShieldModeOff()GetCommands()
Signature
public List<Streamer.bot.Plugin.Interface.Model.CommandData> GetCommands()Parameters
No parametersCPH Code
CPH.GetCommands()EnableCommand(id)
Signature
public void EnableCommand(string id)Parameters
idrequired
string
default:
CPH Code
CPH.EnableCommand(id)DisableCommand(id)
Signature
public void DisableCommand(string id)Parameters
idrequired
string
default:
CPH Code
CPH.DisableCommand(id)CommandResetGlobalCooldown(id)
Signature
public void CommandResetGlobalCooldown(string id)Parameters
idrequired
string
default:
CPH Code
CPH.CommandResetGlobalCooldown(id)CommandRemoveGlobalCooldown(id)
Signature
public void CommandRemoveGlobalCooldown(string id)Parameters
idrequired
string
default:
CPH Code
CPH.CommandRemoveGlobalCooldown(id)CommandAddToGlobalCooldown(id, seconds)
Signature
public void CommandAddToGlobalCooldown(string id, int seconds)Parameters
idrequired
string
default:
secondsrequired
int
default:
CPH Code
CPH.CommandAddToGlobalCooldown(id, seconds)CommandResetUserCooldown(id, userId)
Signature
public void CommandResetUserCooldown(string id, int userId)Parameters
idrequired
string
default:
userIdrequired
int
default:
CPH Code
CPH.CommandResetUserCooldown(id, userId)CommandResetUserCooldown(id, userId, platform)
Signature
public void CommandResetUserCooldown(string id, string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform)Parameters
idrequired
string
default:
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
CPH Code
CPH.CommandResetUserCooldown(id, userId, platform)CommandRemoveUserCooldown(id, userId)
Signature
public void CommandRemoveUserCooldown(string id, int userId)Parameters
idrequired
string
default:
userIdrequired
int
default:
CPH Code
CPH.CommandRemoveUserCooldown(id, userId)CommandRemoveUserCooldown(id, userId, platform)
Signature
public void CommandRemoveUserCooldown(string id, string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform)Parameters
idrequired
string
default:
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
CPH Code
CPH.CommandRemoveUserCooldown(id, userId, platform)CommandAddToUserCooldown(id, userId, seconds)
Signature
public void CommandAddToUserCooldown(string id, int userId, int seconds)Parameters
idrequired
string
default:
userIdrequired
int
default:
secondsrequired
int
default:
CPH Code
CPH.CommandAddToUserCooldown(id, userId, seconds)CommandAddToUserCooldown(id, userId, platform, seconds)
Signature
public void CommandAddToUserCooldown(string id, string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform, int seconds)Parameters
idrequired
string
default:
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
secondsrequired
int
default:
CPH Code
CPH.CommandAddToUserCooldown(id, userId, platform, seconds)CommandResetAllUserCooldowns(id)
Signature
public void CommandResetAllUserCooldowns(string id)Parameters
idrequired
string
default:
CPH Code
CPH.CommandResetAllUserCooldowns(id)CommandRemoveAllUserCooldowns(id)
Signature
public void CommandRemoveAllUserCooldowns(string id)Parameters
idrequired
string
default:
CPH Code
CPH.CommandRemoveAllUserCooldowns(id)CommandAddToAllUserCooldowns(id, seconds)
Signature
public void CommandAddToAllUserCooldowns(string id, int seconds)Parameters
idrequired
string
default:
secondsrequired
int
default:
CPH Code
CPH.CommandAddToAllUserCooldowns(id, seconds)CommandSetGlobalCooldownDuration(id, seconds)
Signature
public void CommandSetGlobalCooldownDuration(string id, int seconds)Parameters
idrequired
string
default:
secondsrequired
int
default:
CPH Code
CPH.CommandSetGlobalCooldownDuration(id, seconds)CommandSetUserCooldownDuration(id, seconds)
Signature
public void CommandSetUserCooldownDuration(string id, int seconds)Parameters
idrequired
string
default:
secondsrequired
int
default:
CPH Code
CPH.CommandSetUserCooldownDuration(id, seconds)CommandGetCounter(commandId)
Signature
public int CommandGetCounter(string commandId)Parameters
commandIdrequired
string
default:
CPH Code
CPH.CommandGetCounter(commandId)CommandGetUserCounter(userLogin, platform, commandId)
Signature
public Streamer.bot.Plugin.Interface.Model.CommandCounter CommandGetUserCounter(string userLogin, Streamer.bot.Plugin.Interface.Enums.Platform platform, string commandId)Parameters
userLoginrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
commandIdrequired
string
default:
CPH Code
CPH.CommandGetUserCounter(userLogin, platform, commandId)CommandGetUserCounterById(userId, platform, commandId)
Signature
public Streamer.bot.Plugin.Interface.Model.CommandCounter CommandGetUserCounterById(string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform, string commandId)Parameters
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
commandIdrequired
string
default:
CPH Code
CPH.CommandGetUserCounterById(userId, platform, commandId)CommandResetCounter(commandId)
Signature
public void CommandResetCounter(string commandId)Parameters
commandIdrequired
string
default:
CPH Code
CPH.CommandResetCounter(commandId)CommandResetAllUserCounters(commandId)
Signature
public void CommandResetAllUserCounters(string commandId)Parameters
commandIdrequired
string
default:
CPH Code
CPH.CommandResetAllUserCounters(commandId)CommandResetUsersCounters(userId, platform, persisted)
Signature
public void CommandResetUsersCounters(string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform, bool persisted)Parameters
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
persistedrequired
bool
default:
CPH Code
CPH.CommandResetUsersCounters(userId, platform, persisted)CommandResetUserCounter(commandId, userId, platform)
Signature
public void CommandResetUserCounter(string commandId, string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform)Parameters
commandIdrequired
string
default:
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
CPH Code
CPH.CommandResetUserCounter(commandId, userId, platform)TtsSpeak(voiceAlias, message, badWordFilter)
Signature
public int TtsSpeak(string voiceAlias, string message, bool badWordFilter)Parameters
voiceAliasrequired
string
default:
messagerequired
string
default:
badWordFilter
bool
default:
FalseCPH Code
CPH.TtsSpeak(voiceAlias, message, badWordFilter)TwitchResetRewardUserCounters(rewardId)
Signature
public void TwitchResetRewardUserCounters(string rewardId)Parameters
rewardIdrequired
string
default:
CPH Code
CPH.TwitchResetRewardUserCounters(rewardId)TwitchResetUserRewardCounters(userId, persisted)
Signature
public void TwitchResetUserRewardCounters(string userId, bool persisted)Parameters
userIdrequired
string
default:
persistedrequired
bool
default:
CPH Code
CPH.TwitchResetUserRewardCounters(userId, persisted)TwitchResetUserRewardCounter(rewardId, userId)
Signature
public void TwitchResetUserRewardCounter(string rewardId, string userId)Parameters
rewardIdrequired
string
default:
userIdrequired
string
default:
CPH Code
CPH.TwitchResetUserRewardCounter(rewardId, userId)TwitchGetRewardCounter(rewardId, persisted)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchRewardCounter TwitchGetRewardCounter(string rewardId, bool persisted)Parameters
rewardIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.TwitchGetRewardCounter(rewardId, persisted)TwitchGetRewardUserCounter(userLogin, rewardId, persisted)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchRewardCounter TwitchGetRewardUserCounter(string userLogin, string rewardId, bool persisted)Parameters
userLoginrequired
string
default:
rewardIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.TwitchGetRewardUserCounter(userLogin, rewardId, persisted)TwitchGetRewardUserCounterById(userId, rewardId, persisted)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchRewardCounter TwitchGetRewardUserCounterById(string userId, string rewardId, bool persisted)Parameters
userIdrequired
string
default:
rewardIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.TwitchGetRewardUserCounterById(userId, rewardId, persisted)TwitchGetRewardUserCounters(rewardId, persisted)
Signature
public List<Streamer.bot.Plugin.Interface.Model.TwitchRewardCounter> TwitchGetRewardUserCounters(string rewardId, bool persisted)Parameters
rewardIdrequired
string
default:
persisted
bool
default:
TrueCPH Code
CPH.TwitchGetRewardUserCounters(rewardId, persisted)TwitchRewardGroupEnable(groupName)
Signature
public void TwitchRewardGroupEnable(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.TwitchRewardGroupEnable(groupName)TwitchRewardGroupDisable(groupName)
Signature
public void TwitchRewardGroupDisable(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.TwitchRewardGroupDisable(groupName)TwitchRewardGroupToggleEnable(groupName)
Signature
public void TwitchRewardGroupToggleEnable(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.TwitchRewardGroupToggleEnable(groupName)TwitchRewardGroupPause(groupName)
Signature
public void TwitchRewardGroupPause(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.TwitchRewardGroupPause(groupName)TwitchRewardGroupUnPause(groupName)
Signature
public void TwitchRewardGroupUnPause(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.TwitchRewardGroupUnPause(groupName)TwitchRewardGroupTogglePause(groupName)
Signature
public void TwitchRewardGroupTogglePause(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.TwitchRewardGroupTogglePause(groupName)TwitchGetRewards()
Signature
public List<Streamer.bot.Plugin.Interface.TwitchReward> TwitchGetRewards()Parameters
No parametersCPH Code
CPH.TwitchGetRewards()TwitchGetBitsDonatedByUserId(userId)
Signature
public long TwitchGetBitsDonatedByUserId(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchGetBitsDonatedByUserId(userId)TwitchIsUserSubscribed(userId, tier)
Signature
public bool TwitchIsUserSubscribed(string userId, out System.String& tier)Parameters
userIdrequired
string
default:
tierrequired
System.String&
default:
CPH Code
CPH.TwitchIsUserSubscribed(userId, tier)PlaySound(fileName, volume, finishBeforeContinuing, name, useFileName)
Signature
public double PlaySound(string fileName, System.Single volume, bool finishBeforeContinuing, string name, bool useFileName)Parameters
fileNamerequired
string
default:
volume
System.Single
default:
1finishBeforeContinuing
bool
default:
Falsename
string
default:
useFileName
bool
default:
TrueCPH Code
CPH.PlaySound(fileName, volume, finishBeforeContinuing, name, useFileName)PlaySoundFromFolder(path, volume, recursive, finishBeforeContinuing, name, useFileName)
Signature
public double PlaySoundFromFolder(string path, System.Single volume, bool recursive, bool finishBeforeContinuing, string name, bool useFileName)Parameters
pathrequired
string
default:
volume
System.Single
default:
1recursive
bool
default:
FalsefinishBeforeContinuing
bool
default:
Falsename
string
default:
useFileName
bool
default:
TrueCPH Code
CPH.PlaySoundFromFolder(path, volume, recursive, finishBeforeContinuing, name, useFileName)StopAllSoundPlayback()
Signature
public void StopAllSoundPlayback()Parameters
No parametersCPH Code
CPH.StopAllSoundPlayback()StopSoundPlayback(soundName)
Signature
public void StopSoundPlayback(string soundName)Parameters
soundNamerequired
string
default:
CPH Code
CPH.StopSoundPlayback(soundName)BroadcastUdp(port, data)
Signature
public int BroadcastUdp(int port, object data)Parameters
portrequired
int
default:
datarequired
object
default:
CPH Code
CPH.BroadcastUdp(port, data)ObsGetConnectionByName(name)
Signature
public int ObsGetConnectionByName(string name)Parameters
namerequired
string
default:
CPH Code
CPH.ObsGetConnectionByName(name)ObsConvertRgb(a, r, g, b)
Signature
public long ObsConvertRgb(int a, int r, int g, int b)Parameters
arequired
int
default:
rrequired
int
default:
grequired
int
default:
brequired
int
default:
CPH Code
CPH.ObsConvertRgb(a, r, g, b)ObsConvertColorHex(colorHex)
Signature
public long ObsConvertColorHex(string colorHex)Parameters
colorHexrequired
string
default:
CPH Code
CPH.ObsConvertColorHex(colorHex)ObsIsConnected(connection)
Signature
public bool ObsIsConnected(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsIsConnected(connection)ObsConnect(connection)
Signature
public bool ObsConnect(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsConnect(connection)ObsDisconnect(connection)
Signature
public void ObsDisconnect(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsDisconnect(connection)ObsIsStreaming(connection)
Signature
public bool ObsIsStreaming(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsIsStreaming(connection)ObsStopStreaming(connection)
Signature
public void ObsStopStreaming(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsStopStreaming(connection)ObsStartStreaming(connection)
Signature
public void ObsStartStreaming(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsStartStreaming(connection)ObsIsRecording(connection)
Signature
public bool ObsIsRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsIsRecording(connection)ObsStartRecording(connection)
Signature
public void ObsStartRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsStartRecording(connection)ObsStopRecording(connection)
Signature
public void ObsStopRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsStopRecording(connection)ObsPauseRecording(connection)
Signature
public void ObsPauseRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsPauseRecording(connection)ObsResumeRecording(connection)
Signature
public void ObsResumeRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsResumeRecording(connection)ObsSetScene(sceneName, connection)
Signature
public void ObsSetScene(string sceneName, int connection)Parameters
sceneNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetScene(sceneName, connection)ObsGetCurrentScene(connection)
Signature
public string ObsGetCurrentScene(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsGetCurrentScene(connection)ObsIsSourceVisible(scene, source, connection)
Signature
public bool ObsIsSourceVisible(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsIsSourceVisible(scene, source, connection)ObsSetSourceVisibility(scene, source, visible, connection)
Signature
public void ObsSetSourceVisibility(string scene, string source, bool visible, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
visiblerequired
bool
default:
connection
int
default:
0CPH Code
CPH.ObsSetSourceVisibility(scene, source, visible, connection)ObsSetSourceVisibilityState(scene, source, state, connection)
Signature
public void ObsSetSourceVisibilityState(string scene, string source, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetSourceVisibilityState(scene, source, state, connection)ObsShowSource(scene, source, connection)
Signature
public void ObsShowSource(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsShowSource(scene, source, connection)ObsHideSource(scene, source, connection)
Signature
public void ObsHideSource(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideSource(scene, source, connection)ObsHideGroupsSources(scene, groupName, connection)
Signature
public void ObsHideGroupsSources(string scene, string groupName, int connection)Parameters
scenerequired
string
default:
groupNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideGroupsSources(scene, groupName, connection)ObsSetRandomGroupSourceVisible(scene, groupName, connection)
Signature
public string ObsSetRandomGroupSourceVisible(string scene, string groupName, int connection)Parameters
scenerequired
string
default:
groupNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetRandomGroupSourceVisible(scene, groupName, connection)ObsGetGroupSources(scene, groupName, connection)
Signature
public List<string> ObsGetGroupSources(string scene, string groupName, int connection)Parameters
scenerequired
string
default:
groupNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsGetGroupSources(scene, groupName, connection)ObsSetBrowserSource(scene, source, url, connection)
Signature
public void ObsSetBrowserSource(string scene, string source, string url, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
urlrequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetBrowserSource(scene, source, url, connection)ObsSetGdiText(scene, source, text, connection)
Signature
public void ObsSetGdiText(string scene, string source, string text, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
textrequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetGdiText(scene, source, text, connection)ObsIsFilterEnabled(scene, filterName, connection)
Signature
public bool ObsIsFilterEnabled(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsIsFilterEnabled(scene, filterName, connection)ObsIsFilterEnabled(scene, source, filterName, connection)
Signature
public bool ObsIsFilterEnabled(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsIsFilterEnabled(scene, source, filterName, connection)ObsSetFilterState(scene, filterName, state, connection)
Signature
public void ObsSetFilterState(string scene, string filterName, int state, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetFilterState(scene, filterName, state, connection)ObsSetFilterState(scene, source, filterName, state, connection)
Signature
public void ObsSetFilterState(string scene, string source, string filterName, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetFilterState(scene, source, filterName, state, connection)ObsShowFilter(scene, filterName, connection)
Signature
public void ObsShowFilter(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsShowFilter(scene, filterName, connection)ObsShowFilter(scene, source, filterName, connection)
Signature
public void ObsShowFilter(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsShowFilter(scene, source, filterName, connection)ObsHideFilter(scene, filterName, connection)
Signature
public void ObsHideFilter(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideFilter(scene, filterName, connection)ObsHideFilter(scene, source, filterName, connection)
Signature
public void ObsHideFilter(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideFilter(scene, source, filterName, connection)ObsHideSourcesFilters(scene, source, connection)
Signature
public void ObsHideSourcesFilters(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideSourcesFilters(scene, source, connection)ObsHideScenesFilters(scene, connection)
Signature
public void ObsHideScenesFilters(string scene, int connection)Parameters
scenerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideScenesFilters(scene, connection)ObsToggleFilter(scene, filterName, connection)
Signature
public void ObsToggleFilter(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsToggleFilter(scene, filterName, connection)ObsToggleFilter(scene, source, filterName, connection)
Signature
public void ObsToggleFilter(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsToggleFilter(scene, source, filterName, connection)ObsSetRandomFilterState(scene, state, connection)
Signature
public void ObsSetRandomFilterState(string scene, int state, int connection)Parameters
scenerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetRandomFilterState(scene, state, connection)ObsSetRandomFilterState(scene, source, state, connection)
Signature
public void ObsSetRandomFilterState(string scene, string source, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetRandomFilterState(scene, source, state, connection)ObsSetSourceMuteState(scene, source, state, connection)
Signature
public void ObsSetSourceMuteState(string scene, string source, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetSourceMuteState(scene, source, state, connection)ObsSourceMute(scene, source, connection)
Signature
public void ObsSourceMute(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSourceMute(scene, source, connection)ObsSourceUnMute(scene, source, connection)
Signature
public void ObsSourceUnMute(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSourceUnMute(scene, source, connection)ObsSourceMuteToggle(scene, source, connection)
Signature
public void ObsSourceMuteToggle(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSourceMuteToggle(scene, source, connection)ObsSendRaw(requestType, data, connection)
Signature
public string ObsSendRaw(string requestType, string data, int connection)Parameters
requestTyperequired
string
default:
datarequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSendRaw(requestType, data, connection)ObsSendBatchRaw(data, haltOnFailure, executionType, connection)
Signature
public string ObsSendBatchRaw(string data, bool haltOnFailure, int executionType, int connection)Parameters
datarequired
string
default:
haltOnFailure
bool
default:
FalseexecutionType
int
default:
0connection
int
default:
0CPH Code
CPH.ObsSendBatchRaw(data, haltOnFailure, executionType, connection)ObsSetMediaState(scene, source, state, connection)
Signature
public void ObsSetMediaState(string scene, string source, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetMediaState(scene, source, state, connection)ObsMediaPlay(scene, source, connection)
Signature
public void ObsMediaPlay(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsMediaPlay(scene, source, connection)ObsMediaPause(scene, source, connection)
Signature
public void ObsMediaPause(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsMediaPause(scene, source, connection)ObsMediaRestart(scene, source, connection)
Signature
public void ObsMediaRestart(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsMediaRestart(scene, source, connection)ObsMediaStop(scene, source, connection)
Signature
public void ObsMediaStop(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsMediaStop(scene, source, connection)ObsMediaNext(scene, source, connection)
Signature
public void ObsMediaNext(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsMediaNext(scene, source, connection)ObsMediaPrevious(scene, source, connection)
Signature
public void ObsMediaPrevious(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsMediaPrevious(scene, source, connection)ObsSetReplayBufferState(state, connection)
Signature
public void ObsSetReplayBufferState(int state, int connection)Parameters
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetReplayBufferState(state, connection)ObsReplayBufferStart(connection)
Signature
public void ObsReplayBufferStart(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsReplayBufferStart(connection)ObsReplayBufferStop(connection)
Signature
public void ObsReplayBufferStop(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsReplayBufferStop(connection)ObsReplayBufferSave(connection)
Signature
public void ObsReplayBufferSave(int connection)Parameters
connection
int
default:
0CPH Code
CPH.ObsReplayBufferSave(connection)ObsSetMediaSourceFile(scene, source, file, connection)
Signature
public void ObsSetMediaSourceFile(string scene, string source, string file, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetMediaSourceFile(scene, source, file, connection)ObsSetImageSourceFile(scene, source, file, connection)
Signature
public void ObsSetImageSourceFile(string scene, string source, string file, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetImageSourceFile(scene, source, file, connection)ObsGetSceneItemProperties(scene, source, connection)
Signature
public string ObsGetSceneItemProperties(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsGetSceneItemProperties(scene, source, connection)ObsHideSceneSources(scene, connection)
Signature
public void ObsHideSceneSources(string scene, int connection)Parameters
scenerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsHideSceneSources(scene, connection)ObsSetRandomSceneSourceVisible(scene, connection)
Signature
public string ObsSetRandomSceneSourceVisible(string scene, int connection)Parameters
scenerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetRandomSceneSourceVisible(scene, connection)ObsTakeScreenshot(source, path, quality, connection)
Signature
public bool ObsTakeScreenshot(string source, string path, int quality, int connection)Parameters
sourcerequired
string
default:
pathrequired
string
default:
quality
int
default:
-1connection
int
default:
0CPH Code
CPH.ObsTakeScreenshot(source, path, quality, connection)ObsSetColorSourceColor(scene, source, a, r, g, b, connection)
Signature
public void ObsSetColorSourceColor(string scene, string source, int a, int r, int g, int b, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
arequired
int
default:
rrequired
int
default:
grequired
int
default:
brequired
int
default:
connection
int
default:
0CPH Code
CPH.ObsSetColorSourceColor(scene, source, a, r, g, b, connection)ObsSetColorSourceColor(scene, source, hexColor, connection)
Signature
public void ObsSetColorSourceColor(string scene, string source, string hexColor, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
hexColorrequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetColorSourceColor(scene, source, hexColor, connection)ObsSetColorSourceRandomColor(scene, source, connection)
Signature
public void ObsSetColorSourceRandomColor(string scene, string source, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsSetColorSourceRandomColor(scene, source, connection)ObsCreateRecordChapter(chapterName, connection)
Signature
public bool ObsCreateRecordChapter(string chapterName, int connection)Parameters
chapterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.ObsCreateRecordChapter(chapterName, connection)SlobsIsConnected(connection)
Signature
public bool SlobsIsConnected(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsIsConnected(connection)SlobsConnect(connection)
Signature
public bool SlobsConnect(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsConnect(connection)SlobsDisconnect(connection)
Signature
public void SlobsDisconnect(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsDisconnect(connection)SlobsIsStreaming(connection)
Signature
public bool SlobsIsStreaming(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsIsStreaming(connection)SlobsStopStreaming(connection)
Signature
public void SlobsStopStreaming(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsStopStreaming(connection)SlobsStartStreaming(connection)
Signature
public void SlobsStartStreaming(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsStartStreaming(connection)SlobsIsRecording(connection)
Signature
public bool SlobsIsRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsIsRecording(connection)SlobsStartRecording(connection)
Signature
public void SlobsStartRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsStartRecording(connection)SlobsStopRecording(connection)
Signature
public void SlobsStopRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsStopRecording(connection)SlobsPauseRecording(connection)
Signature
public void SlobsPauseRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsPauseRecording(connection)SlobsResumeRecording(connection)
Signature
public void SlobsResumeRecording(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsResumeRecording(connection)SlobsSetScene(sceneName, connection)
Signature
public void SlobsSetScene(string sceneName, int connection)Parameters
sceneNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsSetScene(sceneName, connection)SlobsGetCurrentScene(connection)
Signature
public string SlobsGetCurrentScene(int connection)Parameters
connection
int
default:
0CPH Code
CPH.SlobsGetCurrentScene(connection)SlobsIsSourceVisible(scene, source, output, connection)
Signature
public bool SlobsIsSourceVisible(string scene, string source, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsIsSourceVisible(scene, source, output, connection)SlobsSetSourceVisibility(scene, source, visible, output, connection)
Signature
public void SlobsSetSourceVisibility(string scene, string source, bool visible, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
visiblerequired
bool
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsSetSourceVisibility(scene, source, visible, output, connection)SlobsSetSourceVisibilityState(scene, source, state, output, connection)
Signature
public void SlobsSetSourceVisibilityState(string scene, string source, int state, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsSetSourceVisibilityState(scene, source, state, output, connection)SlobsShowSource(scene, source, output, connection)
Signature
public void SlobsShowSource(string scene, string source, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsShowSource(scene, source, output, connection)SlobsHideSource(scene, source, output, connection)
Signature
public void SlobsHideSource(string scene, string source, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsHideSource(scene, source, output, connection)SlobsHideGroupsSources(scene, groupName, output, connection)
Signature
public void SlobsHideGroupsSources(string scene, string groupName, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
groupNamerequired
string
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsHideGroupsSources(scene, groupName, output, connection)SlobsSetRandomGroupSourceVisible(scene, groupName, output, connection)
Signature
public string SlobsSetRandomGroupSourceVisible(string scene, string groupName, Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType output, int connection)Parameters
scenerequired
string
default:
groupNamerequired
string
default:
output
Streamer.bot.Plugin.Interface.Enums.StreamlabsDesktopOutputType
default:
Bothconnection
int
default:
0CPH Code
CPH.SlobsSetRandomGroupSourceVisible(scene, groupName, output, connection)SlobsGetGroupSources(scene, groupName, connection)
Signature
public List<string> SlobsGetGroupSources(string scene, string groupName, int connection)Parameters
scenerequired
string
default:
groupNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsGetGroupSources(scene, groupName, connection)SlobsSetBrowserSource(scene, source, url, connection)
Signature
public void SlobsSetBrowserSource(string scene, string source, string url, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
urlrequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsSetBrowserSource(scene, source, url, connection)SlobsSetGdiText(scene, source, text, connection)
Signature
public void SlobsSetGdiText(string scene, string source, string text, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
textrequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsSetGdiText(scene, source, text, connection)SlobsIsFilterEnabled(scene, filterName, connection)
Signature
public bool SlobsIsFilterEnabled(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsIsFilterEnabled(scene, filterName, connection)SlobsIsFilterEnabled(scene, source, filterName, connection)
Signature
public bool SlobsIsFilterEnabled(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsIsFilterEnabled(scene, source, filterName, connection)SlobsSetFilterState(scene, filterName, state, connection)
Signature
public void SlobsSetFilterState(string scene, string filterName, int state, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.SlobsSetFilterState(scene, filterName, state, connection)SlobsSetFilterState(scene, source, filterName, state, connection)
Signature
public void SlobsSetFilterState(string scene, string source, string filterName, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.SlobsSetFilterState(scene, source, filterName, state, connection)SlobsShowFilter(scene, filterName, connection)
Signature
public void SlobsShowFilter(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsShowFilter(scene, filterName, connection)SlobsShowFilter(scene, source, filterName, connection)
Signature
public void SlobsShowFilter(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsShowFilter(scene, source, filterName, connection)SlobsHideFilter(scene, filterName, connection)
Signature
public void SlobsHideFilter(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsHideFilter(scene, filterName, connection)SlobsHideFilter(scene, source, filterName, connection)
Signature
public void SlobsHideFilter(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsHideFilter(scene, source, filterName, connection)SlobsToggleFilter(scene, filterName, connection)
Signature
public void SlobsToggleFilter(string scene, string filterName, int connection)Parameters
scenerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsToggleFilter(scene, filterName, connection)SlobsToggleFilter(scene, source, filterName, connection)
Signature
public void SlobsToggleFilter(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsToggleFilter(scene, source, filterName, connection)SlobsSetRandomFilterState(scene, state, connection)
Signature
public void SlobsSetRandomFilterState(string scene, int state, int connection)Parameters
scenerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.SlobsSetRandomFilterState(scene, state, connection)SlobsSetRandomFilterState(scene, source, state, connection)
Signature
public void SlobsSetRandomFilterState(string scene, string source, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.SlobsSetRandomFilterState(scene, source, state, connection)SlobsSetSourceMuteState(scene, source, state, connection)
Signature
public void SlobsSetSourceMuteState(string scene, string source, int state, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
staterequired
int
default:
connection
int
default:
0CPH Code
CPH.SlobsSetSourceMuteState(scene, source, state, connection)SlobsSourceMute(scene, source, filterName, connection)
Signature
public void SlobsSourceMute(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsSourceMute(scene, source, filterName, connection)SlobsSourceUnMute(scene, source, filterName, connection)
Signature
public void SlobsSourceUnMute(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsSourceUnMute(scene, source, filterName, connection)SlobsSourceMuteToggle(scene, source, filterName, connection)
Signature
public void SlobsSourceMuteToggle(string scene, string source, string filterName, int connection)Parameters
scenerequired
string
default:
sourcerequired
string
default:
filterNamerequired
string
default:
connection
int
default:
0CPH Code
CPH.SlobsSourceMuteToggle(scene, source, filterName, connection)ClearNonPersistedGlobals()
Signature
public void ClearNonPersistedGlobals()Parameters
No parametersCPH Code
CPH.ClearNonPersistedGlobals()get_TwitchClientId()
Signature
public string get_TwitchClientId()Parameters
No parametersCPH Code
CPH.get_TwitchClientId()get_TwitchOAuthToken()
Signature
public string get_TwitchOAuthToken()Parameters
No parametersCPH Code
CPH.get_TwitchOAuthToken()GetVersion()
Signature
public string GetVersion()Parameters
No parametersCPH Code
CPH.GetVersion()Between(min, max)
Signature
public int Between(int min, int max)Parameters
minrequired
int
default:
maxrequired
int
default:
CPH Code
CPH.Between(min, max)NextDouble()
Signature
public double NextDouble()Parameters
No parametersCPH Code
CPH.NextDouble()Wait(milliseconds)
Signature
public void Wait(int milliseconds)Parameters
millisecondsrequired
int
default:
CPH Code
CPH.Wait(milliseconds)UrlEncode(text)
Signature
public string UrlEncode(string text)Parameters
textrequired
string
default:
CPH Code
CPH.UrlEncode(text)EscapeString(text)
Signature
public string EscapeString(string text)Parameters
textrequired
string
default:
CPH Code
CPH.EscapeString(text)GetGroups()
Signature
public List<string> GetGroups()Parameters
No parametersCPH Code
CPH.GetGroups()GroupExists(groupName)
Signature
public bool GroupExists(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.GroupExists(groupName)DeleteGroup(groupName)
Signature
public bool DeleteGroup(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.DeleteGroup(groupName)AddGroup(groupName)
Signature
public bool AddGroup(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.AddGroup(groupName)UserIdInGroup(userId, platform, groupName)
Signature
public bool UserIdInGroup(string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform, string groupName)Parameters
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
groupNamerequired
string
default:
CPH Code
CPH.UserIdInGroup(userId, platform, groupName)UserInGroup(userName, platform, groupName)
Signature
public bool UserInGroup(string userName, Streamer.bot.Plugin.Interface.Enums.Platform platform, string groupName)Parameters
userNamerequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
groupNamerequired
string
default:
CPH Code
CPH.UserInGroup(userName, platform, groupName)UsersInGroup(groupName)
Signature
public List<Streamer.bot.Plugin.Interface.Model.GroupUser> UsersInGroup(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.UsersInGroup(groupName)AddUserIdToGroup(userId, platform, groupName)
Signature
public bool AddUserIdToGroup(string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform, string groupName)Parameters
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
groupNamerequired
string
default:
CPH Code
CPH.AddUserIdToGroup(userId, platform, groupName)AddUserToGroup(userName, platform, groupName)
Signature
public bool AddUserToGroup(string userName, Streamer.bot.Plugin.Interface.Enums.Platform platform, string groupName)Parameters
userNamerequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
groupNamerequired
string
default:
CPH Code
CPH.AddUserToGroup(userName, platform, groupName)RemoveUserIdFromGroup(userId, platform, groupName)
Signature
public bool RemoveUserIdFromGroup(string userId, Streamer.bot.Plugin.Interface.Enums.Platform platform, string groupName)Parameters
userIdrequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
groupNamerequired
string
default:
CPH Code
CPH.RemoveUserIdFromGroup(userId, platform, groupName)RemoveUserFromGroup(userName, platform, groupName)
Signature
public bool RemoveUserFromGroup(string userName, Streamer.bot.Plugin.Interface.Enums.Platform platform, string groupName)Parameters
userNamerequired
string
default:
platformrequired
Streamer.bot.Plugin.Interface.Enums.Platform
default:
groupNamerequired
string
default:
CPH Code
CPH.RemoveUserFromGroup(userName, platform, groupName)ClearUsersFromGroup(groupName)
Signature
public bool ClearUsersFromGroup(string groupName)Parameters
groupNamerequired
string
default:
CPH Code
CPH.ClearUsersFromGroup(groupName)SetArgument(variableName, value)
Signature
public void SetArgument(string variableName, object value)Parameters
variableNamerequired
string
default:
valuerequired
object
default:
CPH Code
CPH.SetArgument(variableName, value)GetSource()
Signature
public Streamer.bot.Common.Events.EventSource GetSource()Parameters
No parametersCPH Code
CPH.GetSource()GetEventType()
Signature
public Streamer.bot.Common.Events.EventType GetEventType()Parameters
No parametersCPH Code
CPH.GetEventType()TryGetArg(argName, value)
Signature
public bool TryGetArg(string argName, out System.Object& value)Parameters
argNamerequired
string
default:
valuerequired
System.Object&
default:
CPH Code
CPH.TryGetArg(argName, value)TryGetArg(argName, value)
Signature
public bool TryGetArg<T>(string argName, out T& value)Parameters
argNamerequired
string
default:
valuerequired
T&
default:
CPH Code
CPH.TryGetArg(argName, value)TwitchGetBroadcaster()
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchUserInfo TwitchGetBroadcaster()Parameters
No parametersCPH Code
CPH.TwitchGetBroadcaster()TwitchGetBot()
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchUserInfo TwitchGetBot()Parameters
No parametersCPH Code
CPH.TwitchGetBot()TwitchGetUserInfoById(userId)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchUserInfo TwitchGetUserInfoById(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchGetUserInfoById(userId)TwitchGetUserInfoByLogin(userLogin)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchUserInfo TwitchGetUserInfoByLogin(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.TwitchGetUserInfoByLogin(userLogin)TwitchGetExtendedUserInfoById(userId)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchUserInfoEx TwitchGetExtendedUserInfoById(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchGetExtendedUserInfoById(userId)TwitchGetExtendedUserInfoByLogin(userLogin)
Signature
public Streamer.bot.Plugin.Interface.Model.TwitchUserInfoEx TwitchGetExtendedUserInfoByLogin(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.TwitchGetExtendedUserInfoByLogin(userLogin)SendMessage(message, useBot, fallback)
Signature
public void SendMessage(string message, bool useBot, bool fallback)Parameters
messagerequired
string
default:
useBot
bool
default:
Truefallback
bool
default:
TrueCPH Code
CPH.SendMessage(message, useBot, fallback)TwitchReplyToMessage(message, replyId, useBot, fallback)
Signature
public void TwitchReplyToMessage(string message, string replyId, bool useBot, bool fallback)Parameters
messagerequired
string
default:
replyIdrequired
string
default:
useBot
bool
default:
Truefallback
bool
default:
TrueCPH Code
CPH.TwitchReplyToMessage(message, replyId, useBot, fallback)SendAction(action, useBot, fallback)
Signature
public void SendAction(string action, bool useBot, bool fallback)Parameters
actionrequired
string
default:
useBot
bool
default:
Truefallback
bool
default:
TrueCPH Code
CPH.SendAction(action, useBot, fallback)SendWhisper(userName, message, bot)
Signature
public bool SendWhisper(string userName, string message, bool bot)Parameters
userNamerequired
string
default:
messagerequired
string
default:
bot
bool
default:
TrueCPH Code
CPH.SendWhisper(userName, message, bot)GetAllClips(isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetAllClips(Boolean? isFeatured)Parameters
isFeatured
Boolean?
default:
CPH Code
CPH.GetAllClips(isFeatured)GetClips(count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClips(int count, Boolean? isFeatured)Parameters
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClips(count, isFeatured)GetClipsForUser(userId)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(int userId)Parameters
userIdrequired
int
default:
CPH Code
CPH.GetClipsForUser(userId)GetClipsForUser(userId, count)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(int userId, int count)Parameters
userIdrequired
int
default:
countrequired
int
default:
CPH Code
CPH.GetClipsForUser(userId, count)GetClipsForUser(userId, start, end)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(int userId, DateTime start, DateTime end)Parameters
userIdrequired
int
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
CPH Code
CPH.GetClipsForUser(userId, start, end)GetClipsForUser(userId, start, end, count)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(int userId, DateTime start, DateTime end, int count)Parameters
userIdrequired
int
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
countrequired
int
default:
CPH Code
CPH.GetClipsForUser(userId, start, end, count)GetClipsForUser(userId, duration)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(int userId, System.TimeSpan duration)Parameters
userIdrequired
int
default:
durationrequired
System.TimeSpan
default:
CPH Code
CPH.GetClipsForUser(userId, duration)GetClipsForUser(userId, duration, count)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(int userId, System.TimeSpan duration, int count)Parameters
userIdrequired
int
default:
durationrequired
System.TimeSpan
default:
countrequired
int
default:
CPH Code
CPH.GetClipsForUser(userId, duration, count)GetClipsForUserById(userId, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUserById(string userId, Boolean? isFeatured)Parameters
userIdrequired
string
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUserById(userId, isFeatured)GetClipsForUserById(userId, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUserById(string userId, int count, Boolean? isFeatured)Parameters
userIdrequired
string
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUserById(userId, count, isFeatured)GetClipsForUserById(userId, start, end, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUserById(string userId, DateTime start, DateTime end, Boolean? isFeatured)Parameters
userIdrequired
string
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUserById(userId, start, end, isFeatured)GetClipsForUserById(userId, start, end, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUserById(string userId, DateTime start, DateTime end, int count, Boolean? isFeatured)Parameters
userIdrequired
string
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUserById(userId, start, end, count, isFeatured)GetClipsForUserById(userId, duration, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUserById(string userId, System.TimeSpan duration, Boolean? isFeatured)Parameters
userIdrequired
string
default:
durationrequired
System.TimeSpan
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUserById(userId, duration, isFeatured)GetClipsForUserById(userId, duration, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUserById(string userId, System.TimeSpan duration, int count, Boolean? isFeatured)Parameters
userIdrequired
string
default:
durationrequired
System.TimeSpan
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUserById(userId, duration, count, isFeatured)GetClipsForUser(username, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(string username, Boolean? isFeatured)Parameters
usernamerequired
string
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUser(username, isFeatured)GetClipsForUser(userName, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(string userName, int count, Boolean? isFeatured)Parameters
userNamerequired
string
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUser(userName, count, isFeatured)GetClipsForUser(username, start, end, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(string username, DateTime start, DateTime end, Boolean? isFeatured)Parameters
usernamerequired
string
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUser(username, start, end, isFeatured)GetClipsForUser(username, start, end, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(string username, DateTime start, DateTime end, int count, Boolean? isFeatured)Parameters
usernamerequired
string
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUser(username, start, end, count, isFeatured)GetClipsForUser(username, duration, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(string username, System.TimeSpan duration, Boolean? isFeatured)Parameters
usernamerequired
string
default:
durationrequired
System.TimeSpan
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUser(username, duration, isFeatured)GetClipsForUser(username, duration, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForUser(string username, System.TimeSpan duration, int count, Boolean? isFeatured)Parameters
usernamerequired
string
default:
durationrequired
System.TimeSpan
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForUser(username, duration, count, isFeatured)GetClipsForGame(gameId, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForGame(int gameId, Boolean? isFeatured)Parameters
gameIdrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForGame(gameId, isFeatured)GetClipsForGame(gameId, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForGame(int gameId, int count, Boolean? isFeatured)Parameters
gameIdrequired
int
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForGame(gameId, count, isFeatured)GetClipsForGame(gameId, start, end, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForGame(int gameId, DateTime start, DateTime end, Boolean? isFeatured)Parameters
gameIdrequired
int
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForGame(gameId, start, end, isFeatured)GetClipsForGame(gameId, start, end, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForGame(int gameId, DateTime start, DateTime end, int count, Boolean? isFeatured)Parameters
gameIdrequired
int
default:
startrequired
DateTime
default:
endrequired
DateTime
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForGame(gameId, start, end, count, isFeatured)GetClipsForGame(gameId, duration, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForGame(int gameId, System.TimeSpan duration, Boolean? isFeatured)Parameters
gameIdrequired
int
default:
durationrequired
System.TimeSpan
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForGame(gameId, duration, isFeatured)GetClipsForGame(gameId, duration, count, isFeatured)
Signature
public List<Twitch.Common.Models.Api.ClipData> GetClipsForGame(int gameId, System.TimeSpan duration, int count, Boolean? isFeatured)Parameters
gameIdrequired
int
default:
durationrequired
System.TimeSpan
default:
countrequired
int
default:
isFeatured
Boolean?
default:
CPH Code
CPH.GetClipsForGame(gameId, duration, count, isFeatured)GetTeamInfo(userId)
Signature
public List<Twitch.Common.Models.Api.TeamInfo> GetTeamInfo(int userId)Parameters
userIdrequired
int
default:
CPH Code
CPH.GetTeamInfo(userId)GetTeamInfo(username)
Signature
public List<Twitch.Common.Models.Api.TeamInfo> GetTeamInfo(string username)Parameters
usernamerequired
string
default:
CPH Code
CPH.GetTeamInfo(username)GetTeamInfoById(userId)
Signature
public List<Twitch.Common.Models.Api.TeamInfo> GetTeamInfoById(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.GetTeamInfoById(userId)GetTeamInfoByLogin(userLogin)
Signature
public List<Twitch.Common.Models.Api.TeamInfo> GetTeamInfoByLogin(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.GetTeamInfoByLogin(userLogin)GetCheermotes()
Signature
public List<Twitch.Common.Models.Api.Cheermote> GetCheermotes()Parameters
No parametersCPH Code
CPH.GetCheermotes()SetChannelTitle(title)
Signature
public bool SetChannelTitle(string title)Parameters
titlerequired
string
default:
CPH Code
CPH.SetChannelTitle(title)SetChannelGame(game)
Signature
public Streamer.bot.Plugin.Interface.GameInfo SetChannelGame(string game)Parameters
gamerequired
string
default:
CPH Code
CPH.SetChannelGame(game)SetChannelGameById(gameId)
Signature
public bool SetChannelGameById(string gameId)Parameters
gameIdrequired
string
default:
CPH Code
CPH.SetChannelGameById(gameId)TwitchClearChannelTags()
Signature
public bool TwitchClearChannelTags()Parameters
No parametersCPH Code
CPH.TwitchClearChannelTags()TwitchSetChannelTags(tags)
Signature
public bool TwitchSetChannelTags(List<string> tags)Parameters
tagsrequired
List<string>
default:
CPH Code
CPH.TwitchSetChannelTags(tags)TwitchAddChannelTag(tag)
Signature
public bool TwitchAddChannelTag(string tag)Parameters
tagrequired
string
default:
CPH Code
CPH.TwitchAddChannelTag(tag)TwitchRemoveChannelTag(tag)
Signature
public bool TwitchRemoveChannelTag(string tag)Parameters
tagrequired
string
default:
CPH Code
CPH.TwitchRemoveChannelTag(tag)CreateClip()
Signature
public Twitch.Common.Models.Api.ClipData CreateClip()Parameters
No parametersCPH Code
CPH.CreateClip()CreateStreamMarker(description)
Signature
public Twitch.Common.Models.Api.StreamMarker CreateStreamMarker(string description)Parameters
descriptionrequired
string
default:
CPH Code
CPH.CreateStreamMarker(description)TwitchAddModerator(userName)
Signature
public bool TwitchAddModerator(string userName)Parameters
userNamerequired
string
default:
CPH Code
CPH.TwitchAddModerator(userName)TwitchRemoveModerator(userName)
Signature
public bool TwitchRemoveModerator(string userName)Parameters
userNamerequired
string
default:
CPH Code
CPH.TwitchRemoveModerator(userName)TwitchAddVip(userName)
Signature
public bool TwitchAddVip(string userName)Parameters
userNamerequired
string
default:
CPH Code
CPH.TwitchAddVip(userName)TwitchRemoveVip(userName)
Signature
public bool TwitchRemoveVip(string userName)Parameters
userNamerequired
string
default:
CPH Code
CPH.TwitchRemoveVip(userName)TwitchBanUser(userName, reason, bot)
Signature
public bool TwitchBanUser(string userName, string reason, bool bot)Parameters
userNamerequired
string
default:
reason
string
default:
bot
bool
default:
FalseCPH Code
CPH.TwitchBanUser(userName, reason, bot)TwitchUnbanUser(userName, bot)
Signature
public bool TwitchUnbanUser(string userName, bool bot)Parameters
userNamerequired
string
default:
bot
bool
default:
FalseCPH Code
CPH.TwitchUnbanUser(userName, bot)TwitchTimeoutUser(username, duration, reason, bot)
Signature
public bool TwitchTimeoutUser(string username, int duration, string reason, bool bot)Parameters
usernamerequired
string
default:
durationrequired
int
default:
reason
string
default:
bot
bool
default:
FalseCPH Code
CPH.TwitchTimeoutUser(username, duration, reason, bot)TwitchBlockUser(userLogin, context, reason)
Signature
public bool TwitchBlockUser(string userLogin, Streamer.bot.Plugin.Interface.Enums.TwitchBlockContext context, Streamer.bot.Plugin.Interface.Enums.TwitchBlockReason reason)Parameters
userLoginrequired
string
default:
context
Streamer.bot.Plugin.Interface.Enums.TwitchBlockContext
default:
Nonereason
Streamer.bot.Plugin.Interface.Enums.TwitchBlockReason
default:
NoneCPH Code
CPH.TwitchBlockUser(userLogin, context, reason)TwitchBlockUserById(userId, context, reason)
Signature
public bool TwitchBlockUserById(string userId, Streamer.bot.Plugin.Interface.Enums.TwitchBlockContext context, Streamer.bot.Plugin.Interface.Enums.TwitchBlockReason reason)Parameters
userIdrequired
string
default:
context
Streamer.bot.Plugin.Interface.Enums.TwitchBlockContext
default:
Nonereason
Streamer.bot.Plugin.Interface.Enums.TwitchBlockReason
default:
NoneCPH Code
CPH.TwitchBlockUserById(userId, context, reason)TwitchUnblockUser(userLogin)
Signature
public bool TwitchUnblockUser(string userLogin)Parameters
userLoginrequired
string
default:
CPH Code
CPH.TwitchUnblockUser(userLogin)TwitchUnblockUserById(userId)
Signature
public bool TwitchUnblockUserById(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchUnblockUserById(userId)TwitchApproveAutoHeldMessage(messageId)
Signature
public bool TwitchApproveAutoHeldMessage(string messageId)Parameters
messageIdrequired
string
default:
CPH Code
CPH.TwitchApproveAutoHeldMessage(messageId)TwitchDenyAutoHeldMessage(messageId)
Signature
public bool TwitchDenyAutoHeldMessage(string messageId)Parameters
messageIdrequired
string
default:
CPH Code
CPH.TwitchDenyAutoHeldMessage(messageId)TwitchWarnUser(userName, reason)
Signature
public bool TwitchWarnUser(string userName, string reason)Parameters
userNamerequired
string
default:
reasonrequired
string
default:
CPH Code
CPH.TwitchWarnUser(userName, reason)TwitchAddBlockedTerm(term)
Signature
public bool TwitchAddBlockedTerm(string term)Parameters
termrequired
string
default:
CPH Code
CPH.TwitchAddBlockedTerm(term)TwitchRemoveBlockedTerm(term)
Signature
public bool TwitchRemoveBlockedTerm(string term)Parameters
termrequired
string
default:
CPH Code
CPH.TwitchRemoveBlockedTerm(term)TwitchGetBlockedTerms()
Signature
public List<string> TwitchGetBlockedTerms()Parameters
No parametersCPH Code
CPH.TwitchGetBlockedTerms()TwitchClearChatMessages(bot)
Signature
public bool TwitchClearChatMessages(bool bot)Parameters
bot
bool
default:
TrueCPH Code
CPH.TwitchClearChatMessages(bot)TwitchDeleteChatMessage(messageId, bot)
Signature
public bool TwitchDeleteChatMessage(string messageId, bool bot)Parameters
messageIdrequired
string
default:
bot
bool
default:
TrueCPH Code
CPH.TwitchDeleteChatMessage(messageId, bot)GetActions()
Signature
public List<Streamer.bot.Plugin.Interface.Model.ActionData> GetActions()Parameters
No parametersCPH Code
CPH.GetActions()RunAction(actionName, runImmediately)
Signature
public bool RunAction(string actionName, bool runImmediately)Parameters
actionNamerequired
string
default:
runImmediately
bool
default:
TrueCPH Code
CPH.RunAction(actionName, runImmediately)RunActionById(actionId, runImmediately)
Signature
public bool RunActionById(string actionId, bool runImmediately)Parameters
actionIdrequired
string
default:
runImmediately
bool
default:
TrueCPH Code
CPH.RunActionById(actionId, runImmediately)DisableAction(actionName)
Signature
public void DisableAction(string actionName)Parameters
actionNamerequired
string
default:
CPH Code
CPH.DisableAction(actionName)DisableActionById(actionId)
Signature
public void DisableActionById(string actionId)Parameters
actionIdrequired
string
default:
CPH Code
CPH.DisableActionById(actionId)EnableAction(actionName)
Signature
public void EnableAction(string actionName)Parameters
actionNamerequired
string
default:
CPH Code
CPH.EnableAction(actionName)EnableActionById(actionId)
Signature
public void EnableActionById(string actionId)Parameters
actionIdrequired
string
default:
CPH Code
CPH.EnableActionById(actionId)ActionExists(actionName)
Signature
public bool ActionExists(string actionName)Parameters
actionNamerequired
string
default:
CPH Code
CPH.ActionExists(actionName)LogInfo(logLine)
Signature
public void LogInfo(string logLine)Parameters
logLinerequired
string
default:
CPH Code
CPH.LogInfo(logLine)LogWarn(logLine)
Signature
public void LogWarn(string logLine)Parameters
logLinerequired
string
default:
CPH Code
CPH.LogWarn(logLine)LogError(logLine)
Signature
public void LogError(string logLine)Parameters
logLinerequired
string
default:
CPH Code
CPH.LogError(logLine)LogDebug(logLine)
Signature
public void LogDebug(string logLine)Parameters
logLinerequired
string
default:
CPH Code
CPH.LogDebug(logLine)LogVerbose(logLine)
Signature
public void LogVerbose(string logLine)Parameters
logLinerequired
string
default:
CPH Code
CPH.LogVerbose(logLine)DisableTimer(timerName)
Signature
public void DisableTimer(string timerName)Parameters
timerNamerequired
string
default:
CPH Code
CPH.DisableTimer(timerName)DisableTimerById(timerId)
Signature
public void DisableTimerById(string timerId)Parameters
timerIdrequired
string
default:
CPH Code
CPH.DisableTimerById(timerId)EnableTimer(timerName)
Signature
public void EnableTimer(string timerName)Parameters
timerNamerequired
string
default:
CPH Code
CPH.EnableTimer(timerName)EnableTimerById(timerId)
Signature
public void EnableTimerById(string timerId)Parameters
timerIdrequired
string
default:
CPH Code
CPH.EnableTimerById(timerId)DisableReward(rewardId)
Signature
public void DisableReward(string rewardId)Parameters
rewardIdrequired
string
default:
CPH Code
CPH.DisableReward(rewardId)EnableReward(rewardId)
Signature
public void EnableReward(string rewardId)Parameters
rewardIdrequired
string
default:
CPH Code
CPH.EnableReward(rewardId)PauseReward(rewardId)
Signature
public void PauseReward(string rewardId)Parameters
rewardIdrequired
string
default:
CPH Code
CPH.PauseReward(rewardId)UnPauseReward(rewardId)
Signature
public void UnPauseReward(string rewardId)Parameters
rewardIdrequired
string
default:
CPH Code
CPH.UnPauseReward(rewardId)UpdateRewardCost(rewardId, cost, additive)
Signature
public void UpdateRewardCost(string rewardId, int cost, bool additive)Parameters
rewardIdrequired
string
default:
costrequired
int
default:
additive
bool
default:
FalseCPH Code
CPH.UpdateRewardCost(rewardId, cost, additive)UpdateRewardCooldown(rewardId, cooldown, additive)
Signature
public void UpdateRewardCooldown(string rewardId, long cooldown, bool additive)Parameters
rewardIdrequired
string
default:
cooldownrequired
long
default:
additive
bool
default:
FalseCPH Code
CPH.UpdateRewardCooldown(rewardId, cooldown, additive)UpdateRewardMaxPerStream(rewardId, redeems, additive)
Signature
public void UpdateRewardMaxPerStream(string rewardId, long redeems, bool additive)Parameters
rewardIdrequired
string
default:
redeemsrequired
long
default:
additive
bool
default:
FalseCPH Code
CPH.UpdateRewardMaxPerStream(rewardId, redeems, additive)UpdateRewardMaxPerUserPerStream(rewardId, redeems, additive)
Signature
public void UpdateRewardMaxPerUserPerStream(string rewardId, long redeems, bool additive)Parameters
rewardIdrequired
string
default:
redeemsrequired
long
default:
additive
bool
default:
FalseCPH Code
CPH.UpdateRewardMaxPerUserPerStream(rewardId, redeems, additive)UpdateRewardTitle(rewardId, title)
Signature
public bool UpdateRewardTitle(string rewardId, string title)Parameters
rewardIdrequired
string
default:
titlerequired
string
default:
CPH Code
CPH.UpdateRewardTitle(rewardId, title)UpdateRewardPrompt(rewardId, prompt)
Signature
public bool UpdateRewardPrompt(string rewardId, string prompt)Parameters
rewardIdrequired
string
default:
promptrequired
string
default:
CPH Code
CPH.UpdateRewardPrompt(rewardId, prompt)UpdateRewardBackgroundColor(rewardId, backgroundColor)
Signature
public bool UpdateRewardBackgroundColor(string rewardId, string backgroundColor)Parameters
rewardIdrequired
string
default:
backgroundColorrequired
string
default:
CPH Code
CPH.UpdateRewardBackgroundColor(rewardId, backgroundColor)UpdateReward(rewardId, title, prompt, cost, backroundColor)
Signature
public bool UpdateReward(string rewardId, string title, string prompt, Int32? cost, string backroundColor)Parameters
rewardIdrequired
string
default:
title
string
default:
prompt
string
default:
cost
Int32?
default:
backroundColor
string
default:
CPH Code
CPH.UpdateReward(rewardId, title, prompt, cost, backroundColor)TwitchRedemptionFulfill(rewardId, redemptionId)
Signature
public bool TwitchRedemptionFulfill(string rewardId, string redemptionId)Parameters
rewardIdrequired
string
default:
redemptionIdrequired
string
default:
CPH Code
CPH.TwitchRedemptionFulfill(rewardId, redemptionId)TwitchRedemptionCancel(rewardId, redemptionId)
Signature
public bool TwitchRedemptionCancel(string rewardId, string redemptionId)Parameters
rewardIdrequired
string
default:
redemptionIdrequired
string
default:
CPH Code
CPH.TwitchRedemptionCancel(rewardId, redemptionId)TwitchGetChannelPointsUsedByUserId(userId)
Signature
public long TwitchGetChannelPointsUsedByUserId(string userId)Parameters
userIdrequired
string
default:
CPH Code
CPH.TwitchGetChannelPointsUsedByUserId(userId)TwitchResetRewardCounter(rewardId)
Signature
public void TwitchResetRewardCounter(string rewardId)Parameters
rewardIdrequired
string
default:
CPH Code
CPH.TwitchResetRewardCounter(rewardId)