mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
134 lines
3.7 KiB
YAML
134 lines
3.7 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: AudioDeviceOutput
|
|
type: class
|
|
memory_category: Internal
|
|
summary: |
|
|
Accepts audio streams to be rendered out to physical hardware devices such as
|
|
speakers or headphones.
|
|
description: |
|
|
`Class.AudioDeviceOutput` accepts audio streams to be rendered out to physical
|
|
hardware devices such as speakers or headphones. It provides a single
|
|
**Input** pin that can be targeted by `Class.Wire|Wires`. Any audio streams
|
|
wired to an `Class.AudioDeviceOutput` are heard.
|
|
code_samples:
|
|
- audio-wiring---device-output
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: AudioDeviceOutput.Player
|
|
summary: |
|
|
A `Class.Player` who is intended to hear the connected audio streams.
|
|
description: |
|
|
An optional `Class.Player` who is intended to hear the connected audio
|
|
streams. If left unspecified, the streams wired to this
|
|
`Class.AudioDeviceOutput` are heard by everyone.
|
|
code_samples: []
|
|
type: Player
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: State
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Audio
|
|
methods:
|
|
- name: AudioDeviceOutput:GetConnectedWires
|
|
summary: |
|
|
Returns an array of `Class.Wire|Wires` that are connected to the specified
|
|
pin.
|
|
description: |
|
|
Returns an array of `Class.Wire|Wires` that are connected to the specified
|
|
pin. `Class.AudioDeviceOutput` has one "Input" pin.
|
|
code_samples: []
|
|
parameters:
|
|
- name: pin
|
|
type: string
|
|
default:
|
|
summary: ''
|
|
returns:
|
|
- type: Instances
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Audio
|
|
- name: AudioDeviceOutput:GetInputPins
|
|
summary: ''
|
|
description: ''
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: Array
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Audio
|
|
- name: AudioDeviceOutput:GetOutputPins
|
|
summary: ''
|
|
description: ''
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: Array
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Audio
|
|
events:
|
|
- name: AudioDeviceOutput.WiringChanged
|
|
summary: |
|
|
Fires when another instance is connected to or disconnected from the
|
|
`Class.AudioDeviceOutput` via a `Class.Wire`.
|
|
description: |
|
|
Event that fires after a `Class.Wire` becomes connected or disconnected,
|
|
and that `Class.Wire` is now or was previously connected to a pin on the
|
|
`Class.AudioDeviceOutput` and to some other wirable instance.
|
|
code_samples: []
|
|
parameters:
|
|
- name: connected
|
|
type: boolean
|
|
default:
|
|
summary: |
|
|
Whether the instance got connected or disconnected.
|
|
- name: pin
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The pin on the `Class.AudioDeviceOutput` that the `Class.Wire`
|
|
targets.
|
|
- name: wire
|
|
type: Wire
|
|
default:
|
|
summary: |
|
|
The `Class.Wire` between the `Class.AudioDeviceOutput` and the other
|
|
instance.
|
|
- name: instance
|
|
type: Instance
|
|
default:
|
|
summary: |
|
|
The other instance that is or was connected through the `Class.Wire`.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Audio
|
|
callbacks: []
|