mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 22:11:38 +00:00
92 lines
4 KiB
YAML
92 lines
4 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: AudioChannelLayout
|
||
type: enum
|
||
summary: |
|
||
Describes the channel layout of an audio stream.
|
||
description: |
|
||
The `AudioChannelLayout` enum describes the channel layout of an audio stream.
|
||
Audio streams contain one or more channels that are intended to be rendered
|
||
simultaneously with a particular arrangement of speakers. In general, more
|
||
channels impact performance but provide higher spatial quality.
|
||
code_samples: []
|
||
tags: []
|
||
deprecation_message: ''
|
||
items:
|
||
- name: Mono
|
||
summary: |
|
||
Monaural audio streams contain only one **Center** channel.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Mono.jpg" width="810" alt="Diagram showing position of channels for Mono layout." />
|
||
value: 0
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: Stereo
|
||
summary: |
|
||
Stereophonic audio streams consist of two channels: **Left** and
|
||
**Right**.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Stereo.jpg" width="810" alt="Diagram showing position of channels for Stereo layout." />
|
||
value: 1
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: Quad
|
||
summary: |
|
||
Quadrophonic audio streams consist of four channels: **Left**, **Right**,
|
||
**BackLeft**, and **BackRight**. Quadrophonic streams can encode
|
||
forward/backward spatial information that stereo streams might struggle
|
||
with.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Quad.jpg" width="810" alt="Diagram showing position of channels for Quad layout." />
|
||
value: 2
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: Surround_5
|
||
summary: |
|
||
Surround sound audio streams consist of five channels: **Left**,
|
||
**Right**, **Center**, **BackLeft**, and **BackRight**. Surround sound
|
||
streams encode spatial information with better resolution front and
|
||
center.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_5.jpg" width="810" alt="Diagram showing position of channels for Surround 5 layout." />
|
||
value: 3
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: Surround_5_1
|
||
summary: |
|
||
5.1 surround sound consists of six channels: **Left**, **Right**,
|
||
**Center**, **BackLeft**, **BackRight**, and a **Sub** (subsonic)
|
||
low‑frequency channel. 5.1 surround sound benefits from low frequencies
|
||
being less directional in order to encode higher resolution spatial
|
||
information versus simple 5‑channel surround sound.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_5_1.jpg" width="810" alt="Diagram showing position of channels for Surround 5.1 layout." />
|
||
value: 4
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: Surround_7_1
|
||
summary: |
|
||
7.1 surround sound consists of eight channels: **Left**, **Right**,
|
||
**Center**, **SurroundLeft**, **SurroundRight**, **BackLeft**,
|
||
**BackRight**, and a **Sub** (subsonic) low‑frequency channel. 7.1
|
||
surround sound is an improvement over 5.1 surround sound, offering better
|
||
spatial resolution directly to the left and right as well.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_7_1.jpg" width="810" alt="Diagram showing position of channels for Surround 7.1 layout." />
|
||
value: 5
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: Surround_7_1_4
|
||
summary: |
|
||
7.1.4 surround sound consists of twelve channels: **Left**, **Right**,
|
||
**Center**, **SurroundLeft**, **SurroundRight**, **BackLeft**,
|
||
**BackRight**, **Sub**, **TopLeft**, **TopRight**, **TopBackLeft**, and
|
||
**TopBackRight**. 7.1.4 is the only currently supported channel layout
|
||
that encodes height information.
|
||
|
||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_7_1_4.jpg" width="810" alt="Diagram showing position of channels for Surround 7.1.4 layout." />
|
||
value: 6
|
||
tags: []
|
||
deprecation_message: ''
|