pymel.core.windows.soundControl¶

soundControl(*args, **kwargs)¶

This command creates a control used for changing current time and scratching/scrubbing through sound files.

Flags:

Long Name / Short Name		Argument Types	Properties
annotation / ann		unicode
	Annotate the control with an extra string value.
backgroundColor / bgc		float, float, float
	The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
beginScrub / bs		bool
	Set this widget up for sound scrubbing. Subsequent changes to current time will result in sound scrubbingbehavior, until the -endScrubcommand is issued for this widget.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and arguments are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
displaySound / ds		bool
	Turn sound display off. Query returns int.
docTag / dtg		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
dragCallback / dgc		script
	Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y, modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’
dropCallback / dpc		script
	Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages, x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’
enable / en		bool
	The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground / ebg		bool
	Enables the background color of the control.
endScrub / es		bool
	End sound scubbing for this widget. This stops sound scrubbing behavior and should be issued before any subsequent -beginScrubflags
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
fullPathName / fpn		bool
	Return the full path name of the widget, which includes all the parents.
height / h		int
	The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor / hlc		float, float, float
	The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
isObscured / io		bool
	Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.
manage / m		bool
	Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
maxTime / max		time
	Controls the max time of the range displayed in the control. Query returns float.
minTime / min		time
	Controls the min time of the range displayed in the control. Query returns float.
noBackground / nbg		bool
	Clear/reset the control’s background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
parent / p		unicode
	The parent layout for this control.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
pressCommand / pc		unicode
	script to run on mouse-down in this control.
preventOverride / po		bool
	If true, this flag prevents overriding the control’s attribute via the control’s right mouse button menu.
releaseCommand / rc		unicode
	script to run on mouse-up in this control.
repeatChunkSize / rcs		float
	How much sound (in the current time unit) is repeated when -repeatOnHold is true. Default is 1.0.
repeatOnHold / roh		bool
	Repeat sound during mouse-down events
resample / r		bool
	Resample the sound display to fit the widget
sound / s		unicode
	Name of audio depend node whose data should display in the sound-display widget. Query returns string.
statusBarMessage / sbm		unicode
	Extra string to display in the status bar when the mouse is over the control.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
visible / vis		bool
	The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand / vcc		script
	Command that gets executed when visible state of the control changes.
waveform / wf		unicode
	Determines what part of the sound waveform to display, when -displaySound is true. Valid values are top, bottom, and both. Default is top. Query returns string.
width / w		int
	The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.soundControl

Example:

import pymel.core as pm

# To display sound in a soundControl, there must first be a sound
# node in the scene. We'll create one and give it the name "ohNo".
# Note that the argument to the -file flag must be a path to a valid
# soundfile.
#
pm.sound( file='ohNo.aiff', name='ohNo' )

# Create a sound control (named "soundScrubber")
# and have it display the sound associated with audio node "ohNo".
#
pm.window()
pm.frameLayout( lv=False )
pm.soundControl( 'soundScrubber', width=600, height=45, sound='ohNo', displaySound=True, waveform='both' )
pm.showWindow()

# Now setup "soundScrubber" to actually scrub with
# mouse drags.
#
pressCmd = "soundControl -e -beginScrub soundScrubber"
releaseCmd = "soundControl -e -endScrub soundScrubber"
pm.soundControl( 'soundScrubber', e=True, pc=pm.soundControl('soundScrubber',e=True,beginScrub=True, rc=pm.sound('soundScrubber',e=True,endScrub=True)))