Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PlayerSettings.XboxOne.GetSocketDefinition

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function GetSocketDefinition(name: string, out port: string, out protocol: int, out usages: int[], out templateName: string, out sessionRequirment: int, out deviceUsages: int[]): void;
public static void GetSocketDefinition(string name, out string port, out int protocol, out int[] usages, out string templateName, out int sessionRequirment, out int[] deviceUsages);

Parameters

nameThe name of the socket description.
portThe port or port range the socket can use.
protocolThe protocol the socket uses.
usagesThe allowed usage flags for this socket description.
templateNameThe name of the device association template.
sessionRequirmentMutiplayer requirement setting for the device association template.
deviceUsagesThe allowed usage flags for the device association template.

Description

Get the values for the socket description with the given name.

The name must be a value found in the PlayerSettings.XboxOne.SocketNames array. Please see the Secure Device Socket Description section in the Xbox One Player Settings documentation for more details on the parameters.