Audio feature

Audio

An audio feature is a little player for mp3s. You can link to any mp3 and we'll try and stream it.

Editor

Sprite

Display a smaller audio element

Streaming

Streams the audio directly, without trying to proxy it through our servers. Should make audio play faster, but if you have weird referrer rules on hosting server this might not work.

Autoplay

As soon as someone enters your parcel, start playing this audio. (With great power comes great responsibility).

Loop

Loop the audio forever.

Spatial rolloff factor

How quickly the sound fades away as the player moves away from the audio player. Value between 0 and 5.

Volume

How loud should the audio play Value between 0 and 1.

URL

Links must be https:// since we force https:// for everything.

Scripting Properties

Scripting Properties {.tabset}

url

String.; Links must be https:// and must finish with an audio extension such as .mp3

get()

feature.get('url')
// returns: "https://..."

set()

feature.set({'url':"https://www.myurl.com/file.mp3"})

default

""

sprite

Boolean.

get()

feature.get('sprite')
// returns: false

set()

feature.set({'sprite': true})

default

false

streaming

Boolean.

get()

feature.get('streaming')
// returns: false

set()

feature.set({'streaming': true})

default

false

autoplay

Boolean.

get()

feature.get('autoplay')
// returns: false

set()

feature.set({'autoplay': true})

default

false

loop

Boolean.

get()

feature.get('loop')
// returns: false

set()

feature.set({'loop': true})

default

false

rolloffFactor

double; Value ranging from 0 to 5

get()

feature.get('rolloffFactor')
// returns: 1.6

set()

feature.set({'rolloffFactor': 1.6})

default

1.6

volume

double; Value ranging from 0 to 1

get()

feature.get('volume')
// returns: 0.5

set()

feature.set({'volume': 0.5})

default

0.5

type

String;

get()

feature.get('type')
/* or */
feature.type

// returns: 'audio'

Scripting Methods

Scripting Methods {.tabset}

play()

feature.play()

plays the audio

pause()

feature.pause()

pauses the audio

stop()

feature.stop()

stops the audio