Expand description
This crate implements a client library and a player for the rocket sync tracker. You can connect to a rocket tracker, get values from tracks, and live-edit your production.
There are two alternative APIs in this crate:
§Simple API
See the simple
module. Requires enabling the simple
feature.
Handles both editing and release playback use cases using conditional compilation.
§Low-level API
The client
module contains the types which you need to connect to a Rocket tracker and edit your production.
The player
module contains a player which you can use when building your production in release mode.
§Features
Feature | Purpose |
---|---|
serde | Derive serde’s traits on the Track -type |
bincode | Derive bincode’s traits on the Track -type |
simple | Enables the simple API |
player | Builds the simple API in file player mode instead of client mode |
All features are mutually compatible, but if you choose to use bincode
as your serialization library,
you don’t need to use serde
.
The simple
feature enables bincode
.
Re-exports§
pub use client::RocketClient;
pub use player::RocketPlayer;
pub use track::Track;
Modules§
- client
- Main client code, including the
RocketClient
type. - interpolation
- Interpolation.
- player
- Player code for playing previously saved tracks,
RocketPlayer
. - simple
- An opinionated abstraction for the lower level
client
andplayer
API. - track
Key
andTrack
types.
Type Aliases§
- Tracks
- Produced by
RocketClient::save_tracks
and consumed byRocketPlayer::new