mergAVAudioSessionSetMode

Typecommand
DictionaryLCS
LibraryLiveCode Script
Syntax
mergAVAudioSessionSetMode <pMode>
Associationsmergav
Summary

iOS5+

Introduced8.0
OSios, mac
Platformsdesktop, mobile
Parameters
NameTypeDescription
pMode
  • default : When this mode is in use, audio session behavior matches that of iOS versions prior to iOS 5.0. You can use this mode with every audio session category. On devices more than one built-in microphone, the primary microphone is used.
  • voice chat : Specify this mode if your app is performing two-way voice communication, such as using Voice over Internet Protocol (VoIP). When this mode is in use, the device‰??s tonal equalization is optimized for voice. For use with the "play an record" audio session category. On devices with more than one built-in microphone, the primary microphone is used.
  • video recording : Specify this mode if your app is recording a movie. For use with the "record" audio session category. Also works with the "play and record" category. On devices with more than one built-in microphone, the microphone closest to the video camera is used. Using this mode may result in the system providing appropriate audio signal processing.
  • measurement : Specify this mode if your app is performing measurement of incoming audio. When this mode is in use, the device does not perform automatic gain adjustment on incoming audio. For use with the "record" or "play and record" audio session categories. On devices with more than one built-in microphone, the primary microphone is used.
  • movie playback : iOS 6 only. Specify this mode if your app is playing back movie content. When this mode is in use, the device engages any appropriate signal processing hardware to improve audio content played over the built-in speaker.
Values
NameTypeDescription
return

an error message if setting the category failed

Description

Set the audio session mode. An audio session mode is a key that identifies a set of device audio configuration details, such as whether or not the device performs automatic gain adjustment on incoming audio. A mode refines the configuration provided by a category.

Tagsexternals