[fade]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The desired duration per audio sample
Specifies the desired duration of each output audio sample. Input will be buffered until a sample of this duration can be made. When draining a sample of a shorter duration may be emitted.
Note: Defaults to 1024 if not set.
Type: Int32
The duration of leading silence.
Represents the duration of silence to prepend before the fade-in begins.
Note: Defaults to 0 if not set. Values are in time-scale units.
Type: Int32
The duration of the fade-in.
Note: Defaults to 0 if not set. Values are in time-scale units.
Type: Int32
The shape of the fade-in.
Note: Defaults to linear if not set.
Type: FadeShapeType
The duration of the fade-out.
Note: Defaults to 0 if not set. Values are in time-scale units.
Type: Int32
The shape of the fade-out.
Note: Defaults to linear if not set.
Type: FadeShapeType
The duration of trailing silence.
Represents the duration of silence to append after the fade-out ends.
Note: Defaults to 0 if not set. Values are in time-scale units.
Type: Int32
Fade shape modes.
| Value | Name | Description |
|---|---|---|
4 |
Sine | Sine |
2 |
Exponential | Exponential |
0 |
Linear | Linear |
1 |
Logarithmic | Logarithmic |
3 |
Cosine | Cosine |
[afc ]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
[amix]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The desired output channel layout.
Specifies the desired channel layout for the output track. A default mix matrix will be constructed from the input channels and may be overriden through the MixMatrix property.
If not specified a default identity matrix will be constructed which then may be altered through the MasterVolume property.
Note: Defaults to Stereo
Type: ChannelLayouts or Array of channel labels
The desired duration per audio sample
Specifies the desired duration of each output audio sample. Input will be buffered until a sample of this duration can be made. When draining a sample of a shorter duration may be emitted.
Note: Defaults to 1024 if not set.
Type: Int32
The desired final master volume adjustment.
Specifies the final gain/attenuation applied to the mix matrix. This is applied to both the user supplied matrix and generated default matrix. The final volume adjustment is also applied after matrix normalization.
Note: Defaults to 1.
Type: Float
Specifies whether or not to normalize the matrix.
Matrix normalization is intended to avoid overflow when mixing. Matrix nomralization is applied to the final matrix and will override the matrix set by the MixMatrix property.
The maximum level of an output channel equals the sum of the row elements:
MaxLevel[out_ch] = Sum(Matrix[out_ch][in_ch])
To avoid overflow we must make the level of all output channels less-than or equal to 1. To do this we divide all matrix elements by the maximum level among all output channels:
MaxLevel = Max(MaxLevel[out_ch]) NormalizedMatrix[i][j] = Matrix[i][j] / MaxLevel
Note: Defaults to true unless MixMatrix was specified.
Type: Bool
The mix matrix.
Allows the client to override the default mix matrix.
Note: The variant array should contain at least 2 x input channels x output channels floating-point values or be constructed as an array of arrays. Each element in the matrix is specified as a complex number, 2 floating-point values (or an array of 2 floating-point values). The first float is the real part and the second is the imaginary part. Phase information is indicated by setting the real part to r * cos (theta) and the imaginary part to r * sin (theta) where r is the attenuation/gain and theta is the phase angle.
Type: VariantArray of Floats or VariantArray of VariantArrays of VariantArrays.
Deinterlace modes
| Value | Name | Description |
|---|---|---|
5 |
C_L_R_Ls_Rs | Center, Left, Right, Left Side, Right Side |
0 |
Mono | Monophonic, single channel |
1 |
Stereo | Stereophonic, left right pair |
6 |
C_L_R_Ls_Rs_LFE | Center, Left, Right, Left Side, Right Side, LFE |
3 |
C_L_R | Center, Left, Right |
2 |
Lt_Rt | Stereophonic down-mix, using Dolby Digital Hybrid down-mixing |
4 |
C_L_R_Cs | Center, Left, Right, Center Back |
7 |
C_Lc_Rc_L_R_Ls_Rs_LFE | Center, Left Center, Right Center, Left, Right, Left Side, Right Side, LFE |
8 |
C_L_R_Ls_Rs_Cs_LFE | Center, Left, Right, Left Side, Right Side, Center Back, LFE |
9 |
C_L_R_Ls_Rs_Lrs_Rrs_LFE | Center, Left, Right, Left Side, Right Side, Left Back, Right Back, LFE |
[apch]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Sets new tempo control value.
Smaller values represent a slower tempo, larger values represent a faster tempo. Changes the audio to play more quickly or slowly without affecting the pitch.
Note: Normal tempo = 1.0.
Type: Double
Sets new rate control value.
Smaller values represent a slower rate, larger values represent a faster rate. Changes both tempo and pitch together.
Note: Normal rate = 1.0.
Type: Double
Sets new pitch control value.
Smaller values represent a lower pitch, larger values represent a higher pitch. Changes the pitch while keeping the original tempo.
Note: Original pitch = 1.0.
Type: Double
[apc ]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The bit rate to be reflected on the output properties.
See Also: CMediaProperties
Type: Int64
The properties collection to set on the output media properties.
Each property in the collection will be set as named property on the output media properties.
Note: Defaults to nullptr.
Type: CProperties
The format to be reflected on the output properties.
See Also: CMediaProperties
Type: Four
The language to be reflected on the output properties.
See Also: CMediaProperties
Type: UInt16 or String
The region to be reflected on the output properties.
See Also: CMediaProperties
Type: UInt16 or String
The channels to be reflected on the output properties.
See Also: CAudioProperties
Type: Int32
The sample rate to be reflected on the output properties.
See Also: CAudioProperties
Type: Int32
The media duration to be reflected on the output properties.
See Also: CMediaProperties
Type: Int64
The channel labels to be reflected on the output properties.
See Also: CAudioProperties
Type: Array
The channel program to be reflected on the output properties.
See Also: CAudioProperties
Type: Array
The channel content to be reflected on the output properties.
See Also: CAudioProperties
Type: Array
The channel coding to be reflected on the output properties.
See Also: CAudioProperties
Type: Array
[atrc]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The start time of the track.
Represents the start time of the input track for which to copy.
Note: Defaults to 0 if not set.
Type: Int32
The desired duration per audio sample
Specifies the desired duration of each output audio sample. Input will be buffered until a sample of this duration can be made. When draining a sample of a shorter duration may be emitted.
Note: Defaults to 1024 if not set.
Type: Int32
The stop time of the track.
Represents the stop time of the input track for which to copy.
Note: Defaults to 0 if not set.
Type: Int32
The duration of leading silence.
Represents the duration of silence to prepend before the fade-in begins.
Note: Defaults to 0 if not set. Values are in time-scale units.
Type: Int32
The duration of trailing silence.
Represents the duration of silence to append after the fade-out ends.
Note: Defaults to 0 if not set. Values are in time-scale units.
Type: Int32
[cfac]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The audio fade in duration in seconds.
Type: Double
The audio cross fade duration in seconds.
Type: Double
The audio fade out duration in seconds.
Type: Double
[aic ]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The audio fade in duration in seconds.
Type: Double
The total audio duration in seconds.
Type: Double
The audio fade out duration in seconds.
Type: Double
[amc ]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The array of gains to be applied to each input channel.
Type: Double[]
The matrix of gains to be applied to create each output channel.
Type: Double[]
The array of gains to be applied to each output channel.
Type: Double[]
[2aes]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
[337c]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
[aoc ]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
[asrc]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
[dacv]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the input channel configuration.
Used only in CBI mode. Channels not found in the confisguration will be replaced with silence.
Note: Detaults to CBI_5_1_4 or the most appropriate configuration base on the available channel labels.
Type: ChannelConfigurationType
The desired output channel configuration.
Specifies the desired channel layout for the output track.
Type: RenderModeType
Specifies the speech content threshold as a percentage.
If the percentage of speech detected in the program exceeds this threshold the speech gated loudness measurment is used for normalization.
Note: Set as an integer percentage between 0 and 100 (0% to 100%). Defaults to 50 (50%).
Type: Int
Specifies the loudness measurement algorithm.
Note: Defaults to LEQ_A.
Type: MeteringModeType
Indicates whether dialogue intelligence is enabled.
This feature identifies and analyzes dialogue segments within the audio as a basis for speech gating.
Note: Defaults to true.
Type: Bool
Gating identifier.
Note: This property will be set on the filter after the stream has received a null EOS sample. Deprecated 7/24/2020. This property is not necessary and will be removed.
Type: GatingType
Integrated level-gated loudness.
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Integrated speech-gated loudness.
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Speech content over the program, as a percentage.
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Integrated loudness (automatic selection of one of the loudness results).
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Loudness range over the program, in LU.
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Peak absolute sample value, since reset or since it was last cleared. Units are dBFS.
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Maximum True Peak value, as per ITU-R BS.1770-2, since reset or since it was last cleared. Units are dBTP.
Note: This property will be set on the filter after the stream has received a null EOS sample.
Type: Float
Render modes.
| Value | Name | Description |
|---|---|---|
0 |
Stereo | Stereophonic, left right pair |
1 |
C_L_R_Ls_Rs_LFE | Center, Left, Right, Left Surround, Right Surround, LFE |
2 |
C_Lc_Rc_L_R_Ls_Rs_LFE | Center, Left Center, Right Center, Left, Right, Left Surround, Right Surround, LFE |
Identifiers for each of the Dolby Professional Loudness Measurement (DPLM) gating techniques.
| Value | Name | Description |
|---|---|---|
0 |
Ungated | Ungated. |
1 |
Speech | Speech gated. |
2 |
Level | Level gated. |
Metering modes.
| Value | Name | Description |
|---|---|---|
0 |
BS_1770_4 | Rec. ITU-R BS.1770-4, higher channel count |
1 |
BS_1770_3 | Rec. ITU-R BS.1770-3, improved true peak |
2 |
BS_1770_2 | Rec. ITU-R BS.1770-2, gated loudness |
3 |
BS_1770_1 | Rec. ITU-R BS.1770-1, ungated loudness |
4 |
LEQ_A | Equivalent Continuous Sound Level with A-weighting |
Channel configurations.
| Value | Name | Description |
|---|---|---|
0 |
CBI_9_1_6 | Channel mode is 9.1.6 with channels: L, R, C, LFE, Ls, Rs, Lrs, Rrs, Lw, Rw, Ltf, Rtf, Ltm, Rtm, Ltr, Rtr |
1 |
CBI_7_1_4 | Channel mode is 7.1.4 with channels: L, R, C, LFE, Ls, Rs, Lrs, Rrs, Ltf, Rtf, Ltr, Rtr |
2 |
CBI_5_1_4 | Channel mode is 5.1.4 with channels: L, R, C, LFE, Ls, Rs, Ltf, Rtf, Ltr, Rtr |
[nwmc]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The scheduled broadcast duration in seconds. If not specified the preprocessor will use the input content duration.
Type: Int64
Source identifier. A 16 bit value that uniquely indentifies the content provider or distribution source.
Type: String
Unique identifier assigned to the watermarker (32 digit hex string).
Type: String
User assigned watermark name.
Type: String
Indentifies the output container respresenting the watermark data. This is a ZIP file containing the watermark metadata and log files.
Type: String
CBET source indentifier. A 20 bit value that identifies the content provider or distrubution source.
Type: String
[nlwc]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The license file path, not needed if using the default two paths.
/license/NielsenTicLicence.lic
Type: String
Intended use.
Type: String
The Nielsen source ID.
Authenticator will validate.
Type: Int
Password used to validate the CBET source identifier (CSID).
Corresponds to the CSID and assigned when the Nielsen Watermark SDK is delivered. If the CBET check-digit string does not match the CSID, the authenticator does not permit watermarking with the CSID.
Type: String
Sets the watermark application.
The following list categorizes the watermark encoder properties. The watermark engine properties are set to appropriate default values based on the application type.
Type: WatermarkApplicationType_t
Gets the staring TIC.
Note: Available once the filter has been initialized.
This property may not be appropriate for all watermark applications.
Type: UInt32
Determines if initialization of the watermark engine should defered until the first sample is received.
When true, initialization is defered until the first sample is deliviered to the filter. This avoids unnecessary requets for CommIds and TICs when repeated Begin/End cycles may be expected.
Note: StartingTic, FirstTimeStampm and CommId are invalid if DeferInitialization is true. DeferInitialization must be false for these properties to be set.
Defaults to true
Type: Boolean
Path to the folder that contains the output files produced by the watermark engine.
Type: String
Starting timestamp of the broadcast.
The value is the number of seconds that have elapsed since the Unix epoch (00:00:00 on 1 January 1970 TUC).
Type: UInt32
The watermarking process type.
Determines which, if any, watermarking processes are activated.
Note: Always enable both NW and N2 (or) NW, N2 and CBET (or) CBET.
Type: ActiveWatermarkProcess_t
ApplicationName.
Type: String
Specifies the watermarking engine.
Type: WatermarkProcessType_t
The commercial metadata duration.
Type: String
The Nielsen CBET source ID.
Authenticator will validate.
Type: Int
Determines whether the time-stamp field of the watermark represents a time-in-content serial number (usually generated by a SID/TIC server) or is based on system-clock time.
If system-clock time, does the watermark engine derive the first time stamp from the system clock, then calculate the others (required for testing the encoder by using offline file content), or does it derive every time stamp from the system clock?
Type: TimecodeType_t
Sets a parameter to flag N2 as N2HF encoding.
Type: Bool
Specifies the content type (NEAS6)
Indicates whether encoding is for a commercial (where PC codes are inserted into the commercial band) or non-commercial material (where PC or FD codes are inserted into the program band). A third, less-frequently used source type is service-breakout, where the timecode field is used to denote the breakout type.
Note: for Commercial Encoding use WATERMARK_COMMERCIAL
Type: WatermarkSourceType_t
Identifies the value that will be inserted in the legacy ‘timecode’ field if the source type is SERVICE_BREAKOUT.
Type: BreakoutType_t
Commercial distributor.
Type: String
Identifies watermark types that are used with TIC (offline) encoding.
Type: DistributionType_t
The metadata file reports the size of the input file, in bytes.
Type: Int32
Determines the method of handling a second FD code if FD codes are already present in the stream (N2 only).
Type: InsertionMode_t
Indicates using immersive channels.
Note: Channels greater than 8, must be identified as immersive.
Default is true if channels is greater than 8; otherwise, false.
Type: Bool
Asset name.
Type: String
Enables or disables CBETStepAside.
Note: CBET default behavior is overwrite when prior encoding is detected on the same layer.
Type: Bool
Asset identifier.
Type: String
Checks for the existence of an Emergency Alert System (EAS) alert.
Note: For US domestic, EAS deteciton is required to be enabled.
Type: Bool
Client media name.
Type: String
Sets the method for CBET VOD Mode.
Type: Int
Sets the Nielsen Client ID. The authenticator will validate.
Only applicable to Commercial watermarking using CommID.
Type: Int
Episode identifier.
Type: String
Enables LibVOD encoding.
Type: Bool
ADI file name.
Type: String
Sets the RtVod WatermarkType.
Type: RtVodMatermarkType_t
Sets the retry timeout (in milliseconds).
If initialization fails for APP_CC_WATERMARK, APP_FD_WATERMARK, or APP_COMMID_WATERMARK the filter will sleep for the specified amout of time and try again.
Type: Int32
Client name.
Type: String
Password used to validate the source identifier (SID).
Corresponds to the SID and assigned when the Nielsen Watermark SDK is delivered. If the check-digit string does not match the SID, the authenticator does not permit watermarking with the SID.
Type: String
The time zone offset of the local broadcast.
Type: Int32
The destination DST state.
Type: Int
The broadcast time delay.
Type: Int
SID/TIC discovery.
If this setting is true, CWatermarkAPI uses the discovery method of locating an available active SID/TIC server.
Type: Bool
Discovery port.
Identifies the port on which CWatermarkAPI listens for SID/TIC Server hosts to respond to its discovery request.
Note: Default is 6543. Should not be changed unless absolutely necessary.
Type: Int
The OEM hardware version.
OEM HW version should be set to number which is mapped to actual OEM HW version. This mapping may be different to each OEM vendor. 5 bits are allocated (i.e 1 to 32 numbers ) which can be mapped to OEM SW version. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Byte
IP Address of SID/TIC Server
If the discovery-flag is set to false, the watermark application uses this IP address to establish a direct socket connection with the SID/TIC server.
Type: String “xxx.xxx.xxx.xxx”
Enables or disables insertion of the encoder SID information.
Type: Bool
The encoder type that identfies the OEM encoder.
7 bits (128 sources) are allocated to specifying the type of encoder. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Byte
Commercial type.
Type: String
Seed for the random number generator.
RandomNumber in InfoSID is used to identify the group of InfoSID messages. This is InfoSID encoding parameter and is applicable only for TS App
Type: Int
Time source should be set to value as below which indicates time source used by encoder.
Type: TimeSource_t
Client media identifier.
Type: String
The OEM software version.
OEM SW version should be set to number which is mapped to actual OEM SW version. This mapping may be different to each OEM vendor. 7 bits are allocated (i.e 1 to 128 numbers ) which can be mapped to OEM SW version. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Byte
The encoder serial number.
27bit allocated that can be used to set the OEM hardware serial number. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Int
Gets the first timestamp.
Note: Available once the filter has been initialized.
This property may not be appropriate for all watermark applications.
Type: UInt32
Application version.
Type: String
Path to the folder that contains the metadata files produced by the watermark engine.
Type: String
Advertiser identifier.
Type: String
Brand identifier.
Type: String
Advertiser name.
Type: String
Agency identifier.
Type: String
Agency name.
Type: String
Brand name.
Type: String
HD content.
Type: String
Secondary language.
Type: String
Gets the last timestamp.
Note: Available when the final sample has been delivered.
This property may not be appropriate for all watermark applications.
Type: UInt32
Primary language.
Type: String
Gets the commercial id.
Note: Available once the filter has been initialized.
This property may not be appropriate for all watermark applications.
Type: UInt32
Determines whether the time source used for watermarking content.
| Value | Name | Description |
|---|---|---|
0 |
TIMESOURCE_MANUAL | Manual |
1 |
TIMESOURCE_LTC | LTC |
2 |
TIMESOURCE_NTP | NTP |
Determines watermark application.
| Value | Name | Description |
|---|
Specifies type of watermarking engine to be used.
| Value | Name | Description |
|---|---|---|
4 |
NIELSEN_WATERMARK_ENGINE | Nielsen |
0 |
NAES2_WATERMARK | NAES1 legacy NAES II watermarking |
3 |
CBET_WATERMARK | CBET |
1 |
NAES2_HF_WATERMARK | NAES2 HF high-frequency watermarking (for commercials) |
2 |
NAES6_WATERMARK | NAES6 VI watermarking (introduced in 2009) |
5 |
WATERMARK_TYPE_UNDEFINED | Undefined |
Determines whether the content being watermarked is RTVOD_C3_WATERMARKING (after 3 days) or RTVOD_C7_WATERMARKING (after 7 days)
| Value | Name | Description |
|---|
Identifies watermark types that are used with TIC (offline) encoding.
| Value | Name | Description |
|---|---|---|
1 |
FINAL_DISTRIBUTOR | Final Distributor: codes are applied to content that already contains Nielsen watermarks (program-content or final-distributor) |
0 |
PROGRAM_CONTENT | Program Content: codes are applied to clean content |
Specifies type of watermarking to activate this session.
| Value | Name | Description |
|---|---|---|
3 |
ENABLE_BOTH_PROCESSES | NAES2 + NAES6: Both NAES II and NAES VI activated. |
0 |
DISABLE_WATERMARKING | Disabled: turns off all watermarking-software bypass |
1 |
ENABLE_NAES_II | NAES2: legacy NAES II watermarking |
2 |
ENABLE_NAES_VI | NAES6: NAES VI watermarking (introduced in 2010) |
5 |
ENABLE_NAES_VI_CBET | NAES6 + CBET: Both NAES VI and CBET activated. |
4 |
ENABLE_CBET | CBET: CBET only activated. |
6 |
ENABLE_NAES_II_VI_CBET | NAES2 + NAES6 + CBET: NAES II, NAES VI and CBET all three activated. |
Identifies the value that will be inserted in the legacy ‘timecode’ field if the source type is SERVICE_BREAKOUT.
| Value | Name | Description |
|---|---|---|
3 |
MOBILE_BREAKOUT | Mobile |
0 |
BREAKOUT_RESERVED | Reserved |
1 |
VOD_BREAKOUT | VOD |
2 |
INTERNET_BREAKOUT | Internet |
4 |
BREAKOUT_UNDEFINED | Undefined |
Determines the method of handling a second FD code if FD codes are already present in the stream (NAES II HF and NAES VI).
| Value | Name | Description |
|---|---|---|
0 |
WATERMARK_REFRAIN | Refrain: indicates that the second code should not be inserted at all |
1 |
WATERMARK_INSERT | Insert: indicates that the code should be inserted in the manner appropriate for the specified WatermarkProcessType_t |
Determines whether the time-stamp field of the watermark represents a time-in-content serial number (usually generated by a SID/TIC server) or is based on system-clock time.
| Value | Name | Description |
|---|---|---|
0 |
INSERTER_TIC | TIC Server: the time-stamp field is occupied by a TIC, usually generated by the SID/TIC server. |
1 |
INSERTER_CLOCK_ALWAYS | System clock: the time-stamp field in every watermark is derived from the system clock time. |
2 |
INSERTER_SERVICE_BREAKOUT | Service breakout: the time stamp field is used to define a service break-out (for example, VOD BREAK-OUT is represented by a value of 1). |
3 |
INSERTER_CLOCK_STARTING_TIME | Starting time: the time-stamp field is occupied by a number representing a clock-time that can be translated into a date-time string. However, only the first time stamp is read from the system clock. All others are computed as offsets from the first time stamp. |
4 |
INSERTER_USER_CLOCK_TIME | User clock time: the user sets the starting time-stamp. All others are computed as offsets from the first time-stamp. |
Determines whether the time source used for watermarking content.
| Value | Name | Description |
|---|---|---|
0 |
CheckDigitAuthenticator | Use check-digits to validate SID |
1 |
SidTicAuthenticator | Use SID/TIC server to validate SID |
2 |
AuthenticatorParamsUndefined | Undefined |
Specifies the type of content being watermarked. Applies to NAES VI only.
| Value | Name | Description |
|---|---|---|
1 |
WATERMARK_COMMERCIAL | Commercials: used to watermark commercials |
0 |
WATERMARK_TAM | All content types: used to watermark all other types of content. |
2 |
WATERMARK_SERVICE_BREAKOUT | Service breakout: used to flag type as VOD, INTERNET, etc. |
[nlwm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the watermarking engine
Type: WatermarkProcessType_t
The broadcast time delay.
Type: Int
Identifies watermark types that are used with TIC (offline) encoding.
Type: DistributionType_t
Identifies the value that will be inserted in the legacy ‘timecode’ field if the source type is SERVICE_BREAKOUT.
Type: BreakoutType_t
The Nielsen source identifier (SID) assigned to the content owner or distributor.
Authenticator will validate.
Type: UInt32
The destination DST state.
Type: Int
Determines whether the time-stamp field of the watermark represents a time-in-content serial number (usually generated by a SID/TIC server) or is based on system-clock time.
If system-clock time, does the watermark engine derive the first time stamp from the system clock, then calculate the others (required for testing the encoder by using offline file content), or does it derive every time stamp from the system clock?
Type: TimecodeType_t
Set the source media base name.
Type: String
Specifies the content type (NEAS6)
Type: WatermarkSourceType_t
The time zone offset of the local broadcast.
Type: Int32
Specifies the watermarking type
Type: ActiveWatermarkProcess_t
Determines the handling of second FD codes (NAES2 HF).
Type: InsertionMode_t
The encoder type that identfies the OEM encoder.
7 bits (128 sources) are allocated to specifying the type of encoder. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Byte
The OEM software version.
OEM SW version should be set to number which is mapped to actual OEM SW version. This mapping may be different to each OEM vendor. 7 bits are allocated (i.e 1 to 128 numbers ) which can be mapped to OEM SW version. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Byte
The OEM hardware version.
OEM HW version should be set to number which is mapped to actual OEM HW version. This mapping may be different to each OEM vendor. 5 bits are allocated (i.e 1 to 32 numbers ) which can be mapped to OEM SW version. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Byte
Time source should be set to value as below which indicates time source used by encoder.
Type: TimeSource_t
The encoder serial number.
27bit allocated that can be used to set the OEM hardware serial number. This is InfoSID encoding parameter and is applicable only for TS App.
Type: Int
Seed for the random number generator.
RandomNumber in InfoSID is used to identify the group of InfoSID messages. This is InfoSID encoding parameter and is applicable only for TS App
Type: Int
Sets the value of the AssetName element.
Type: String
Enables or disables insertion of the encoder SID information.
Type: Bool
Enables or disables CBET EAS.
Note: For US domestic, EAS deteciton is required to be enabled.
Type: Bool
Set the first timestamp.
Type: String
Enables or disables CBETStepAside.
Note: CBET default behavior is overwrite when prior encoding is detected on the same layer.
Type: Bool
The license file path, not needed if using the default two paths.
/license/NielsenTsLicence.lic
Type: String
Sets SID-authentication type.
Determines which of the remaining parameters currently apply.
Type: AuthenticatorParam_t
The Nielsen assigned CBET source identifier.
Authenticator will validate.
Type: UInt32
Password used to validate the source identifier (SID).
Corresponds to the SID and assigned when the Nielsen Watermark SDK is delivered. If the check-digit string does not match the SID, the authenticator does not permit watermarking with the SID.
Type: String
Password used to validate the CBET source identifier (CSID).
Corresponds to the CSID and assigned when the Nielsen Watermark SDK is delivered. If the CBET check-digit string does not match the CSID, the authenticator does not permit watermarking with the CSID.
Type: String
Sets the value of the ClientName element.
Type: String
Starting timestamp of the broadcast.
The value is the number of seconds that have elapsed since the Unix epoch (00:00:00 on 1 January 1970 TUC).
Type: UInt32
Path to the folder that contains the metadata and log files produced by the watermark engine.
Type: String
Sets the value of the ApplicationName element.
Type: String
Set the metadata field: OEM version.
Type: String
Set the last timestamp.
Type: String
Identifies watermark types that are used with TIC (offline) encoding.
| Value | Name | Description |
|---|---|---|
1 |
FINAL_DISTRIBUTOR | Final Distributor: codes are applied to content that already contains Nielsen watermarks (program-content or final-distributor) |
0 |
PROGRAM_CONTENT | Program Content: codes are applied to clean content |
Specifies type of watermarking to activate this session.
| Value | Name | Description |
|---|---|---|
3 |
ENABLE_BOTH_PROCESSES | NAES2 + NAES6: Both NAES II and NAES VI activated. |
0 |
DISABLE_WATERMARKING | Disabled: turns off all watermarking-software bypass |
1 |
ENABLE_NAES_II | NAES2: legacy NAES II watermarking |
2 |
ENABLE_NAES_VI | NAES6: NAES VI watermarking (introduced in 2010) |
5 |
ENABLE_NAES_VI_CBET | NAES6 + CBET: Both NAES VI and CBET activated. |
4 |
ENABLE_CBET | CBET: CBET only activated. |
6 |
ENABLE_NAES_II_VI_CBET | NAES2 + NAES6 + CBET: NAES II, NAES VI and CBET all three activated. |
Specifies the type of content being watermarked. Applies to NAES VI only.
| Value | Name | Description |
|---|---|---|
1 |
WATERMARK_COMMERCIAL | Commercials: used to watermark commercials |
0 |
WATERMARK_TAM | All content types: used to watermark all other types of content. |
2 |
WATERMARK_SERVICE_BREAKOUT | Service breakout: used to flag type as VOD, INTERNET, etc. |
Identifies the value that will be inserted in the legacy ‘timecode’ field if the source type is SERVICE_BREAKOUT.
| Value | Name | Description |
|---|---|---|
3 |
MOBILE_BREAKOUT | Mobile |
0 |
BREAKOUT_RESERVED | Reserved |
1 |
VOD_BREAKOUT | VOD |
2 |
INTERNET_BREAKOUT | Internet |
4 |
BREAKOUT_UNDEFINED | Undefined |
Determines whether the time source used for watermarking content.
| Value | Name | Description |
|---|---|---|
0 |
TIMESOURCE_MANUAL | Manual |
1 |
TIMESOURCE_LTC | LTC |
2 |
TIMESOURCE_NTP | NTP |
Determines whether the time source used for watermarking content.
| Value | Name | Description |
|---|---|---|
0 |
CheckDigitAuthenticator | Use check-digits to validate SID |
1 |
SidTicAuthenticator | Use SID/TIC server to validate SID |
2 |
AuthenticatorParamsUndefined | Undefined |
Determines whether the time-stamp field of the watermark represents a time-in-content serial number (usually generated by a SID/TIC server) or is based on system-clock time.
| Value | Name | Description |
|---|---|---|
0 |
INSERTER_TIC | TIC Server: the time-stamp field is occupied by a TIC, usually generated by the SID/TIC server. |
1 |
INSERTER_CLOCK_ALWAYS | System clock: the time-stamp field in every watermark is derived from the system clock time. |
2 |
INSERTER_SERVICE_BREAKOUT | Service breakout: the time stamp field is used to define a service break-out (for example, VOD BREAK-OUT is represented by a value of 1). |
3 |
INSERTER_CLOCK_STARTING_TIME | Starting time: the time-stamp field is occupied by a number representing a clock-time that can be translated into a date-time string. However, only the first time stamp is read from the system clock. All others are cd as offsets from the first time stamp. |
4 |
INSERTER_USER_CLOCK_TIME | User: the user sets the starting time-stamp. All others are computed as offsets from the first time-stamp. |
Specifies type of watermarking engine to be used.
| Value | Name | Description |
|---|---|---|
4 |
NIELSEN_WATERMARK_ENGINE | Nielsen |
0 |
NAES2_WATERMARK | NAES1 legacy NAES II watermarking |
3 |
CBET_WATERMARK | CBET |
1 |
NAES2_HF_WATERMARK | NAES2 HF high-frequency watermarking (for commercials) |
2 |
NAES6_WATERMARK | NAES6 VI watermarking (introduced in 2009) |
5 |
WATERMARK_TYPE_UNDEFINED | Undefined |
Determines the method of handling a second FD code if FD codes are already present in the stream (NAES II HF and NAES VI).
| Value | Name | Description |
|---|---|---|
0 |
WATERMARK_REFRAIN | Refrain: indicates that the second code should not be inserted at all |
1 |
WATERMARK_INSERT | Insert: indicates that the code should be inserted in the manner appropriate for the specified WatermarkProcessType_t |
[nnlw]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Determines the handling of second FD codes (NAES2 HF).
Type: InsertionMode_t
Specifies the watermarking engine..
Type: WatermarkProcessType_t
Identifies watermark types that are used with TIC (offline) encoding.
Type: DistributionType_t
The license file path, not needed if using the default two paths.
/license/NielsenTicLicence.lic
Type: String
Determines whether the time-stamp field of the watermark represents a time-in-content serial number (usually generated by a SID/TIC server) or is based on system-clock time.
If system-clock time, does the watermark engine derive the first time stamp from the system clock, then calculate the others (required for testing the encoder by using offline file content), or does it derive every time stamp from the system clock?
Type: TimecodeType_t
Specifies the content type (NEAS6)
Type: WatermarkSourceType_t
Checks for the existence of an Emergency Alert System (EAS) alert.
Type: Bool
The metadata file reports the size of the input file, in bytes.
Type: Int32
The watermarking process type.
Type: ActiveWatermarkProcess_t
Sets SID-authentication type.
Determines which of the remaining parameters currently apply.
Type: AuthenticatorParam_t
The Nielsen source ID.
Authenticator will validate.
Type: Int
The Nielsen CBET source ID.
Authenticator will validate.
Type: Int
SID/TIC discovery.
If this setting is true, CWatermarkAPI uses the discovery method of locating an available active SID/TIC server.
Type: Bool
Discovery port.
Identifies the port on which CWatermarkAPI listens for SID/TIC Server hosts to respond to its discovery request.
Note: Default is 6543. Should not be changed unless absolutely necessary.
Type: Int
IP Address of SID/TIC Server
If the discovery-flag is set to false, the watermark application uses this IP address to establish a direct socket connection with the SID/TIC server.
Type: String “xxx.xxx.xxx.xxx”
Path to the metadata file to be written when watermarking is complete.
Type: String
The SID/TIC Server must be informed of the number of seconds in the file so that it can allocate the proper range of TICs.
Type: Int32
Identifies watermark types that are used with TIC (offline) encoding.
| Value | Name | Description |
|---|---|---|
1 |
FINAL_DISTRIBUTOR | Final distrubutor: codes are applied to content that already contains Nielsen watermarks (program-content or final-distributor) |
0 |
PROGRAM_CONTENT | Program content: codes are applied to clean content |
Determines whether the time source used for watermarking content.
| Value | Name | Description |
|---|---|---|
0 |
CheckDigitAuthenticator | Check Digits: Use check-digits to validate SID |
1 |
SidTicAuthenticator | SID/TIC Server: Use SID/TIC server to validate SID |
2 |
AuthenticatorParamsUndefined | Authenticationr parameters undefined |
Determines whether the time-stamp field of the watermark represents a time-in-content serial number (usually generated by a SID/TIC server) or is based on system-clock time.
| Value | Name | Description |
|---|---|---|
0 |
INSERTER_TIC | TIC Server: the time-stamp field is occupied by a TIC, usually generated by the SID/TIC server. |
1 |
INSERTER_CLOCK_ALWAYS | System clock: the time-stamp field in every watermark is derived from the system clock time. |
2 |
INSERTER_SERVICE_BREAKOUT | Service breakout: the time stamp field is used to define a service break-out (for example, VOD BREAK-OUT is represented by a value of 1). |
3 |
INSERTER_CLOCK_STARTING_TIME | Starting time: the time-stamp field is occupied by a number representing a clock-time that can be translated into a date-time string. However, only the first time stamp is read from the system clock. All others are computed as offsets from the first time stamp. |
4 |
INSERTER_USER_CLOCK_TIME | User clock time: the user sets the starting time-stamp. All others are computed as offsets from the first time-stamp. |
Specifies type of watermarking to activate this session.
| Value | Name | Description |
|---|---|---|
3 |
ENABLE_BOTH_PROCESSES | NAES2 + NAES6: Both NAES II and NAES VI activated. |
0 |
DISABLE_WATERMARKING | Disabled: turns off all watermarking-software bypass |
1 |
ENABLE_NAES_II | NAES2: legacy NAES II watermarking |
2 |
ENABLE_NAES_VI | NAES6: NAES VI watermarking (introduced in 2010) |
5 |
ENABLE_NAES_VI_CBET | NAES6 + CBET: Both NAES VI and CBET activated. |
4 |
ENABLE_CBET | CBET: CBET only activated. |
6 |
ENABLE_NAES_II_VI_CBET | NAES2 + NAES6 + CBET: NAES II, NAES VI and CBET all three activated.< |
Specifies the type of content being watermarked. Applies to NAES VI only.
| Value | Name | Description |
|---|---|---|
1 |
WATERMARK_COMMERCIAL | Commericials: used to watermark commercials |
0 |
WATERMARK_TAM | All content types: used to watermark all other types of content. |
2 |
WATERMARK_SERVICE_BREAKOUT | Service breakout: used to flag type as VOD, INTERNET, etc. |
Specifies type of watermarking engine to be used.
| Value | Name | Description |
|---|---|---|
4 |
NIELSEN_WATERMARK_ENGINE | Nielsen |
0 |
NAES2_WATERMARK | NAES2: legacy NAES II watermarking |
3 |
CBET_WATERMARK | CBET |
1 |
NAES2_HF_WATERMARK | NAES2 HF: high-frequency watermarking (for commercials) |
2 |
NAES6_WATERMARK | NAES6: NAES VI watermarking (introduced in 2009) |
5 |
WATERMARK_TYPE_UNDEFINED | Undefined |
Determines the method of handling a second FD code if FD codes are already present in the stream (NAES II HF and NAES VI).
| Value | Name | Description |
|---|---|---|
0 |
WATERMARK_REFRAIN | Refrain: indicates that the second code should not be inserted at all |
1 |
WATERMARK_INSERT | Insert: indicates that the code should be inserted in the manner appropriate for the specified WatermarkProcessType_t |
[kwmc]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Login username for the connection to the Kantar online license server.
Note: For online mode both OnlineLogin and OnlinePassword must be set.
Type: String
Path to the KantarMedia license file for offline mode.
Note: If not set, defaults to working directory.
Type: String
The id of the license.
Note: For online mode only. Defaults to the id of the first license.
Type: Int64
Optional license password for offline mode.
For specific KantarMedia license files, a password is mandatory.
Note: If not set, defaults to null.
Type: String
Password for the connection to the Kantar online license server.
Note: For online mode both OnlineLogin and OnlinePassword must be set.
Type: String
Path to the audience license file for offline mode.
Note: If not set, defaults to working directory.
Type: String
Port of the Kantar online license server.
Note: For online mode both OnlineLogin and OnlinePassword must be set. Defaults to 443.
Type: Integer
The hostname of the Kantar online license server.
Note: For online mode both OnlineLogin and OnlinePassword must be set. Defaults to ‘licenseofe.kantarmedia.com’.
Type: String
Specifies the path to the metadata file.
The metadata file contains the unique content identifier (first line of file), the channel name (second line of file) and other optional metadata (up to 8 additional metadata, one per line of file). Channel name is used to get watermark id in license.aud. The unique identifier and the other metadata are added in embedding report. This property is mutually exclusive with use of UniqueContentId, ChannelName, and Metadata.
Type: String
Specifies the unique content identifier which is added in embedding report.
Must be used in conjunction with Metadata and ChannelName properties. This property is mutually exclusive with MetadataFilePath.
Type: String
The channel name to be used for the embedding process.
This will select the associated watermark value from the audience measurement license. The same channel name will be used for both NTAM and Snap in case of an Hybrid embedding. This property is mutually exclusive with MetadataFilePath.
Type: String
Metadata is optional for the offline embedder; however, it is needed by online embedder.
Property has to be used in conjunction with UniqueContentId and ChannelName. This property is mutually exclusive with method MetadataFilePath. For online watermarking this should be set as a CProperties dictionary.
Type: VariantArray of Strings or CProperties dictionary.
The input filename.
The input filename is written in the report file, but is not needed by the SDK.
Type: String
Specifies the path to the report file.
The report file contains information about watermarking process like the channel name and the watermark id.
Type: String
Enables the recording of all input samples and watermarked samples from inside the SDK as WAVE files.
Note: This shall be used for integration purpose only to be sure that the samples are correctly sent to the SDK.
Type: String
Overrides the input file duration.
Note: This property is specified in timescale units.
Type: Int64
[nawc]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The license key name.
Note: This property is read-only.
Type: String
Path to the Media license file.
Note: If not set, the library searches for license files in the current working directory by default.
Type: String
The number of tokens currently available.
Note: This property is read-only.
Type: Int32
An array of key information.
Each element in the array contains two properties, KeyName and KeyAlgorithm.
Note: This property is read-only.
Specifies the watermark id to embed in the stream.
The watermark value must be greater than 0 and less than or equal to 4194303.
Note: Values outside the range will be trimmed to 22 bits.
Type: UInt64
Index or name of key to use.
A license can contain multiple keys. This property represents the key index or the name of the key to use for watermarking. To retrieve the number of keys and their names refer to the Keys property.
Type: UInt32
NexGuard/NexGuardVideo SDK version string.
Note: This property is read-only.
Type: String
The algorithm used dictated by the license key.
Note: This property is read-only.
Type: Int
Algorithm values
| Value | Name | Description |
|---|---|---|
0 |
NotDefined | No algorithm defined (Legacy). |
3 |
G1 | Screener. |
18 |
G2 | Master+. |
50 |
NGPRAudio | Audio Pre Release. |