iphoneSetAudioCategory

Type

command

Summary

Sets the category identifier for an audio session.

Syntax

iphoneSetAudioCategory <category>

Description

Use the iphoneSetAudioCategory command to set the audio category identifier for the audio session.

The iphoneSetAudioCatagory command allows the current audio session category to be set and changed while the application is running. This command should be used if the application sound output is to be muted, played on its own or mixed with the sound from other applications.

note

When using the record sound command the category will be temporarily overridden to "play and record" and will be reverted back by the stop recording command.

Parameters

Name	Type	Description
category	enum	The audio category to use.

Examples

iphoneSetAudioCategory "ambient"

iphoneSetAudioCategory "play and record"

Related

command: play, play file, mobilePlaySoundOnChannel

Compatibility and Support

Introduced

LiveCode 5.5.3

OS

ios

Platforms

mobile