Docs /Templates/ sinapsis-data-readers

ExecuteNTimesLazyAudioReaderSoundfile

sinapsis-data-readerscommunityaudioreaderspydubsoundfile

Python template · sinapsis_data_readers.templates.audio_readers.audio_reader_soundfile

Overview

This template provides functionality to read multiple audios, each of them assigned to its own DataContainer and to its own reader process. Similar to its base class, it reads the audio using the Soundfile library, n_times_execute determines the number of times the template's execute method is called. By default, it only gets called once. Further calls to execute are bypassed.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-data-readers==1.0.0
uv pip install sinapsis-data-readers==1.0.0
uv add sinapsis-data-readers==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

source
str
Optional
Default: "f8beca0a-1ed4-4fd3-a751-cbbda0405dca"
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
root_dir
str | None
Optional
Default: null
generic_keyRequired
str
Required
Default: null
audio_file_path
str | None
Optional
Default: null
n_times_execute
int
Optional
Default: 1

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "ExecuteNTimesLazyAudioReaderSoundfile"
    class_name: "ExecuteNTimesLazyAudioReaderSoundfile"
    attributes:
      source: "f8beca0a-1ed4-4fd3-a751-cbbda0405dca"
      root_dir: null
      generic_key: "<required>"
      audio_file_path: null
      n_times_execute: 1

Inheritance

Immediate parent: sinapsis_data_readers.templates.audio_readers.audio_reader_soundfile.ExecuteNTimesLazyAudioReaderSoundfile

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.