ILMSsfWrt Interface

This is the interface for the LEAD SSF Writer.

Data types:

eLMSSFWRT_MODE:

typedef enum
{
 LMSSFWRT_MODE_CBR_1PASS
} eLMSSFWRT_MODE;
 

eLMSSFWRT_QUALITY:

typedef enum
{
  LMSSFWRT_QUALITY_FASTEST,
  LMSSFWRT_QUALITY_BALANCED,
  LMSSFWRT_QUALITY_BEST
} eLMSSFWRT_QUALITY;
 

eLMSSFWRT_VF:

typedef enum
{
 LMSSFWRT_VF_VC1,
 LMSSFWRT_VF_H264_MAIN,
 LMSSFWRT_VF_H264_BASELINE,
 LMSSFWRT_VF_LEAD_H264_MAIN,
 LMSSFWRT_VF_LEAD_H264_BASELINE
} eLMSSFWRT_VF;
 

eLMSSFWRT_AF:

typedef enum

{

 LMSSFWRT_AF_WMA,

 LMSSFWRT_AF_WMA_PRO,

 LMSSFWRT_AF_AAC,

 LMSSFWRT_AF_LEAD_AAC

} eLMSSFWRT_AF;

eLMSSFWRT_APILEVEL:

typedef enum
{
  LMSSFWRT_APILEVEL_1 = 0,
} eLMSSFWRT_APILEVEL;
 

Interface Properties:

Interface Methods:

HRESULT  ResetToDefaults(eLMSSFWRT_APILEVEL ApiLevel)

Parameters

Description

Resets the SSF Writer to default values. The ApiLevel determines which default values to use. Current applications should set ApiLevel to LMSSFWRT_APILEVEL_1 = 0.

The Writer might change in the future and have different properties or default behaviour. Calling this method ensures the filter will have the same default values as they were at the time you developed your application.

It is best to call ResetToDefaults(LMSSFWRT_APILEVEL_1) before you start setting properties and start calling other methods for this interface.

This method does the following:

• Sets the Quality property to LMSSFWRT_QUALITY_BALANCED

• Sets the VideoFormat property to LMSSFWRT_VF_VC1

• Sets the VideoMode property to LMSSFWRT_MODE_CBR_1PASS

• Sets the VideoBufferWindow property to 4.0

• Sets the VideoKeyFrameInterval property to 2.0

• Sets the VideoStreamCount property to 1

• Sets the VideoStreamCount property to 1, with the video stream having the following property values:

• BitRate property: 1644

• Width property: 852

• Height property: 480

• Sets the AudioFormat property to LMSSFWRT_AF_WMA_PRO

• Sets the AudioMode property to LMSSFWRT_MODE_CBR_1PASS

• Sets the audio stream properties to the following property values:

• BitRate property: 128

• Channels property: 2

• SampleRate property: 44100

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT  EnterEdit()

Description

Enters settings edit mode.

The EnterEdit method pushes the current settings onto a saved settings stack. Any settings changes can be discarded later by calling LeaveEdit and passing the value VARIANT_TRUE for the discard parameter.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT  LeaveEdit(VARIANT_BOOL discard)

Parameters

Description

Leaves settings edit mode.

The LeaveEdit method pops the top entry from the saved settings stack and optionally reverts the settings to the values held before the EnterEdit method was called. To discard settings changes pass the value VARIANT_TRUE for the discard parameter.

Returns

S_OK if successful, E_UNEXPECTED if EnterEdit was not called prior to LeaveEdit.

HRESULT  RealizeSettings()

Description

Validates all settings changes and clears any edit dirty flags.

The RealizeSettings method validates settings changes to Quality, as well as, all Video and Audio Stream property settings. The following property constraints are applied:

• Quality property: A valid eLMSSFWRT_QUALITY enumeration value

• VideoFormat property: A valid eLMSSFWRT_VF enumeration value

• VideoMode property: A valid eLMSSFWRT_MODE enumeration value

• VideoBufferWindow property: A valid value from .01 to 100

• VideoKeyFrameInterval property: A valid value from .01 to 100

• Constrains each video stream's property values for:

• BitRate property: A valid value from 4 to 135000

• Width property: A valid value from 64 to 4096

• Width property: A valid value from 64 to 4096

• AudioFormat property: A valid eLMSSFWRT_AF enumeration value

• AudioMode property: A valid eLMSSFWRT_MODE enumeration value

• Constrains the audio stream property values for: BitRate, Channels, SampleRate and BitsPerSample to valid values depending on those allowed by the format.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT  CommitSettings()

