Function: app.ConnectAudio

Connects audio inputs to outputs.

Requires AOP API version wg.app 0.4.0 or later.

Syntax

{
	"method": "app.ConnectAudio",
	"params": {
		"id": "...",
		"sources": "...",
		"destinations": "...",
		"priority": "...",
		"delay": "...",
		"connectavailableonly": "...",
		"repeat": "...",
		"parameters": "...",
		"eventid": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<void> ConnectAudio( bool repeat
	 bool connectavailableonly,
	 int delay,
	 int priority,
	 std::vector<AdvGuid> destinations,
	 std::vector<AdvGuid> sources,
	 std::optional<AdvString> id = std::nullopt,
	 std::optional<AdvString> parameters = std::nullopt,
	 std::optional<AdvGuid> eventid = std::nullopt );
public Task ConnectAudioAsync(IList<Guid> sources,
		IList<Guid> destinations,
		long priority,
		long delay,
		bool connectavailableonly,
		bool repeat,
		string? id = null,
		string? parameters = null,
		Guid? eventid = null,
		CancellationToken ct = default);
connectAudio(sources: string[], destinations: string[], priority: number, delay: number, connectavailableonly: boolean, repeat: boolean, id?: string | undefined, parameters?: string | undefined, eventid?: string | undefined): Promise<>;

Parameters

id : string optional

An optional id for the audio connection, used as name by the audio control panel for the corresponding connection, can also be used as reference to end the connection.

sources : guid[]

Ids of the audio input Datapoints.

destinations : guid[]

Ids of the audio output Datapoints.

priority : int

The priority of the connect audio activity.

delay : int

Delay before the audio connects.

connectavailableonly : bool

If true, audio inputs are connected to free audio outputs, otherwise this audio connect activity gets discarded if there are no available audio outputs.

repeat : bool

Audio shall be played cyclically.

parameters : string optional

Additional extension-specific parameters.

eventid : guid optional

The audio connect activity should be executed under the context of this event.

Result : void

Remarks

This method requires API control access.