Class VideoFrameOptions

Options for `TransformType.video_frame`. Supplying this message with any other transform type fails with `invalid_options_error`.

Inheritance

object

VideoFrameOptions

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 VideoFrameOptions

Constructors

VideoFrameOptions(double, uint)

Initializes a new instance of the VideoFrameOptions class.

Declaration

public VideoFrameOptions(double offsetInSeconds = 0, uint scalePercent = 100)

Parameters

Type	Name	Description
double	offsetInSeconds	Offset into the video, in seconds, of the frame to extract. Should be within the video's duration. Defaults to 0 (the first frame) when omitted. Only the lower bound is enforced, because the upper bound is the source's duration, which is not known until the video is opened. An offset past the end is not rejected.
uint	scalePercent	Scale the extracted frame to this percentage of the video's natural frame size. Must be in (0, 100]; the pipeline does not upscale. Defaults to 100 (no scaling) when omitted.

Properties

OffsetInSeconds

Offset into the video, in seconds, of the frame to extract. Should be within the video's duration. Defaults to 0 (the first frame) when omitted. Only the lower bound is enforced, because the upper bound is the source's duration, which is not known until the video is opened. An offset past the end is not rejected.

Declaration

public double OffsetInSeconds { get; protected set; }

Property Value

Type	Description
double

ScalePercent

Scale the extracted frame to this percentage of the video's natural frame size. Must be in (0, 100]; the pipeline does not upscale. Defaults to 100 (no scaling) when omitted.

Declaration

public uint ScalePercent { get; protected set; }

Property Value

Type	Description
uint