Audio¶

static class · namespace Hazel

public static class Audio

Methods¶

CreateAudioEntity(AudioCommandID, Transform, float, float)¶

static

public static AudioEntity CreateAudioEntity(AudioCommandID triggerEventID, Transform location, float volume = 1.0f, float pitch = 1.0f)

CreateAudioEntity(string, Transform, float, float)¶

static

public static AudioEntity CreateAudioEntity(string triggerEventName, Transform location, float volume = 1.0f, float pitch = 1.0f)

PauseEventID(uint)¶

static

public static bool PauseEventID(uint eventID)

Pause playing audio sources associated to active event. Returns true - if event has playing audio soruces to pause.

PostEvent(AudioCommandID, AudioComponent)¶

static

public static uint PostEvent(AudioCommandID id, ref AudioComponent audioComponent)

Post event on AudioComponent. Returns active Event ID

PostEvent(AudioCommandID, ulong)¶

static

public static uint PostEvent(AudioCommandID id, ulong objectID)

Post event on an object. Returns active Event ID

PostEvent(string, ulong)¶

static

public static uint PostEvent(string eventName, ulong objectID)

Post event by name. Prefer overload that takes CommandID for speed and initialize CommandIDs once. This creates new CommandID object from eventName, which has to hash the string.

PostEventAtLocation(AudioCommandID, Vector3, Vector3)¶

static

public static uint PostEventAtLocation(AudioCommandID id, Vector3 location, Vector3 rotation)

Post event on at location creating temporary Audio Object. Returns active Event ID

PreloadEventSources(AudioCommandID)¶

static

public static void PreloadEventSources(AudioCommandID eventID)

ResumeEventID(uint)¶

static

public static bool ResumeEventID(uint eventID)

Resume playing audio sources associated to active event. Returns true - if event has playing audio soruces to resume.

SetHighPassFilterValue(AudioComponent, float)¶

static

public static void SetHighPassFilterValue(ref AudioComponent audioComponent, float value)

SetHighPassFilterValue(uint, float)¶

static

public static void SetHighPassFilterValue(uint eventID, float value)

SetHighPassFilterValueObj(ulong, float)¶

static

public static void SetHighPassFilterValueObj(ulong objectID, float value)

SetLowPassFilterValue(AudioComponent, float)¶

static

public static void SetLowPassFilterValue(ref AudioComponent audioComponent, float value)

SetLowPassFilterValue(uint, float)¶

static

public static void SetLowPassFilterValue(uint eventID, float value)

SetLowPassFilterValueObj(ulong, float)¶

static

public static void SetLowPassFilterValueObj(ulong objectID, float value)

SetParameter(ParameterID, uint, bool)¶

static

public static void SetParameter(ParameterID id, uint eventID, bool value)

SetParameter(ParameterID, uint, float)¶

static

public static void SetParameter(ParameterID id, uint eventID, float value)

SetParameter(ParameterID, uint, int)¶

static

public static void SetParameter(ParameterID id, uint eventID, int value)

SetParameter(ParameterID, ulong, bool)¶

static

public static void SetParameter(ParameterID id, ulong objectID, bool value)

SetParameter(ParameterID, ulong, float)¶

static

public static void SetParameter(ParameterID id, ulong objectID, float value)

SetParameter(ParameterID, ulong, int)¶

static

public static void SetParameter(ParameterID id, ulong objectID, int value)

SetParameterForAC(ParameterID, AudioComponent, bool)¶

static

public static void SetParameterForAC(ParameterID id, ref AudioComponent audioComponent, bool value)

SetParameterForAC(ParameterID, AudioComponent, float)¶

static

public static void SetParameterForAC(ParameterID id, ref AudioComponent audioComponent, float value)

SetParameterForAC(ParameterID, AudioComponent, int)¶

static

public static void SetParameterForAC(ParameterID id, ref AudioComponent audioComponent, int value)

StopEventID(uint)¶

static

public static bool StopEventID(uint eventID)

Stop playing audio sources associated to active event. Returns true - if event has playing audio soruces to stop.

UnloadEventSources(AudioCommandID)¶

static

public static void UnloadEventSources(AudioCommandID eventID)

Source: Hazel/Audio/Audio.cs