Show / Hide Table of Contents

    Interface IAudioClip

    An audio clip that can be played multiple times during the game. The audio clip should be loaded from a file using IAudioFactory. You can then set its properties (volume, pitch, panning) which will be used for all sounds played from this clip.

    Note that an audio clip is the template for the sound, whereas ISound is the actual playing sound instance.

    Inherited Members
    ISoundProperties.Volume
    ISoundProperties.Pitch
    ISoundProperties.Panning
    ISoundProperties.Tags
    ISoundPlayer.Play(Boolean, ISoundProperties)
    ISoundPlayer.Play(Single, Boolean)
    ISoundPlayer.PlayAndWait(ISoundProperties)
    ISoundPlayer.PlayAndWait(Single)
    ISoundPlayer.IsPlaying
    ISoundPlayer.CurrentlyPlayingSounds
    ISoundPlayer.OnSoundStarted
    ISoundPlayer.OnSoundCompleted
    Namespace: AGS.API
    Assembly: AGS.API.dll
    Syntax
    public interface IAudioClip : ISoundProperties, ISoundPlayer

    Properties

    | Improve this Doc View Source

    Duration

    Gets duration of the sound in seconds.

    Declaration
    float Duration { get; }
    Property Value
    Type Description
    System.Single
    | Improve this Doc View Source

    ID

    A unique identifier for the audio clip.

    Declaration
    string ID { get; }
    Property Value
    Type Description
    System.String

    The identifier.

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX