Table of Contents > OSC API |
Ultrasonic Documentation
|
Ultrasonic's OSC Server can be activated from the Preferences screen:
The OSC documentation below uses the following format conventions:
/address
— an OSC address with no arguments/address ARG
— an OSC address with a single argument/address [ARG]
— an OSC address with an optional argument/address ARG [ARG_2 ...]
— an OSC address that can have one or more arguments./address {ARG_1,ARG_2,ARG_3}
— an OSC address with a not-optional argument which must be selected from a list of recognized arguments./address/{addr_1,addr_2,addr_3}
— an OSC address with multiple paths.Definitions:
/load/playlist PLAYLIST_NAME
— find and load a playlist with the given name. NOTE: playlist names are precise and case sensitive. This command will immediately pause playback and load the given playlist. If a playlist with the given name is not found, there is no effect.
/load/queue
— load the Play Queue.
/load MEDIA_INDEX
— select Media by index from the Active Playlist. Playlists are zero-indexed, so the first track is loaded with /load 0
, the second with /load 1
, etc.
/play
— play the currently loaded media. If Ultrasonic is already playing, there is no effect.
/play MEDIA_INDEX
— load and immediately play Media at the given index from the Active Playlist. If the given Media is already playing, there is no effect.
/stop
— stop playback of the Active Media and reset the playhead to 0:00.
/panic
— trigger a panic stop. This fades volume out and then stops.
/next
— immediately skip to the next Media in the playlist. If Shuffle mode is on,
/prev
— If more than 2 seconds of the Active Media have played, skip to the
beginning of the Active Media. If less than 2 seconds have played, skip to the
previous Media in the playlist.
/gototime TIME_IN_SECONDS
— immediately move the playhead to the given time
in the Active Media. If Media is already playing, it will continue playing. If
Media is paused, playback will continue from the given time when unpaused. If
the given time is past the end of the Media, this command will have the same
effect as /next
. If the given time is less than 0, this command will reset
playback to 0 seconds.
/volume VOL_IN_DB
— set volume in Db in the range -120 to 0 inclusive.
/volume/linear VOL_IN_LINEAR
— set volume on a linear scale, from 0 to 1.0 inclusive,
where 0 is minimum and 1.0 is maximum.
/toggle/loop
— toggle through loop modes: Loop List, Loop Track, No Loop.
/toggle/shuffle
— toggle Shuffle on / off.
/toggle/transient
— toggle Transient Mode on / off.
/toggle/play
— toggle between Playing and Paused states.
Alternatively, you can use the argument form:
/toggle {loop,shuffle,transient,play}
— toggle the given setting on or off.
/shuffle
— turn on Shuffle mode. If it's already on, do nothing.
/unshuffle
— turn off Shuffle mode. If it's already off, do nothing.
/loop
— turn on Loop Track mode. If it's already on, do nothing.
/loop/list
— turn on Loop List mode. If it's already on, do nothing.
/unloop
— turn off Loop mode. If it's already off, do nothing.
Previous: Scripting
|