pp v0.0.52 (2019-04-12T13:41:01Z)

Music

polyplex core audio music
Undocumented in source.
class Music {
static
size_t BufferSize;
static
size_t BufferCount;
this(Audio audio, AudioRenderFormats format);
~this();
void Play(bool isLooping);
void Stop();
void Pause();
size_t Tell();
void Seek(size_t position);
size_t Length();
int XRuns();
void HandledXRun();
bool Paused();
bool Playing();
AudioEffect Effect [@property getter];
AudioEffect Effect [@property setter];
AudioFilter Filter [@property getter];
AudioFilter Filter [@property setter];
bool Looping [@property getter];
bool Looping [@property setter];
int ByteOffset [@property getter];
int SecondOffset [@property getter];
int SampleOffset [@property getter];
float Pitch [@property getter];
float Pitch [@property setter];
float Gain [@property getter];
float Gain [@property setter];
float MinGain [@property getter];
float MinGain [@property setter];
float MaxGain [@property getter];
float MaxGain [@property setter];
float MaxDistance [@property getter];
float MaxDistance [@property setter];
float RolloffFactor [@property getter];
float RolloffFactor [@property setter];
float ConeOuterGain [@property getter];
float ConeOuterGain [@property setter];
float ConeInnerAngle [@property getter];
float ConeInnerAngle [@property setter];
float ConeOuterAngle [@property getter];
float ConeOuterAngle [@property setter];
float ReferenceDistance [@property getter];
float ReferenceDistance [@property setter];
Vector3 Position [@property getter];
Vector3 Position [@property setter];
Vector3 Velocity [@property getter];
Vector3 Velocity [@property setter];
Vector3 Direction [@property getter];
Vector3 Direction [@property setter];
}

Constructors

this
this(Audio audio, AudioRenderFormats format)

Constructs a Music via an Audio source.

Destructor

~this
~this()
Undocumented in source.

Members

Functions

HandledXRun
void HandledXRun()

Mark XRuns as handled.

Length
size_t Length()

Gets length of music (in samples)

Pause
void Pause()

Pause music

Paused
bool Paused()

Gets wether the music is paused.

Play
void Play(bool isLooping)

Play music

Playing
bool Playing()

Gets wether the music is playing

Seek
void Seek(size_t position)

Seeks the music stream (in samples)

Stop
void Stop()

Stop playing music Does nothing if music isn't playing.

Tell
size_t Tell()

Gets the current position in the music stream (in samples)

XRuns
int XRuns()

Get amount of unhandled XRuns that has happened.

Properties

ByteOffset
int ByteOffset [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ConeInnerAngle
float ConeInnerAngle [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ConeInnerAngle
float ConeInnerAngle [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
ConeOuterAngle
float ConeOuterAngle [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ConeOuterAngle
float ConeOuterAngle [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
ConeOuterGain
float ConeOuterGain [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ConeOuterGain
float ConeOuterGain [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Direction
Vector3 Direction [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Direction
Vector3 Direction [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Effect
AudioEffect Effect [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Effect
AudioEffect Effect [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Filter
AudioFilter Filter [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Filter
AudioFilter Filter [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Gain
float Gain [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Gain
float Gain [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Looping
bool Looping [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Looping
bool Looping [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
MaxDistance
float MaxDistance [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
MaxDistance
float MaxDistance [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
MaxGain
float MaxGain [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
MaxGain
float MaxGain [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
MinGain
float MinGain [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
MinGain
float MinGain [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Pitch
float Pitch [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Pitch
float Pitch [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
Position
Vector3 Position [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Position
Vector3 Position [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
ReferenceDistance
float ReferenceDistance [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ReferenceDistance
float ReferenceDistance [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
RolloffFactor
float RolloffFactor [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
RolloffFactor
float RolloffFactor [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
SampleOffset
int SampleOffset [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
SecondOffset
int SecondOffset [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Velocity
Vector3 Velocity [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
Velocity
Vector3 Velocity [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

BufferCount
size_t BufferCount;

Amount of buffers to provision per audio track Takes effect on new audio load.

BufferSize
size_t BufferSize;

Changes the size of the buffers for music playback. Changes take effect immidiately

Meta

Source

See Implementation

polyplex core audio music classesfunctionsstatic variables

Page generated by adrdox