blob: 7714e5222b4acfce28a5d2baa28c6d939ace7b0d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="IHandBrakeInstance.cs" company="HandBrake Project (http://handbrake.fr)">
// This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
// </copyright>
// <summary>
// The Interface for HandBrakeInstance
// </summary>
// --------------------------------------------------------------------------------------------------------------------
namespace HandBrake.Interop.Interop.Interfaces
{
using System;
using HandBrake.Interop.Interop.EventArgs;
using HandBrake.Interop.Interop.Json.Encode;
using HandBrake.Interop.Interop.Json.Scan;
using HandBrake.Interop.Interop.Model.Preview;
/// <summary>
/// The Interface for HandBrakeInstance
/// </summary>
public interface IHandBrakeInstance
{
#region Events
/// <summary>
/// Fires when an encode has completed.
/// </summary>
event EventHandler<EncodeCompletedEventArgs> EncodeCompleted;
/// <summary>
/// Fires for progress updates when encoding.
/// </summary>
event EventHandler<EncodeProgressEventArgs> EncodeProgress;
/// <summary>
/// Fires when a scan has completed.
/// </summary>
event EventHandler<EventArgs> ScanCompleted;
/// <summary>
/// Fires for progress updates when scanning.
/// </summary>
event EventHandler<ScanProgressEventArgs> ScanProgress;
#endregion
#region Properties
/// <summary>
/// Gets the index of the default title.
/// </summary>
int FeatureTitle { get; }
/// <summary>
/// Gets the list of titles on this instance.
/// </summary>
JsonScanObject Titles { get; }
/// <summary>
/// Gets the HandBrake version string.
/// </summary>
string Version { get; }
/// <summary>
/// Gets the HandBrake build number.
/// </summary>
int Build { get; }
#endregion
#region Public Methods
/// <summary>
/// Initializes this instance.
/// </summary>
/// <param name="verbosity">
/// The code for the logging verbosity to use.
/// </param>
void Initialize(int verbosity);
/// <summary>
/// Frees any resources associated with this object.
/// </summary>
void Dispose();
/// <summary>
/// Gets an image for the given job and preview
/// </summary>
/// <remarks>
/// Only incorporates sizing and aspect ratio into preview image.
/// </remarks>
/// <param name="job">
/// The encode job to preview.
/// </param>
/// <param name="previewNumber">
/// The index of the preview to get (0-based).
/// </param>
/// <param name="deinterlace">
/// True to enable basic deinterlace of preview images.
/// </param>
/// <returns>
/// An image with the requested preview.
/// </returns>
RawPreviewData GetPreview(PreviewSettings job, int previewNumber, bool deinterlace);
/// <summary>
/// Pauses the current encode.
/// </summary>
void PauseEncode();
/// <summary>
/// Resumes a paused encode.
/// </summary>
void ResumeEncode();
/// <summary>
/// Starts an encode with the given job.
/// </summary>
/// <param name="jobToStart">
/// The job to start.
/// </param>
void StartEncode(JsonEncodeObject jobToStart);
/// <summary>
/// Starts a scan of the given path.
/// </summary>
/// <param name="path">
/// The path of the video to scan.
/// </param>
/// <param name="previewCount">
/// The number of previews to make on each title.
/// </param>
/// <param name="minDuration">
/// The min Duration.
/// </param>
void StartScan(string path, int previewCount, TimeSpan minDuration, int titleIndex);
/// <summary>
/// Stops the current encode.
/// </summary>
void StopEncode();
/// <summary>
/// Stop any running scans
/// </summary>
void StopScan();
#endregion
}
}
|
