Cue Collection API¶

The cue collection API is common to all objects implementing the Cue Collection interface. This includes Dataset and Sequencer.

class CueCollection(options)¶

Arguments:	options.order (object) – order, see Cue Ordering

Constructor abstrac base class for cue collection.

CueCollection.size¶: see JS Map Documentation

CueCollection.has(key)¶: see JS Map Documentation

CueCollection.get(key)¶: see JS Map Documentation

CueCollection.keys()¶

see JS Map Documentation

No particular ordering is guaranteed.

CueCollection.values()¶

see JS Map Documentation

No particular ordering is guaranteed.

CueCollection.entries()¶

see JS Map Documentation

No particular ordering is guaranteed.

CueCollection.cues(options)¶

The cues method is similar to CueCollection.values(), but conveniently adds support for sorting the resulting cues. See Cue Ordering. Order supplied in this function take precedent over order supplied in constructor.

Arguments:	options.order (object) – ordering of cues string “low” : ascending order by lower cue interval endpoint string “high”: ascending order by higher cue interval endpoint function cmp: custom order by supplying ordering function, similar to Array.sort(cmp).
Returns Array:	array of cues

CueCollection.on(name, callback[, options])¶: see EventProviderInterface.on()

CueCollection.off(name, subscription)¶: see EventProviderInterface.off()