Interface Trigger.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Trigger.Builder,Trigger>, SdkBuilder<Trigger.Builder,Trigger>, SdkPojo
Enclosing class:
Trigger

@Mutable @NotThreadSafe public static interface Trigger.Builder extends SdkPojo, CopyableBuilder<Trigger.Builder,Trigger>
  • Method Details

    • fixedInterval

      Trigger.Builder fixedInterval(FixedIntervalTrigger fixedInterval)

      Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.

      Parameters:
      fixedInterval - Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fixedInterval

      default Trigger.Builder fixedInterval(Consumer<FixedIntervalTrigger.Builder> fixedInterval)

      Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.

      This is a convenience method that creates an instance of the FixedIntervalTrigger.Builder avoiding the need to create one manually via FixedIntervalTrigger.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fixedInterval(FixedIntervalTrigger).

      Parameters:
      fixedInterval - a consumer that will call methods on FixedIntervalTrigger.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • perShot

      Trigger.Builder perShot(ShotTrigger perShot)

      Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.

      Parameters:
      perShot - Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • perShot

      default Trigger.Builder perShot(Consumer<ShotTrigger.Builder> perShot)

      Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.

      This is a convenience method that creates an instance of the ShotTrigger.Builder avoiding the need to create one manually via ShotTrigger.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to perShot(ShotTrigger).

      Parameters:
      perShot - a consumer that will call methods on ShotTrigger.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • perScene

      Trigger.Builder perScene(SceneTrigger perScene)

      Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.

      Parameters:
      perScene - Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • perScene

      default Trigger.Builder perScene(Consumer<SceneTrigger.Builder> perScene)

      Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.

      This is a convenience method that creates an instance of the SceneTrigger.Builder avoiding the need to create one manually via SceneTrigger.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to perScene(SceneTrigger).

      Parameters:
      perScene - a consumer that will call methods on SceneTrigger.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • perClip

      Trigger.Builder perClip(ClipTrigger perClip)

      Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.

      Parameters:
      perClip - Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • perClip

      default Trigger.Builder perClip(Consumer<ClipTrigger.Builder> perClip)

      Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.

      This is a convenience method that creates an instance of the ClipTrigger.Builder avoiding the need to create one manually via ClipTrigger.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to perClip(ClipTrigger).

      Parameters:
      perClip - a consumer that will call methods on ClipTrigger.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: