DCX Directshow - Dialog Control Xtension DLL v3.1 by ClickHeRe, twig* & Ook

Home | Download | Forum | Bug Tracker

v3.1

Directshow

The DirectShow control allows playback of media files. Formats which can be played will depend upon the codecs avaiable on the system.

Control Styles

These control styles are available when creating a Directshow control. Remember that the general styles disabled, group, hidden, notheme, tabstop and transparent apply to all DCX controls except the embedded Dialog and Window controls.

fixratio	The content maintains its aspect ratio. By default, the content fills the control.
hgradient	Draws a horizontal gradient with the colors specified.
vgradient	Draws a vertical gradient with the colors specified.

/xdid flags

Control commands are input to the control with the /xdid command.

/xdid -a
This command lets you load and unload any previous file.
Syntax:	/xdid -a [DNAME] [ID] [+FLAGS] [FILENAME]
Example:	/xdid -a dcx 4 + fileCopy.mpeg
Parameters:
+FLAGS	Previous flags.
p	Play right away.
l	Loop playback.
a	Specifies audio only, no VMR is loaded, no video rendered.
FILENAME	Previous filename.

/xdid -c
This lets you control playback of the file.
Syntax:	/xdid -c [DNAME] [ID] [COMMAND] [ARGS]
Example:	/xdid -c dcx 4 play /xdid -c dcx 4 seek 3500
Parameters:
COMMAND	DirectShow commands.
play	Plays the loaded file.
pause	Pauses the playback.
stop	Stops the playback.
close	Close the playback and unload it.
seek	Seeks to the millisecond of the clip specified.
Variable parameters ARGS:
play	[FILENAME]
seek	[TIME]
TIME	The time to seek to, specified in milliseconds.

/xdid -v
This command sets the brightness, contrast, hue, & saturation
Syntax:	/xdid -v [DNAME] [ID] [+FLAGS] [BRIGHTNESS] [CONTRAST] [HUE] [SATURATION] [ALPHA]
Example:	/xdid -v dcx 4 +ab 80.00 0 0 0 0.5
Parameters:
+FLAGS	Command switches.
a	Sets the alpha blend with the background, accepts values between 1.0 & 0 (fractions are valid values).
b	Sets the brightness level as a percentage between 0.00 & 100.00 (fractions are valid values).
c	Sets the contrast level as a percentage between 0.00 & 100.00 (fractions are valid values).
h	Sets the hue level as a percentage between 0.00 & 100.00 (fractions are valid values).
s	Sets the saturation level as a percentage between 0.00 & 100.00 (fractions are valid values).

/xdid -V
This command sets the volume or speakerbalance
Syntax:	/xdid -V [DNAME] [ID] [+FLAG] [VALUE]
Example:	/xdid -V dcx 4 +v 80.00
Parameters:
+FLAG	Command switches.
v	Sets the volume level as a percentage between 0.00 & 100.00 (fractions are valid values).
b	Sets speaker balance between -10000 & 10000

$xdid() Properties

The $xdid identifier is a given mIRC alias that communicates with the DCX DLL to extract information in DCX controls.

$xdid().author
This property returns the author of the media. Not all media types support this.
Syntax:	$xdid(dialog, ID).author
Example:	$xdid(dcx, 4).author
Return	authors name Name of the author. D_ERROR Message Error in determining state of control.

$xdid().balance
This property returns audio balance as a value between -10000 and 10000.
Syntax:	$xdid(dialog, ID).balance
Example:	$xdid(dcx, 4).balance

$xdid().brange
This property returns the range of values that the video brightness can be set to.
Syntax:	$xdid(dialog, ID).brange
Example:	$xdid(dcx, 4).brange
Parameters:
DEFAULT	The default value.
MIN	The minimum value.
MAX	The maximum value.
STEP	The value to use when changing this property.

$xdid().crange
This property returns the range of values that the video contrast can be set to.
Syntax:	$xdid(dialog, ID).crange
Example:	$xdid(dcx, 4).crange
Parameters:
DEFAULT	The default value.
MIN	The minimum value.
MAX	The maximum value.
STEP	The value to use when changing this property.

