Dana: /* Optional parameters */

2013-01-18T16:02:36Z

‎Optional parameters

Dana: Created page with " This special message is used by a channel to request to insert a data source or consumer (or both) provided by another module. Typically the Tone Generator, Wave File and RT..."

2012-10-08T09:12:28Z

Created page with " This special message is used by a channel to request to insert a data source or consumer (or both) provided by another module. Typically the Tone Generator, Wave File and RT..."

New page

This special message is used by a channel to request to insert a data source or consumer (or both) provided by another module.

Typically the Tone Generator, Wave File and RTP modules can provide data nodes to other modules.

This message must be sent ''synchronously''.

=== Resource identifier parameters (each is optional) ===

'''source'''
:::the data source the sender module wants to attach
'''consumer'''
:::the consumer the sender module wants to attach; this can be used at the same time with source
'''override'''
:::the data source that is to be temporarily connected to the sender's consumer; the intended usage is for local announcements and inband tone injection
'''sniffer'''
:::a data consumer to be attached as sniffer (supplementary consumer) instead of replacing the consumer
'''replace'''
:::a data source to temporarily replace the sender's source

=== Optional parameters ===

'''notify'''
:::the id of the target that should recieve the chan.notify message that is send when the source or consumer reach end of data
'''maxlen'''
:::the maximum number of octets that should be transferred; this parameter is currently used only by the wave consumer
'''autorepeat'''
:::set to true to indicate the desire for data sources to repeat indefinitely; this parameter is currently used only by the wave source
'''single'''
:::boolean indication that the message contains a single resource identifier so the first matching handler can stop the message flow
'''rate'''
:::desired sample rate of the attached data node(s), default 8000Hz; not all modules support sample rate setting

← Older revision		Revision as of 16:02, 18 January 2013
Line 31:		Line 31:
	'''rate'''		'''rate'''
	:::desired sample rate of the attached data node(s), default 8000Hz; not all modules support sample rate setting		:::desired sample rate of the attached data node(s), default 8000Hz; not all modules support sample rate setting
		+
		+
		+	'''See also'''
		+
		+	* [[chan.connected]]

Chan.attach - Revision history

Dana: /* Optional parameters */

Dana: Created page with " This special message is used by a channel to request to insert a data source or consumer (or both) provided by another module. Typically the Tone Generator, Wave File and RT..."