Automated: create new component page |
add info |
||
Line 4: | Line 4: | ||
}} | }} | ||
{{stub}} | {{stub}} | ||
Twitch interface is a component that is used to allow resonite to communicate to and recieve twitch API events from twitch for a given <code>Channel</code> through a [[Type:User|User]]. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TargetUser|{{RootFieldType|UserRef}}|TypeAdv0=true| | |TargetUser|{{RootFieldType|UserRef}}|TypeAdv0=true| The user to handle sending and receiving network packets to and from twitch. User will need to have agreed to communicate with Twitch for this component to work. | ||
|Channel|String| | |Channel|String| The twitch channel to get communications from. | ||
|Connected|Bool| | |Connected|Bool| Whether the connection to <code>Channel</code> is a success and is communicating. | ||
|StreamLive|Bool| | |StreamLive|Bool| Whether <code>Channel</code> is currently streaming. | ||
|ViewerCount|Int| | |ViewerCount|Int| How many viewers are viewing <code>Channel</code>'s stream. | ||
|FollowTimeoutSeconds|Float| | |FollowTimeoutSeconds|Float| How many seconds to wait before allowing another follow event through. | ||
}} | }} | ||
Line 18: | Line 19: | ||
== Examples == | == Examples == | ||
This component is used in [[:Category:ProtoFlux:Network:Twitch|Twitch ProtoFlux Nodes]] to allow them to function. | |||
== See Also == | == See Also == | ||
[[:Category:ProtoFlux:Network:Twitch|Twitch ProtoFlux Nodes]] | |||
[[Category:Components:Network{{#translation:}}|Twitch Interface]] | [[Category:Components:Network{{#translation:}}|Twitch Interface]] | ||
[[Category:Components{{#translation:}}|Twitch Interface]] | [[Category:Components{{#translation:}}|Twitch Interface]] | ||
Latest revision as of 19:31, 23 October 2024
Component image
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Twitch interface is a component that is used to allow resonite to communicate to and recieve twitch API events from twitch for a given Channel
through a User.
Usage
Name | Type | Description |
---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
TargetUser
|
direct UserRef | The user to handle sending and receiving network packets to and from twitch. User will need to have agreed to communicate with Twitch for this component to work. |
Channel
|
String | The twitch channel to get communications from. |
Connected
|
Bool | Whether the connection to Channel is a success and is communicating.
|
StreamLive
|
Bool | Whether Channel is currently streaming.
|
ViewerCount
|
Int | How many viewers are viewing Channel 's stream.
|
FollowTimeoutSeconds
|
Float | How many seconds to wait before allowing another follow event through. |
Behavior
Examples
This component is used in Twitch ProtoFlux Nodes to allow them to function.