class MusicPlayer

in global :: Sandbox

Enables music playback. Use this for music, not for playing game sounds.

public int SampleRate { get; }

Sample rate of the audio being played.

public int Channels { get; }

Number of channels of the audio being played.

public float Duration { get; }

Gets the total duration of the video in seconds.

public float PlaybackTime { get; }

Gets the current playback time in seconds.

public Action OnFinished { get; set; }

Invoked when the audio has finished playing.

public Action OnRepeated { get; set; }

Invoked when the audio has repeated.

public bool ListenLocal { get; set; }

Place the listener at 0,0,0 facing 1,0,0.

public Vector3 Position { get; set; }

Position of the sound.

public bool Paused { get; set; }

Pause playback of audio.

public bool Repeat { get; set; }

Audio will repeat when reaching the end.

public float Volume { get; set; }

Change the volume of this music.

public bool LipSync { get; set; }

Enables lipsync processing.

public Mixer TargetMixer { get; set; }

Which mixer do we want to write to

public float Distance { get; set; }

🤡 Doc inheritance is not yet supported.

No summary.

public Curve Falloff { get; set; }

🤡 Doc inheritance is not yet supported.

No summary.

public IReadOnlyList<float> Visemes { get; }

A list of 15 lipsync viseme weights. Requires to be enabled.

public string Title { get; }

Get title of the track.

public ReadOnlySpan<float> Spectrum { get; }

512 FFT magnitudes used for audio visualization.

public float Amplitude { get; }

Approximate measure of audio loudness.

public static MusicPlayer PlayUrl( string url )

Plays a music stream from a URL.

public static MusicPlayer Play( BaseFileSystem filesystem, string path )

Plays a music file from a relative path.

public void Seek( float time )

Sets the playback position to a specified time in the audio, given in seconds.

public void Dispose( )

😔 No documentation found.

public void Stop( )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.