Editing Engine interfaces
The following section describes the interfaces that are used to tune and control the SolveigMM Video Editing Engine.
IModuleConfig interface
The IModuleConfig interface provides access for the reading and writing of the module (SolveigMM Video Editing Engine) parameters. All of the module parameters have their own unique GUIDs. The parameter GUID must be known in order to read or write its value. All of the parameter values are transferred via the VARIANT structure that represents a general store for different data types.
For more detailed information about IModuleConfig interface please read Elecard Module Configuration Programmer Guide to be shipped with SolveigMM Video Editing SDK.
The GUIDs of parameters supported by SolveigMM Video Editing Engine through IModuleConfig interface are described in Editing Engine Parameters section.
IID of IModuleConfig interface is IID_IModuleConfig {486F726E-4D43-49b9-8A0C-C22A2B0524E8}
Methods in VTable order
| Interface | Description |
| IUnknown | |
| QueryInterface | Retrieves pointers to supported interfaces |
| AddRef | Increments reference count |
| Release | Decrements reference count |
| IPersist | GetClassID | Retrieves the class identifier (CLSID) of an object |
| IPersistStream | |
| IsDirty | Checks the object for changes since it was last saved |
| Load | Initializes an object from the stream where it was previously saved |
| Save | Saves an object into the specified stream and indicates whether the object should reset its dirty flag. |
| GetSizeMax | Return the size in bytes of the stream needed to save the object |
| IModuleConfig | |
| SetValue | Sets a new parameter value. |
| GetValue | Retrieves the current parameter value. |
| GetParamConfig | Retrieves the pointer to the IParamConfig interface. |
| IsSupported | Clarifies whether the parameter identified by pParamID is available for the given module or not. |
| SetDefState | Resets all of the module parameters to default values. |
| EnumParams | Retrieves the list of parameters that are valid for the given module. |
| CommitChanges | Verifies and applies the modified parameter values. |
| DeclineChanges | Declines all of the parameter modifications that have been made since the last CommitChanges call; sets the module to the previous committed state |
| SaveToRegistry | Saves the committed module state into the registry database. |
| LoadFromRegistry | Loads the module parameters from the registry database. The loaded values should be verified and applied by the CommitChanges call. |
| RegisterForNotifies | Subscribes the client for the notification messages about the module parameters modification. |
| UnregisterFromNotifies | Unsubscribes the client from the notification messages about the module parameters modification. |
ITrimmerObjControl interface
The ITrimmerObjControl interface is a specific to the SolveigMM Video Editing Engine. The ITrimmerObjControl interface is exposed by the SolveigMM Video Editing Engine and provides methods to start/stop the engine, the rest routines are obsolete. Instead, IModuleConfig interface is used.
IID of ITrimmerObjControl interface is IID_ITrimmerObjControl {9D9BF96C-8E7A-41FC-ABB1-CCC9CEF493E9}
Methods in VTable order
| Interface | Description |
| IUnknown | |
| QueryInterface | Retrieves pointers to supported interfaces |
| AddRef | Increments reference count |
| Release | Decrements reference count |
| IDispatch | |
| GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1) |
| GetTypeInfo | Gets the type information for an object |
| GetIDsOfNames | Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs |
| Invoke | Provides access to properties and methods exposed by an object |
| ITrimmerObjControl | |
| Start | Starts the engine process |
| Stop | Stops the engine process |
| put_InputFN | Obsolete. Substituted IModuleConfig interface with SMAT_InputFile guid |
| get_InputFN | Obsolete. Substituted IModuleConfig interface with SMAT_InputFile guid |
| put_OutputFN | Obsolete. Substituted IModuleConfig interface with SMAT_OutputFile guid |
| get_OutputFN | Obsolete. Substituted IModuleConfig interface with SMAT_OutputFile guid |
| get_Status | Obsolete. Substituted IModuleConfig interface with SMAT_Progress guid |
| get_StreamLength | Obsolete. |
| put_StartPosition | Obsolete. Substituted IModuleConfig interface with SMAT_TrimList guid |
| get_StartPosition | Obsolete. Substituted IModuleConfig interface with SMAT_TrimList guid |
| put_StopPosition | Obsolete. Substituted IModuleConfig interface with a SMAT_TrimList guid |
| get_StopPosition | Obsolete. Substituted IModuleConfig interface with SMAT_TrimList guid |
| SetCallback | Obsolete. Substituted IModuleConfig interface with SMAT_Callback guid |
ITrimmerObjControl::Start
The Start method starts the engine with the parameters set
Syntax
HRESULT Start (
void
);
Return Value
Returns S_OK if the process was successfully started or an HRESULT error code otherwise.
ITrimmerObjControl::Stop
The Stop method stops the current engine process
Syntax
HRESULT Stop (
void
);
Return Value
Returns S_OK if the process was successfully started or an HRESULT error code otherwise.
ITrimmerObjControlCB interface
The ITrimmerObjControlCB interface is a specific to the SolveigMM Video Editing Engine. The ITrimmerObjControlCB interface provides callback methods for an application implemented this interface.The interface is set by IModuleConfig::SetValue interface with SMAT_Callback parameter guid.
IID of ITrimmerObjControlCB interface is IID_ITrimmerObjControlCB {33968711-8887-46D4-A71B-9B1B061EEDCA}
Methods in VTable order
| Interface | Description |
| IUnknown | |
| QueryInterface | Retrieves pointers to supported interfaces |
| AddRef | Increments reference count |
| Release | Decrements reference count |
| ITrimmerObjControlCB | |
| OnStart | Callback method to indicate the engine started trimming process |
| OnStop | Callback method to indicate the engine stopped trimming process |
| OnError | Callback method to indicate that some error occurred |
| OnPause | Not implemented |
ITrimmerObjControlCB::OnStart
The OnStart callback method is called indicating the engine started trimming process
Syntax
HRESULT OnStart (
void
);
Return Value
Returns S_OK if successful, or an HRESULT error code otherwise.
ITrimmerObjControlCB::OnStop
The OnStop callback method is called indicating the engine stopped trimming process
Syntax
HRESULT OnStop (
void
);
Return Value
Returns S_OK if successful, or an HRESULT error code otherwise.
ITrimmerObjControlCB::OnError
The OnError callback method is called indicating some error occurred
Syntax
HRESULT OnError (
HRESULT hr,
BSTR Val
);
Parameters
hr - Variable to contain error code
Val - Variable to contain error description
Return Value
Returns S_OK if successful, or an HRESULT error code otherwise