Class KeyframesExtractOptions

Options for `ExtractType.keyframes`.

Inheritance

object

KeyframesExtractOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Riviera

Assembly: Dropbox.Api.dll

Syntax

public class KeyframesExtractOptions

Constructors

KeyframesExtractOptions(double, bool)

Initializes a new instance of the KeyframesExtractOptions class.

Declaration

public KeyframesExtractOptions(double sceneChangeThreshold = 0, bool includeImages = false)

Parameters

Type	Name	Description
double	sceneChangeThreshold	Sensitivity of scene-change detection. A keyframe is emitted whenever the frame-to-frame scene score crosses this threshold, so a LOWER value yields MORE keyframes. When omitted (0.0) the service uses 0.3, a good starting point for most videos. Values above 1.0 fail with user_error.
bool	includeImages	When true, each keyframe carries its JPEG image, base64-encoded, in ApiKeyframe.image_base64. When false (the default), only timestamps and scene scores are returned, which keeps the result small.

Properties

IncludeImages

When true, each keyframe carries its JPEG image, base64-encoded, in `ApiKeyframe.image_base64`. When false (the default), only timestamps and scene scores are returned, which keeps the result small.

Declaration

public bool IncludeImages { get; protected set; }

Property Value

Type	Description
bool

SceneChangeThreshold

Sensitivity of scene-change detection. A keyframe is emitted whenever the frame-to-frame scene score crosses this threshold, so a LOWER value yields MORE keyframes. When omitted (0.0) the service uses 0.3, a good starting point for most videos. Values above 1.0 fail with `user_error`.

Declaration

public double SceneChangeThreshold { get; protected set; }

Property Value

Type	Description
double