urMus - Audio and Media Interactions and Interfaces on Mobile Phones


urMus

API Documentation

Flowbox API

These functions are members of any created Flowbox.

Flowbox:Name

Synopsis

flowboxName = flowbox:Name()

Description

Returns the name of the flowbox given as input

Returns

Flowbox:NumIns

Synopsis

numIns = flowbox:NumIns()

Description

Returns the number of inlets for this given flowbox.

Returns

Flowbox:NumOuts

Synopsis

numOuts = flowbox:NumOuts()

Description

Returns the number of outlets for this given flowbox.

Returns

Flowbox:Ins

Synopsis

insName1, insName2, ... insNameN = flowbox:Ins()

Description

Returns the names of N flowbox inputs.

Returns

Flowbox:Outs

Synopsis

outName1, outName2, ... = flowbox:Outs()

Returns

Flowbox:SetPushLink

Synopsis

didLink = flowbox:SetPushLink(outIndex, targetObject, targetInIndex)

Description

Adds a link between the this flowbox's outIndex to the targetObject's inIndex. In other words, updates from this flowbox's output will be sent to the target object's input.

Arguments

Returns

Note

Equivalent functionality can be achieved by using outlet member function API flowbox.out:SetPush(flowbox.in). This version of the API is still active but is discouraged from use because it is a candidate for deprication.

Flowbox:SetPullLink

Synopsis

didLink = flowbox:SetPullLink(inIndex, targetObject, targetOutIndex)

Description

Adds a pull link between the this flowbox's input index to the targetObject's output index.

Arguments

Returns

Note

Equivalent functionality can be achieved by using inlet member function API flowbox.in:SetPull(flowbox.out). This version of the API is still active but is discouraged from use because it is a candidate for deprication.

Flowbox:RemovePushLink

Synopsis

didRemoveLink = flowbox:RemovePushLink(outIndex, targetObject, targetInIndex)

Description

Removes a link between the this flowbox's outIndex to the targetObject's inIndex.

Arguments

Returns

Note

Equivalent functionality can be achieved by using outlet member function API flowbox.out:RemovePush(flowbox.in). This version of the API is still active but is discouraged from use because it is a candidate for deprication.

Flowbox:RemovePullLink

Synopsis

didRemoveLink = flowbox:RemovePullLink(inIndex, targetObject, targetOutIndex)

Description

Removes a pull link between the this flowbox's input index to the targetObject's output index.

Arguments

Returns

Note

Equivalent functionality can be achieved by using inlet member function API flowbox.in:RemovePull(flowbox.out). This version of the API is still active but is discouraged from use because it is a candidate for deprication.

Flowbox:IsPushed

Synopsis

isPushed = flowbox:IsPushed(outIndex, targetObject, targetInIndex)

Returns

Flowbox:IsPulled

Synopsis

isPulled = flowbox:IsPulled(inIndex, targetObject, targetOutIndex)

Returns

Flowbox:IsPushing

Synopsis

isPushing = flowbox:IsPushing(index)

Returns

Flowbox:IsPulling

Synopsis

isPulling = flowbox:IsPulling(index)

Returns

Flowbox:Push

Synopsis

flowbox:Push(data)

Description

Pushes out a given value to all the flowbox's outs. Currently only well defined for the Push flowbox.

Arguments

Flowbox:Get

Synopsis

data = flowbox:Get()

Description

Gets the latest data received from a self-clocking sink. Currenly only well defined for the Vis flowbox.

Returns

Flowbox:Pull

Synopsis

data = flowbox:Pull()

Description

Pulls the dataflow and returns the data received. Currenly only well defined for the Pull flowbox.

Returns

Flowbox:AddFile

Synopsis

flowbox:AddFile(filename)

Description

Adds a sound file to the file stack of a flowbox. Currently only well defined for the Sample flowbox.

Arguments

Flowbox:IsInstantiable

Synopsis

isInstantiable = flowbox:IsInstantiable()

Returns

Flowbox:InstanceNumber

Synopsis

number = flowbox:InstanceNumber()

Description

Returns the instance number of the flowbox. This is a monotonically increasing number assigned to each instantiated flowbox, and can be used to uniquely identify itself.

Returns

Flowbox:NumberInstances

Synopsis

numInstances = flowbox:NumberInstances()

Description

Returns

Flowbox:Couple

Synopsis

in, out = flowbox:Couple()

Description

Returns which in and out index are coupled (that is will propagate frame rates.) Returns nil if no couple exists.

Return

Flowbox:IsCoupled

Synopsis

iscoupled = flowbox:Couple()

Description

Returns if the flowbox has a coupled pair (i.e. an inlet/outlet pair which will propagate frame rates).

Return

Flowbox Inlet API

These functions are members of any inlet of a Flowbox. The names of the inlets are specified by the flowbox itself and can be found as part of the specification of flowboxes.

Flowbox.in:SetPull

Synopsis

didLink = flowbox.in:SetPull(flowbox2.out)

Description

Adds a pull link between the this flowbox's input in to the flowbox2's output out.

Arguments

Returns

Note

Requires V1.0 or later. Equivalent functionality can be achieved by using function API flowbox.SetPullLink(). This version of the API is recommended as the other alternative is a candidate for deprication.

Flowbox.in:RemovePull

Synopsis

didRemoveLink = flowbox.in:RemovePull(flowbox2.out)

Description

Removes a pull link between the this flowbox's input in to flowbox2's output out.

Arguments

Returns

Note

Requires V1.0 or later. Equivalent functionality can be achieved by using function API flowbox.RemovePullLink(). This version of the API is recommended as the other alternative is a candidate for deprication.

Flowbox Outlet API

These functions are members of any outlet of a Flowbox. The names of the outlets are specified by the flowbox itself and can be found as part of the specification of flowboxes.

Flowbox.out:SetPush

Synopsis

didLink = flowbox.out:SetPush(flowbox2.in)

Description

Adds a push link between the this flowbox's output out to the flowbox2's input in.

Arguments

Returns

Note

Requires V1.0 or later. Equivalent functionality can be achieved by using function API flowbox.SetPushLink(). This version of the API is recommended as the other alternative is a candidate for deprication.

Flowbox.out:RemovePush

Synopsis

didRemoveLink = flowbox.out:RemovePush(flowbox2.in)

Description

Removes a push link between this flowbox's input in to flowbox2's output out.

Arguments

Returns

Note

Requires V1.0 or later. Equivalent functionality can be achieved by using function API flowbox.RemovePushLink(). This version of the API is recommended as the other alternative is a candidate for deprication.

urMus API Overview