Jump to content

CONNECTOR

From EDM2

The CONNECTOR command enables, disables, or queries the status of connectors on a device.

Syntax

CONNECTOR ─── object ───┬─ ENABLE ──┬───┬──────────────────────────┬───┬──────────┬───┤
                        ├─ DISABLE ─┤   ├─ NUMBER connector_number ─┤   ├─ WAIT    ─┤
                        └─ QUERY ───┘   └─ TYPE connector_type ────┘   └─ NOTIFY  ─┘

Keywords

object
Object associated with this media control interface command. The object can be one of the following:
  • Device type
  • Device name
  • Filename
  • Alias
ENABLE
Enables information flow through the indicated connector. Use of this option requires that the NUMBER or TYPE keywords, or both must also be specified.
DISABLE
Disables information flow through the indicated connector. Use of this option requires that the NUMBER or TYPE keywords, or both must also be specified.
QUERY
Queries the status of the indicated connector. The return value will be either TRUE or FALSE to indicate enabled or disabled respectively. Use of this option requires that the NUMBER or TYPE keywords, or both must also be specified.
NUMBER connector_number
The connector number on which to perform the requested action. If this item is omitted, the first connector is assumed. If the TYPE keyword is included, then the connector number is interpreted as a relative offset within the specified connector type.
TYPE connector_type
The type of connector to which the requested action applies. See the TYPE keyword for CONNECTION for a list of connector types.
WAIT
The command is executed synchronously. The function waits until the requested action is complete before returning to the application.
NOTIFY
The command is executed asynchronously, allowing control to be returned immediately to the application. When the requested action is complete, an MM_MCINOTIFY message is sent to the application window procedure.

Purpose

The CONNECTOR command enables, disables, or queries the status of connectors on a device.

Example

connector waveaudio01 enable type microphone