Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

AudioFormat

struct in UnityEngine.Audio

/

Implemented in:UnityEngine.AudioModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Represents an audio format containing information used for signal processing.

An AudioFormat provides information such as sample rate, speaker setup, and buffer size. It is used by types such as ControlContext and ProcessorInstance.

Additional resources: AudioConfiguration

Properties

Property Description
bufferFrameCount The number of audio frames processed in each audio callback.
channelCount The number of channels represented by the current speakerMode.
sampleRate The sample rate this AudioFormat is configured to run at.
speakerMode The speaker mode this AudioFormat is configured to run in.

Constructors

Constructor Description
AudioFormat Initializes a new instance of AudioFormat using the provided AudioConfiguration.