Permalink
Browse files

Documentation API4 -> API5

  • Loading branch information...
bjorn-nesby committed Jun 24, 2016
1 parent 98aa40a commit 21d5867ae9ef5e33f33f79666b3183628d86ffba
@@ -21,7 +21,7 @@ Do not try to execute this file. It uses a .lua extension for markup only.
-------- Constants
-- Currently 4.0. Any changes in the API which are not backwards compatible,
-- Currently 5.0. Any changes in the API which are not backwards compatible,
-- will increase the internal API's major version number (e.g. from 1.4 -> 2.0).
-- All other backwards compatible changes, like new functionality, new functions
-- and classes which do not break existing scripts, will increase only the minor
@@ -113,11 +113,51 @@ renoise.app():new_song_no_template()
-- Just like new_song(), the song is not loaded immediately, but soon after
-- the call was made. See 'renoise.app():new_song()' for details.
renoise.app():load_song(filename)
-- Load a file into the currently selected components (selected instrument,
-- track, sampl, ...) of the song. If no component is selected it will be
-- created when possible. Any errors during the export are shown to the user.
-- returns success.
renoise.app():load_track_device_chain(filename)
-> [boolean]
renoise.app():load_track_device_preset(filename)
-> [boolean]
renoise.app():load_instrument(filename)
-> [boolean]
renoise.app():load_instrument_multi_sample(filename)
-> [boolean]
renoise.app():load_instrument_device_chain(filename)
-> [boolean]
renoise.app():load_instrument_device_preset(filename)
-> [boolean]
renoise.app():load_instrument_modulation_set(filename)
-> [boolean]
renoise.app():load_instrument_phrase(filename)
-> [boolean]
renoise.app():load_instrument_sample(filename)
-> [boolean]
renoise.app():load_theme(filename)
-- Quicksave or save the current song under a new name. Any errors
-- during the export are shown to the user.
renoise.app():save_song()
renoise.app():save_song_as(filename)
-- Save a currently selected components of the song. Any errors
-- during the export are shown to the user. returns success
renoise.app():save_track_device_chain(filename)
-> [boolean]
renoise.app():save_instrument(filename)
-> [boolean]
renoise.app():save_instrument_multi_sample(filename)
-> [boolean]
renoise.app():save_instrument_device_chain(filename)
-> [boolean]
renoise.app():save_instrument_modulation_set(filename)
-> [boolean]
renoise.app():save_instrument_phrase(filename)
-> [boolean]
renoise.app():save_instrument_sample(filename)
-> [boolean]
renoise.app():save_theme(filename)
-------- Properties
@@ -162,9 +202,9 @@ renoise.ApplicationWindow.UPPER_FRAME_MASTER_SPECTRUM
renoise.ApplicationWindow.MIDDLE_FRAME_PATTERN_EDITOR
renoise.ApplicationWindow.MIDDLE_FRAME_MIXER
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_SAMPLE_OVERVIEW
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_PHRASE_EDITOR
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_SAMPLE_KEYZONES
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_SAMPLE_MODULATION
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_SAMPLE_EFFECTS
renoise.ApplicationWindow.MIDDLE_FRAME_INSTRUMENT_PLUGIN_EDITOR
@@ -305,7 +305,7 @@ serializable:from_string(string)
--------------------------------------------------------------------------------
-- renoise.Document.Observable (inherits Serializable)
-- renoise.Document.Observable
--------------------------------------------------------------------------------
-------- Functions
@@ -327,9 +327,23 @@ observable:remove_notifier(function or (object, function) or
--------------------------------------------------------------------------------
-- renoise.Document.ObservableBoolean/Number/String (inherits Observable)
-- renoise.Document.ObservableBang (inherits Observable)
--------------------------------------------------------------------------------
-- Observable without a value which sends out notifications when "banging" it.
-------- Functions
-- fire a notification, calling all registered notifiers.
observable:bang()
--------------------------------------------------------------------------------
-- renoise.Document.ObservableBoolean/Number/String (inherits Observable, Serializable)
--------------------------------------------------------------------------------
-- Observables which send out notifications on value changes.
-------- Properties
-- Read/write access to the value of an Observable.
@@ -338,7 +352,7 @@ observable.value
--------------------------------------------------------------------------------
-- renoise.Document.ObservableBoolean/String/NumberList (inherits Observable)
-- renoise.Document.ObservableBoolean/String/NumberList (inherits Observable, Serializable)
--------------------------------------------------------------------------------
-------- Operators
@@ -75,6 +75,7 @@ To do so, use one of the specified categories in its name:
+ "Pattern Matrix Header"
+ "Phrase Editor"
+ "Phrase Mappings"
+ "Phrase Grid"
+ "Sample Navigator"
+ "Sample Editor"
+ "Sample Editor Ruler"
@@ -238,8 +239,8 @@ The Lua table passed to 'add_file_import_hook' is defined as:
* Required fields:
+ ["category"] = in which disk browser category the file type shows up.
"song", "instrument", "effect chain", "modulation set", "phrase",
"sample" or "theme"
"song", "instrument", "effect chain", "effect preset", "modulation set",
"phrase", "sample" or "theme"
+ ["extensions"] = a list of strings, file extensions, that will invoke
your hook, like for example {"txt", "swave"}
+ ["invoke"] = function that is called to do the import. return true when
@@ -152,8 +152,12 @@ socket_client.peer_port -> [number]
-------- Functions
-- Send a message string to the connected server. When sending failed, "success"
-- will be false and error_message is set.
-- Send a message string (or OSC messages or bundles) to the connected server.
-- When sending fails, "success" return value will be false and "error_message"
-- is set, describing the error in a human readable format.
-- NB: when using TCP instead of UDP as protocol for OSC messages, !no! SLIP
-- encoding and no size prefixing of the passed OSC data will be done here.
-- So, when necessary, do this manually by your own please.
socket_client:send(message) ->
[success (boolean), error_message (string or nil)]
Oops, something went wrong.

0 comments on commit 21d5867

Please sign in to comment.