pulp::host::TimelineOfflineRenderResult Struct Reference

Result of a one-shot render. audio is populated only when code == Ok. More...

#include <timeline_offline_renderer.hpp>

Public Member Functions
constexpr	operator bool () const noexcept

Public Attributes
TimelineOfflineRenderCode	code = TimelineOfflineRenderCode::Ok
audio::AudioFileData	audio
std::uint64_t	region_frames = 0
	Frames of audio that precede the tail pad. Equals the region length.
std::uint64_t	tail_frames = 0
	Frames of tail pad actually rendered. Equals options.tail_frames on Ok.
TimelineGraphAdmission	admission {}
	Populated when code == BindingRejected.
TimelineGraphProcessResult	process {}
	Populated when code == ProcessFailed.
playback::TransportError	transport_error = playback::TransportError::None
	Populated when code == TransportRejected.

Detailed Description

Result of a one-shot render. audio is populated only when code == Ok.

Member Function Documentation

operator bool()

pulp::host::TimelineOfflineRenderResult::operator bool ( ) const

inlineexplicitconstexprnoexcept

Member Data Documentation

admission

TimelineGraphAdmission pulp::host::TimelineOfflineRenderResult::admission {}

Populated when code == BindingRejected.

audio

audio::AudioFileData pulp::host::TimelineOfflineRenderResult::audio

code

TimelineOfflineRenderCode pulp::host::TimelineOfflineRenderResult::code = TimelineOfflineRenderCode::Ok

process

TimelineGraphProcessResult pulp::host::TimelineOfflineRenderResult::process {}

Populated when code == ProcessFailed.

region_frames

std::uint64_t pulp::host::TimelineOfflineRenderResult::region_frames = 0

Frames of audio that precede the tail pad. Equals the region length.

tail_frames

std::uint64_t pulp::host::TimelineOfflineRenderResult::tail_frames = 0

Frames of tail pad actually rendered. Equals options.tail_frames on Ok.

transport_error

playback::TransportError pulp::host::TimelineOfflineRenderResult::transport_error = playback::TransportError::None

Populated when code == TransportRejected.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/core/host/include/pulp/host/timeline_offline_renderer.hpp