Operates a preview.
Methods
PreviewAudioVolumeGet
Gets an audio volume for the preview
Syntax
void PreviewAudioVolumeGet( string _bsChannelID, int _nChannel, out double _pdblAttenuationdB )
Parameters
_bsChannelID -
_nChannel - index of a channel. Use "-1" to get a volume for all channels.
_pdblAttenuationdB - volume in dB for the selected channel.
PreviewAudioVolumeSet
Sets preview's audio volume for specified audio channels.
Syntax
void PreviewAudioVolumeSet( string _bsChannelID, int _nChannel, double _dblAttenuationdB )
Parameters
_bsChannelID - channel ID. By default use empty string
_nChannel - number of the audio channels. To set the volume for all channels use "-1"
_dblAttenuationdB - volume in dB
PreviewEnable
Enables a preview (audio and video)
Syntax
void PreviewEnable( string _bsChannelID, int _bEnableAudio, int _bEnableVideo )
Parameters
_bsChannelID - channel ID. By default use empty string
_bEnableAudio - 0 is to disable audio preview, 1 is to enable audio preview
_bEnableVideo - 0 is to disable video preview, 1 is to enable video preview
PreviewFullScreen
Enables (disables) a full-screen mode for preview
Syntax
void PreviewFullScreen( string _bsChannelID, int _bFullScreen, int _nDisplay )
Parameters
_bsChannelID - channel ID. By default use empty string
_bFullScreen - 0 is to disable full screen, 1 is to enable full-screen mode
_nDisplay - index of a display where the full-screen will be implemented
PreviewIsEnabled
Gets information about whether preview is enabled
Syntax
void PreviewIsEnabled( string _bsChannelID, out int _pbEnabledAudio, out int _pbEnabledVideo )
Parameters
_bsChannelID - channel ID. By default use empty string
_pbEnabledAudio - indicates whether the audio preview is enabled
_pbEnabledVideo - indicates whether video preview is enabled
PreviewIsFullScreen
Indicates whether a preview in full-screen mode and what display is used
Syntax
void PreviewIsFullScreen( string _bsChannelID, ref int _pbFullScreen, ref int _pnDisplay )
Parameters
_bsChannelID - channel ID. By default use empty string
_pbFullScreen - 0 means that full screen is disabled, 1 means that it is enabled
_pnDisplay - number of display
PreviewSetCursor
Sets a cursor for a preview
Syntax
void PreviewSetCursor( string _bsChannelID, eMCursorType _eCursor )
Parameters
_bsChannelID - channel ID. By default use empty string
_eCursor - cursor type
PreviewWindowSet
Sets a parent element for a preview.
Syntax
void PreviewWindowSet( string _bsChannelID, long _hWndParent )
Parameters
_bsChannelID - channel ID. By default use empty string
_hWndParent - handle of a control where preview will be displayed
PreviewWindowSetVB6
Sets a parent element for a preview. This method is for VB6 only. For other languages please use the PreviewWindowSet method.
Syntax
void PreviewWindowSetVB6( string _bsChannelID, int _hWndParent )
Parameters
_bsChannelID - channel ID. By default use empty string
_hWndParent - handle of a control where preview will be displayed