su.plo.voice.api.client.audio.device

Interface DeviceManager

public interface DeviceManager

This manager can be used to add or remove devices

Method Summary

Modifier and Type	Method and Description
void	add(@NotNull AudioDevice device) Adds new device
void	clear(@Nullable DeviceType type) Removes all devices
SourceGroup	createSourceGroup(@Nullable DeviceType type) Creates a new source group todo: doc
<T extends AudioDevice> java.util.Collection<T>	getDevices(@Nullable DeviceType type) Returns immutable collection of devices by type (if type is empty then all devices will be returned)
InputDevice	openInputDevice(@Nullable javax.sound.sampled.AudioFormat format, @NotNull Params params) Opens a new input device from config device name
OutputDevice<AlSource>	openOutputDevice(@Nullable javax.sound.sampled.AudioFormat format, @NotNull Params params) Opens a new output device from config device name
void	remove(@NotNull AudioDevice device) Removes the device
void	replace(@Nullable AudioDevice oldDevice, @NotNull AudioDevice newDevice) Replaces old device with the new one

Method Detail

add

void add(@NotNull
         @NotNull AudioDevice device)

Adds new device

Parameters:

device - the device

replace

void replace(@Nullable
             @Nullable AudioDevice oldDevice,
             @NotNull
             @NotNull AudioDevice newDevice)

Replaces old device with the new one

Parameters:

oldDevice - old device if null first device will be replaced

newDevice - new device

remove

void remove(@NotNull
            @NotNull AudioDevice device)

Removes the device

Parameters:

device - the device

clear

void clear(@Nullable
           @Nullable DeviceType type)

Removes all devices

Parameters:

type - the device type (if type is empty then all devices will be removed)

getDevices

<T extends AudioDevice> java.util.Collection<T> getDevices(@Nullable
                                                           @Nullable DeviceType type)

Returns immutable collection of devices by type (if type is empty then all devices will be returned)

Parameters:

type - the device type

createSourceGroup

SourceGroup createSourceGroup(@Nullable
                              @Nullable DeviceType type)

Creates a new source group todo: doc

Returns:

the source group

openInputDevice

InputDevice openInputDevice(@Nullable
                            @Nullable javax.sound.sampled.AudioFormat format,
                            @NotNull
                            @NotNull Params params)
                     throws java.lang.Exception

Opens a new input device from config device name

Parameters:

format - audio format if null current ServerInfo voice format will be used

params - device params, may be different depending on DeviceFactory

Returns:

the input device

Throws:

java.lang.Exception - if device cannot be open

openOutputDevice

OutputDevice<AlSource> openOutputDevice(@Nullable
                                        @Nullable javax.sound.sampled.AudioFormat format,
                                        @NotNull
                                        @NotNull Params params)
                                 throws java.lang.Exception

Opens a new output device from config device name

Parameters:

format - audio format if null current ServerInfo voice format will be used

params - device params, may be different depending on DeviceFactory

Returns:

the output device

Throws:

java.lang.Exception - if device cannot be open