Description

Commits the SSF filter settings to the registry.

The CommitSettings method calls RealizeSettings to validate the SSF interface settings and then saves the settings to the registry.

Returns

S_OK if successful, E_FAIL on failure.

HRESULT  GetVideoFormatSupported(long index, eLMSSFWRT_VF *pVal)

Parameters

Description

Gets the supported video format for the index specified.

Returns

S_OK if successful

E_POINTER if the return eLMSSFWRT_VF pointer is NULL.

E_INVALIDARG if the index specified exceeds the current video formats count (see VideoFormatSupportedCount property above).

HRESULT  IsVideoFormatSupported(eLMSSFWRT_VF format, VARIANT_BOOL *pVal)

Parameters

Description

Checks whether or not the specified video format is supported.

Returns

S_OK if successful; *pVal equals VARIANT_TRUE if the format is supported, else VARIANT_FALSE

E_POINTER if the return VARIANT_BOOL pointer is NULL.

HRESULT  GetVideoModeSupported(long index, eLMSSFWRT_MODE *pVal)

Parameters

Description

Gets the supported video mode for the index specified.

Returns

S_OK if successful

E_POINTER if the return eLMSSFWRT_MODE pointer is NULL.

E_INVALIDARG if the index specified exceeds the current video modes count (see VideoModeSupportedCount property above).

HRESULT  IsVideoModeSupported(eLMSSFWRT_MODE format, VARIANT_BOOL *pVal)

Parameters

Description

Checks whether or not the specified video mode is supported.

Returns

S_OK if successful; *pVal equals VARIANT_TRUE if the mode is supported, else VARIANT_FALSE

E_POINTER if the return VARIANT_BOOL pointer is NULL.

HRESULT  GetVideoStream(long index,  ILMSsfWrtVideoStream **pVal)

Parameters

Description

Gets an ILMSsfWrtVideoStream interface pointer for the video stream indicated by index value.  This interface is used to set the bitrate, width and height of the video stream.  See ILMSsfWrtVideoStream for more information.

Note: After using ILMSsfWrtVideoStream interface, the caller should release the object.

Returns

S_OK if successful; pVal holds the interface pointer

E_INVALIDARG if the index is out of range.

E_POINTER if the ILMSsfWrtVideoStream pointer is NULL.

HRESULT  AddVideoStream()

Description

Adds a new video stream.

This method creates a new video stream object and adds it to the current video stream list. If successful, the VideoStreamCount property will be incremented by one. To retrieve the interface for the newly added video stream, call GetVideoStream, passing the index of VideoStreamCount-1.

Returns

S_OK if successful, S_FALSE otherwise.

E_INVALIDARG if the current VideoStreamCount is equal to 16 (the maximum number of allowed video streams).

HRESULT  DeleteVideoStream(long index)

Parameters

Description

Deletes an existing video stream indicated by index value.

Returns

S_OK if successful

E_INVALIDARG if the index is out of range OR there is only 1 video stream.

HRESULT  GetAudioFormatSupported(long index, eLMSSFWRT_AF *pVal)

Parameters

Description

Gets the supported audio format for the index specified.

Returns

S_OK if successful

E_POINTER if the return eLMSSFWRT_AF pointer is NULL.

E_INVALIDARG if the index specified exceeds the current audio formats count (see AudioFormatSupportedCount property above).

HRESULT  IsAudioFormatSupported(eLMSSFWRT_AF format, VARIANT_BOOL *pVal)

Parameters

Description

Checks whether or not the specified audio format is supported.

Returns

S_OK if successful; *pVal equals VARIANT_TRUE if the format is supported, else VARIANT_FALSE

E_POINTER if the return VARIANT_BOOL pointer is NULL.

HRESULT  GetAudioModeSupported(long index, eLMSSFWRT_MODE *pVal)

Parameters

Description

Gets the supported audio mode for the index specified.

Returns

S_OK if successful

E_POINTER if the return eLMSSFWRT_MODE pointer is NULL.

E_INVALIDARG if the index specified exceeds the current audio modes count (see AudioModeSupportedCount property above).

HRESULT  IsAudioModeSupported(eLMSSFWRT_MODE format, VARIANT_BOOL *pVal)

Parameters

Description

Checks whether or not the specified audio mode is supported.

Returns

S_OK if successful; *pVal equals VARIANT_TRUE if the mode is supported, else VARIANT_FALSE

E_POINTER if the return VARIANT_BOOL pointer is NULL.