View source

enum abstract AudioPlaybackMode(Null<Int>)

package openfl.media

@:enum

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the SoundMixer class.

Known Issue: No audio is played in the Media Playback mode for StageVideo, when the mute switch is ON.

Each of these constants represents a set of behavior for audio on mobile tailored to a particular use.

Variables

@:value(cast 0)@:impl@:enuminlineread onlyAMBIENT:AudioPlaybackMode = 0

A mode for playing ambient sound. Use this mode for playing sounds that are accompaniments to the actual purpose of the application and are not necessary for its successful use. When using this mode, audio is routed through the speakerphone. If headphones are plugged in, they override the speakerphone. The operating system uses defaults for ambient sound when deciding behavior and priority for audio.

This setting has no special effect on the desktop or TV.

On iOS, using this mode causes audio to be silenced by locking the screen (or sending the app to the background by any other means) and enabling the hardware Silent switch while the Microphone is not in use. If a Microphone is in use, audio is not affected by these actions.

Note: Audio is not silenced by the Silent switch if a Headset is connected.

@:value(cast 1)@:impl@:enuminlineread onlyMEDIA:AudioPlaybackMode = 1

A mode for playing media sounds. When using this mode on mobile, sound is routed through the speakerphone. If headphones are plugged in they override the speakerphone. The operating system uses defaults for media audio when deciding behavior and priority for audio.

This setting has no special effect on the desktop or TV.

This is the default.

@:value(cast 2)@:impl@:enuminlineread onlyVOICE:AudioPlaybackMode = 2

A mode for playing voice audio. When using this mode, audio is routed through the phone earpiece by default. If headphones are plugged in they override the earpiece. If the SoundMixer.useSpeakerphoneForVoice property is set, sound goes to the speakerphone, overriding the earpiece/headphones. The operating system uses defaults for voice audio when deciding behavior and priority for audio.

Try to minimize usage of AudioPlaybackMode.VOICE, and try to switch to AudioPlaybackMode.MEDIA as soon as possible after a voice call ends, which allows other applications to play in media mode.

This setting has no special effect on the desktop or TV.