Drive a View's Camera through a CameraTour's waypoints.
Snaps the camera to tour.waypoints[startWaypointIndex]
immediately, then begins the dwell → transit cycle. The first
onWaypointEnter callback fires synchronously on the success
path so the host can sync HUDs / narration overlays before the
first tick.
Returns an SDKResult wrapping the
CameraTourPlayback handle — never throws, matching the
SDK's result-monad convention. On invalid input (empty tour,
destroyed view), returns
{ok: false, type: SDKErrorType.InvalidInput, error: "…"}.
Drive a
View's Camera through a CameraTour's waypoints.Snaps the camera to
tour.waypoints[startWaypointIndex]immediately, then begins the dwell → transit cycle. The firstonWaypointEntercallback fires synchronously on the success path so the host can sync HUDs / narration overlays before the first tick.Returns an SDKResult wrapping the CameraTourPlayback handle — never throws, matching the SDK's result-monad convention. On invalid input (empty tour, destroyed view), returns
{ok: false, type: SDKErrorType.InvalidInput, error: "…"}.