$xdid().currentpos
This property returns the current position of the content.
Syntax:	$xdid(dialog, ID).currentpos
Example:	$xdid(dcx, 4).currentpos
Parameters:
STATE	This is D_OK if the command succeeded. Otherwise STATE is D_ERROR.
RESULT	The time in milliseconds. If STATE was not D_OK, then RESULT will be the appropriate error message. (ie. Method Not Supported)

$xdid().duration
This property returns the length of the media clip.
Syntax:	$xdid(dialog, ID).duration
Example:	$xdid(dcx, 4).duration
Parameters:
STATE	This is D_OK if the command succeeded. Otherwise STATE is D_ERROR.
RESULT	The time in milliseconds. If STATE was not D_OK, then RESULT will be the appropriate error message. (ie. Method Not Supported)

$xdid().fname
This property returns the filename of the loaded media (if any).
Syntax:	$xdid(dialog, ID).fname
Example:	$xdid(dcx, 4).fname

$xdid().hrange
This property returns the range of values that the video hue can be set to.
Syntax:	$xdid(dialog, ID).hrange
Example:	$xdid(dcx, 4).hrange
Parameters:
DEFAULT	The default value.
MIN	The minimum value.
MAX	The maximum value.
STEP	The value to use when changing this property.

$xdid().isloaded
This property returns if a file is loaded or not.
Syntax:	$xdid(dialog, ID).isloaded
Example:	$xdid(dcx, 4).isloaded

$xdid().size
This property returns the media size.
Syntax:	$xdid(dialog, ID).size
Example:	$xdid(dcx, 4).size
Parameters:
WIDTH	Original width of the content.
HEIGHT	Original height of the content.
ARWIDTH	Aspect ratio width of the content.
ARHEIGHT	Aspect ratio height of the content.

Note. This returns the media size, not the control size.

$xdid().srange
This property returns the range of values that the video saturation can be set to.
Syntax:	$xdid(dialog, ID).srange
Example:	$xdid(dcx, 4).srange
Parameters:
DEFAULT	The default value.
MIN	The minimum value.
MAX	The maximum value.
STEP	The value to use when changing this property.

$xdid().state
This property returns the state of the media file, if any.
Syntax:	$xdid(dialog, ID).state
Example:	$xdid(dcx, 4).state
Return	nofile No file has been specified. stopped Stopped state. paused Paused state. playing Currently playing state. unknown Unknown media state. D_ERROR Message Error in determining state of control.

$xdid().title
This property returns the title of the media. Not all media types support this.
Syntax:	$xdid(dialog, ID).title
Example:	$xdid(dcx, 4).title
Return	title Title of the media. D_ERROR Message Error in determining state of control.

$xdid().video
This property returns properties on the video media which can be altered.
Syntax:	$xdid(dialog, ID).video
Example:	$xdid(dcx, 4).video
Parameters:
+FLAGS	Flags can be any combination of the following.
b	The brightness of the video.
c	The contrast of the video.
h	The hue of the video.
s	The saturation of the video.

$xdid().volume
This property returns volume percentage as a value between 0.00 and 100.00.
Syntax:	$xdid(dialog, ID).volume
Example:	$xdid(dcx, 4).volume

Directshow Events

These events are fired when activity occurs in the Directshow control.

dshow
When the media has triggered an event, usually finished playing.
Syntax:	/cb_alias DNAME dshow ID EVENT
Example:	/cb_alias dcx dshow 4 completed
Parameters:
EVENT	Media event that triggered.

help
Launched when you click on a control using the ? contexthelp button.
Syntax:	/cb_alias DNAME help ID
Example:	/cb_alias dcx help 4

loaderror
When the media has failed to load, Usually unsupported codec.
Syntax:	/cb_alias DNAME loaderror ID FILENAME
Example:	/cb_alias dcx loaderror 4 file.avi
Parameters:
FILENAME	Filename that failed to load.

Note. Dont call any DCX commands within the callback, use a timer instead.