Struct AudioEventLogEntry

Namespace

BSGameLib.Game.Audio

Assembly

BSGameLib.Game.dll

One change to an audio event, as listed in RecentEvents.

public readonly struct AudioEventLogEntry

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

AudioEventLogEntry(string, AudioEventCategory, AudioEventAction, DateTime)

Creates an entry for an action on an event. The audio service creates these.

public AudioEventLogEntry(string eventId, AudioEventCategory category, AudioEventAction action, DateTime timestamp)

Parameters

eventId string

category AudioEventCategory

action AudioEventAction

timestamp DateTime

Properties

Action

What happened to the event.

public AudioEventAction Action { get; }

Property Value

AudioEventAction

Category

The event's category. For a stop of several events, the category it was given.

public AudioEventCategory Category { get; }

Property Value

AudioEventCategory

EventId

The event's id. Empty for a StopAll(AudioEventCategory?, int), which covers several events.

public string EventId { get; }

Property Value

string

Timestamp

When the action happened, in UTC.

public DateTime Timestamp { get; }

Property Value

DateTime