STATUS (Basic Command)

The STATUS command obtains status information for the device.

Syntax

STATUS ─── object ───┬─ CURRENT TRACK ───────┬───┬──────────┬───┤
                     ├─ LENGTH ──────────────┤   ├─ WAIT    ─┤
                     ├─ LENGTH TRACK number ─┤   └─ NOTIFY  ─┘
                     ├─ NUMBER OF TRACKS ────┤
                     ├─ POSITION ────────────┤
                     ├─ POSITION IN TRACK ───┤
                     ├─ POSITION TRACK number┤
                     ├─ SPEED FORMAT ────────┤
                     ├─ TIME FORMAT ─────────┤
                     └─ VOLUME ──────────────┘

Keywords

object

Object associated with this media control interface command. The object can be one of the following:

Device type
Device name
Filename
Alias

CURRENT TRACK: Returns the current track.

LENGTH: Returns the total length of the segment. For compound devices, such as waveaudio, a device element must be opened or loaded to obtain the length.

LENGTH TRACK number: Returns the length of the track specified by number. Returned value is in MMTIME units unless the object has been opened and its time format has been changed.

NUMBER OF TRACKS: Returns the number of tracks on the media.

POSITION: Returns the current position.

POSITION IN TRACK: Returns the current position relative to the beginning of the track.

POSITION TRACK number: Returns the position of the start of the track specified by number. Returned value is in MMTIME units unless the object has been opened and its time format has been changed.

SPEED FORMAT: Returns the speed format.

TIME FORMAT: Returns the time format.

VOLUME: Returns the current volume setting. The volume is returned as a string in the format left:right where left and right are percentages of the maximum achievable effect for the left and right channels respectively. Leading zeros are suppressed for the volume level in each channel.

WAIT: The command is executed synchronously. The function waits until the requested action is complete before returning to the application. The WAIT keyword must be specified in order to receive return string information.

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 STATUS command obtains status information for the device.

Example

status waveaudio01 volume wait