<m-audio>

The m-audio element is used to play audio in a 3D scene.

Try it

Attributes

  • src: string

    The source URI of the audio file. Supported formats may vary depending on the rendering engine used.

  • loop: boolean

    Whether the audio should loop (true) or play once (false). Default value is true.

  • loop-duration: float

    The duration in seconds of the audio loop if loop is true. Can be shorter or longer than the audio file duration. Durations longer than the audio file will add silence. If not specified, the entire audio file will loop.

  • enabled: boolean

    Whether the audio is enabled (true) or disabled (false). Default value is true.

  • volume: float

    The volume of the audio, ranging from 0 (silent) to 1 (maximum volume). Default value is 1.

  • cone-angle: float

    The angle in degrees within which sound is at full volume. Default value is 360 (the sound is not directional).

  • cone-falloff-angle: float

    The angle in degrees beyond which sound is inaudible. Must be greater than cone-angle to have an effect. Default value is 0 (there is no gradual drop-off).

  • start-time: int

    The time in milliseconds since the start of the document lifecycle when the audio should start playing. Default value is 0.

  • pause-time: int

    The time in milliseconds since the start of the document lifecycle when the audio should pause. If there is no value the audio will not be paused.

Attribute Groups

  • Attribute Group: debuggable

    • debug: boolean

      A boolean that indicates whether the element should be drawn with debug information (e.g. axes helper). Default value is false.

  • Attribute Group: transformable

    • x: float

      The position of the element along the X-axis in meters. Default value is 0.

    • y: float

      The position of the element along the Y-axis in meters. Default value is 0.

    • z: float

      The position of the element along the Z-axis in meters. Default value is 0.

    • rx: float

      The rotation of the element around the X-axis in degrees. Default value is 0.

    • ry: float

      The rotation of the element around the Y-axis in degrees. Default value is 0.

    • rz: float

      The rotation of the element around the Z-axis in degrees. Default value is 0.

    • sx: float

      The scale of the element along the X-axis. Default value is 1.

    • sy: float

      The scale of the element along the Y-axis. Default value is 1.

    • sz: float

      The scale of the element along the Z-axis. Default value is 1.

    • visible: boolean

      Whether the element is visible (true) or hidden (false) in the scene. Default value is true.

    • socket: string

      The name of a bone in the parent element's skeletal mesh to which this element will be attached. If not specified, the element will attach to the origin of its parent.

  • Attribute Group: coreattrs

    • id: ID

      A unique identifier for the element, used for selection and manipulation through scripting. It must be unique within the document.

    • class: string

      A space-separated list of class names that can be used for scripting purposes.

Compatibility Table

WEBUNREAL
m-audio✓✓
src✓✓
loop✓✓
loop-duration✓✗
enabled✓✓
volume✓✓
cone-angle✓✗
cone-falloff-angle✓✗
start-time✓✓
pause-time✓✓
debug✓✓
x✓✓
y✓✓
z✓✓
rx✓✓
ry✓✓
rz✓✓
sx✓✓
sy✓✓
sz✓✓
visible✓✓
socket✓✗
id✓✓
class✓✓