mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 22:11:38 +00:00
rules
This commit is contained in:
Joe
parent
a9b4f8e83b
commit
e6efc04756
8494 changed files with 495610 additions and 0 deletions
|
|
@ -0,0 +1,307 @@
|
|||
# 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: AudioDeviceInput
|
||||
type: class
|
||||
memory_category: Internal
|
||||
summary: |
|
||||
Produces audio streams from physical devices, such as microphones.
|
||||
description: |
|
||||
`Class.AudioDeviceInput` produces audio streams from physical devices, such as
|
||||
microphones. It provides a single **Output** pin which can be connected to
|
||||
other pins via `Class.Wire|Wires`. `Class.AudioDeviceInput` has properties for
|
||||
selecting which `Class.Player` is producing the stream, and controlling
|
||||
whether or not they are muted.
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: AudioDeviceInput.AccessType
|
||||
summary: |
|
||||
Determines whether the list of user IDs provided to
|
||||
`Class.AudioDeviceInput.SetUserIdAccessList|SetUserIdAccessList` is
|
||||
treated as an allow-list or deny-list.
|
||||
description: |
|
||||
Determines whether the list of user IDs provided to
|
||||
`Class.AudioDeviceInput.SetUserIdAccessList|SetUserIdAccessList` is
|
||||
treated as an allow-list or deny-list.
|
||||
|
||||
If `Class.AudioDeviceInput.AccessType|AccessType` is
|
||||
`Enum.AccessModifierType.Allow`, then **only** the supplied user IDs are
|
||||
**permitted** to hear this `Class.AudioDeviceInput`. If
|
||||
`Class.AudioDeviceInput.AccessType|AccessType` is
|
||||
`Enum.AccessModifierType.Deny`, then **only** the supplied user IDs are
|
||||
**blocked** from hearing this `Class.AudioDeviceInput`.
|
||||
|
||||
Since player voices are networked, this property should only be assigned
|
||||
from the server in order to replicate properly.
|
||||
code_samples: []
|
||||
type: AccessModifierType
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Permissions
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput.Active
|
||||
summary: |
|
||||
Controls whether the physical device is actively recording.
|
||||
description: |
|
||||
Controls whether the physical device is actively recording. This property
|
||||
is only set by Roblox core scripts, but it may be read by user scripts.
|
||||
Generally, an `Class.AudioDeviceInput` may only be producing sound if
|
||||
`Class.AudioDeviceInput.Active|Active` is true **and**
|
||||
`Class.AudioDeviceInput.Muted|Muted` is false.
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Recording
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput.IsReady
|
||||
summary: |
|
||||
Denotes whether this `Class.AudioDeviceInput` is ready to produce sound.
|
||||
description: |
|
||||
Denotes whether this `Class.AudioDeviceInput` is ready to produce sound,
|
||||
meaning all network connections have been established.
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags:
|
||||
- ReadOnly
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Recording
|
||||
serialization:
|
||||
can_load: false
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput.Muted
|
||||
summary: |
|
||||
Controls whether this `Class.AudioDeviceInput` is muted.
|
||||
description: |
|
||||
Controls whether this `Class.AudioDeviceInput` is muted. Unlike
|
||||
`Class.AudioDeviceInput.Active|Active`, this property is publicly
|
||||
scriptable.
|
||||
|
||||
Generally, an `Class.AudioDeviceInput` may only be heard if
|
||||
`Class.AudioDeviceInput.Active|Active` is true **and**
|
||||
`Class.AudioDeviceInput.Muted|Muted` is false.
|
||||
code_samples:
|
||||
- audio-wiring---push-to-talk
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Recording
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput.MutedByLocalUser
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags:
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Recording
|
||||
serialization:
|
||||
can_load: false
|
||||
can_save: false
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput.Player
|
||||
summary: |
|
||||
Determines whose device is producing sound.
|
||||
description: |
|
||||
Determines whose device is producing sound. In order to replicate
|
||||
properly, this should only be assigned from the server. Assigning this
|
||||
property locally generally does not work, unless
|
||||
`Class.AudioDeviceInput.Player|Player` is `Class.Players.LocalPlayer`.
|
||||
code_samples: []
|
||||
type: Player
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Recording
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput.Volume
|
||||
summary: |
|
||||
Volume level which is multiplied onto the output audio stream.
|
||||
description: |
|
||||
Volume level which is multiplied onto the output audio stream. Ranges from
|
||||
0 to 3.
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: State
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
methods:
|
||||
- name: AudioDeviceInput: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.AudioDeviceInput` has one "Output" pin.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: pin
|
||||
type: string
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Instances
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput:GetInputPins
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Array
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput:GetOutputPins
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Array
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput:GetUserIdAccessList
|
||||
summary: |
|
||||
Returns a list of user IDs that are either permitted to hear or blocked
|
||||
from hearing this `Class.AudioDeviceInput`.
|
||||
description: |
|
||||
Returns a list of user IDs that are either permitted to hear or blocked
|
||||
from hearing this `Class.AudioDeviceInput`, depending on the
|
||||
`Class.AudioDeviceInput.AccessType|AccessType`.
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Array
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AudioDeviceInput:SetUserIdAccessList
|
||||
summary: |
|
||||
Sets a list of user IDs that are either permitted to hear or blocked from
|
||||
hearing this `Class.AudioDeviceInput`.
|
||||
description: |
|
||||
Sets a list of user IDs that are either permitted to hear or blocked from
|
||||
hearing this `Class.AudioDeviceInput`, depending on the
|
||||
`Class.AudioDeviceInput.AccessType|AccessType`.
|
||||
|
||||
Note that this method replicates from server to client; in general, it
|
||||
should only be called from the server in order to replicate properly.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userIds
|
||||
type: Array
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
events:
|
||||
- name: AudioDeviceInput.WiringChanged
|
||||
summary: |
|
||||
Fires when another instance is connected to or disconnected from the
|
||||
`Class.AudioDeviceInput` 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.AudioDeviceInput` 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.AudioDeviceInput` that the `Class.Wire` targets.
|
||||
- name: wire
|
||||
type: Wire
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Wire` between the `Class.AudioDeviceInput` 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: []
|
||||
callbacks: []
|
||||
Loading…
Add table
Add a link
Reference in a new issue