MCI_STATUS Parameter - ulParam1

ulParam1 (ULONG)

This parameter can contain any of the following flags:

MCI_NOTIFY

A notification message will be posted to the window specified in the hwndCallback parameter of the data structure pointed to by the pParam2 parameter. The notification will be posted when the action indicated by this message is completed or when an error occurs.
MCI_WAIT
Control is not to be returned until the action indicated by this message is completed or an error occurs.
MCI_STATUS_START
Returns the starting position of the media. Specify MCI_STATUS_POSITION as the status item in ulItem.
MCI_TRACK
A status track parameter is included in the ulTrack field of the data structure pointed to by pParam2. If MCI_TRACK is specified, the status item must be either MCI_STATUS_POSITION or MCI_STATUS_LENGTH. When used with MCI_STATUS_POSITION, the starting position of the given track, segment, or chapter is returned. When used with MCI_STATUS_LENGTH, the length of the given track, segment, element, or chapter is returned.
MCI_STATUS_CONNECTOR
If this flag is specified, a valid connector must be in the ulValue field of MCI_STATUS_PARMS. The specific audio setting to be queried is set in the ulItem field. MCI_STATUS_CONNECTOR and MCI_STATUS_ITEM are mutually exclusive. If both of these flags are specified, MCIERR_INVALID_FLAG will be returned.
MCI_STATUS_ITEM
Indicates that the ulItem field of the data structure identified by pParam2 contains a constant specifying the status item in question. The following constants are defined:

MCI_STATUS_AUDIO

One of the following status audio parameters must be included in the ulValue field of the data structure pointed to by pParam2. The following predefined channel numbers can be specified. You can specify other channel numbers by specifying the appropriate channel number.

MCI_STATUS_AUDIO_ALL

Returns MCI_TRUE if all channels are on; otherwise, returns MCI_FALSE. This is the default value.
MCI_STATUS_AUDIO_LEFT
Returns MCI_TRUE if the left channel is on; otherwise, returns MCI_FALSE.
MCI_STATUS_AUDIO_RIGHT
Returns MCI_TRUE if the right channel is on; otherwise, returns MCI_FALSE.
MCI_STATUS_CAN_PASTE
Returns MCI_TRUE if compatible data is to be placed in clipboard; otherwise, returns MCI_FALSE.
MCI_STATUS_CAN_REDO
Returns MCI_TRUE if an operation that was undone can be redone; otherwise, returns MCI_FALSE.
MCI_STATUS_CAN_UNDO
Returns MCI_TRUE if a change has been made that can be undone; otherwise, returns MCI_FALSE.
MCI_STATUS_CLIPBOARD
Returns MCI_TRUE if the clipboard contains information understood by the current device; otherwise returns MCI_FALSE.
MCI_STATUS_CURRENT_TRACK
Returns the current track, segment, or chapter number.
MCI_STATUS_LENGTH
Returns the total media length in units as specified in the MCI_SET message with the MCI_SET_TIME_FORMAT flag.

Note: If the time format has been set to MCI_FORMAT_TMSF, the actual time value returned will be in the format MCI_FORMAT_MSF.

If the media length cannot be determined because a playlist is currently loaded, or for any other reason, MCIERR_INDETERMINATE_LENGTH is returned.

MCI_STATUS_MODE
Returns the current mode of the device. Possible values are:

• MCI_MODE_NOT_READY
  
• MCI_MODE_PAUSE
  
• MCI_MODE_PLAY
  
• MCI_MODE_STOP
  
• MCI_MODE_RECORD
  
• MCI_MODE_SEEK
MCI_STATUS_MEDIA_PRESENT
Returns MCI_TRUE or MCI_FALSE. If the device does not have removable media, it returns MCI_TRUE. Note that this function is only applicable to devices which are dependent on removable media. Receiving a return of MCI_FALSE indicates that the device cannot function without inserting the media into the device. Examples of devices which might return MCI_FALSE to this command are CD audio and videodisc devices.
MCI_STATUS_MONITOR
Returns MCI_ON or MCI_OFF to indicate whether monitoring of the incoming video signal is turned on or off.
MCI_STATUS_NUMBER_OF_TRACKS
Returns the total number of playable tracks, segments, or chapters.
MCI_STATUS_POSITION
Returns the current position.
MCI_STATUS_POSITION_IN_TRACK
Returns the current position relative to the beginning of the current track, segment, or chapter.
MCI_STATUS_READY
Returns MCI_TRUE if the device is ready; otherwise, returns MCI_FALSE.
MCI_STATUS_SPEED_FORMAT
Returns the currently set speed format. Possible values are:

