Welcome to muvid’s documentation!

Contents:

• muvid
  • CharacterRef
  • EnvironmentRef
  • MusicVideoProject
  • ProjectSpec
  • SectionSpec
  • ShotSpec
  • SongInfo
  • align_lyrics()
  • init_project()
  • render()
  • render_audio_video()
  • status()
  • transcribe_song()
• muvid.__main__
  • align()
  • character()
  • character_curate()
  • character_curate_interactive()
  • character_generate()
  • character_images()
  • compose()
  • environment()
  • environment_render()
  • estimate_cost()
  • init()
  • render()
  • script()
  • script_apply()
  • serve()
  • status()
  • transcribe()
• muvid.align
  • AlignerName
  • AlignerSpec
  • AlignmentResult
  • LineAlignment
  • SectionAlignment
  • WordAlignment
  • align_lyrics()
  • align_scribe_greedy()
  • align_stars()
  • align_user_provided()
  • align_whisperx_lite()
  • list_aligners()
  • register_aligner()
  • write_alignment_store()
• muvid.characters
  • add_character()
  • add_reference_images()
  • curate_references()
  • curate_references_interactive()
  • generate_reference_images()
  • get_character_anchor_image()
• muvid.compose
  • compose()
• muvid.contracts
  • character_to_falaw()
  • environment_to_falaw()
  • progress_event_to_dict()
  • shifted_word_timings()
  • word_timings_for_window()
• muvid.cost
  • CostLine
  • CostRollup
  • estimate_render_cost()
• muvid.downloads
• muvid.environments
  • add_environment()
  • get_environment_anchor_image()
  • render_environment()
• muvid.events
  • log_fal_events_to()
  • read_recent_fal_events()
• muvid.facade
  • align_lyrics()
  • curate_character_interactive()
  • estimate_render_cost()
  • format_status()
  • init_project()
  • render()
  • status()
  • transcribe_song()
• muvid.footage
  • EdlEntry
  • FootageAlignment
  • derive_cuts()
  • list_strategies()
  • register_selection_strategy()
  • resolve_strategy()
  • select_edl()
  • validate_edl()
• muvid.footage.align
  • ALIGN_SAMPLE_RATE
  • align_footage()
• muvid.footage.assemble
  • DEFAULT_CANVAS
  • DEFAULT_FPS
  • assemble_music_video()
• muvid.footage.edl
  • AssemblyCut
  • EdlEntry
  • FootageAlignment
  • MAX_EDL_ENTRIES
  • MIN_TRANSITION_S
  • TRANSITION_CURVES
  • TRANSITION_SPLIT
  • Transition
  • derive_cuts()
  • fill_gaps()
  • validate_edl()
• muvid.footage.lacing_bridge
  • CLIP_ALIGNMENT_SCHEMA
  • DECISION_TIER
  • TIME_RATE
  • alignment_annotations()
  • editor_document()
  • edl_annotations()
  • edl_from_annotations()
  • score_track_annotations()
• muvid.footage.scoring
• muvid.footage.scoring._frame_metrics
  • exposure_quality()
  • flow_residual_and_global()
  • sharpness()
  • to_gray()
• muvid.footage.scoring.frames
  • DEFAULT_MAX_FRAMES
  • DEFAULT_SAMPLE_FPS
  • FramePass
  • make_face_scorer()
  • sample_clip_frames()
• muvid.footage.scoring.grid
  • DEFAULT_HOP_S
  • ScoreTensor
  • ScoreTrack
  • align_fingerprint()
  • apply_norm()
  • build_tensor()
  • compute_norm()
  • grid_len()
  • load_tensor()
  • manifest_is_current()
  • resample_to_grid()
  • save_scores()
• muvid.footage.scoring.lipsync
  • lipsync_available()
  • lipsync_tracks()
  • separate_master_vocals()
• muvid.footage.scoring.motionbeat
  • motionbeat_tracks()
• muvid.footage.scoring.orchestrator
  • DEFAULT_METRICS
  • list_available_extractors()
  • score_project()
• muvid.footage.scoring.quality
  • SHARPNESS_FLOOR
  • quality_gate_mask()
  • quality_tracks()
• muvid.footage.scoring.segment
  • coverage_mask()
  • shot_boundaries()
• muvid.footage.select_score
  • DEFAULT_WEIGHTS
  • PRESETS
  • SelectionContext
  • WeightedSelectionConfig
  • resolve_config()
  • run_weighted()
  • selection_margin()
  • weighted_selection()
• muvid.footage.strategy
  • DEFAULT_STRATEGY
  • SelectionStrategy
  • best_confidence()
  • fewest_cuts()
  • list_strategies()
  • longest_take()
  • register_lazy_strategy()
  • register_selection_strategy()
  • resolve_strategy()
  • select_edl()
• muvid.footage.workspace
  • CANVASES
  • FootageWorkspace
  • MusicVideoFootageProject
• muvid.genre
• muvid.genre_music_video
• muvid.lyrics
  • LyricLine
  • LyricSection
  • LyricsDoc
  • lyrics_from_transcript()
  • parse_lyrics_md()
  • render_lyrics_md()
  • transcribe()
  • words_from_transcript()
