Platform SDK: Broadcast Architecture

BPCVid

The BPCVid class defines the ActiveX control that provides streaming video functionality in Broadcast Architecture. BPCVid is designed to be forward-compatible with the DirectShow version 1.0 ActiveX control.

Note  However, the current version of Broadcast Architecture is not compatible with the DirectShow 1.0 ActiveX control.

The BPCVid class has the following properties:

Property Description
Balance Value that describes the current audio balance between left and right speakers.
ClosedCaption Value that indicates whether closed captioning is turned on.
ColorKey    Color to use for color keying.
Debug Value that indicates whether debugging information is displayed.
DeviceCount Number of devices currently available. This property is read-only.
Devices Collection of the devices currently available on the user's computer. This property is read-only.
DisplayMode Value that indicates whether the current position in the video is measured in number of frames displayed or time elapsed.
Font Font used in the Video control's title window.
HWnd Handle to the window hosting the Video control. This property is read-only.
ImageSourceHeight    Original, authored height of the source image. This value does not change if the user resizes the control. This property is read-only.
ImageSourceWidth Original, authored width of the source image. This value does not change if the user resizes the control. This property is read-only.
Input Device supplying input to the Video control.
LocaleID Locale identifier. This property supports the country codes of Microsoft® Windows® operating systems and determines which control character set to display, which date and currency formats to use, and so on.
MovieWindowSetting    Value that sizes the window displaying the images associated with a multimedia stream.
Output Device to which the Video control sends output.
Power Value that indicates or controls whether a device is currently turned on.
PrerollTime Value that indicates the amount of time to allow a tape to roll before starting to record.
Priority Priority of this application. This value is used to resolve device conflicts.
VideoOn Value that indicates whether video is being displayed by the control.
Volume Current audio volume level.

The following properties of BPCVid are implemented in Extender class. For more information about Extender, see Visual Basic Extender Object.

Property Description
Container Read-only object that represents the container of a control, in this case of the Video control. The Container property returns or sets the container of the control on a Visual Basic form.
DragIcon Icon to use when the control is dragged.
DragMode Integer that specifies if the control can be dragged automatically, or if the application using the control must call the control's Drag method.
Enabled Boolean value that specifies whether the control is enabled.
Height Integer that specifies the height of the control in the container's scale units.
HelpContextID Integer that specifies the Help context identifier to use when the F1 key is pressed and the control has the focus.
Index Integer that specifies the position in a control array that one instance of the control occupies.
Left Integer that specifies the position of the left edge of the control relative to the left edge of the container, specified in the container's scale units.
Name String that contains the developer-defined name of the control.
Parent Read-only object that represents the container of the control. The Parent property returns the form, object, or collection that contains the control. Use Parent to access the properties, methods, or events of the control's parent.
TabIndex Integer that specifies the position of the control in the tab order of controls in the container.
TabStop Boolean value that specifies if the cursor stops on the control when tabbing between controls.
Tag String that contains an expression that stores any extra data needed for your application.
ToolTipText String that contains the text to be displayed when the cursor hovers above the control for more than a second.
Top Integer that specifies the position of the upper edge of the control relative to the upper edge of the container, specified in the container's scale units.
Visible Boolean value that specifies whether the control is visible.
WhatThisHelpID Context identifier to use when the What's This pop-up menu is used to provide information on the control.
Width Width of the control in the container's scale units.

The following methods are implemented in the BPCVid class.

Method Description
AboutBox    Displays version and copyright information about the Video control.
AutoScan Retrieves the signal strength of the channel.
Close Sets all inputs and outputs for the control to NULL.
MinMaxChannel Returns the lowest and highest channel numbers supported by the specified tuning space.
Refresh    Forces an update to the control's current window size, position, and visibility.
ReInit Requests that the Video Access server reinitialize the filter graph.
TSDeviceCount    Returns the number of devices available for a specified tuning space.
Tune Sets the current input device to the input device for the specified tuning space, and tunes that device to the specified channel.

The following methods are implemented in the BPCVid class as wrappers for the equivalent methods in the Visual Basic Extender object.

Method Description
Drag Begins, ends, or cancels an operation in which the control is dragged.
Move Moves the position of the control.
SetFocus Set the focus to the control.
ShowWhatsThis    Displays a selected Help topic using the What's This pop-up menu.
ZOrder Places the control at the front or back of the z-order within the control's graphical level.

The following events comprise the DBPCVidEvents dispatch interface and are sent by the Video control to the application or container hosting the Video control.

Event Description
Click A user clicked in the control.
DblClick A user double-clicked in the control.
Error An error has occurred in the control or in the input or output device for the control.
GotControl The control receiving this notification has requested a device and now has the highest priority for that device.
KeyDown The user pressed any key.
KeyPress The user pressed an ANSI key.
KeyUp The user released any pressed key.
LostControl An application with higher priority than the current application requested the control's input or output device. The instance of the Video control receiving this event must release the device in response to a LostControl event.
MouseDown The user clicked a mouse button over the Video control.
MouseMove The user moved the mouse over the Video control.
MouseUp The user has released a mouse button over the Video control.
Power The Video Access server received a Windows power-management event.
StateChange A device's state changed.

Note that BPCVid contains several reserved properties, methods, and events. For more information on these, see Reserved Properties, Methods, and Events in BPCVid.

Requirements

  Windows NT/2000: Unsupported.
  Windows 95/98: Requires Windows 98.
  Header: Declared in vidsvr.odl.
  Import Library: Included as a resource in vid.ocx.