Struct Shot

Represents a shot. A shot stores information about the take to play, the slate used, and the output directory. The TakeRecorder uses that information to name and store the recorded takes in the correct directory.

Namespace: Unity.LiveCapture

Assembly: Unity.LiveCapture.dll

Syntax

[Serializable]
public struct Shot

Properties

Description

The description of the shot stored in the slate.

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

Directory

The file path containing the recorded takes.

Declaration

public string Directory { get; set; }

Property Value

Type	Description
string

Duration

The duration of the shot in seconds.

Declaration

public double Duration { get; set; }

Property Value

Type	Description
double

IterationBase

The take to iterate from in the next recording.

Declaration

public Take IterationBase { get; set; }

Property Value

Type	Description
Take

Name

The name of the shot stored in the slate.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Remarks

The recorded takes automatically inherit from this name.

SceneNumber

The number associated with the scene to record.

Declaration

public int SceneNumber { get; set; }

Property Value

Type	Description
int

Slate

The slate associated with the shot to record.

Declaration

public Slate Slate { get; set; }

Property Value

Type	Description
Slate

Take

The selected take of the slate.

Declaration

public Take Take { get; set; }

Property Value

Type	Description
Take

TakeNumber

The number associated with the take to record.

Declaration

public int TakeNumber { get; set; }

Property Value

Type	Description
int

Remarks

The number increments after recording a take.

TimeOffset

The time, in seconds, to add to the contents of a recording.

Declaration

public double TimeOffset { get; set; }

Property Value

Type	Description
double

Methods

Equals(object)

Determines whether the specified object is equal to the current shot.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object specified to compare with the current shot.

Returns

Type	Description
bool	true if the specified object is equal to the current shot; otherwise, false.

Overrides

ValueType.Equals(object)

Equals(Shot)

Determines whether the specified shot is equal to the current one.

Declaration

public bool Equals(Shot other)

Parameters

Type	Name	Description
Shot	other	The shot specified to compare with the current one.

Returns

Type	Description
bool	true if the specified shot is equal to the current one; otherwise, false.

GetHashCode()

Gets the hash code for the shot.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The hash value generated for this shot.

Overrides

ValueType.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

ValueType.ToString()

Operators

operator ==(Shot, Shot)

Determines whether the two specified shots are equal.

Declaration

public static bool operator ==(Shot a, Shot b)

Parameters

Type	Name	Description
Shot	a	The first shot.
Shot	b	The second Shot.

Returns

Type	Description
bool	true if the specified shots are equal; otherwise, false.

operator !=(Shot, Shot)

Determines whether the two specified shots are different.

Declaration

public static bool operator !=(Shot a, Shot b)

Parameters

Type	Name	Description
Shot	a	The first shot.
Shot	b	The second shot.

Returns

Type	Description
bool	true if the specified shots are different; otherwise, false.