• MCI_FORMAT_PERCENTAGE
  
• MCI_FORMAT_FPS
MCI_STATUS_TIME_FORMAT
Returns the currently set time format. Possible values are:

• MCI_FORMAT_MILLISECONDS
  
• MCI_FORMAT_MMTIME
  
• MCI_FORMAT_MSF
  
• MCI_FORMAT_TMSF
  
• MCI_FORMAT_CHAPTERS
  
• MCI_FORMAT_FRAMES
  
• MCI_FORMAT_HMS
  
• MCI_FORMAT_TRACKS
  
• MCI_FORMAT_BYTES
  
• MCI_FORMAT_SAMPLES
  
• MCI_FORMAT_HMSF
  
• MCI_FORMAT_SET_SMPTE_24
  
• MCI_FORMAT_SET_SMPTE_25
  
• MCI_FORMAT_SET_SMPTE_30
  
• MCI_FORMAT_SET_SMPTE_30DROP
  
• MCI_FORMAT_SET_SONGPTR
MCI_STATUS_VIDEO
Returns MCI_TRUE if video is on; otherwise returns MCI_FALSE.
MCI_STATUS_VOLUME
Returns the actual volume level set in the device as a percentage of the maximum achievable effect. The left channel is returned in the low-order word, and the right channel is returned in the high-order word.
Amplifier Mixer Extensions

The following additional status items apply to amplifier-mixer devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag:

MCI_AMP_STATUS_BALANCE

Returns a balance level for this mixer channel. A value of zero indicates full left balance while 100 indicates full right balance, and 50 indicates neutral balance.
MCI_AMP_STATUS_BASS
Returns a bass level for this mixer channel as a percentage of the maximum achievable bass effect.
MCI_AMP_STATUS_GAIN
Returns the gain setting as a percentage of the maximum achievable effect.
MCI_AMP_STATUS_PITCH
Returns the pitch as a percentage of the maximum achievable effect.
MCI_AMP_STATUS_TREBLE
Returns treble level for this mixer channel as a percentage of the maximum treble effect.
If MCI_STATUS_CONNECTOR is specified, the following additional items can be specified in the ulItem field of MCI_STATUS_PARMS.

MCI_AMP_STATUS_ALC

Returns the current auto-level control setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_BASS
Returns the current bass setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_BALANCE
Returns the current balance setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_CHORUS
Returns the current chorus setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_CROSSOVER
Returns the current crossover setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_CUSTOM1
Returns the current custom effect setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_CUSTOM2
Returns the current custom effect setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_CUSTOM3
Returns the current custom effect setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_GAIN
Returns the current gain setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_LOUDNESS
Returns the current loudness setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_MID
Returns the current mid setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_MONITOR
Returns the current monitor setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_MUTE
Returns the current mute setting for the connector specified in ulValue of MCI_STATUS_PARMS. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_PITCH
Returns the current pitch setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_REVERB
Returns the current reverb setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_STEREOENHANCE
Returns the current stereo enhance setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_TREBLE
Returns the current treble setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
MCI_AMP_STATUS_VOLUME
Returns the current volume setting for the connector specified in ulValue of MCI_STATUS_PARMS as a percentage of the maximum achievable effect. MCI_STATUS_CONNECTOR must be specified.
CD Audio Extensions

The following additional status items apply to CD audio devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag:

MCI_CD_STATUS_TRACK_TYPE

Returns one of the following:

• MCI_CD_TRACK_AUDIO
  
• MCI_CD_TRACK_DATA
  
