Class MultiplayService

Here is the first point and call for accessing Multiplay package's features! Use the Instance method to get a singleton of the IMultiplayService and from there you can make various requests to the Multiplay service API.

Inheritance

object

MultiplayService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Multiplay

Assembly: Unity.Services.Multiplayer.Multiplay.dll

Syntax

[Obsolete("The Multiplay service will cease to operate on March 31st 2026 - For alternative hosting providers, please update to com.unity.services.multiplayer 2.1")]
public static class MultiplayService

Remarks

The Multiplay service will cease to operate on March 31st 2026 - For alternative hosting providers, please update to com.unity.services.multiplayer 2.1.
The MultiplayService is not available in the editor, tyring to access it will result in an InvalidOperationException.

Properties

Instance

Provides the Multiplay Service interface for making service API requests.

Declaration

public static IMultiplayService Instance { get; }

Property Value

Type	Description
IMultiplayService

Exceptions

Type	Condition
InvalidOperationException	Thrown in the following scenarios: Trying to access the Multiplay API before initializing the Unity services. Trying to access the Multiplay API while not deployed in Multiplay Hosting (i.e. in editor).