Linphone.AudioDevice Class Reference

Inheritance diagram for Linphone.AudioDevice:

Public Member Functions
bool	HasCapability (Linphone.AudioDeviceCapabilities capability)

Properties
Linphone.AudioDeviceCapabilities	Capabilities [get]
string	DeviceName [get]
string	DriverName [get]
bool	FollowsSystemRoutingPolicy [get]
string	Id [get]
Linphone.AudioDeviceType	Type [get]
bool	UseForRinging [get, set]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

Object holding audio device information.

It contains the name of the device, it's type if available (Earpiece, Speaker, Bluetooth, etc..) and capabilities (input, output or both) the name of the driver that created it (filter in mediastreamer). You can use the Linphone.AudioDevice objects to configure default input/output devices or do it dynamically during a call. To get the list of available devices, use Linphone.Core.AudioDevices. This list will be limited to one device of each type. Use Linphone.Core.ExtendedAudioDevices for a complete list.

Member Function Documentation

bool Linphone.AudioDevice.HasCapability ( Linphone.AudioDeviceCapabilities  capability )

inline

Returns whether or not the audio device has the given capability.

Parameters

capability

the Linphone.AudioDeviceCapabilities to check

Returns

true if the audio device has the capability, false otherwise

Property Documentation

Linphone.AudioDeviceCapabilities Linphone.AudioDevice.Capabilities

get

Returns the capabilities of the device.

Returns

the Linphone.AudioDeviceCapabilities of the audio device (RECORD, PLAY or both) as a bit mask

string Linphone.AudioDevice.DeviceName

get

Returns the name of the audio device.

Returns

the name of the audio device.

string Linphone.AudioDevice.DriverName

get

Returns the driver name used by the device.

Returns

the name of the driver used by this audio device.

bool Linphone.AudioDevice.FollowsSystemRoutingPolicy

get

Returns whether the audio device automatically follows the system's audio routing policy.

This capability is available on some system (typically iOS) and might be convenient to simply specify liblinphone to let the system decide about which audio route is being used to handle a call. The actual Linphone.AudioDeviceType may be unknown at some point, typically when no calls are running, otherwise it is reflected to be the actual system's audio route.

Returns

true if the audio device automatically follows the system audio routing policy.

string Linphone.AudioDevice.Id

get

Returns the id of the audio device.

Returns

the id of the audio device.

Linphone.AudioDeviceType Linphone.AudioDevice.Type

get

Returns the type of the device.

Returns

the Linphone.AudioDeviceType of the audio device (microphone, speaker, earpiece, bluetooth, etc...)

bool Linphone.AudioDevice.UseForRinging

getset

Returns whether the audio device is used to play the ringtone or not.

Returns

Whether the audio device is used to play the ringtone or not.

---

The documentation for this class was generated from the following file:

• LinphoneWrapper.cs