API reference

ILoggerRegistry Interface

Used to create VSDK loggers.

Properties

AllLoggers : IEnumerable< IVLogger >
[Get]
Returns a list of all loggers the registry created.
Signature
IEnumerable<IVLogger> Meta.Voice.Logging.ILoggerRegistry.AllLoggers
EditorLogFilteringLevel : VLoggerVerbosity
[Get][Set]
Ignores logs in editor if less than log level. Changing this value at runtime will update it for all existing VLoggers.
Signature
VLoggerVerbosity Meta.Voice.Logging.ILoggerRegistry.EditorLogFilteringLevel
LogSink : ILogSink
[Get][Set]
The log sink loggers will write to by default.
Signature
ILogSink Meta.Voice.Logging.ILoggerRegistry.LogSink
LogStackTraceLevel : VLoggerVerbosity
[Get][Set]
The level at which we collect and write stack traces.
Signature
VLoggerVerbosity Meta.Voice.Logging.ILoggerRegistry.LogStackTraceLevel
LogSuppressionLevel : VLoggerVerbosity
[Get][Set]
Logs that are lower than this level will be suppressed by default. Suppressed logs will not be written unless an error occurs with a related correlation ID or they are explicitly flushed. Changing this value at runtime will update it for all existing VLoggers.
Signature
VLoggerVerbosity Meta.Voice.Logging.ILoggerRegistry.LogSuppressionLevel
Options : LoggerOptions
[Get]
The logger options. All loggers created by this factory will share these options.
Signature
LoggerOptions Meta.Voice.Logging.ILoggerRegistry.Options
PoolLoggers : bool
[Get][Set]
When true, caches the loggers and reuse them for the same category. This should always be set to true, except in rare circumstances (such as unit tests).
Signature
bool Meta.Voice.Logging.ILoggerRegistry.PoolLoggers

Methods

GetLogger ( logCategory , logSink )
Gets a logger with a category pulled from the source directly.
Signature
IVLogger Meta.Voice.Logging.ILoggerRegistry.GetLogger(LogCategory logCategory, ILogSink logSink=null)
Parameters
logCategory: LogCategory  The category of the logs written by this logger.
logSink: ILogSink  An optional log sink.
Returns
IVLogger  The logger.
GetLogger ( category , logSink )
Gets a logger with an explicitly specified category.
Gets a logger with an explicitly specified category.
Signature
IVLogger Meta.Voice.Logging.ILoggerRegistry.GetLogger(string category, ILogSink logSink=null)
Parameters
category: string  The category of the logs written by this logger.
logSink: ILogSink  An optional log sink.
Returns
IVLogger  The logger. The logger.