Clipping Preference

Definition

Determines the curation of clips that are returned

Structure

{
  "SortType": "<sort-type>",
  "IsDescending": "boolean to sort clipped strokes in reverse",
  "KeepDuplicates": "boolean to keep duplicate strokes",
  "DurationLimit": "Video duration time limit",
  "CountLimit": "Hole count limit"
}

SortType enum

How the clips from the replay request will be sorted

  None: 0,
  Shuffle: 1,
  Time: 2,
  HoleOrder: 3,

• Shuffle - Clips are sorted randomly per hole (strokes within hole are still ordered sequentially by play)
• Time - Clips are sorted per hole in play order (from tee hole onwards)
• HoleOrder - Clips are sorted per hole from Hole 1 to 18

IsDescending boolean Default: false

By default, holes are clipped in ascending order (if not Shuffled). If set to true, it will flip the order of the clips

Keep Duplicates boolean Default: none

By default, selected strokes for certain holes will filter out duplicates. If true, duplicate holes will not be removed from the clips

Duplicates

When Duplicates are not kept, there is a random sorting of what holes are kept if duplicate holes are added to the final clip list

Duration Limit timespan Optional e.g. value: "00:01:00" - 1 minute

Limit as for how long the cumulative duration of the clips will be. The limit is only enforced once the limit is exceeded. ie: as soon as the set of clips ticks to higher than the specified Duration Limit, no new sets of clips will be added

The limit is checked as all the clipped strokes within a hole are added to the overall set of clips. The number of strokes clipped per hole depend on the metrics/scenario specified.

Count Limit int Optional

Limit to the number of Holes that appear in the resulting clips. This applies to the Hole itself, not to the strokes within the hole that are being added to the clip list