From 039847a29868d335c08fe0a587260dffc71ca5c4 Mon Sep 17 00:00:00 2001 From: Ludvig Gunne Lindström Date: Fri, 17 Jul 2026 11:43:24 +0200 Subject: init --- doc/classes/playback.html | 331 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 331 insertions(+) create mode 100644 doc/classes/playback.html (limited to 'doc/classes/playback.html') diff --git a/doc/classes/playback.html b/doc/classes/playback.html new file mode 100644 index 0000000..fcee0d6 --- /dev/null +++ b/doc/classes/playback.html @@ -0,0 +1,331 @@ + + + + + Melisma modules + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class playback

+

Audio sample playback.

+

+ + + +

+local msample = require 'melisma.sample'
+local mplayback = require 'melisma.playback'
+
+local sample = msample.load('sample.wav')
+local playb = mplayback.init(sample)
+
+playb:loop(true)
+playb:spped(2)
+playb:play()
+
+ +

+ + +

Functions

+ + + + + +
playback.init(smp)Intialize a playback unit.
+

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
playback:loop(b)Enable/disable automatic looping.
playback:pause()Pause playback.
playback:phase(x)Set playback phase.
playback:play()Start playback.
playback:reset()Reset playback.
playback:reset()Set playback speed.
playback:set_sample(smp)Set playback sample.
playback:stop()Stop playback.
+ +
+
+ + +

Functions

+ Methods +
+
+ + playback.init(smp) +
+
+ Intialize a playback unit. + + +

Parameters:

+
    +
  • smp + sample or nil + + + +
    • +
+ +

Returns:

+
    + + playback + + + +
+ + + + +
+
+

Methods

+ +
+
+ + playback:loop(b) +
+
+ Enable/disable automatic looping. + + +

Parameters:

+
    +
  • b + bool + + + +
    • +
+ + + + + +
+
+ + playback:pause() +
+
+ Pause playback. + + + + + + + +
+
+ + playback:phase(x) +
+
+ Set playback phase. + + +

Parameters:

+
    +
  • x + number + Phase ranging from 0 to 1. +
    • +
+ + + + + +
+
+ + playback:play() +
+
+ Start playback. + + + + + + + +
+
+ + playback:reset() +
+
+ Reset playback.

+ +

Equivalent to playback.phase(0). + + + + + + + +

+
+ + playback:reset() +
+
+ Set playback speed.

+ +

A negative speed will play the sample in reverse. + + + + + + + +

+
+ + playback:set_sample(smp) +
+
+ Set playback sample. + + +

Parameters:

+ + + + + + +
+
+ + playback:stop() +
+
+ Stop playback.

+ +

Equivalent to playback.pause; playback.reset. + + + + + + + +

+
+ + +
+
+
+generated by LDoc 1.5.0 +Last updated 1980-01-01 00:00:00 +
+
+ + -- cgit v1.3.1