This class encapsulates properties and methods to handle audio output thread on iOS/Android.
You may be able to reduce the power consumption of your app or game by using this class. In general, for apps with simple
looped music and short sound effects, you should set AudioSettings.Mobile.stopAudioOutputOnMute to true, and also call
AudioSettings.Mobile.StopAudioOutput if the user of your app sets music/sound volume to 0 in game settings. This helps to reduce
power consumption on most mobile devices. Also you can check AudioSettings.Mobile.muteState property and listen to
AudioSettings.Mobile.OnMuteStateChanged event to stop/start audio output thread when required.
However, if your game or app has more complex sound or music logic, doing this could cause synchronization issues. In particular, any sounds playing
when output is stopped are resumed from the same position when output is restarted, and so may be out of sync with any gameplay code that continued
to run during that time. Therefore this setting may not be suitable if you are relying on gameplay elements that should be synchronized with parts of
audio that may be continuing to play during output being switched off or on.
audioOutputStarted | Returns true if audio output thread is working. |
muteState | Returns true if current device media volume is 0. |
stopAudioOutputOnMute | Set this property to true to make audio output thread automatically stop when device media volume is set to 0 and to start it again when volume is not 0. |
StartAudioOutput | Starts audio output thread on Android/iOS. |
StopAudioOutput | Stops audio thread on Android/iOS. |
OnMuteStateChanged | A delegate called whenever the device mute state is changed. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.