Titania X3D Editor

It starts with you!

Titania v3.0.4

It starts with you!

X3D Reference

AudioClip

AudioClip

AudioClip provides audio data used by parent Sound nodes.

The AudioClip node belongs to the Sound component and its container field is source. It is available since X3D version 3.0 or later.

Hierarchy

* Derived from multiple interfaces.

Fields

SFNode [in, out] metadata NULL [X3DMetadataObject]

Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.

SFBool [in, out] enabled TRUE

Input/Output field enabled.

SFString [in, out] description ""

Author-provided text tooltip that tells users the expected action of this node.

Hint

Many XML tools substitute XML character references automatically if needed (such as & for & ampersand, or " for " quotation mark).

MFString [in, out] url [ ] [URI]

Location and filename of sound file or stream. Support for .wav format is required, .midi format is recommended, other formats are optional.

Hints

MFString arrays can have multiple values, so separate each individual string by quote marks. "http://www.web3d.org" "http://www.web3d.org/about" "etc." XML encoding for quotation mark " is " (which is called a character entity). Can replace embedded blank(s) in url queries with %20 for each blank character.

Warning

Strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https and other operating systems are not.

See Also

X3D Scene Authoring Hints, urls

SFFloat [in, out] speed 1

Input/Output field speed.

SFFloat [in, out] pitch 1 (0,∞)

Multiplier for the rate at which sampled sound is played. Changing pitch also changes playback speed.

SFBool [in, out] loop FALSE

Repeat indefinitely when loop=true, repeat only once when loop=false.

SFTime [in, out] startTime (-∞,∞)

Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

Hint

Usually receives a ROUTEd time value.

SFTime [in, out] resumeTime (-∞,∞)

When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

Hint

Usually receives a ROUTEd time value.

SFTime [in, out] pauseTime (-∞,∞)

When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

Hint

Usually receives a ROUTEd time value.

SFTime [in, out] stopTime (-∞,∞)

Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

Hint

Usually receives a ROUTEd time value.

Warnings

An active TimeSensor node ignores set_cycleInterval and set_startTime events. An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.

SFBool [out] isPaused

IsPaused true/false events are sent when AudioClip is paused/resumed.

SFBool [out] isActive

IsActive true/false events are sent when playback starts/stops.

SFTime [out] cycleTime

Output field cycleTime.

SFTime [out] elapsedTime

Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.

SFTime [out] duration_changed

Duration_changed is length of time in seconds for one cycle of audio.

Description

Hints

  • Add a parent Sound node first.
  • Utilize DEF/USE references for multiple copies of a single AudioClip sound file in order to avoid multiple-download delays, reduce memory requirements, and maintain synchronization.
  • Authors can provide multiple audio formats for the same audio track, with each source address listed separately in the url field.
  • Player support for .wav format is required, .midi format is recommended, other formats are optional.

Browser Compatibility

Titania X_ITE
yes yes