AudioLayer Class

    Namespace: Stride.Audio
    Assembly: Stride.Audio.dll

    Wrapper around OpenAL

    System.Object → AudioLayer
    Derived from AudioLayer: 

    public class AudioLayer
    Name Description
    Methods
    BufferCreate(Int32)
    BufferDestroy(AudioLayer.Buffer)
    BufferFill(AudioLayer.Buffer, IntPtr, Int32, Int32, Boolean)
    Create(String, AudioLayer.DeviceFlags)
    Destroy(AudioLayer.Device)
    Init()
    ListenerCreate(AudioLayer.Device)
    ListenerDestroy(AudioLayer.Listener)
    ListenerDisable(AudioLayer.Listener)
    ListenerEnable(AudioLayer.Listener)
    ListenerPush3D(AudioLayer.Listener, ref Vector3, ref Vector3, ref Vector3, ref Vector3, ref Matrix)
    SetMasterVolume(AudioLayer.Device, Single)
    SourceCreate(AudioLayer.Listener, Int32, Int32, Boolean, Boolean, Boolean, Boolean, Single, HrtfEnvironment)
    SourceDestroy(AudioLayer.Source)
    SourceFlushBuffers(AudioLayer.Source)
    SourceGetFreeBuffer(AudioLayer.Source)
    SourceGetPosition(AudioLayer.Source)
    SourceIsPlaying(AudioLayer.Source)
    SourcePause(AudioLayer.Source)
    SourcePlay(AudioLayer.Source)
    SourcePush3D(AudioLayer.Source, ref Vector3, ref Vector3, ref Vector3, ref Vector3, ref Matrix)
    SourceQueueBuffer(AudioLayer.Source, AudioLayer.Buffer, IntPtr, Int32, AudioLayer.BufferType)
    SourceSetBuffer(AudioLayer.Source, AudioLayer.Buffer)
    SourceSetGain(AudioLayer.Source, Single)
    SourceSetLooping(AudioLayer.Source, Boolean)
    SourceSetPan(AudioLayer.Source, Single)
    SourceSetPitch(AudioLayer.Source, Single)
    SourceSetRange(AudioLayer.Source, Double, Double)
    SourceStop(AudioLayer.Source)
    Update(AudioLayer.Device)
    | Improve this Doc View Source

    Methods

    BufferCreate(Int32)

    public static extern AudioLayer.Buffer BufferCreate(int maxBufferSizeBytes)
    Parameters
    Type Name Description
    System.Int32 maxBufferSizeBytes
    Returns
    Type Description
    AudioLayer.Buffer

    BufferDestroy(AudioLayer.Buffer)

    public static extern void BufferDestroy(AudioLayer.Buffer buffer)
    Parameters
    Type Name Description
    AudioLayer.Buffer buffer

    BufferFill(AudioLayer.Buffer, IntPtr, Int32, Int32, Boolean)

    public static extern void BufferFill(AudioLayer.Buffer buffer, IntPtr pcm, int bufferSize, int sampleRate, bool mono)
    Parameters
    Type Name Description
    AudioLayer.Buffer buffer
    System.IntPtr pcm
    System.Int32 bufferSize
    System.Int32 sampleRate
    System.Boolean mono

    Create(String, AudioLayer.DeviceFlags)

    public static extern AudioLayer.Device Create(string deviceName, AudioLayer.DeviceFlags flags)
    Parameters
    Type Name Description
    System.String deviceName
    AudioLayer.DeviceFlags flags
    Returns
    Type Description
    AudioLayer.Device

    Destroy(AudioLayer.Device)

    public static extern void Destroy(AudioLayer.Device device)
    Parameters
    Type Name Description
    AudioLayer.Device device

    Init()

    public static extern bool Init()
    Returns
    Type Description
    System.Boolean

    ListenerCreate(AudioLayer.Device)

    public static extern AudioLayer.Listener ListenerCreate(AudioLayer.Device device)
    Parameters
    Type Name Description
    AudioLayer.Device device
    Returns
    Type Description
    AudioLayer.Listener

    ListenerDestroy(AudioLayer.Listener)

    public static extern void ListenerDestroy(AudioLayer.Listener listener)
    Parameters
    Type Name Description
    AudioLayer.Listener listener

    ListenerDisable(AudioLayer.Listener)

    public static extern void ListenerDisable(AudioLayer.Listener listener)
    Parameters
    Type Name Description
    AudioLayer.Listener listener

    ListenerEnable(AudioLayer.Listener)

    public static extern bool ListenerEnable(AudioLayer.Listener listener)
    Parameters
    Type Name Description
    AudioLayer.Listener listener
    Returns
    Type Description
    System.Boolean

    ListenerPush3D(AudioLayer.Listener, ref Vector3, ref Vector3, ref Vector3, ref Vector3, ref Matrix)

    public static extern void ListenerPush3D(AudioLayer.Listener listener, ref Vector3 pos, ref Vector3 forward, ref Vector3 up, ref Vector3 vel, ref Matrix worldTransform)
    Parameters
    Type Name Description
    AudioLayer.Listener listener
    Vector3 pos
    Vector3 forward
    Vector3 up
    Vector3 vel
    Matrix worldTransform

    SetMasterVolume(AudioLayer.Device, Single)

    public static extern void SetMasterVolume(AudioLayer.Device device, float volume)
    Parameters
    Type Name Description
    AudioLayer.Device device
    System.Single volume

    SourceCreate(AudioLayer.Listener, Int32, Int32, Boolean, Boolean, Boolean, Boolean, Single, HrtfEnvironment)

    public static extern AudioLayer.Source SourceCreate(AudioLayer.Listener listener, int sampleRate, int maxNumberOfBuffers, bool mono, bool spatialized, bool streamed, bool hrtf, float hrtfDirectionFactor, HrtfEnvironment environment)
    Parameters
    Type Name Description
    AudioLayer.Listener listener
    System.Int32 sampleRate
    System.Int32 maxNumberOfBuffers
    System.Boolean mono
    System.Boolean spatialized
    System.Boolean streamed
    System.Boolean hrtf
    System.Single hrtfDirectionFactor
    HrtfEnvironment environment
    Returns
    Type Description
    AudioLayer.Source

    SourceDestroy(AudioLayer.Source)

    public static extern void SourceDestroy(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source

    SourceFlushBuffers(AudioLayer.Source)

    public static extern void SourceFlushBuffers(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source

    SourceGetFreeBuffer(AudioLayer.Source)

    public static extern AudioLayer.Buffer SourceGetFreeBuffer(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source
    Returns
    Type Description
    AudioLayer.Buffer

    SourceGetPosition(AudioLayer.Source)

    public static extern double SourceGetPosition(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source
    Returns
    Type Description
    System.Double

    SourceIsPlaying(AudioLayer.Source)

    public static extern bool SourceIsPlaying(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source
    Returns
    Type Description
    System.Boolean

    SourcePause(AudioLayer.Source)

    public static extern void SourcePause(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source

    SourcePlay(AudioLayer.Source)

    public static extern void SourcePlay(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source

    SourcePush3D(AudioLayer.Source, ref Vector3, ref Vector3, ref Vector3, ref Vector3, ref Matrix)

    public static extern void SourcePush3D(AudioLayer.Source source, ref Vector3 pos, ref Vector3 forward, ref Vector3 up, ref Vector3 vel, ref Matrix worldTransform)
    Parameters
    Type Name Description
    AudioLayer.Source source
    Vector3 pos
    Vector3 forward
    Vector3 up
    Vector3 vel
    Matrix worldTransform

    SourceQueueBuffer(AudioLayer.Source, AudioLayer.Buffer, IntPtr, Int32, AudioLayer.BufferType)

    public static extern void SourceQueueBuffer(AudioLayer.Source source, AudioLayer.Buffer buffer, IntPtr pcm, int bufferSize, AudioLayer.BufferType streamType)
    Parameters
    Type Name Description
    AudioLayer.Source source
    AudioLayer.Buffer buffer
    System.IntPtr pcm
    System.Int32 bufferSize
    AudioLayer.BufferType streamType

    SourceSetBuffer(AudioLayer.Source, AudioLayer.Buffer)

    public static extern void SourceSetBuffer(AudioLayer.Source source, AudioLayer.Buffer buffer)
    Parameters
    Type Name Description
    AudioLayer.Source source
    AudioLayer.Buffer buffer

    SourceSetGain(AudioLayer.Source, Single)

    public static extern void SourceSetGain(AudioLayer.Source source, float gain)
    Parameters
    Type Name Description
    AudioLayer.Source source
    System.Single gain

    SourceSetLooping(AudioLayer.Source, Boolean)

    public static extern void SourceSetLooping(AudioLayer.Source source, bool looped)
    Parameters
    Type Name Description
    AudioLayer.Source source
    System.Boolean looped

    SourceSetPan(AudioLayer.Source, Single)

    public static extern void SourceSetPan(AudioLayer.Source source, float pan)
    Parameters
    Type Name Description
    AudioLayer.Source source
    System.Single pan

    SourceSetPitch(AudioLayer.Source, Single)

    public static extern void SourceSetPitch(AudioLayer.Source source, float pitch)
    Parameters
    Type Name Description
    AudioLayer.Source source
    System.Single pitch

    SourceSetRange(AudioLayer.Source, Double, Double)

    public static extern void SourceSetRange(AudioLayer.Source source, double startTime, double stopTime)
    Parameters
    Type Name Description
    AudioLayer.Source source
    System.Double startTime
    System.Double stopTime

    SourceStop(AudioLayer.Source)

    public static extern void SourceStop(AudioLayer.Source source)
    Parameters
    Type Name Description
    AudioLayer.Source source

    Update(AudioLayer.Device)

    public static extern void Update(AudioLayer.Device device)
    Parameters
    Type Name Description
    AudioLayer.Device device

    Extension Methods