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

Processes audio tracks and connects them to the correct mixer on the playable graph. Use the TrackProcessor attribute to set the track type the processor will be in charge of. More...

Inheritance diagram for TimelineMixer.AudioTrackProcessor:
[legend]

Public Member Functions

override 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.
override 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.

Additional Inherited Members

Protected Member Functions inherited from TimelineMixer.TrackProcessor
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

Processes audio tracks and connects them to the correct mixer on the playable graph. Use the TrackProcessor attribute to set the track type the processor will be in charge of.

Member Function Documentation

◆ DisconnectTrack()

override void TimelineMixer.AudioTrackProcessor.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.

Reimplemented from TimelineMixer.TrackProcessor.

◆ ProcessTrack()

override void TimelineMixer.AudioTrackProcessor.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 from TimelineMixer.TrackProcessor.