timeline

class janim.anims.timeline.Timeline(*args, **kwargs)

基类：object

继承该类并实现 construct() 方法，以实现动画的构建逻辑

调用 build() 可以得到构建完成的动画对象

CONFIG: Config | None = None

在子类中定义该变量可以起到设置配置的作用，例如：

class Example(Timeline):
    CONFIG = Config(
        font=['Consolas', 'LXGW WenKai Lite']
    )

    def construct(self) -> None:
        ...

另见：Config

classmethod with_config() → _WithConfig

使用定义在 Timeline 子类中的 config

ctx_var: ContextVar = <ContextVar name='Timeline.ctx_var' default=None>
static get_context(raise_exc=True) → Timeline | None

调用该方法可以得到当前正在构建的 Timeline 对象

class TimeOfCode(time: float, line: int)

基类：object

标记 construct() 执行到的代码行数所对应的时间

time: float
line: int
class ScheduledTask(at: float, func: Callable, args: list, kwargs: dict)

基类：object

另见 schedule()

at: float
func: Callable
args: list
kwargs: dict
class PlayAudioInfo(audio: Audio, range: TimeRange, clip_range: TimeRange)

基类：object

调用 play_audio() 的参数信息

audio: Audio
range: TimeRange
clip_range: TimeRange
class SubtitleInfo(text: str, range: TimeRange, kwargs: dict, subtitle: Text)

基类：object

调用 subtitle() 的参数信息

text: str
range: TimeRange
kwargs: dict
subtitle: Text
class PausePoint(at: 'float', at_previous_frame: 'bool')

基类：object

at: float
at_previous_frame: bool
class ItemHistory

基类：object

abstractmethod construct() → None

继承该方法以实现动画的构建逻辑

build(*, quiet=False, hide_subtitles=False) → TimelineAnim

构建动画并返回

schedule(at: float, func: Callable, *args, **kwargs) → None

计划执行

会在进度达到 at 时，对 func 进行调用， 可传入 *args 和 **kwargs

timeout(delay: float, func: Callable, *args, **kwargs) → None

相当于 schedule(self.current_time + delay, func, *args, **kwargs)

forward(dt: float = 1, *, _detect_changes=True, _record_lineno=True) → None

向前推进 dt 秒

forward_to(t: float, *, _detect_changes=True) → None

向前推进到 t 秒的时候

prepare(*anims: Animation, **kwargs) → TimeRange

应用动画

play(*anims: Animation, **kwargs) → TimeRange

应用动画并推进到动画结束的时候

pause_point(*, offset: float = 0, at_previous_frame: bool = True) → None

标记在预览界面中，执行到当前时间点时会暂停

  • at_previous_frame 控制是在前一帧暂停（默认）还是在当前帧暂停

  • offset 表示偏移多少秒，例如 offset=2 则是当前位置 2s 后

  • 在 GUI 界面中，可以使用 Ctrl+Z 快速移动到前一个暂停点，Ctrl+C 快速移动到后一个

is_displaying(item: Item) → None

判断特定的物件是否正在显示中

另见：show()、hide()

show(*roots: Item, root_only=False) → None

显示物件

hide(*roots: Item, root_only=False) → None

隐藏物件

cleanup_display() → None

对目前显示中的所有物件调用隐藏，使得正确产生 Display 对象

aas(file_path: str, subtitle: str | Iterable[str], **kwargs) → TimeRange

audio_and_subtitle() 的简写

audio_and_subtitle(file_path: str, subtitle: str | Iterable[str], *, clip: tuple[float, float] | None | EllipsisType = Ellipsis, delay: float = 0, mul: float | Iterable[float] | None = None, **subtitle_kwargs) → TimeRange

播放音频，并在对应的区间显示字幕

  • 如果 clip=... （默认，省略号），则表示自动确定裁剪区间，将前后的空白去除（可以传入 clip=None 禁用自动裁剪）

  • 如果 mul 不是 None，则会将音频振幅乘以该值

play_audio(audio: Audio, *, delay: float = 0, begin: float = 0, end: float = -1, clip: tuple[float, float] | None = None) → TimeRange

在当前位置播放音频

  • 可以指定 begin 和 end 表示裁剪区段

  • 可以指定在当前位置往后 delay 秒才开始播放

  • 若指定 clip，则会覆盖 begin 和 end （可以将 clip 视为这二者的简写）

返回值表示播放的时间段

has_audio() → bool

是否有可以播放的音频

get_audio_samples_of_frame(fps: float, framerate: int, frame: int, *, count: int = 1) → ndarray

提取特定帧的音频流

subtitle(text: str | Iterable[str], duration: float = 1, delay: float = 0, scale: float | Iterable[float] = 0.8, use_typst_text: bool | Iterable[bool] = False, surrounding_color: JAnimColor = BLACK, surrounding_alpha: float = 0.5, font: str | Iterable[str] = [], depth: float = -100000.0, **kwargs) → TimeRange
subtitle(text: str | Iterable[str], range: TimeRange, **kwargs) → TimeRange

添加字幕

  • 文字可以传入一个列表，纵向排列显示

  • 可以指定在当前位置往后 delay 秒才显示

  • duration 表示持续时间

  • scale 表示对文字的缩放，默认为 0.8，可以传入列表表示对各个文字的缩放

  • use_typst_text 表示是否使用 TypstText，可以传入列表表示各个文字是否使用

返回值表示显示的时间段

place_subtitle(subtitle: Text | TypstText, range: TimeRange) → None

被 subtitle() 调用以将字幕放置到合适的位置：

  • 对于同一批添加的字幕 [a, b]，则 a 放在 b 的上面

  • 如果在上文所述的 [a, b] 仍存在时，又加入了一个 c，则 c 放在最上面

has_subtitle() → bool
track(item: Item) → None

使得 item 在每次 forward 和 play 时都会被自动调用 detect_change()

track_item_and_descendants(item: Item, *, root_only: bool = False) → None

相当于对 item 及其所有的后代物件调用 track()

detect_changes_of_all() → None

检查所有物件是否有产生变化并记录

detect_changes(items: Iterable[Item], *, as_time: float | None = None) → None

检查指定的列表中的物件是否有产生变化并记录（仅检查自身而不包括子物件的）

register_dynamic(item: Item, dynamic: DynamicItem, static: Item | None, begin: float, end: float, static_replaceable: bool) → None
item_current(item: T, *, as_time: float | None = None, skip_dynamic=False) → T

另见 current()

get_construct_lineno() → int | None

得到当前在 construct() 中执行到的行数

get_lineno_at_time(time: float)

根据 time 得到对应执行到的行数

static fmt_time(t: float) → str
dbg_time(ext_msg: str = '') → None
class janim.anims.timeline.SourceTimeline(*args, **kwargs)

基类：Timeline

与 Timeline 相比，会在背景显示源代码

build(*, quiet=False, hide_subtitles=False) → TimelineAnim

构建动画并返回

class janim.anims.timeline.TimelineAnim(timeline: Timeline, **kwargs)

基类：AnimGroup

运行 Timeline.build() 后返回的动画组

property cfg: Config | ConfigGetter
current_camera_info() → CameraInfo
anim_on(local_t: float) → None

将 local_t 换算为 alpha 并调用 anim_on_alpha()

render_all(ctx: Context) → None

调用所有的 RenderCall 进行渲染

capture_ctx: mgl.Context | None = None
capture_fbo: mgl.Framebuffer | None = None
capture() → Image