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
Syntax
[Serializable]
public struct Shot : IEquatable<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 |
|---|---|
| Int32 |
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 |
|---|---|
| Int32 |
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 |
|---|---|
| Boolean | true if the specified object is equal to the current shot; otherwise, false. |
Overrides
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 |
|---|---|
| Boolean | 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 |
|---|---|
| Int32 | The hash value generated for this shot. |
Overrides
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
Operators
Equality(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 |
|---|---|
| Boolean | true if the specified shots are equal; otherwise, false. |
Inequality(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 |
|---|---|
| Boolean | true if the specified shots are different; otherwise, false. |