Wire¶
Connects one or more Instances to form a processing graph of their streams. At the moment, only audio streams are supported, but this may expand in the future.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
Wire connects one or more Instances to form a processing graph of their streams. Each Wire connects a source and target instance, and a source and target "pin" within each of those instances. Pins are string identifiers that select which stream is to be carried by the wire.
At the moment, only audio streams are supported, but this may expand in the future.
The following instances may be connected by Wires:
- AudioAnalyzer
- AudioChannelMixer
- AudioChannelSplitter
- AudioChorus
- AudioCompressor
- AudioDeviceInput
- AudioDeviceOutput
- AudioDistortion
- AudioEcho
- AudioEmitter
- AudioEqualizer
- AudioFader
- AudioFilter
- AudioFlanger
- AudioGate
- AudioLimiter
- AudioListener
- AudioPitchShifter
- AudioPlayer
- AudioRecorder
- AudioReverb
- AudioSpeechToText
- AudioTextToSpeech
- AudioTremolo
- VideoPlayer
- VideoDisplay
Inheritance¶
Properties¶
| Member | Signature | Summary |
|---|---|---|
Connected |
Connected: bool |
Denotes whether the Wire is carrying a stream of data. |
SourceInstance |
SourceInstance: Instance |
The Instance producing a stream to be carried over the wire. |
SourceName |
SourceName: string |
The name of the pin on SourceInstance that is producing a stream. |
TargetInstance |
TargetInstance: Instance |
The Instance to receive a stream from SourceInstance. |
TargetName |
TargetName: string |
The name of the pin on TargetInstance that is receiving a stream. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
RenameToDefault |
Wire:RenameToDefault(): null |
— |
Roblox reference: Wire
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.