You're currently browsing the Ignition 7.8 docs. Click here to view the latest docs.

General

Component Palette Icon:


 

Description

The Sound Player component is an invisible component that facilitates audio playback in the client. Each Sound Player component has one sound clip associated with it, and will play that clip on demand. There is a built in triggering system, as well as facilities to loop the sound while the trigger is set. Note that the sound clip needs to be a *.wav file, and that the clip becomes embedded within the window that the sound player is on - clients do not need access to a shared *.wav file.

Properties

Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have scripting functions associated with it.

Event Handlers

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

This event fires when the mouse enters the space over the source component.

This event fires when the mouse leaves the space over the source component.

This event fires when a mouse button is pressed down on the source component.

This event fires when a mouse button is released, if that mouse button's press happened over this component.

Fires when the mouse moves over a component after a button has been pushed.

Fires when the mouse moves over a component, but no buttons are pushed.

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

Customizers

This component does not have any custom properties.

Examples

There are no examples associated with this component.

  • No labels