diff --git a/apps/docs/content/3.api/2.events.md b/apps/docs/content/3.api/2.events.md index 46e73be..7342ca9 100644 --- a/apps/docs/content/3.api/2.events.md +++ b/apps/docs/content/3.api/2.events.md @@ -21,261 +21,437 @@ When using the `.on()` method, you can utilize the shorthand `[source].[type]` s ```ts [StreamerbotEventsSubscription.ts] const StreamerbotEvents = { - Application: ['ActionAdded', 'ActionUpdated', 'ActionDeleted'], - Command: ['Triggered', 'Cooldown'], - CrowdControl: [ - 'GameSessionStart', - 'GameSessionEnd', - 'EffectRequest', - 'EffectSuccess', - 'EffectFailure', - 'TimedEffectStarted', - 'TimedEffectEnded', - 'TimedEffectUpdated', - ], - Custom: ['Event', 'CodeEvent'], - DonorDrive: ['Donation', 'ProfileUpdated', 'Incentive'], - Elgato: [ - 'WaveLinkOutputSwitched', - 'WaveLinkOutputVolumeChanged', - 'WaveLinkOutputMuteChanged', - 'WaveLinkSelectedOutputChanged', - 'WaveLinkInputVolumeChanged', - 'WaveLinkInputMuteChanged', - 'WaveLinkInputNameChanged', - 'WaveLinkMicrophoneGainChanged', - 'WaveLinkMicrophoneOutputVolumeChanged', - 'WaveLinkMicrophoneBalanceChanged', - 'WaveLinkMicrophoneMuteChanged', - 'WaveLinkMicrophoneSettingChanged', - 'WaveLinkFilterAdded', - 'WaveLinkFilterChanged', - 'WaveLinkFilterDeleted', - 'WaveLinkFilterBypassStateChanged', - 'WaveLinkConnected', - 'WaveLinkDisconnected', - 'WaveLinkInputLevelMeterChanged', - 'WaveLinkOutputLevelMeterChanged', - ], - FileTail: ['Changed'], - FileWatcher: ['Changed', 'Created', 'Deleted', 'Renamed'], - Fourthwall: [ - 'ProductCreated', - 'ProductUpdated', - 'GiftPurchase', - 'OrderPlaced', - 'OrderUpdated', - 'Donation', - 'SubscriptionPurchased', - 'SubscriptionExpired', - 'SubscriptionChanged', - ], - General: ['Custom'], - HotKey: ['Press'], - HypeRate: ['HeartRatePulse'], - Kofi: ['Donation', 'Subscription', 'Resubscription', 'ShopOrder', 'Commission'], - Midi: ['Message'], - Misc: [ - 'TimedAction', - 'Test', - 'ProcessStarted', - 'ProcessStopped', - 'ChatWindowAction', - 'StreamerbotStarted', - 'StreamerbotExiting', - 'ToastActivation', - 'GlobalVariableUpdated', - 'ApplicationImport', - ], - Obs: [ - 'Connected', - 'Disconnected', - 'Event', - 'SceneChanged', - 'StreamingStarted', - 'StreamingStopped', - 'RecordingStarted', - 'RecordingStopped', - ], - Patreon: ['FollowCreated', 'FollowDeleted', 'PledgeCreated', 'PledgeUpdated', 'PledgeDeleted'], - Pulsoid: ['HeartRatePulse'], - Quote: ['Added', 'Show'], - Raw: ['Action', 'SubAction', 'ActionCompleted'], - Shopify: ['OrderCreated', 'OrderPaid'], - SpeakerBot: ['Connected', 'Disconnected'], - SpeechToText: ['Dictation', 'Command'], - StreamDeck: ['Action', 'Connected', 'Disconnected', 'Info'], - StreamElements: ['Tip', 'Merch', 'Connected', 'Disconnected'], - Streamlabs: ['Donation', 'Merchandise', 'Connected', 'Disconnected'], - StreamlabsDesktop: [ - 'Connected', - 'Disconnected', - 'SceneChanged', - 'StreamingStarted', - 'StreamingStopped', - 'RecordingStarted', - 'RecordingStopped', - ], - ThrowingSystem: [ - 'Connected', - 'WebsocketConnected', - 'WebsocketDisconnected', - 'EventsConnected', - 'EventsDisconnected', - 'ItemHit', - 'TriggerActivated', - 'TriggerEnded', - ], - TipeeeStream: ['Donation'], - TreatStream: ['Treat'], - Trovo: [ - 'BroadcasterAuthenticated', - 'BroadcasterChatConnected', - 'BroadcasterChatDisconnected', - 'FirstWords', - 'PresentViewers', - 'ChatMessage', - 'Follow', - 'SpellCast', - 'CustomSpellCast', - 'Raid', - 'Subscription', - 'Resubscription', - 'GiftSubscription', - 'MassGiftSubscription', - 'StreamOnline', - 'StreamOffline', - ], - Twitch: [ - 'Follow', - 'Cheer', - 'Sub', - 'ReSub', - 'GiftSub', - 'GiftBomb', - 'Raid', - 'HypeTrainStart', - 'HypeTrainUpdate', - 'HypeTrainLevelUp', - 'HypeTrainEnd', - 'RewardRedemption', - 'RewardCreated', - 'RewardUpdated', - 'RewardDeleted', - 'CommunityGoalContribution', - 'CommunityGoalEnded', - 'StreamUpdate', - 'Whisper', - 'FirstWord', - 'SubCounterRollover', - 'BroadcastUpdate', - 'StreamUpdateGameOnConnect', - 'PresentViewers', - 'PollCreated', - 'PollUpdated', - 'PollCompleted', - 'PredictionCreated', - 'PredictionUpdated', - 'PredictionCompleted', - 'PredictionCanceled', - 'PredictionLocked', - 'ChatMessage', - 'ChatMessageDeleted', - 'UserTimedOut', - 'UserBanned', - 'Announcement', - 'AdRun', - 'BotWhisper', - 'CharityDonation', - 'CharityCompleted', - 'CoinCheer', - 'ShoutoutCreated', - 'UserUntimedOut', - 'CharityStarted', - 'CharityProgress', - 'GoalBegin', - 'GoalProgress', - 'GoalEnd', - 'ShieldModeBegin', - 'ShieldModeEnd', - 'AdMidRoll', - 'StreamOnline', - 'StreamOffline', - 'ShoutoutReceived', - 'ChatCleared', - 'RaidStart', - 'RaidSend', - 'RaidCancelled', - 'PollTerminated', - 'PyramidSuccess', - 'PyramidBroken', - 'ViewerCountUpdate', - 'GuestStarSessionBegin', - 'GuestStarSessionEnd', - 'GuestStarGuestUpdate', - 'GuestStarSlotUpdate', - 'GuestStarSettingsUpdate', - 'HypeChat', - 'RewardRedemptionUpdated', - 'HypeChatLevel', - 'BroadcasterAuthenticated', - 'BroadcasterChatConnected', - 'BroadcasterChatDisconnected', - 'BroadcasterPubSubConnected', - 'BroadcasterPubSubDisconnected', - 'BroadcasterEventSubConnected', - 'BroadcasterEventSubDisconnected', - 'SevenTVEmoteAdded', - 'SevenTVEmoteRemoved', - 'BetterTTVEmoteAdded', - 'BetterTTVEmoteRemoved', - 'BotChatConnected', - 'BotChatDisconnected', - 'UpcomingAd', - ], - VStream: [ - 'BroadcasterAuthenticated', - 'BroadcasterChatConnected', - 'BroadcasterChatDisconnected', - 'FirstWords', - 'PresentViewers', - 'ChatMessage', - 'NewFollower', - 'StreamOnline', - 'StreamOffline', - ], - VTubeStudio: [ - 'ModelLoaded', - 'ModelUnloaded', - 'BackgroundChanged', - 'ModelConfigChanged', - 'HotkeyTriggered', - 'ModelAnimation', - 'Connected', - 'Disconnected', - 'TrackingStatusChanged', - ], - WebsocketClient: ['Open', 'Close', 'Message'], - WebsocketCustomServer: ['Open', 'Close', 'Message'], - YouTube: [ - 'BroadcastStarted', - 'BroadcastEnded', - 'Message', - 'MessageDeleted', - 'UserBanned', - 'SuperChat', - 'SuperSticker', - 'NewSponsor', - 'MemberMileStone', - 'NewSponsorOnlyStarted', - 'NewSponsorOnlyEnded', - 'StatisticsUpdated', - 'BroadcastUpdated', - 'MembershipGift', - 'GiftMembershipReceived', - 'FirstWords', - 'PresentViewers', - 'NewSubscriber', - ], + "Application": [ + "ActionAdded", + "ActionUpdated", + "ActionDeleted", + "CommandAdded", + "CommandUpdated", + "CommandDeleted" + ], + "Command": [ + "Triggered", + "Cooldown" + ], + "Elgato": [ + "WaveLinkOutputSwitched", + "WaveLinkOutputVolumeChanged", + "WaveLinkOutputMuteChanged", + "WaveLinkSelectedOutputChanged", + "WaveLinkInputVolumeChanged", + "WaveLinkInputMuteChanged", + "WaveLinkInputNameChanged", + "WaveLinkMicrophoneGainChanged", + "WaveLinkMicrophoneOutputVolumeChanged", + "WaveLinkMicrophoneBalanceChanged", + "WaveLinkMicrophoneMuteChanged", + "WaveLinkMicrophoneSettingChanged", + "WaveLinkFilterAdded", + "WaveLinkFilterChanged", + "WaveLinkFilterDeleted", + "WaveLinkFilterBypassStateChanged", + "WaveLinkConnected", + "WaveLinkDisconnected", + "WaveLinkInputLevelMeterChanged", + "WaveLinkOutputLevelMeterChanged" + ], + "CrowdControl": [ + "GameSessionStart", + "GameSessionEnd", + "EffectRequest", + "EffectSuccess", + "EffectFailure", + "TimedEffectStarted", + "TimedEffectEnded", + "TimedEffectUpdated", + "CoinExchange" + ], + "VTubeStudio": [ + "ModelLoaded", + "ModelUnloaded", + "BackgroundChanged", + "ModelConfigChanged", + "HotkeyTriggered", + "ModelAnimation", + "Connected", + "Disconnected", + "TrackingStatusChanged" + ], + "Custom": [ + "Event", + "CodeEvent" + ], + "YouTube": [ + "BroadcastStarted", + "BroadcastEnded", + "Message", + "MessageDeleted", + "UserBanned", + "SuperChat", + "SuperSticker", + "NewSponsor", + "MemberMileStone", + "NewSponsorOnlyStarted", + "NewSponsorOnlyEnded", + "StatisticsUpdated", + "BroadcastUpdated", + "MembershipGift", + "GiftMembershipReceived", + "FirstWords", + "PresentViewers", + "NewSubscriber" + ], + "DonorDrive": [ + "Donation", + "ProfileUpdated", + "Incentive" + ], + "FileTail": [ + "Changed" + ], + "FileWatcher": [ + "Changed", + "Created", + "Deleted", + "Renamed" + ], + "Fourthwall": [ + "ProductCreated", + "ProductUpdated", + "GiftPurchase", + "OrderPlaced", + "OrderUpdated", + "Donation", + "SubscriptionPurchased", + "SubscriptionExpired", + "SubscriptionChanged", + "ThankYouSent", + "NewsletterSubscribed", + "GiftDrawStarted", + "GiftDrawEnded" + ], + "Streamlabs": [ + "Donation", + "Merchandise", + "Connected", + "Disconnected" + ], + "General": [ + "Custom" + ], + "HotKey": [ + "Press" + ], + "HypeRate": [ + "HeartRatePulse", + "TwitchClipCreated", + "Connected", + "Disconnected" + ], + "Kofi": [ + "Donation", + "Subscription", + "Resubscription", + "ShopOrder", + "Commission" + ], + "Inputs": [ + "InputKeyPress", + "InputMouseClick" + ], + "Midi": [ + "Message" + ], + "Misc": [ + "TimedAction", + "Test", + "ProcessStarted", + "ProcessStopped", + "ChatWindowAction", + "StreamerbotStarted", + "StreamerbotExiting", + "ToastActivation", + "GlobalVariableUpdated", + "UserGlobalVariableUpdated", + "GlobalVariableCreated", + "GlobalVariableDeleted", + "ApplicationImport" + ], + "Obs": [ + "Connected", + "Disconnected", + "Event", + "SceneChanged", + "StreamingStarted", + "StreamingStopped", + "RecordingStarted", + "RecordingStopped", + "VendorEvent" + ], + "Patreon": [ + "FollowCreated", + "FollowDeleted", + "PledgeCreated", + "PledgeUpdated", + "PledgeDeleted" + ], + "Pulsoid": [ + "HeartRatePulse" + ], + "Quote": [ + "Added", + "Show" + ], + "Raw": [ + "Action", + "SubAction", + "ActionCompleted" + ], + "Shopify": [ + "OrderCreated", + "OrderPaid" + ], + "SpeakerBot": [ + "Connected", + "Disconnected" + ], + "SpeechToText": [ + "Dictation", + "Command" + ], + "StreamDeck": [ + "Action", + "Connected", + "Disconnected", + "Info" + ], + "StreamElements": [ + "Tip", + "Merch", + "Connected", + "Disconnected", + "Authenticated" + ], + "StreamlabsDesktop": [ + "Connected", + "Disconnected", + "SceneChanged", + "StreamingStarted", + "StreamingStopped", + "RecordingStarted", + "RecordingStopped" + ], + "System": [ + "ClipboardChanged" + ], + "Kick": [ + "BroadcasterAuthenticated", + "BroadcasterChatConnected", + "BroadcasterChatDisconnected", + "FirstWords", + "PresentViewers", + "ChatMessage", + "Follow", + "StreamOnline", + "StreamOffline", + "Subscription", + "Resubscription", + "GiftSubscription", + "MassGiftSubscription", + "UserTimedOut", + "UserBanned", + "ChannelUpdate", + "SevenTVEmoteAdded", + "SevenTVEmoteRemoved", + "ViewerCountUpdate" + ], + "StreamerBot": [ + "CustomWebook" + ], + "MeldStudio": [ + "Connected", + "Disconnected", + "StreamingStarted", + "StreamingStopped", + "RecordingStarted", + "RecordingStopped", + "SceneChanged", + "LayerVisbilityChanged", + "LEffectEnabledStateChanged", + "TrackMonitoringStateChanged", + "TrackMustedStateChanged", + "Event" + ], + "Group": [ + "Added", + "Removed", + "Cleared", + "UsersAdded", + "UsersRemoved" + ], + "VoiceMod": [ + "Connected", + "Disconnected", + "VoiceLoaded", + "SoundboardChanged" + ], + "StreamerBotRemote": [ + "InstanceConnected", + "InstanceDisconnected", + "InstanceTrigger", + "InstanceSignal" + ], + "Pallygg": [ + "Connected", + "Disconnected", + "CampaignTip" + ], + "ThrowingSystem": [ + "Connected", + "WebsocketConnected", + "WebsocketDisconnected", + "EventsConnected", + "EventsDisconnected", + "ItemHit", + "TriggerActivated", + "TriggerEnded" + ], + "TreatStream": [ + "Treat" + ], + "TipeeeStream": [ + "Donation" + ], + "Trovo": [ + "BroadcasterAuthenticated", + "BroadcasterChatConnected", + "BroadcasterChatDisconnected", + "FirstWords", + "PresentViewers", + "ChatMessage", + "Follow", + "SpellCast", + "CustomSpellCast", + "Raid", + "Subscription", + "Resubscription", + "GiftSubscription", + "MassGiftSubscription", + "StreamOnline", + "StreamOffline" + ], + "Twitch": [ + "AdMidRoll", + "AdMidRoll", + "AdRun", + "Announcement", + "BetterTTVEmoteAdded", + "BetterTTVEmoteRemoved", + "BotChatConnected", + "BotChatConnected", + "BotChatDisconnected", + "BotChatDisconnected", + "BotWhisper", + "BroadcastUpdate", + "BroadcasterAuthenticated", + "BroadcasterChatConnected", + "BroadcasterChatDisconnected", + "BroadcasterEventSubConnected", + "BroadcasterEventSubDisconnected", + "BroadcasterPubSubConnected", + "BroadcasterPubSubConnected", + "BroadcasterPubSubDisconnected", + "BroadcasterPubSubDisconnected", + "CharityCompleted", + "CharityDonation", + "CharityProgress", + "CharityStarted", + "ChatCleared", + "ChatMessage", + "ChatMessageDeleted", + "Cheer", + "CoinCheer", + "CommunityGoalContribution", + "CommunityGoalEnded", + "FirstWord", + "Follow", + "GiftBomb", + "GiftSub", + "GoalBegin", + "GoalEnd", + "GoalProgress", + "GuestStarGuestUpdate", + "GuestStarSessionBegin", + "GuestStarSessionEnd", + "GuestStarSettingsUpdate", + "GuestStarSlotUpdate", + "HypeChat", + "HypeChatLevel", + "HypeTrainEnd", + "HypeTrainLevelUp", + "HypeTrainStart", + "HypeTrainUpdate", + "PollCompleted", + "PollCreated", + "PollTerminated", + "PollUpdated", + "PredictionCanceled", + "PredictionCompleted", + "PredictionCreated", + "PredictionLocked", + "PredictionUpdated", + "PresentViewers", + "PyramidBroken", + "PyramidSuccess", + "Raid", + "RaidCancelled", + "RaidSend", + "RaidStart", + "ReSub", + "RewardCreated", + "RewardDeleted", + "RewardRedemption", + "RewardRedemptionUpdated", + "RewardUpdated", + "SevenTVEmoteAdded", + "SevenTVEmoteRemoved", + "ShieldModeBegin", + "ShieldModeEnd", + "ShoutoutCreated", + "ShoutoutReceived", + "StreamOffline", + "StreamOnline", + "StreamUpdate", + "StreamUpdateGameOnConnect", + "Sub", + "SubCounterRollover", + "UpcomingAd", + "UserBanned", + "UserTimedOut", + "UserUntimedOut", + "ViewerCountUpdate", + "Whisper" + ], + "VStream": [ + "BroadcasterAuthenticated", + "BroadcasterChatConnected", + "BroadcasterChatDisconnected", + "FirstWords", + "PresentViewers", + "ChatMessage", + "NewFollower", + "StreamOnline", + "StreamOffline" + ], + "WebsocketClient": [ + "Open", + "Close", + "Message" + ], + "WebsocketCustomServer": [ + "Open", + "Close", + "Message" + ] }; -``` \ No newline at end of file +```