lovr.audio.setDevice

Switches either the playback or capture device to a new one.

If a device for the given type is already active, it will be stopped and destroyed. The new device will not be started automatically, use lovr.audio.start to start it.

A device id (previously retrieved using lovr.audio.getDevices) can be given to use a specific audio device, or nil can be used for the id to use the default audio device.

A sink can be also be provided when changing the device. A sink is an audio stream (Sound object with a stream type) that will receive all audio samples played (for playback) or all audio samples captured (for capture). When an audio device with a sink is started, be sure to periodically call Sound:read on the sink to read audio samples from it, otherwise it will overflow and discard old data. The sink can have any format, data will be converted as needed. Using a sink for the playback device will reduce performance, but this isn't the case for capture devices.

Audio devices can be started in shared or exclusive mode. Exclusive devices may have lower latency than shared devices, but there's a higher chance that requesting exclusive access to an audio device will fail (either because it isn't supported or allowed). One strategy is to first try the device in exclusive mode, switching to shared if it doesn't work.

success = lovr.audio.setDevice(type, id, sink, mode)

Arguments

NameTypeDefaultDescription
typeAudioType'playback'The device to switch.
iduserdatanilThe id of the device to use, or nil to use the default device.
sinkSoundnilAn optional audio stream to use as a sink for the device.
modeAudioShareModesharedThe sharing mode for the device.

Returns

NameTypeDescription
successbooleanWhether creating the audio device succeeded.

See also