_{Official ZPE/YASS documentation}AudioStream

Loads, plays, pauses, stops, splits, saves, and exports audio streams. Streams may be played synchronously or asynchronously, muted, assigned a volume between 0 and 1, or converted to another audio format using FFmpeg.

Object functions

• construct [1.8.5+]

  The `construct` operation for the AudioStream object.

• export_to [1.14.11+]

  Exports the audio stream to the specified filename and format using FFmpeg.

• length [1.8.5+]

  Returns the length of the currently opened clip in milliseconds.

• open_stream [1.8.5+]

  Opens an audio stream from a URL or file path and prepares it for playback. Returns true if the stream was successfully opened, otherwise false.

• play [1.8.5+]

  Plays the currently opened clip and blocks until playback has finished. Once finished, the internal frame position is reset to the start of the clip. Returns true.

• play_async [1.8.5+]

  Plays the currently opened clip without blocking the current script. The frame position is reset to the start immediately after starting playback. Returns true.

• play_segment [1.14.11+]

  The `play_segment` operation for the AudioStream object.

• play_segment_async [1.14.11+]

  The `play_segment_async` operation for the AudioStream object.

• save [1.14.10+]

  The `save` operation for the AudioStream object.

• set_volume [1.14.11+]

  Sets playback volume from 0 (silent) to 1 (full volume) and returns whether the change succeeded.

• split [1.14.10+]

  The `split` operation for the AudioStream object.