Class RpcError

Namespace

LiveKit

Errors thrown by RPC method handlers or generated due to a failure in the RPC call.

Built-in error codes are listed in RpcError.ErrorCode.

You may also throw custom errors with your own code and data.
Errors of this type thrown in your handler will be transmitted as-is without modification. All other errors will be converted to a generic APPLICATION_ERROR (1500).

public class RpcError : Exception, ISerializable

Inheritance

object

Exception

RpcError

Implements

ISerializable

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

RpcError(uint, string, string)

public RpcError(uint code, string message, string rpcData = null)

Parameters

code uint

message string

rpcData string

Properties

Code

Integer error code. Values 1000-1999 are reserved for the framework, see RpcError.ErrorCode.

public uint Code { get; }

Property Value

uint

RpcData

String error data. Max 15KiB UTF-8.

public string RpcData { get; }

Property Value

string