Interface ITakeBuilder

Represents a Take asset creator.

Namespace: Unity.LiveCapture

Syntax

public interface ITakeBuilder

Properties

ContextStartTime

The start time in seconds of the recording context.

Declaration

double ContextStartTime { get; }

Property Value

Type	Description
Double

Methods

AddBinding<T>(TakeBinding<T>, T)

Adds a TakeBinding<T> to the Take.

Declaration

void AddBinding<T>(TakeBinding<T> binding, T value)
    where T : Object

Parameters

Type	Name	Description
TakeBinding<T>	binding	The binding to add.
T	value	The object to bind.

Type Parameters

Name	Description
T	The type of binding created. The track type must be derived from ITakeBinding.

CreateAnimationTrack(String, Animator, AnimationClip, ITrackMetadata, Nullable<Double>)

Creates an animation track.

Declaration

void CreateAnimationTrack(string name, Animator animator, AnimationClip animationClip, ITrackMetadata metadata = null, double? alignTime = null)

Parameters

Type	Name	Description
String	name	The name of the track.
Animator	animator	The target animator component to bind.
AnimationClip	animationClip	The animation clip to set into the new track.
ITrackMetadata	metadata	The metadata associated with the new track (optional).
Nullable<Double>	alignTime	The timecode (expressed in seconds) of first recorded sample (optional).

Remarks

This method checks if another animation track is using the same binding. In that case, the new track becomes an override of the existing one. You can optionally pass in a alignTime, which will be used for aligning synchronized recordings under the same timecode source. If alignTime is null, no alignment will be performed for this track.

CreateTrack<T>(String, Nullable<Double>)

Creates a new track without binding.

Declaration

T CreateTrack<T>(string name, double? alignTime = null)
    where T : TrackAsset, new()

Parameters

Type	Name	Description
String	name	The name of the track.
Nullable<Double>	alignTime	The timecode (expressed in seconds) of first recorded sample (optional).

Returns

Type	Description
T	Returns the created track.

Type Parameters

Name	Description
T	The type of track being created. The track type must be derived from TrackAsset.

Remarks

You can optionally pass in a alignTime, which will be used for aligning synchronized recordings under the same timecode source. If alignTime is null, no alignment will be performed for this track.

CreateTrack<T>(String, ITakeBinding, Nullable<Double>)

Creates a new track with binding.

Declaration

T CreateTrack<T>(string name, ITakeBinding binding, double? alignTime = null)
    where T : TrackAsset, new()

Parameters

Type	Name	Description
String	name	The name of the track.
ITakeBinding	binding	The binding to use for the new track.
Nullable<Double>	alignTime	The timecode (expressed in seconds) of first recorded sample (optional).

Returns

Type	Description
T	Returns the created track.

Type Parameters

Name	Description
T	The type of track being created. The track type must be derived from TrackAsset.

Remarks

You can optionally pass in a alignTime, which will be used for aligning synchronized recordings under the same timecode source. If alignTime is null, no alignment will be performed for this track.