BPCVid.ColorKey

[This is preliminary documentation and subject to change.]

The ColorKey property specifies the color to use for color keying. This property is not fully implemented. Currently, the ColorKey value is always set to magenta (0x00FF00FF).

Syntax

object.ColorKey [ = lColorVal ]
 

Parts

object
Object expression that resolves to a BPCVid object.
lColorVal
A Long or constant that determines the color to use for color keying. The following table lists and describes the possible values for the lColorVal parameter.
Value Meaning
Normal RGB colors Colors specified by using the Color palette or programmatically by using the RGB or QBColor functions. For more information, see Further Information on Streaming Video Services for the Client.
System default colors Colors specified by system color constants listed in the object library in the Visual Basic Object Browser. As needed, Windows substitutes the user's color choices for default colors as specified in the Control Panel settings.

Remarks

The valid range for a normal RGB color is 0 to 16,777,215 (&HFFFFFF). The high byte of a number in this range equals zero; the lower three bytes, from least to most significant byte, determine the amount of red, green, and blue, respectively. The red, green, and blue components are each represented by a number between 0 and 255 (&HFF). If the high byte isn't zero, Visual Basic uses the system colors, as defined in the user's Control Panel settings and by constants listed in the object library in the Object Browser.

This property is not stored locally in the BPCVid object; instead, it is passed to the restricted property in the corresponding BPCDevices object. You set this property, however, using BPCVid. This ensures that the Video control is properly updated.