/// <summary>
/// Enumeration of transfer direction for Endpoints.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum EndpointDirection
{
/// <summary>
/// <summary>
/// Event arguments for Hot Plugged event for USB devices.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class HotPluggedEventArgs : EventArgs
{
internal HotPluggedEventArgs(UsbDevice device, HotplugEventType type)
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbDevice Device { get; }
/// <summary>
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public HotplugEventType EventType { get; }
}
}
/// <summary>
/// Enumeration of hot plugged event type for USB devices.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum HotplugEventType
{
/// <summary>
/// <summary>
/// Enumeration of isochronous endpoint's synchronization type.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum SynchronizationType
{
/// <summary>
/// <summary>
/// Enumeration of an endpoint's usage type.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum UsageType
{
/// <summary>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Transfer(byte[] buffer, int length, uint timeout)
{
return TransferImpl(buffer, length, timeout);
/// <summary>
/// Class to manage USB Configuration.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbConfiguration : IDisposable
{
internal readonly Interop.UsbConfigHandle _handle;
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool IsSelfPowered
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool SupportRemoteWakeup
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int MaximumPowerRequired
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IReadOnlyDictionary<int, UsbInterface> Interfaces
{
get
/// <exception cref="InvalidOperationException">
/// Throws exception if device is disconnected or not opened for operation or busy as its interfaces are currently claimed.
/// </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string ConfigurationString
{
get
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void SetAsActive()
{
ThrowIfDisposed();
/// <summary>
/// Releases all resources used by the ConnectionProfile.
/// It should be called after finished using of the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
/// <summary>
/// Releases all resources used by the ConnectionProfile.
/// It should be called after finished using of the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
Dispose(true);
/// <summary>
/// USB Control Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbControlEndpoint : UsbEndpoint
{
private readonly UsbDevice _device;
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5</since_tizen>
public new int Id
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public new EndpointDirection Direction
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public new int MaxPacketSize
{
get
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Transfer(byte requestType, byte request, ushort value, ushort index, byte[] data, ushort length, uint timeout)
{
_device.ThrowIfDisposed();
/// <summary>
/// Class to manage USB host devices. This class contains operations for enumerating, opening and closing devices.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbDevice : IDisposable
{
internal readonly Interop.HostDeviceHandle _handle;
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int BusId {
get
{
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Address
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IEnumerable<int> Ports
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool IsOpened
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbControlEndpoint ControlEndpoint
{
get
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation. </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbConfiguration ActiveConfiguration
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IReadOnlyDictionary<int, UsbConfiguration> Configurations
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbDeviceInformation DeviceInformation
{
get
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbDeviceStrings Strings
{
get
/// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Open()
{
ThrowIfDisposed();
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Close()
{
ThrowIfDisposed();
/// <summary>
/// Releases all resources used by the ConnectionProfile.
/// It should be called after finished using of the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
/// <summary>
/// Releases all resources used by the ConnectionProfile.
/// It should be called after finished using of the object.</summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
Dispose(true);
/// <summary>
/// Device information for USB device.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbDeviceInformation
{
private readonly UsbDevice _device;
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int UsbVersion
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Class
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Subclass
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Protocol
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int VendorId
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int ProductId
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int DeviceVersion
{
get
/// <summary>
/// String information for USB device.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbDeviceStrings
{
private readonly UsbDevice _device;
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string Manufacturer
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string Product
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string Serial
{
get
/// <summary>
/// USB Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbEndpoint
{
internal readonly Interop.UsbEndpointHandle _handle;
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Id
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public EndpointDirection Direction
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int MaxPacketSize
{
get
/// <summary>
/// Class to manage USB Interfaces.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbInterface
{
internal readonly Interop.UsbInterfaceHandle _handle;
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Id
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int AlternateSetting
{
set
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IReadOnlyDictionary<int, UsbEndpoint> Endpoints
{
get
/// <exception cref="InvalidOperationException">
/// Throws exception if device is disconnected or not opened for operation.
/// </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string InterfaceString
{
get
/// <exception cref="InvalidOperationException">
/// Throws exception if device is disconnected or not opened for operation or another program or driver has claimed the interface.
/// </exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Claim(bool force)
{
ThrowIfDisposed();
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Release()
{
ThrowIfDisposed();
/// <summary>
/// USB Interrupt Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbInterruptEndpoint : UsbEndpoint
{
internal UsbInterruptEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle)
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int PollingInterval
{
get
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Transfer(byte[] buffer, int length, uint timeout)
{
return TransferImpl(buffer, length, timeout);
/// <summary>
/// USB Isochronous Endpoint class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbIsochronousEndpoint : UsbEndpoint
{
internal UsbIsochronousEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle)
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public SynchronizationType SynchronizationType
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsageType UsageType
{
get
/// <summary>
/// USB Manager class.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class UsbManager : IDisposable
{
// It needs to be static as its destroy function must be called after closing all devices and before application close.
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public UsbManager()
{
if (_context == null) throw new NotSupportedException("USB host operations are not supported in this device");
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public IEnumerable<UsbDevice> AvailableDevices
{
get
/// </summary>
/// <feature>http://tizen.org/feature/usb.host</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<HotPluggedEventArgs> DeviceHotPlugged;
internal void HostHotplugAttachCallback(IntPtr devHandle, IntPtr userData)
Dispose(false);
}
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
Dispose(true);