• MCI_CD_TRACK_OTHER
MCI_CD_STATUS_TRACK_COPYPERMITTED
Returns MCI_TRUE if digital copying is permitted; otherwise, returns MCI_FALSE.
MCI_CD_STATUS_TRACK_CHANNELS
Returns the number of audio channels on the track.
MCI_CD_STATUS_TRACK_PREEMPHASIS
Returns MCI_TRUE if the track was recorded with pre-emphasis; otherwise, returns MCI_FALSE.

Note: When used with the MCI_TRACK flag, these items return the status information of the specified track instead of the current track.

CD/XA Extensions

The following extensions apply to CD-XA devices and can be specified for the ulItem field of the data structure pointed to by pParam2:

MCI_CDXA_STATUS_CHANNEL

Returns the destination of the data in channel ulChannel. Returns one of the following:

• MCI_CDXA_AUDIO_DEVICE
  
• MCI_CDXA_AUDIO_BUFFER
  
• MCI_CDXA_VIDEO_BUFFER
  
• MCI_CDXA_DATA_BUFFER
  
• MCI_CDXA_NONE
Digital Video Extensions

The following additional status items apply to digital video devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag.

MCI_DGV_STATUS_FORMATTAG

Returns WAVE_FORMAT_PCM, the only format currently supported by the digital video device. If a movie is loaded that contains a format other than PCM, the format used in the movie will be returned.
MCI_DGV_STATUS_DROPPED_FRAME_PCT
Returns the percentage of dropped frames for recording or playback operations. The value returned is in the range 0-100, where a value of zero indicates that no frame drops are occurring or have occurred and a value of 100 indicates that all frames are being dropped or have been dropped. This status value can be queried during a recording operation to obtain the cumulative percentage of frame drops that have occurred since recording began, or during playback to obtain the cumulative percentage of frame drops that have occurred since playback began or was resumed after a seek, pause, or stop. If the value is queried when the device is stopped, the percentage of dropped frames accumulated at the end of the last playback or recording operation that was performed is returned. A value of zero is returned if no playback or recording operations have been performed, the device is seeking or has been seeked, the device is paused or stopped, or the device is playing in scan mode.
MCI_DGV_STATUS_SAMPLESPERSEC
Returns the currently set samples per second used for playing, recording, and saving.
MCI_DGV_STATUS_BITSPERSAMPLE
Returns the currently set bits per sample used for playing, recording, and saving.
MCI_DGV_STATUS_CHANNELS
Returns the currently set number of channels used for playing, recording, and saving.
MCI_DGV_STATUS_HWND
Returns the handle of the playback window.
MCI_DGV_STATUS_VIDEO_COMPRESSION
Returns the current FOURCC compression format for recording of motion video. Only symmetric compressors will be enabled for real-time recording.
MCI_DGV_STATUS_VIDEO_QUALITY
Returns the currently set compression quality level for recording of motion video.
MCI_DGV_STATUS_MONITOR
Returns MCI_ON or MCI_OFF to indicate whether monitoring of the incoming video signal is on or off.
MCI_DGV_STATUS_HWND_MONITOR
Returns the monitor window handle.
MCI_DGV_STATUS_REF_INTERVAL
Returns the value of n where n refers to a reference frame being inserted every nth frame.
MCI_DGV_STATUS_IMAGE_BITSPERPEL
Returns the pel format used for saving bitmaps.
MCI_DGV_STATUS_IMAGE_PELFORMAT
Returns the data format used of image data for the capture device. Possible values are:

