Class GetKeyframesArgs

Arguments for the asynchronous `get_keyframes_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the video whose scene-change keyframes should be extracted.

Inheritance

object

GetKeyframesArgs

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 GetKeyframesArgs

Constructors

GetKeyframesArgs(FileIdOrUrl, double, bool)

Initializes a new instance of the GetKeyframesArgs class.

Declaration

public GetKeyframesArgs(FileIdOrUrl fileIdOrUrl = null, double sceneChangeThreshold = 0, bool includeImages = false)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the video file to extract keyframes from. Callers must set exactly one of the FileIdOrUrl variants. Keyframe extraction is supported for video files only; see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error.
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. Valid range is (0.0, 1.0]. When omitted (0.0) the service uses a default of 0.3, which is a good starting point for most videos.
bool	includeImages	When true, each returned keyframe includes the JPEG image bytes, base64-encoded, in ApiKeyframe.image_base64. When false, the response contains only per-keyframe metadata (timestamp and scene score) and image_base64 is left empty -- useful when you only need the scene boundaries and want a small response. NOTE: because the field defaults to false in proto3, callers who want images must set this explicitly to true.

Properties

FileIdOrUrl

Identifier of the video file to extract keyframes from. Callers must set exactly one of the `FileIdOrUrl` variants. Keyframe extraction is supported for video files only; see the route description for the supported formats. Requests against unsupported formats return `unsupported_format_error`.

Declaration

public FileIdOrUrl FileIdOrUrl { get; protected set; }

Property Value

Type	Description
FileIdOrUrl

IncludeImages

When true, each returned keyframe includes the JPEG image bytes, base64-encoded, in `ApiKeyframe.image_base64`. When false, the response contains only per-keyframe metadata (timestamp and scene score) and `image_base64` is left empty -- useful when you only need the scene boundaries and want a small response. NOTE: because the field defaults to false in proto3, callers who want images must set this explicitly to true.

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. Valid range is (0.0, 1.0]. When omitted (0.0) the service uses a default of 0.3, which is a good starting point for most videos.

Declaration

public double SceneChangeThreshold { get; protected set; }

Property Value

Type	Description
double