Skip to main content

Args

Struct Args 

Source
struct Args {
Show 19 fields episode: Option<String>, tag: Option<String>, show: Option<String>, script: Option<String>, dry_run: bool, max_duration: Option<f64>, gen_sfx: bool, gen_music: bool, gen_ambience: bool, sfx_music: bool, local_only: bool, sfx_backend: String, mmaudio_python: Option<String>, mmaudio_duration: f64, mmaudio_cfg: f64, mmaudio_steps: i64, mmaudio_negative_prompt: String, mmaudio_seed: Option<i64>, mmaudio_accept_noncommercial: bool,
}

Fields§

§episode: Option<String>

Episode tag (e.g. S01E01) — derives cast and SFX config paths

§tag: Option<String>

Raw tag for non-episodic content (e.g. V01C03, D01)

§show: Option<String>

Show name override (default: from project.json)

§script: Option<String>

Path to parsed script JSON (default: derived from cast config)

§dry_run: bool

Preview existing vs. new stems and estimated credit cost

§max_duration: Option<f64>

Only process effects with duration_seconds <= this value

§gen_sfx: bool

Limit to SFX and BEAT entries only

§gen_music: bool

Limit to MUSIC entries only

§gen_ambience: bool

Limit to AMBIENCE entries only

§sfx_music: bool

(deprecated) shorthand for –gen-sfx –gen-music –gen-ambience

§local_only: bool

Only place stems for effects already present in SFX/; skip API generation

§sfx_backend: String

Backend for SFX/music/ambience generation, independent of the dialogue –backend. ‘elevenlabs’ (default) calls the ElevenLabs Sound Effects API. ‘mmaudio’ runs MMAudio locally in venv-mmaudio — free and GPU-accelerated, writes backend-tagged assets to SFX/.mmaudio.mp3. MMAudio’s weights are CC BY-NC 4.0 (non-commercial only) and require –mmaudio-accept-noncommercial.

§mmaudio_python: Option<String>

Path to the Python executable in the MMAudio venv (default: auto-detect ./venv-mmaudio/bin/python3). Used only with –sfx-backend mmaudio.

§mmaudio_duration: f64

Generation length in seconds before trimming (default: 8.0, MMAudio’s training duration). The result is trimmed to each cue’s duration_seconds; generating at the native length and trimming gives better audio than asking for a short clip.

§mmaudio_cfg: f64

MMAudio classifier-free guidance strength (default: 4.5).

§mmaudio_steps: i64

MMAudio flow-matching sampling steps (default: 25).

§mmaudio_negative_prompt: String

Optional MMAudio negative prompt (default: none).

§mmaudio_seed: Option<i64>

MMAudio reproducibility seed (default: nondeterministic).

§mmaudio_accept_noncommercial: bool

Acknowledge that MMAudio’s weights are CC BY-NC 4.0 (NON-COMMERCIAL USE ONLY) and that generated audio must not appear in a monetised production. Required for –sfx-backend mmaudio.

Trait Implementations§

Source§

impl Args for Args

Source§

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut] Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut] Read more
Source§

impl CommandFactory for Args

Source§

fn command<'b>() -> Command

Build a [Command] that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a [Command] that can update self. Read more
Source§

impl FromArgMatches for Args

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Parser for Args

§

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.
§

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.
§

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.
§

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.
§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error. Read more
§

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Auto Trait Implementations§

§

impl Freeze for Args

§

impl RefUnwindSafe for Args

§

impl Send for Args

§

impl Sync for Args

§

impl Unpin for Args

§

impl UnsafeUnpin for Args

§

impl UnwindSafe for Args

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more