Timeline Mixer Documentation
Loading...
Searching...
No Matches
TimelineMixer.TrackProcessor Class Reference

Track processor for timeline tracks that do not have a custom track processor, this will connect all unknown tracks to their own output. More...

Inheritance diagram for TimelineMixer.TrackProcessor:
[legend]

Public Member Functions

virtual void ProcessTrack (PlayableGraph graph, TrackAsset track, ScriptPlayable< TimelinePlayable > playable, int trackIndex, Object boundComponent, ref PlayableConnectionInfo info)
 Connect the current track index to any required mixer and playable output.
virtual void DisconnectTrack (PlayableNode timelineNode, int trackIndex, ref PlayableConnectionInfo info)
 Use this to cleanly disconnect tracks from their mixers and destroy any intermediary Playables. If you have added a lot of mixers or other playables between the timeline and output override this and destroy them here. Used when rebinding a timeline track at runtime, or removing a timeline.

Protected Member Functions

void ConnectPlayable (PlayableNode mixerNode, PlayableNode timelineNode, int trackIndex, ref PlayableConnectionInfo info)
 Connects the Timeline Playable to a mixer or passthrough and stores information about connections in the PlayableConnectionInfo.

Detailed Description

Track processor for timeline tracks that do not have a custom track processor, this will connect all unknown tracks to their own output.

Member Function Documentation

◆ ConnectPlayable()

void TimelineMixer.TrackProcessor.ConnectPlayable ( PlayableNode mixerNode,
PlayableNode timelineNode,
int trackIndex,
ref PlayableConnectionInfo info )
inlineprotected

Connects the Timeline Playable to a mixer or passthrough and stores information about connections in the PlayableConnectionInfo.

Parameters
mixerNodeThe Playable mixer or passthrough
timelineNodeThe TimelineNode wrapper for the TimelinePlayable
trackIndexThe track index
infoThe PlayableConnectionInfo instance that will hold connection data used for setting weights

◆ DisconnectTrack()

virtual void TimelineMixer.TrackProcessor.DisconnectTrack ( PlayableNode timelineNode,
int trackIndex,
ref PlayableConnectionInfo info )
inlinevirtual

Use this to cleanly disconnect tracks from their mixers and destroy any intermediary Playables. If you have added a lot of mixers or other playables between the timeline and output override this and destroy them here. Used when rebinding a timeline track at runtime, or removing a timeline.

Specialized track processors may need to override this method if they involve multiple Playables between the timeline and the mixer. For example:

  • The audio track processor uses an extra AudioMixerPlayable to work around a bug in the Playables API that affects audio mixing.

The default track processor does not offer blending, so the "mixer" and output are destroyed when disconnected from the timeline.

Parameters
trackIndexThe index of the timeline track to disconnect.

Implements TimelineMixer.ITrackProcessor.

Reimplemented in TimelineMixer.AnimationTrackProcessor, and TimelineMixer.AudioTrackProcessor.

◆ ProcessTrack()

virtual void TimelineMixer.TrackProcessor.ProcessTrack ( PlayableGraph graph,
TrackAsset track,
ScriptPlayable< TimelinePlayable > playable,
int trackIndex,
Object boundComponent,
ref PlayableConnectionInfo info )
inlinevirtual

Connect the current track index to any required mixer and playable output.

Parameters
graph
track
playable
trackIndex
boundComponent
info

Reimplemented in TimelineMixer.AudioTrackProcessor, TimelineMixer.MarkerTrackProcessor, and TimelineMixer.SignalTrackProcessor.