CONNECTOR (CD/XA Commands)
Appearance
The CONNECTOR command enables, disables, or queries the status of connectors on a device.
The CONNECTOR command modifies or queries the operational state of data routing connections on a Compact Disc Digital Audio/Extended Architecture (CD/XA) device instance. This Media Control Interface (MCI) command controls whether data streams can pass through specific physical or logical device lines.
Syntax
connector object action modifiers execution
Syntax Diagram
┌───────────────────────────────┐
│
CONNECTOR ──── object ────┬─ ENABLE ──┬────────┬─ NUMBER connector_number ─┬─┴─┬──────────┬──────────────┤
├─ DISABLE ─┤ └─ TYPE connector_type ─────┘ ├─ WAIT ───┤
└─ QUERY ───┘ └─ NOTIFY ─┘
Parameters
- object
- Specifies the target object associated with this media control interface command. It can be one of the following:
- Device type (e.g., `cdxa`)
- Device name
- Filename
- Alias
- action
- Specifies the operation to perform on the targeted connection. You must specify exactly one of the following keywords:
- ENABLE: Activates data and information flow through the designated connector line. Requires accompanying `NUMBER` and/or `TYPE` modifiers.
- DISABLE: Deactivates and blocks information flow through the designated connector line. Requires accompanying `NUMBER` and/or `TYPE` modifiers.
- QUERY: Queries the active connection routing state. Returns either `TRUE` (enabled) or `FALSE` (disabled). Requires accompanying `NUMBER` and/or `TYPE` modifiers.
Modifiers
- NUMBER connector_number
- Specifies the structural connector ID line on which to execute the request. If this modifier is omitted entirely, the subsystem defaults to processing the first connector (`1`). If combined with the `TYPE` modifier, this integer value represents a zero-based relative offset within that specified category pool.
- TYPE connector_type
- Specifies the functional classification of the target connection. The CD/XA device ecosystem supports the following type value:
- XA stream: Digital audio extraction output stream bound for the audio amplifier or hardware system mixer. This architectural connector path is permanently active (`always enabled`).
Synchronization Keywords
- WAIT
- Executes the command synchronously. The subsystem blocks the calling application context thread and waits until the connector adjustment or query is processed. **The `WAIT` keyword must be explicitly specified within the text command string to retrieve string data from a `QUERY` action.**
- NOTIFY
- Executes the command asynchronously. Control returns immediately to the calling thread. Once the subsystem completes the connector state transition, an `MM_MCINOTIFY` message is dispatched to the registered application window procedure.
Example Code
The following text command string queries the routing state of the main XA stream digital output connection path on the default CD/XA device driver instance, enforcing synchronous tracking execution to block until the return value string is available:
connector cdxa query type XA stream wait