• muvid.mcp
  • FREE_TOOLS
  • TOOL_NAMES
  • TOOL_REFS
  • VisualizerWorkspace
  • build_server()
  • current_email()
  • data_root()
  • register_tools()
  • token_email()
  • use_email()
• muvid.mcp._fetch
  • FetchError
  • MAX_BYTES
  • MAX_REDIRECTS
  • MIN_RATE_BPS
  • PermissionDeniedError
  • TOTAL_TIMEOUT_S
  • deadline_for()
  • extract_media_members()
  • fetch_bytes()
  • fetch_to_file()
  • fetch_to_file_streaming()
  • resolve_share_link()
• muvid.mcp._guide
• muvid.mcp.footage_tools
  • add_footage()
  • add_footage_folder()
  • align_footage()
  • assemble_music_video()
  • footage_editor_document()
  • footage_edl_from_annotations()
  • footage_status()
  • footage_timeline()
  • list_strategies()
  • propose_edit()
  • set_song()
• muvid.mcp.identity
  • current_email()
  • token_email()
  • use_email()
• muvid.mcp.scoring_tools
  • footage_score_status()
  • footage_scores()
  • score_footage()
• muvid.mcp.tools
• muvid.mcp.workspace
  • DATA_HOME_ENV_VAR
  • VisualizerProject
  • VisualizerWorkspace
  • data_root()
• muvid.project
  • MusicVideoProject
• muvid.renderers
  • RenderContext
  • billed_video_seconds()
  • render_shot()
  • shot_is_rendered()
• muvid.renderers._common
  • storyboard_prompt()
  • trim_video_to_duration()
  • upload_local_file_to_temp_url()
• muvid.renderers._errors
  • AnimationRenderError
  • RendererUnavailable
• muvid.renderers.animation
  • AN_CAMERA_MOVE_PHRASES
  • DFLT_AN_CAMERA_MOVE
  • an_camera_move()
  • render_animation()
• muvid.renderers.image_to_video
• muvid.renderers.lipsync
• muvid.renderers.still
• muvid.renderers.text_to_video
• muvid.schema
  • CharacterRef
  • EnvironmentRef
  • ProjectSpec
  • RenderStrategy
  • SectionSpec
  • ShotSpec
  • SongInfo
• muvid.script
  • parse_and_apply()
  • parse_script()
  • render_script()
  • write_script()
• muvid.ui
• muvid.ui.app
  • serve()
• muvid.visualize
  • Check
  • CoverLayout
  • FfmpegError
  • Loudness
  • RenderResult
  • TitleStyle
  • VisualContext
  • VisualPlan
  • canvas_image()
  • decode_pcm()
  • failures()
  • flash_filter()
  • has_filter()
  • list_visuals()
  • measure_loudness()
  • media_duration()
  • onset_envelope()
  • probe()
  • register_visual()
  • render_audio_video()
  • report()
  • require_ffmpeg()
  • resolve_visual()
  • run_ffmpeg()
  • thumbnail_image()
  • verify_video()
• muvid.visualize.canvas
  • CoverLayout
  • DEFAULT_SIZE
  • THUMBNAIL_SIZE
  • TitleStyle
  • background_chain()
  • canvas_image()
  • compose_chain()
  • cover_box()
  • cover_chain()
  • default_font()
  • escape_filter_value()
  • overlay_chain()
  • thumbnail_image()
  • title_chain()
• muvid.visualize.ffmpeg
  • DEFAULT_LOUDNESS_I
  • FFMPEG_TIMEOUT_ENV_VAR
  • FfmpegError
  • Loudness
  • PCM_SAMPLE_FORMAT
  • decode_pcm()
  • has_filter()
  • measure_loudness()
  • media_duration()
  • probe()
  • require_ffmpeg()
  • require_filter()
  • run_ffmpeg()
• muvid.visualize.reactive
  • DEFAULT_FLASH_LABEL
  • ENVELOPE_SR
  • FLASH_BRIGHTNESS
  • FLASH_DECAY
  • FLASH_FILTERS
  • FLASH_SATURATION
  • flash_filter()
  • onset_envelope()
• muvid.visualize.verify
  • Check
  • DURATION_TOLERANCE
  • LOUDNESS_TOLERANCE
  • failures()
  • report()
  • verify_video()
• muvid.visualize.video
  • AUDIO_SAMPLE_RATE
  • DEFAULT_AUDIO_BITRATE
  • DEFAULT_CRF
  • DEFAULT_GOP_SECONDS
  • RenderResult
  • render_audio_video()
• muvid.visualize.visuals
  • DEFAULT_TINT
  • REACTIVE_BG_SATURATION
  • REACTIVE_COVER_FRACTION
  • SCOPE_COVER_ALPHA
  • Visual
  • VisualContext
  • VisualPlan
  • bars_visual()
  • cqt_visual()
  • ken_burns_visual()
  • list_visuals()
  • register_visual()
  • resolve_visual()
  • scope_visual()
  • spectrum_visual()
  • still_visual()
  • waves_visual()

Indices and tables

• Index

• Module Index

• Search Page

Release: 0.0.38

Last change: Aug 31, 2026