Class VideoMixer

Namespace

VAST.File.Utility

Assembly

VAST.File.dll

Provides video mixing functionality to overlay images onto a video file, with support for animated waypoints, pauses, and transcoding.

public class VideoMixer

Inheritance

object

VideoMixer

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

VideoMixer()

public VideoMixer()

Properties

AllowFullVideoTranscoding

Gets or sets a value indicating whether full video transcoding is allowed when source files are incompatible.

public bool AllowFullVideoTranscoding { get; set; }

Property Value

bool

CancellationToken

Gets or sets the cancellation token for operation cancellation.

public CancellationToken? CancellationToken { get; set; }

Property Value

CancellationToken?

ErrorDescription

Gets the last error description if the last method call returned false.

public string ErrorDescription { get; }

Property Value

string

FileCache

Gets or sets the file cache for optimized file access.

public FileCache FileCache { get; set; }

Property Value

FileCache

Images

Gets or sets the list of image overlays to apply to the video.

public List<InputFileItem> Images { get; set; }

Property Value

List<InputFileItem>

InputFile

Gets or sets the input video file item.

public InputFileItem InputFile { get; set; }

Property Value

InputFileItem

OutputFilePath

Gets or sets the output file path for the mixed video.

public string OutputFilePath { get; set; }

Property Value

string

OutputVideoType

Gets or sets the output video media type configuration.

public MediaType OutputVideoType { get; set; }

Property Value

MediaType

Progress

Gets the current mixing progress as a percentage (0-100).

public float Progress { get; }

Property Value

float

VideoRenderer

Gets or sets the video renderer for preview during mixing.

public IVideoRenderer VideoRenderer { get; set; }

Property Value

IVideoRenderer

Methods

Execute()

Executes video mixing using the properties configured on this instance.

public Task<bool> Execute()

Returns

Task<bool>

A task that returns true if mixing succeeded, false otherwise.

Execute(string, List<InputFileItem>, string)

Executes video mixing with the specified parameters.

public Task<bool> Execute(string inputFilePath, List<InputFileItem> images, string outputFilePath)

Parameters

inputFilePath string

The path to the input video file.

images List<InputFileItem>

The list of image overlays to apply.

outputFilePath string

The path for the output mixed video file.

Returns

Task<bool>

A task that returns true if mixing succeeded, false otherwise.

Execute(string, List<InputFileItem>, string, CancellationToken?)

Executes video mixing with the specified parameters and cancellation support.

public Task<bool> Execute(string inputFilePath, List<InputFileItem> images, string outputFilePath, CancellationToken? cancellationToken)

Parameters

inputFilePath string

The path to the input video file.

images List<InputFileItem>

The list of image overlays to apply.

outputFilePath string

The path for the output mixed video file.

cancellationToken CancellationToken?

Optional cancellation token to cancel the operation.

Returns

Task<bool>

A task that returns true if mixing succeeded, false otherwise.