User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata


Component Palette Icon:


The UI for this component is hidden by default and is browser dependent. There is a "hidden" property (props.display) which can be used to display UI for this component. In the event a user is displaying the UI (props.display = true), the component will be displayed differently based on the browser in use.

On this page ...

The following feature is new in Ignition version 8.1.16
Click here to check out the other new features
An Audio component, hidden by default, that designers can use to play and pause sound clips in the browser. 

Supported Audio Files

Supported audio file types are browser dependent.

File TypeBrowser Compatibility
3GPFirefox for Android
ADTS

Firefox

Available only if available on the underlying operating system's media framework.

FLACChrome 56, Edge 16, Firefox 51, Safari 11
MPEG-4 (MP4)Chrome 3, Edge 12, Firefox, Internet Explorer 9, Opera 24, Safari 3.1
Ogg

Chrome 3, Firefox 3.5, Edge 17 (desktop only), Internet Explorer 9, Opera 10.50

Edge requires Web Media Extensions to be installed.

QuickTime (MOV)Only older versions of Safari, plus other browsers that supported Apple's QuickTime plugin
WebM

Chrome 6, Edge 17 (desktop only), Firefox 4, Opera 10.6, Safari 14.1 (macOS), Safari 15 (iOS).

Edge requires Web Media Extensions to be installed.

Properties

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective.
This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.


NameDescriptionProperty Type
source

The source URL of the media file.



value: string
playThe play state of the media file. Toggling this property will start or pause the media file.value: boolean
loop

Determines if the media file should loop after reaching the end.

value: boolean
volumeThe percentage of maximum volume (from 0 to 100).value: numeric
playbackRateA double that represents the playback rate of the media file.value: numeric
allowDownloadDetermines whether the audio player allows downloading of the media file.value: boolean
styleSets a style that applies to the component. Full menu of style options is available. You can also specify a style classobject




Component Methods


  • Description

Plays the media file, triggering the onPlay component event.

  • Parameters

None

  •  Return

Nothing

  • Description

Pauses the media file, triggering the onPause component event.

  • Parameters

None

  •  Return

Nothing

  • Description

Replays the media file from the beginning.

  • Parameters

None

  •  Return

Nothing


Component Events

Perspective Component Events
The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.

This event is fired when playback has begun.

  • Object Path

event

  • Type

Null

  • Description

An empty event object.

This event is fired when playback has been paused.

  • Object Path

event

  • Type

Null

  • Description

An empty event object.

This event is fired when there is an error attempting to play the media file.


This component event is designed to be used in tandem with a script action. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

  • Object Path

event.errorMessage

  • Type

String

  • Description

Error message when attempting to play the media file.

This event is fired when playback has ended due to reaching the end of the media.

  • Object Path

event

  • Type

Null

  • Description

An empty event object.

This event is fired when the first frame of the media has loaded.

  • Object Path

event

  • Type

Null

  • Description

An empty event object.

This event is fired when the playback rate of the media has changed.

  • Object Path

event

  • Type

Null

  • Description

An empty event object.





  • No labels