Class LiveStreamCaptureDevice
The base class for implementing a capture device that manages a Live
Inheritance
Inherited Members
Namespace: Unity.LiveCapture
Assembly: Unity.LiveCapture.dll
Syntax
public abstract class LiveStreamCaptureDevice : LiveCaptureDevice
Properties
CurrentFrameTime
The current frame time and frame rate of the Live
Declaration
public FrameTimeWithRate? CurrentFrameTime { get; }
Property Value
Type | Description |
---|---|
Frame |
See Also
FirstFrameTime
The time of the first recorded frame.
Declaration
protected double? FirstFrameTime { get; }
Property Value
Type | Description |
---|---|
double? |
See Also
Methods
BakeAnimationClip()
Generates an animation clip from the last recording.
Declaration
protected AnimationClip BakeAnimationClip()
Returns
Type | Description |
---|---|
Animation |
An animation clip containing the last recording. |
See Also
CreateLiveProperties(LiveStream)
Override this method to create new properties to the specified Live
Declaration
protected virtual void CreateLiveProperties(LiveStream stream)
Parameters
Type | Name | Description |
---|---|---|
Live |
stream | The Live |
See Also
LiveUpdate()
Override this method to update the device during live mode.
Declaration
protected override void LiveUpdate()
Overrides
Remarks
This method is called after the animation system execution and before the script's LateUpdate.
See Also
OnDisable()
The device calls this method when the device is about to get disabled.
Declaration
protected override void OnDisable()
Overrides
Remarks
If you override this method, call the base method in your implementation.
See Also
OnEnable()
The device calls this method when the device is about to get enabled.
Declaration
protected override void OnEnable()
Overrides
Remarks
If you override this method, call the base method in your implementation.
See Also
OnStartRecording()
The device calls this method when a new recording started.
Declaration
protected override void OnStartRecording()
Overrides
See Also
ProcessFrame(LiveStream)
Override this method to process the specified Live
Declaration
protected abstract void ProcessFrame(LiveStream stream)
Parameters
Type | Name | Description |
---|---|---|
Live |
stream | The Live |
See Also
RegisterLiveProperties()
Registers the values of the live properties to prevent Unity from marking Prefabs or the Scene as modified when you preview animations.
Declaration
protected void RegisterLiveProperties()
See Also
RestoreLiveProperties()
Restores the original values of any created live property.
Declaration
protected void RestoreLiveProperties()
See Also
UpdateStream(Transform, FrameTimeWithRate)
Updates the internal Live
Declaration
protected void UpdateStream(Transform root, FrameTimeWithRate frameTime)
Parameters
Type | Name | Description |
---|---|---|
Transform | root | The root transform to bind. |
Frame |
frameTime | The frame time to use for recording. |