• MMIO_RGB_5_6_5

  Each pixel is represented by 16 bits of data as follows:

  15:5

  Red level in the range 0-31
  10:6
  Green level in the range 0-63
  4:5
  Blue level in the range 0-31
  
  MMIO_YUV_4_1_1

  This format uses 16 bits per pixel, but uses 4-pixel horizontal chrominance subsampling. Each pixel has a unique luminance value (Y) with a single chrominance value (U and V) shared by four pixels. Y, U, and V all have 7 bits of significance in this format.

  23:8

  Red level in the range 0-255
  15:8
  Green level in the range 0-255
  7:8
  Blue level in the range 0-255
  
  MMIO_YUV_4_2_2

  4 bytes of Y, 2 bytes of U, 2 bytes of V; all 8-bit values in this form YUYVYUYV

  MCI_DGV_STATUS_FORWARD
  Returns MCI_TRUE if playing forward; otherwise returns MCI_FALSE.
  MCI_DGV_STATUS_NORMAL_RATE
  Returns the normal-play rate of the currently loaded motion video device element, in the current speed format, either as a percentage or in frames per second.
  MCI_DGV_STATUS_VIDEO_X_EXTENT
  Returns the horizontal (X) extent of the digital motion video image for the currently loaded motion video device element.
  MCI_DGV_STATUS_VIDEO_Y_EXTENT
  Returns the vertical (Y) extent of the digital motion video image for the currently loaded motion video device element.
  MCI_DGV_STATUS_BRIGHTNESS
  Returns the brightness level.
  MCI_DGV_STATUS_CONTRAST
  Returns the contrast level.
  MCI_DGV_STATUS_HUE
  Returns the hue level.
  MCI_DGV_STATUS_SATURATION
  Returns the saturation level.
  MCI_DGV_STATUS_RECORD_AUDIO
  Returns MCI_ON or MCI_OFF to indicate whether recording the audio soundtrack has been turned on or off.
  MCI_DGV_STATUS_SPEED
  Returns the digital video speed in frames per second.
  MCI_DGV_STATUS_TRANSPARENT_COLOR
  Returns a value representing the transparent color used as the chroma-key on video overlay hardware.
  MCI_DGV_STATUS_VIDEO_RECORD_FRAME_DURATION
  Returns the frame rate for recording as the time duration of each frame in microseconds.
  MCI_DGV_STATUS_TUNER_TV_CHANNEL
  This flag returns the channel that the tuner device is tuned to.
  MCI_DGV_STATUS_TUNER_HIGH_TV_CHANNEL
  This flag returns the highest channel for the region.
  MCI_DGV_STATUS_TUNER_LOW_TV_CHANNEL
  This flag returns the lowest channel for the region.
  MCI_DGV_STATUS_TUNER_FINETUNE
  This flag returns the fine-tuning value that the tuner device is tuned to.
  MCI_DGV_STATUS_TUNER_FREQUENCY
  This flag returns the frequency value that the tuner device is tuned to.
  MCI_DGV_STATUS_VALID_SIGNAL
  This flag returns MCI_TRUE if there is a signal present.
  Sequencer Extensions

  The following additional status items apply to MIDI sequencer devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag:

  MCI_SEQ_STATUS_DIVTYPE

  Returns one of the following values as the current division type of a sequence:

  • MCI_SEQ_DIV_PPQN 
    MCI_SEQ_DIV_SMPTE_24
    
    MCI_SEQ_DIV_SMPTE_25
    
    MCI_SEQ_DIV_SMPTE_25
    
    MCI_SEQ_DIV_SMPTE_30
    
    MCI_SEQ_DIV_SMPTE_30DROP
    MCI_SEQ_STATUS_MASTER
    Returns the synchronization type used for master operation.
    MCI_SEQ_STATUS_OFFSET
    Returns the current SMPTE offset of a sequence.
    MCI_SEQ_STATUS_PORT
    Returns the MIDI device ID for the current port used by the sequence.
    MCI_SEQ_STATUS_SLAVE
    Returns the synchronization type used for slave operation.
    MCI_SEQ_STATUS_TEMPO
    Returns the current tempo of a MIDI sequence in beats-per-minute for PPQN files, or frames-per-second for SMPTE files. Currently this function is not supported by the IBM sequencer.
    Videodisc Extensions

    The following additional status items apply to videodisc devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag:

    MCI_VD_STATUS_SPEED

    Returns the speed in the currently set speed format.
    MCI_VD_STATUS_FORWARD
    Returns MCI_TRUE if playing forward; otherwise, returns MCI_FALSE.
    MCI_VD_MEDIA_TYPE
    Returns one of the following:

    • MCI_VD_MEDIA_CAV 
      MCI_VD_MEDIA_CLV
      
      MCI_VD_MEDIA_OTHER
      MCI_VD_STATUS_SIDE
      Returns 1 or 2 to indicate which side of the disc is loaded.
      MCI_VD_STATUS_DISC_SIZE
      Returns the size of the loaded disc in inches (8 or 12).
      Video Overlay Extensions

      The following additional items apply to video overlay devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag.

      MCI_OVLY_STATUS_HWND

      Returns the handle of the playback window.
      MCI_OVLY_STATUS_IMAGE_COMPRESSION
      Returns the compression format of the currently loaded bitmap/image.
      MCI_OVLY_STATUS_BITSPERPEL
      Returns the number of bits per pel of the currently loaded bitmap/image. Return values include:

      • MCI_IMG_PALETTE 
        MCI_IMG_RGB
        
        MCI_IMG_YUV
        MCI_OVLY_STATUS_PELFORMAT
        Returns the pel format of the currently loaded bitmap/image.
        MCI_OVLY_STATUS_BRIGHTNESS
        Returns the brightness level.
        MCI_OVLY_STATUS_CONTRAST
        Returns the contrast level.
        MCI_OVLY_STATUS_HUE
        Returns the hue level.
        MCI_OVLY_STATUS_SATURATION
        Returns the saturation level.
        MCI_OVLY_STATUS_SHARPNESS
        Returns the sharpness level.
        MCI_OVLY_STATUS_TRANSPARENT_COLOR
        Returns a value representing the RGB value or palette value, which specifies the transparent color. RGB values are returned as a 32-bit RGB2 data item.
        MCI_OVLY_STATUS_TRANSPARENT_TYPE
        Returns a value representing information to assist in interpreting the MCI_OVLY_STATUS_TRANSPARENT_COLOR.

        Return values include:

        • MCI_IMG_PALETTE 
          MCI_IMG_RGB
          
          MCI_IMG_YUV
          MCI_OVLY_STATUS_GREYSCALE
          Returns MCI_ON or MCI_OFF.
          MCI_OVLY_STATUS_IMAGE_COMPRESSION
          Returns the compression type for saving still images.
          MCI_OVLY_STATUS_IMAGE_BITSPERPEL
          Returns the number of bits per pel used for the image file to be saved.
          MCI_OVLY_STATUS_IMAGE_PELFORMAT
          Returns the pel format used for saving bitmaps.
          MCI_OVLY_STATUS_IMAGE_QUALITY
          Returns the quality of the image in the element buffer.
          MCI_OVLY_STATUS_IMAGE_X_EXTENT
          Returns the width, in pels, of the image in the element buffer.
          MCI_OVLY_STATUS_IMAGE_Y_EXTENT
          Returns the height, in pels, of the image in the element buffer.
          MCI_OVLY_STATUS_IMAGE_FILE_FORMAT
          Returns the format in which an image capture will be stored when saved.
          Wave Audio Extensions

          The following additional status items apply to wave audio devices and can be specified for the ulItem field (of the data structure pointed to by pParam2) for use with the MCI_STATUS_ITEM flag:

          MCI_WAVE_STATUS_FORMATTAG

          Returns the currently set format tag used for playing, recording, and saving.
          MCI_WAVE_STATUS_CHANNELS
          Returns the currently set channel count used for playing, recording, and saving.
          MCI_WAVE_STATUS_SAMPLESPERSEC
          Returns the currently set samples per second used for playing, recording, and saving.
          MCI_WAVE_STATUS_AVGBYTESPERSEC
          Returns the currently set bytes per second used for playing, recording, and saving. Playback software can use this number to estimate required buffer sizes. Refer to the RIFF WAVE format documentation for more information.
          MCI_WAVE_STATUS_BLOCKALIGN
          Returns the currently set block alignment used for playing, recording, and saving.
          MCI_WAVE_STATUS_BITSPERSAMPLE
          Returns the currently set bits per sample used for playing, recording, and saving.
          MCI_WAVE_STATUS_LEVEL
          Returns the current record or playback level. The value is returned as an 8-bit or 16-bit value, depending on the sample size being used. The right or Mono channel level is returned in the low-order word. The left channel level is returned in the high-order word.

          ---

          [Back: MCI_STATUS]
          [Next: MCI_STATUS Parameter - pParam2]