using System.Runtime.InteropServices;
/// <summary>
-/// Interop class for Wi-Fi Direct
+/// The Interop class for Wi-Fi Direct.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Wi-Fi Direct Native Apis
+ /// The Wi-Fi Direct native APIs.
/// </summary>
internal static partial class WiFiDirect
{
namespace Tizen.Network.WiFiDirect
{
/// <summary>
- /// Enumeration for Wi-Fi Direct discovery state.
+ /// Enumeration for the Wi-Fi Direct discovery state.
/// </summary>
public enum WiFiDirectDiscoveryState
{
}
/// <summary>
- /// Enumeration for Wi-Fi Direct display device type.
+ /// Enumeration for the Wi-Fi Direct display device types.
/// </summary>
public enum WiFiDirectDisplayType
{
/// <summary>
- /// Configure as WFD source.
+ /// Configure as the WFD source.
/// </summary>
Source = 0,
/// <summary>
- /// Configure as WFD primary sink.
+ /// Configure as the WFD primary sink.
/// </summary>
Prisink,
/// <summary>
- /// Configure as WFD secondary sink.
+ /// Configure as the WFD secondary sink.
/// </summary>
Secsink,
/// <summary>
- /// Configure as WFD dual role.
+ /// Configure as the WFD dual role.
/// </summary>
Dual
}
/// <summary>
- /// Enumeration for Wi-Fi Discovery channel.
+ /// Enumeration for the Wi-Fi Discovery channel.
/// </summary>
public enum WiFiDirectDiscoveryChannel
{
}
/// <summary>
- /// Enumeration for Wi-Fi Direct connection state.
+ /// Enumeration for the Wi-Fi Direct connection state.
/// </summary>
public enum WiFiDirectConnectionState
{
/// </summary>
ConnectionRequest,
/// <summary>
- /// Wps is requested.
+ /// WPS is requested.
/// </summary>
ConnectionWpsRequest,
/// <summary>
/// </summary>
ConnectionInProgress,
/// <summary>
- /// Connected .
+ /// Connected.
/// </summary>
ConnectionRsp,
/// <summary>
- /// Disconnected by remote group client.
+ /// Disconnected by the remote group client.
/// </summary>
DisassociationInd,
/// <summary>
- /// Disconnected by local device.
+ /// Disconnected by the local device.
/// </summary>
DisconnectRsp,
/// <summary>
- /// Disconnected by remote group owner.
+ /// Disconnected by the remote group owner.
/// </summary>
DisconnectInd,
/// <summary>
}
/// <summary>
- /// Enumeration for Wi-Fi Direct primary device type.
+ /// Enumeration for the Wi-Fi Direct primary device type.
/// </summary>
public enum WiFiDirectPrimaryDeviceType
{
}
/// <summary>
- /// Enumeration for Wi-Fi Direct secondary device type.
+ /// Enumeration for the Wi-Fi Direct secondary device type.
/// </summary>
public enum WiFiDirectSecondaryDeviceType
{
/// </summary>
ComputerNotebook = 5,
/// <summary>
- /// Computer desktop
+ /// Computer desktop.
/// </summary>
ComputerDesktop = 6,
/// <summary>
/// </summary>
InputController = 5,
/// <summary>
- /// Inpute remote.
+ /// Input remote.
/// </summary>
InputRemote = 6,
/// <summary>
/// </summary>
StorageNas = 1,
/// <summary>
- /// Network ap.
+ /// Network AP.
/// </summary>
NetworkAp = 1,
/// <summary>
/// </summary>
NetworkGateway = 4,
/// <summary>
- /// Display tv.
+ /// Display TV.
/// </summary>
DisplayTv = 1,
/// <summary>
/// </summary>
MultimediaStb = 4,
/// <summary>
- /// Media Server / Media Adapter / Media Extender.
+ /// Media Server/Media Adapter/Media Extender.
/// </summary>
MultimediaMsMaMe = 5,
/// <summary>
/// </summary>
GameXbox = 1,
/// <summary>
- /// The game xbox 360.
+ /// Game xbox 360.
/// </summary>
GameXbox360,
/// <summary>
/// </summary>
TelephonePhoneDual = 3,
/// <summary>
- /// Smart Phone - single mode.
+ /// Smartphone - single mode.
/// </summary>
TelephoneSmartphoneSingle = 4,
/// <summary>
- /// Smart Phone - dual mode.
+ /// Smartphone - dual mode.
/// </summary>
TelephoneSmartphoneDual = 5,
/// <summary>
/// </summary>
AudioSpeaker = 2,
/// <summary>
- /// Audio pmp.
+ /// Audio PMP.
/// </summary>
AudioPmp = 3,
/// <summary>
}
/// <summary>
- /// Enumeration for Wi-Fi Direct link status.
+ /// Enumeration for the Wi-Fi Direct link status.
/// </summary>
public enum WiFiDirectState
{
}
/// <summary>
- /// Enumeration for Wi-Fi WPS type.
+ /// Enumeration for the Wi-Fi WPS type.
/// </summary>
public enum WiFiDirectWpsType
{
}
/// <summary>
- /// Enumeration for Service Discovery type.
+ /// Enumeration for the service discovery type.
/// </summary>
public enum WiFiDirectServiceType
{
/// <summary>
- /// Service discovery Type all.
+ /// The service discovery type All.
/// </summary>
All,
/// <summary>
- /// Service discovery Type bonjour.
+ /// The service discovery type Bonjour.
/// </summary>
Bonjour,
/// <summary>
- /// Service discovery Type UPNP.
+ /// The service discovery type UPNP.
/// </summary>
Upnp,
/// <summary>
- /// Service discovery Type ws discovery.
+ /// The service discovery type WS Discovery.
/// </summary>
WsDiscovery,
/// <summary>
- /// Service discovery Type wifi-display.
+ /// The service discovery type Wi-Fi Display.
/// </summary>
WiFiDisplay,
/// <summary>
- /// Service discovery Type bt address.
+ /// The service discovery type BT Address.
/// </summary>
BtAddress,
/// <summary>
- /// Service discovery Type contact info.
+ /// The service discovery type Contact Info.
/// </summary>
ContactInfo,
/// <summary>
- /// Service discovery Type vendor-specific.
+ /// The service discovery type vendor-specific.
/// </summary>
Vendor
}
/// <summary>
- /// Enumeration for Wi-Fi Direct service Discovery state.
+ /// Enumeration for the Wi-Fi Direct service discovery state.
/// </summary>
public enum WiFiDirectServiceDiscoveryState
{
/// <summary>
- /// Service discovery started.
+ /// The service discovery Started.
/// </summary>
Started,
/// <summary>
- /// Service discovery found.
+ /// The service discovery Found.
/// </summary>
Found,
/// <summary>
- /// Service discovery finished.
+ /// The service discovery Finished.
/// </summary>
Finished
}
/// <summary>
- /// Enumeration for Wi-Fi Direct device state.
+ /// Enumeration for the Wi-Fi Direct device state.
/// </summary>
public enum WiFiDirectDeviceState
{
}
/// <summary>
- /// Enumeration for Wi-Fi Direct error code.
+ /// Enumeration for the Wi-Fi Direct error code.
/// </summary>
public enum WiFiDirectError
{
/// </summary>
PermissionDenied = ErrorCode.PermissionDenied,
/// <summary>
- /// Device or resource busy.
+ /// Device or the resource is busy.
/// </summary>
ResourceBusy = ErrorCode.ResourceBusy,
/// <summary>
/// </summary>
CommunicationFailed = -0x01C60000 | 0x02,
/// <summary>
- /// WiFi is being used.
+ /// Wi-Fi is being used.
/// </summary>
WiFiUsed = -0x01C60000 | 0x03,
/// <summary>
/// </summary>
OperationFailed = -0x01C60000 | 0x07,
/// <summary>
- /// Too many client.
+ /// Too many clients.
/// </summary>
TooManyClient = -0x01C60000 | 0x08,
/// <summary>
- /// Already initialized client.
+ /// Already initialized the client.
/// </summary>
AlreadyInitialized = -0x01C60000 | 0x09,
/// <summary>
- /// Connection cancelled by local device.
+ /// Connection cancelled by the local device.
/// </summary>
ConnectionCancelled = -0x01C60000 | 0x10
}
namespace Tizen.Network.WiFiDirect
{
/// <summary>
- /// An extended EventArgs class which contains changed connection state during connecting or disconnecting peer device.
+ /// An extended EventArgs class which contains the changed connection state during connecting or disconnecting the peer device.
/// </summary>
public class ConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct result.
+ /// The Wi-Fi Direct result.
/// </summary>
public WiFiDirectError Error
{
}
/// <summary>
- /// Wi-Fi Direct connection state of peer.
+ /// The Wi-Fi Direct connection state of the peer.
/// </summary>
public WiFiDirectConnectionState State
{
}
/// <summary>
- /// MacAddress of peer.
+ /// The MacAddress of the peer.
/// </summary>
public string MacAddress
{
}
/// <summary>
- /// MacAddress of connected peer.
+ /// The MacAddress of the connected peer.
/// </summary>
public string MacAddress
{
}
/// <summary>
- /// IpAddress of connected peer.
+ /// The IpAddress of the connected peer.
/// </summary>
public string IpAddress
{
}
/// <summary>
- /// InterfaceAddress of connected peer.
+ /// The InterfaceAddress of the connected peer.
/// </summary>
public string InterfaceAddress
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Wi-Fi Direct state of local device.
+ /// An extended EventArgs class which contains the changed Wi-Fi Direct state of the local device.
/// </summary>
public class StateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct state.
+ /// The Wi-Fi Direct state.
/// </summary>
public WiFiDirectState State
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Wi-Fi Direct discovery state during Wi-Fi Direct scan operation.
+ /// An extended EventArgs class which contains the changed Wi-Fi Direct discovery state during the Wi-Fi Direct scan operation.
/// </summary>
public class DiscoveryStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct result.
+ /// The Wi-Fi Direct result.
/// </summary>
public WiFiDirectError Error
{
}
/// <summary>
- /// Wi-Fi Direct Discovery state.
+ /// The Wi-Fi Direct discovery state.
/// </summary>
public WiFiDirectDiscoveryState DiscoveryState
{
}
/// <summary>
- /// An extended EventArgs class which contains found peer information during Wi-Fi Direct scan operation.
+ /// An extended EventArgs class which contains the found peer information during the Wi-Fi Direct scan operation.
/// </summary>
public class PeerFoundEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct result.
+ /// The Wi-Fi Direct result.
/// </summary>
public WiFiDirectError Error
{
}
/// <summary>
- /// Wi-Fi Direct Discovery state.
+ /// The Wi-Fi Direct discovery state.
/// </summary>
public WiFiDirectDiscoveryState DiscoveryState
{
}
/// <summary>
- /// Found peer.
+ /// The found peer.
/// </summary>
public WiFiDirectPeer Peer
{
}
/// <summary>
- /// An extended EventArgs class which contains changed device state during activation or deactivation.
+ /// An extended EventArgs class which contains the changed device state during activation or deactivation.
/// </summary>
public class DeviceStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct result.
+ /// The Wi-Fi Direct result.
/// </summary>
public WiFiDirectError Error
{
}
/// <summary>
- /// State of the device.
+ /// The state of the device.
/// </summary>
public WiFiDirectDeviceState DeviceState
{
}
/// <summary>
- /// An extended EventArgs class which contains changed service information during service discovery.
+ /// An extended EventArgs class which contains the changed service information during the service discovery.
/// </summary>
public class ServiceStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct result.
+ /// The Wi-Fi Direct result.
/// </summary>
public WiFiDirectError Error
{
}
/// <summary>
- /// Service discovery state.
+ /// The service discovery state.
/// </summary>
public WiFiDirectServiceDiscoveryState ServiceDiscoveryState
{
}
/// <summary>
- /// Types of service.
+ /// The types of service.
/// </summary>
public WiFiDirectServiceType ServiceType
{
}
/// <summary>
- /// Received response.
+ /// The received response.
/// </summary>
public string Response
{
}
/// <summary>
- /// Peer servicing device.
+ /// The peer servicing device.
/// </summary>
public WiFiDirectPeer Peer
{
}
/// <summary>
- /// An extended EventArgs class which contains changed connection state during disconnect all peers or group related operations.
+ /// An extended EventArgs class which contains the changed connection state during disconnecting of all peers or grouping related operations.
/// </summary>
public class ConnectionStatusChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Wi-Fi Direct result.
+ /// The Wi-Fi Direct result.
/// </summary>
public WiFiDirectError Error
{
}
/// <summary>
- /// Connection state.
+ /// The connection state.
/// </summary>
public WiFiDirectConnectionState ConnectionState
{
}
/// <summary>
- /// Initializes or Deintializes the WiFi-Direct Display(MIRACAST) service.
+ /// Initializes or Deintializes the Wi-Fi Direct Display(MIRACAST) service.
/// </summary>
/// <param name="enable">Enables/Disables service.</param>
/// <privilege>
}
/// <summary>
- /// Implementation of Wi-Fi Direct Apis
+ /// The implementation of Wi-Fi Direct APIs.
/// </summary>
internal partial class WiFiDirectManagerImpl : IDisposable
{
namespace Tizen.Network.WiFiDirect
{
/// <summary>
- /// WiFiDirectPeer class is used to handle the connection with remote devices using WiFi Direct.
+ /// The WiFiDirectPeer class is used to handle the connection with remote devices using Wi-Fi Direct.
/// </summary>
/// <privilege> http://tizen.org/privilege/wifidirect </privilege>
public class WiFiDirectPeer
}
/// <summary>
- /// Name of Peer device.
+ /// The name of the peer device.
/// </summary>
public string Name
{
}
/// <summary>
- /// Ip address of the peer device.
+ /// The IP address of the peer device.
/// </summary>
public string IpAddress
{
}
/// <summary>
- /// Mac address of the peer device.
+ /// The MAC address of the peer device.
/// </summary>
public string MacAddress
{
}
/// <summary>
- /// Interface address of the peer device.
+ /// The Interface address of the peer device.
/// </summary>
public string InterfaceAddress
{
}
/// <summary>
- /// Listening channel of the peer device.
+ /// The listening channel of the peer device.
/// </summary>
public int Channel
{
}
/// <summary>
- /// Connected state of the peer device.
+ /// The connected state of the peer device.
/// </summary>
public bool IsConnected
{
}
/// <summary>
- /// P2P group state of the peer device.
+ /// The P2P group state of the peer device.
/// </summary>
public bool IsGroupOwner
{
}
/// <summary>
- /// P2P state of the peer device.
+ /// The P2P state of the peer device.
/// </summary>
public bool P2PSupport
{
}
/// <summary>
- /// Primary catagory of the peer device.
+ /// The primary catagory of the peer device.
/// </summary>
public WiFiDirectPrimaryDeviceType PrimaryType
{
}
/// <summary>
- /// Sub category of the peer device.
+ /// The sub category of the peer device.
/// </summary>
public WiFiDirectSecondaryDeviceType SecondaryType
{
}
/// <summary>
- /// List of supported WPS type of the peer device.
+ /// The list of the supported WPS type of the peer device.
/// </summary>
public int WpsTypes
{
}
/// <summary>
- /// P2P invitation state of the peer device.
+ /// The P2P invitation state of the peer device.
/// </summary>
public bool IsP2PInvitationSupported
{
}
/// <summary>
- /// Number of registered services of the peer device.
+ /// The number of registered services of the peer device.
/// </summary>
public uint ServiceCount
{
}
/// <summary>
- /// List of registered services of the peer device.
+ /// The list of registered services of the peer device.
/// </summary>
public IEnumerable<string> ServiceList
{
}
/// <summary>
- /// Checks if peer device is a wifi display device.
+ /// Checks if the peer device is a Wi-Fi display device.
/// </summary>
public bool IsMiracastDevice
{
}
/// <summary>
- /// Wi-Fi Display device type of the peer device.
+ /// The Wi-Fi display device type of the peer device.
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
- /// If there is any error, default value of WiFiDirectDisplayType will be returned.
+ /// If there is any error, a default value of WiFiDirectDisplayType will be returned.
/// </remarks>
public WiFiDirectDisplayType Display
{
}
/// <summary>
- /// Wi-Fi Display Session Availability of the peer device.
+ /// The Wi-Fi display session availability of the peer device.
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
}
/// <summary>
- /// Hdcp information of the peer device.
+ /// The HDCP information of the peer device.
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
}
/// <summary>
- /// Port of the connected peer device.
+ /// The port of the connected peer device.
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
}
/// <summary>
- /// WiFi Display max throughput of the peer device.
+ /// The Wi-Fi display maximum throughput of the peer device.
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
}
/// <summary>
- /// WiFi RSSI value of the peer device.
+ /// The Wi-Fi RSSI value of the peer device.
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
}
}
/// <summary>
- /// (event) ConnectionStateChanged event is raised when the connection state of the peer device changes.
+ /// The ConnectionStateChanged event is raised when the connection state of the peer device changes.
/// </summary>
public event EventHandler<ConnectionStateChangedEventArgs> ConnectionStateChanged
{
}
/// <summary>
- /// (event) IpAddressAssigned event is raised when ip address of the peer device is assigned.
+ /// The IpAddressAssigned event is raised when the IP address of the peer device is assigned.
/// </summary>
public event EventHandler<IpAddressAssignedEventArgs> IpAddressAssigned
{
}
/// <summary>
- /// (event) ServiceStateChanged is raised when state of service discovery is changed.
+ /// The ServiceStateChanged event is raised when the state of service discovery is changed.
/// </summary>
public event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged
{
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
- /// If this succeeds, ConnectionStateChanged event will be invoked.
+ /// If this succeeds, the ConnectionStateChanged event will be invoked.
/// </remarks>
- /// <exception cref="NotSupportedException">Thrown when the wifidirect is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi Direct is not supported</exception>
public void Connect()
{
if (Globals.IsActivated)
/// <remarks>
/// Wi-Fi Direct must be activated.
/// </remarks>
- /// <exception cref="NotSupportedException">Thrown when the wifidirect is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi Direct is not supported.</exception>
public void CancelConnection()
{
if (Globals.IsActivated)
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
- /// If this succeeds, ConnectionStateChanged event will be invoked.
+ /// If this succeeds, the ConnectionStateChanged event will be invoked.
/// </remarks>
- /// <exception cref="NotSupportedException">Thrown when the wifidirect is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi Direct is not supported.</exception>
public void Disconnect()
{
if (Globals.IsActivated)
/// <remarks>
/// Wi-Fi Direct must be activated.
/// </remarks>
- /// <exception cref="NotSupportedException">Thrown when the wifidirect is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi Direct is not supported.</exception>
public void SetAutoConnect()
{
if (Globals.IsActivated)
/// </summary>
/// <remarks>
/// Wi-Fi Direct must be activated.
- /// If this succeeds, ServiceStateChanged event will be invoked.
+ /// If this succeeds, the ServiceStateChanged event will be invoked.
/// </remarks>
/// <exception cref="NotSupportedException">
- /// Thrown during one of the following cases :
- /// 1. When the wifidirect is not supported
- /// 2. When the wifidirect service discovery is not supported
+ /// Thrown during one of the following cases:
+ /// 1. When the Wi-Fi Direct is not supported.
+ /// 2. When the Wi-Fi Direct service discovery is not supported.
/// </exception>
- /// <param name="type">Type of service.</param>
+ /// <param name="type">The type of the service.</param>
public void StartServiceDiscovery(WiFiDirectServiceType type)
{
if (Globals.IsActivated)
/// Wi-Fi Direct must be activated.
/// </remarks>
/// <exception cref="NotSupportedException">
- /// Thrown during one of the following cases :
- /// 1. When the wifidirect is not supported
- /// 2. When the wifidirect service discovery is not supported
+ /// Thrown during one of the following cases:
+ /// 1. When the Wi-Fi Direct is not supported.
+ /// 2. When the Wi-Fi Direct service discovery is not supported.
/// </exception>
- /// <param name="type">Type of service.</param>
+ /// <param name="type">The type of the service.</param>
public void CancelServiceDiscovery(WiFiDirectServiceType type)
{
if (Globals.IsActivated)
}
/// <summary>
- /// MAC address of the persistent group owner.
+ /// The MAC address of the persistent group owner.
/// </summary>
public string MacAddress
{
}
/// <summary>
- /// SSID (Service Set Identifier) of the persistent group owner.
+ /// The SSID (Service Set Identifier) of the persistent group owner.
/// </summary>
public string Ssid
{
projects / platform / core / csapi / tizenfx.git / commitdiff