Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

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

PlayerSettings.XboxOne.SetSocketDefinition

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 SetSocketDefinition(name: string, port: string, protocol: int, usages: int[], templateName: string, sessionRequirment: int, deviceUsages: int[]): void;
public static void SetSocketDefinition(string name, string port, int protocol, int[] usages, string templateName, int sessionRequirment, int[] deviceUsages);

Parameters

name The name of the socket description.
port The port or port range the socket can use.
protocol The protocol the socket uses.
usages The allowed usage flags for this socket description.
templateName The name of the device association template.
sessionRequirment Mutiplayer requirement setting for the device association template.
deviceUsages The allowed usage flags for the device association template.

Description

Set 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.