24
Argus Encoder Family Version 2.6 API Developer’s Guide
Filter Manager Interface Properties
Filter Manager Interface Properties
Because the Windows Registry is now used to store all of the encoding parame-
ters, the list of Filter Manager interface properties defined in this section is short.
In fact, it includes only those properties that report on the version numbers of
installed hardware and firmware, those that report on the progress or status of an
encoding session, and those that toggle on and off specific Windows functionality.
Listed below are the Filter Manager interface properties that are fully supported
in version 2.6. Though a number of previously used properties may still appear in
the Filter Manager interface, you should assume that properties not defined below
are not fully supported.
Before defining the property, each listing specifies whether the
Get()
method or
the
Put()
method is implemented for that property. In each of the definitions, the
data-type of the property is listed within the set of parentheses. In cases where
the
Get()
method is implemented, this data type specifies the return value of the
Get()
method. In cases where the
Put()
method is implemented, the data type
within the parentheses indicates the data type of the setting that is to be passed
as an argument.
For example, if a property is listed as
PropertyX( long )
, then assume that the defi-
nition of the corresponding
Put()
method is
void PutPropertyX( long val )
; and
that the definition of the corresponding
Get()
method is
long GetPropertyX()
;.
WriteToMessageBox( BOOL ):
(Put)
If this property is set to 1, the Filter Man-
ager software will pop up Windows message boxes when specific errors occur.
When the property is set to 0, those message boxes will be suppressed. This
method should be called before any other Filter Manager method is called.
EncoderFirmwareVersion( BSTR ):
(Get)
Returns the version number charac-
ter string of the firmware installed on the encoder board. Only version “1.20”
or later supports ATSC closed captioning.
EncoderHardwareVersion( BSTR ):
(Get)
Returns the string representation of
the version of the encoder board. “S422 SBE” is the 4:2:2 single-chip encoder
board, “S420 SBE” is the 4:2:0 single-chip encoder board, and “ME31 SBE”
is the 4:2:2 three-chip encoder board.
SecondAudioVersion( BSTR ):
(Get)
Returns the version number character
string of the firmware that controls the second audio encoder.
DurationFrameCount(long):
(Get)
Anytime after the
Cue()
method has been
called for the current encode,
GetDurationFrameCount()
can be called to
retrieve the total number of frames that are to be encoded (including all
