Platforms to show: All Mac Windows Linux Cross-Platform
Back to WIAVideoMBS class.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Requires Windows XP or Windows Server 2003.
WIAVideoMBS.CreateVideoByDevNum(DeviceNumber as integer, win as DesktopWindow, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 22.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
DeviceNumber: Specifies the video device's Directshow device number.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to TRUE to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
See also:
WIAVideoMBS.CreateVideoByDevNum(DeviceNumber as Integer, win as window, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
DeviceNumber: Specifies the video device's Directshow device number.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to TRUE to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
See also:
WIAVideoMBS.CreateVideoByDevNum(DeviceNumber as Integer, WindowHandle as Integer, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
DeviceNumber: Specifies the video device's Directshow device number.
WindowHandle: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to TRUE to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
See also:
WIAVideoMBS.CreateVideoByName(FriendlyName as string, win as DesktopWindow, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 22.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
FriendlyName: Specifies the video device's friendly name obtained from a Directshow device enumeration.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to TRUE to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
See also:
WIAVideoMBS.CreateVideoByName(FriendlyName as string, win as window, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
FriendlyName: Specifies the video device's friendly name obtained from a Directshow device enumeration.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to TRUE to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
See also:
WIAVideoMBS.CreateVideoByName(FriendlyName as string, WindowHandle as Integer, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
FriendlyName: Specifies the video device's friendly name obtained from a Directshow device enumeration.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to TRUE to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
See also:
WIAVideoMBS.CreateVideoByWiaDevID(WiaDeviceID as string, win as DesktopWindow, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 22.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
WiaDeviceID: Specifies the value of the video device's DeviceID property.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to true to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
In order for the function to succeed, the ImagesDirectory property must be specified first.
See also:
WIAVideoMBS.CreateVideoByWiaDevID(WiaDeviceID as string, win as window, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
WiaDeviceID: Specifies the value of the video device's DeviceID property.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to true to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
In order for the function to succeed, the ImagesDirectory property must be specified first.
See also:
WIAVideoMBS.CreateVideoByWiaDevID(WiaDeviceID as string, WindowHandle as Integer, StretchToFitParent as boolean, AutoBeginPlayback as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
WiaDeviceID: Specifies the value of the video device's DeviceID property.
win: Specifies the window in which to display the streaming video.
StretchToFitParent: Specifies whether the video display is stretched to fit the parent window. Set this parameter to true if the display should be stretched to fit the parent window; otherwise, set to false.
AutoBeginPlayback: Specifies whether the streaming video begins playback as soon as this method returns. Set this parameter to true to cause immediate playback; set it to false to require a call to Play before video playback begins.
Lasterror is set.
By default, the video is displayed in the video device's default resolution. If bStretchToFitParent is set to TRUE, the video display fills the window.
In order for the function to succeed, the ImagesDirectory property must be specified first.
See also:
WIAVideoMBS.CurrentState as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
See the kState* constants.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
To restart video playback, the application must call one of the CreateVideo methods again.
Lasterror is set.
Call this method only after a successful call to CreateVideoByWiaDevID, CreateVideoByDevNum, or CreateVideoByName.
WIAVideoMBS.ImagesDirectory as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Lasterror is set.
(Read and Write computed property)
WIAVideoMBS.ImagesFolder as folderitem
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Lasterror is set.
(Read and Write computed property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Call this method only after a successful call to CreateVideoByWiaDevID, CreateVideoByDevNum, or CreateVideoByName.
Lasterror is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Call this method only after a successful call to CreateVideoByWiaDevID, CreateVideoByDevNum, or CreateVideoByName.
Lasterror is set.
WIAVideoMBS.PreviewVisible as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This does not affect the state of the video.
Lasterror is set.
(Read and Write computed property)
WIAVideoMBS.ResizeVideo(StretchToFitParent as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Call this method whenever the parent window is moved or resized.
By default, the video is displayed in a supported resolution smaller than the parent window. If bStretchToFitParent is set to true, the video display fills the window.
Lasterror is set.
WIAVideoMBS.TakePicture as folderitem
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Returns the full path and filename of the JPEG file that this method creates.
Lasterror is set.
The path and directory where the image file is saved are specified by the ImagesDirectory or ImageFolder property.
See also:
WIAVideoMBS.TakePicture as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS Win Plugin | 10.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Returns the full path and filename of the JPEG file that this method creates.
Lasterror is set.
The path and directory where the image file is saved are specified by the ImagesDirectory or ImageFolder property.
See also:
The items on this page are in the following plugins: MBS Win Plugin.