MMPM/2 Device Driver Reference:Vendor-Specific Driver Commands
Vendor-Specific Driver Commands
The vendor-specific driver (VSD) commands enable communication between vendor-specific drivers (VSDs) and an application such as the user-level audio stream handler or amplifier mixer MCI driver. The interface to the VSD is DLL-based. First, a DosLoadModule function is issued for the VSD's DLL. The DosLoadModule function returns a handle for the VSD. Next, using the VSD handle, DosQueryProcAddr is issued to receive the VSD entry point address. This must be done prior to issuing any VSD commands. Once the entry point address is received, calls to the VSD are made to VSDEntryentry point.
VSDEntry
Select an item:
Syntax Parameters Returns Remarks Glossary
This entry point enables communication between vendor-specific drivers ( VSDs) and an application such as the user-level audio stream handler or amplifier mixer. For audio VSDs, be sure to define INCL_AUDIO_VSD before including the VSDCMDS.H header file.
#define INCL_AUDIO_VSD #include <vsdcmds.h> #include <os2mixer.h> HVSD hvsd; /* Handle to VSD instance. */ ULONG ulFunc; /* Function code. */ ULONG ulFlags; /* Flags for driver. */ PVOID pRequest; /* Request parameter block value. */ ULONG rc; /* Return codes. */ rc = VSDEntry(hvsd, ulFunc, ulFlags, pRequest);
VSDEntry - Syntax
This entry point enables communication between vendor-specific drivers ( VSDs) and an application such as the user-level audio stream handler or amplifier mixer. For audio VSDs, be sure to define INCL_AUDIO_VSD before including the VSDCMDS.H header file.
#define INCL_AUDIO_VSD #include <vsdcmds.h> #include <os2mixer.h> HVSD hvsd; /* Handle to VSD instance. */ ULONG ulFunc; /* Function code. */ ULONG ulFlags; /* Flags for driver. */ PVOID pRequest; /* Request parameter block value. */ ULONG rc; /* Return codes. */ rc = VSDEntry(hvsd, ulFunc, ulFlags, pRequest);
VSDEntry Parameter - hvsd
hvsd(HVSD) - input This parameter is the handle to the VSD instance.
VSDEntry Parameter - ulFunc
ulFunc(ULONG) - input The VSD command to be issued. The following commands are supported for audio VSDs.
/-------------------------------------------------------------\ |Command |Description | |------------------------------+------------------------------| |VSD_CLOSE |Closes the device. (Required) | |------------------------------+------------------------------| |VSD_DDCMD |Allows communication between | | |stream handlers and their | | |attached devices. (Required) | |------------------------------+------------------------------| |VSD_ESCAPE |Sends a buffer to the device. | | |(Optional) | |------------------------------+------------------------------| |VSD_GETDEVCAPS |Retrieves the device | | |capabilities. (Required) | |------------------------------+------------------------------| |VSD_OPEN |Opens an instance of the | | |device. (Required) | |------------------------------+------------------------------| |VSD_QUERY |Queries the status of the | | |device. (Required) | |------------------------------+------------------------------| |VSD_RESOURCE |Manages resources. (Required) | |------------------------------+------------------------------| |VSD_RESTORE |Restores device to a saved | | |state. (Required) | |------------------------------+------------------------------| |VSD_SAVE |Saves the current state of the| | |device instance. (Required) | |------------------------------+------------------------------| |VSD_SET |Modifies settings of the | | |device. (Required) | |------------------------------+------------------------------| |VSD_USER |Allows user-defined commands | | |to be passed into the VSD. | | |(Optional) | \-------------------------------------------------------------/
VSDEntry Parameter - ulFlags
ulFlags(ULONG) - input The ulFlagsparameter is used to further qualify the command specified in ulFunc. In many cases it is used as a subcommand. For more information on ulFlags, see the specific ulFuncparameter.
VSDEntry Parameter - pRequest
pRequest(PVOID) - input Specifies the pointer to the request packet. The caller of the VSD supplies all request buffers. See individual commands for more detailed information.
VSDEntry Return Value - rc
rc(ULONG) - returns The return codes are listed for each command and will vary based on the command sent.
If a VSD requires unique return codes for certain conditions, it can use return codes starting at VSDERR_BASE.
VSDEntry - Parameters
hvsd(HVSD) - input This parameter is the handle to the VSD instance.
ulFunc(ULONG) - input The VSD command to be issued. The following commands are supported for audio VSDs.
/-------------------------------------------------------------\ |Command |Description | |------------------------------+------------------------------| |VSD_CLOSE |Closes the device. (Required) | |------------------------------+------------------------------| |VSD_DDCMD |Allows communication between | | |stream handlers and their | | |attached devices. (Required) | |------------------------------+------------------------------| |VSD_ESCAPE |Sends a buffer to the device. | | |(Optional) | |------------------------------+------------------------------| |VSD_GETDEVCAPS |Retrieves the device | | |capabilities. (Required) | |------------------------------+------------------------------| |VSD_OPEN |Opens an instance of the | | |device. (Required) | |------------------------------+------------------------------| |VSD_QUERY |Queries the status of the | | |device. (Required) | |------------------------------+------------------------------| |VSD_RESOURCE |Manages resources. (Required) | |------------------------------+------------------------------| |VSD_RESTORE |Restores device to a saved | | |state. (Required) | |------------------------------+------------------------------| |VSD_SAVE |Saves the current state of the| | |device instance. (Required) | |------------------------------+------------------------------| |VSD_SET |Modifies settings of the | | |device. (Required) | |------------------------------+------------------------------| |VSD_USER |Allows user-defined commands | | |to be passed into the VSD. | | |(Optional) | \-------------------------------------------------------------/
ulFlags(ULONG) - input The ulFlagsparameter is used to further qualify the command specified in ulFunc. In many cases it is used as a subcommand. For more information on ulFlags, see the specific ulFuncparameter.
pRequest(PVOID) - input Specifies the pointer to the request packet. The caller of the VSD supplies all request buffers. See individual commands for more detailed information.
rc(ULONG) - returns The return codes are listed for each command and will vary based on the command sent.
If a VSD requires unique return codes for certain conditions, it can use return codes starting at VSDERR_BASE.
VSDEntry - Remarks
If a VSD requires unique return codes for certain conditions, it can use return codes starting at VSDERR_BASE.
VSDEntry - Topics
Select an item:
Syntax Parameters Returns Remarks Glossary
VSD_CLOSE
Select an item:
Syntax Returns Remarks Example Code Glossary
This command closes the device. VSD_CLOSE is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to the VSD to be closed.
ulFunc(ULONG) Set to VSD_CLOSE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVOID) Not used for this command.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_CANNOT_CLOSE VSD is unable to close the device.
VSDERR_HARDWARE A hardware error occurred.
VSD_CLOSE Parameter - hvsd
hvsd(HVSD) Handle to the VSD to be closed.
VSD_CLOSE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_CLOSE.
VSD_CLOSE Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_CLOSE Parameter - pRequest
pRequest(PVOID) Not used for this command.
VSD_CLOSE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_CANNOT_CLOSE VSD is unable to close the device.
VSDERR_HARDWARE A hardware error occurred.
VSD_CLOSE - Syntax
This command closes the device. VSD_CLOSE is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to the VSD to be closed.
ulFunc(ULONG) Set to VSD_CLOSE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVOID) Not used for this command.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_CANNOT_CLOSE VSD is unable to close the device.
VSDERR_HARDWARE A hardware error occurred.
VSD_CLOSE - Remarks
The hvsdhandle is no longer valid after this command is issued.
VSD_CLOSE - Example Code
The following code illustrates how to close a VSD.
HVSD hvsd;
ULONG rc;
rc = pInstance ->pfnAUDIOIF( hvsd,
VSD_CLOSE,
0,
0 );
return (rc);
VSD_CLOSE - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_DDCMD
Select an item:
Syntax Returns Remarks Glossary
Stream handlers can communicate to their attached devices using the VSD_ DDCMD call. The DDCMD interface is the primary method of moving data to and from devices in OS/2 multimedia. See the OS/2 Multimedia Programming Referencefor more detailed information on stream handler command (SHC) messages.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_DDCMD.
ulFlags(ULONG) The following flags (subcommands) are defined for this command:
DDCMD_CONTROL This subcommand of VSD_DDCMD performs a device-specific command. pRequestis a pointer to the DDCMDCONTROLstructure.
DDCMD_DEREG_STREAM This subcommand of VSD_DDCMD deregisters a stream instance with the device driver. pRequestis a pointer to DDCMDDEREGISTERstructure.
DDCMD_READ This subcommand of VSD_DDCMD is used by a stream handler to give an emptybuffer to the VSD (for example, during a record operation). When the buffer has been filled, the VSD is responsible for communicating to the caller that the buffer has been filled. The VSD should pass a MSG_ REPORTINTstructure to the pSHDEntryPointin DDCMDREGISTERto inform the caller.
pRequestis a pointer to DDCMDREADWRITEstructure.
DDCMD_REG_STREAM This subcommand of VSD_DDCMD registers a stream instance with the device driver. pRequestis a pointer to DDCMDREGISTERstructure.
DDCMD_SETUP This subcommand of VSD_DDCMD performs device-specific stream instance setup. pRequestis a pointer to DDCMDSETUPstructure.
DDCMD_STATUS This VSD subcommand requests streaming status from a device. Typically, it is called to request the current stream time. pRequestis a pointer to DDCMDSTATUSstructure.
DDCMD_WRITE This VSD subcommand is used by a stream handler to give a fullbuffer to the VSD (for example, during a playback operation). When the buffer has been consumed, the VSD is responsible for communicating to the caller that the buffer has been used. The VSD should pass a MSG_REPORTINTstructure to the pSHDEntryPointin DDCMDREGISTERto inform the caller.
pRequestis a pointer to DDCMDREADWRITEstructure.
pRequest(PVOID) The value of pRequestvaries according to the ulFlagsvalue. See each particular ulFlagsvalue for the definition of pRequest.
rc(ULONG) Possible error codes vary according to the value of ulFlags.
VSD_DDCMD Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_DDCMD Parameter - ulFunc
ulFunc(ULONG) Set to VSD_DDCMD.
VSD_DDCMD Parameter - ulFlags
ulFlags(ULONG) The following flags (subcommands) are defined for this command:
DDCMD_CONTROL This subcommand of VSD_DDCMD performs a device-specific command. pRequestis a pointer to the DDCMDCONTROLstructure.
DDCMD_DEREG_STREAM This subcommand of VSD_DDCMD deregisters a stream instance with the device driver. pRequestis a pointer to DDCMDDEREGISTERstructure.
DDCMD_READ This subcommand of VSD_DDCMD is used by a stream handler to give an emptybuffer to the VSD (for example, during a record operation). When the buffer has been filled, the VSD is responsible for communicating to the caller that the buffer has been filled. The VSD should pass a MSG_ REPORTINTstructure to the pSHDEntryPointin DDCMDREGISTERto inform the caller.
pRequestis a pointer to DDCMDREADWRITEstructure.
DDCMD_REG_STREAM This subcommand of VSD_DDCMD registers a stream instance with the device driver. pRequestis a pointer to DDCMDREGISTERstructure.
DDCMD_SETUP This subcommand of VSD_DDCMD performs device-specific stream instance setup. pRequestis a pointer to DDCMDSETUPstructure.
DDCMD_STATUS This VSD subcommand requests streaming status from a device. Typically, it is called to request the current stream time. pRequestis a pointer to DDCMDSTATUSstructure.
DDCMD_WRITE This VSD subcommand is used by a stream handler to give a fullbuffer to the VSD (for example, during a playback operation). When the buffer has been consumed, the VSD is responsible for communicating to the caller that the buffer has been used. The VSD should pass a MSG_REPORTINTstructure to the pSHDEntryPointin DDCMDREGISTERto inform the caller.
pRequestis a pointer to DDCMDREADWRITEstructure.
VSD_DDCMD Parameter - pRequest
pRequest(PVOID) The value of pRequestvaries according to the ulFlagsvalue. See each particular ulFlagsvalue for the definition of pRequest.
VSD_DDCMD Return Value - rc
rc(ULONG) Possible error codes vary according to the value of ulFlags.
VSD_DDCMD - Syntax
Stream handlers can communicate to their attached devices using the VSD_ DDCMD call. The DDCMD interface is the primary method of moving data to and from devices in OS/2 multimedia. See the OS/2 Multimedia Programming Referencefor more detailed information on stream handler command (SHC) messages.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_DDCMD.
ulFlags(ULONG) The following flags (subcommands) are defined for this command:
DDCMD_CONTROL This subcommand of VSD_DDCMD performs a device-specific command. pRequestis a pointer to the DDCMDCONTROLstructure.
DDCMD_DEREG_STREAM This subcommand of VSD_DDCMD deregisters a stream instance with the device driver. pRequestis a pointer to DDCMDDEREGISTERstructure.
DDCMD_READ This subcommand of VSD_DDCMD is used by a stream handler to give an emptybuffer to the VSD (for example, during a record operation). When the buffer has been filled, the VSD is responsible for communicating to the caller that the buffer has been filled. The VSD should pass a MSG_ REPORTINTstructure to the pSHDEntryPointin DDCMDREGISTERto inform the caller.
pRequestis a pointer to DDCMDREADWRITEstructure.
DDCMD_REG_STREAM This subcommand of VSD_DDCMD registers a stream instance with the device driver. pRequestis a pointer to DDCMDREGISTERstructure.
DDCMD_SETUP This subcommand of VSD_DDCMD performs device-specific stream instance setup. pRequestis a pointer to DDCMDSETUPstructure.
DDCMD_STATUS This VSD subcommand requests streaming status from a device. Typically, it is called to request the current stream time. pRequestis a pointer to DDCMDSTATUSstructure.
DDCMD_WRITE This VSD subcommand is used by a stream handler to give a fullbuffer to the VSD (for example, during a playback operation). When the buffer has been consumed, the VSD is responsible for communicating to the caller that the buffer has been used. The VSD should pass a MSG_REPORTINTstructure to the pSHDEntryPointin DDCMDREGISTERto inform the caller.
pRequestis a pointer to DDCMDREADWRITEstructure.
pRequest(PVOID) The value of pRequestvaries according to the ulFlagsvalue. See each particular ulFlagsvalue for the definition of pRequest.
rc(ULONG) Possible error codes vary according to the value of ulFlags.
VSD_DDCMD - Remarks
A user-level 32-bit buffer pointer is available in the pProcessLinfield of the DDCMDREADWRITE. VSDs should use this pointer if they want to operate on the data while they are not in protect mode. The pBufferfield of the DDCMDREADWRITEcontains a pointer whose address type was specified by the VSD on DDCMD_REG_STREAM. When the application returns a buffer, it must return the buffer specified by pBufferand notby pProcessLin
VSD_DDCMD - Topics
Select an item:
Syntax Returns Remarks Glossary
VSD_GETDEVCAPS
Select an item:
Syntax Returns Remarks Example Code Glossary
This command queries the device capabilities. These values should be constants that describe the device and driver characteristics. In general, the flags indicate what set of commands are supported. VSD_GETDEVCAPS is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_GETDEVCAPS.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_GETDEVCAPS_PARMS) Pointer to the VSD_GETDEVCAPS_PARMSdata structure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_REQUEST_BUF_TOO_SMALL The ulLengthin the request packet is too small.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_HARDWARE A hardware error occurred.
VSD_GETDEVCAPS Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_GETDEVCAPS Parameter - ulFunc
ulFunc(ULONG) Set to VSD_GETDEVCAPS.
VSD_GETDEVCAPS Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_GETDEVCAPS Parameter - pRequest
pRequest(PVSD_GETDEVCAPS_PARMS) Pointer to the VSD_GETDEVCAPS_PARMSdata structure.
VSD_GETDEVCAPS Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_REQUEST_BUF_TOO_SMALL The ulLengthin the request packet is too small.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_HARDWARE A hardware error occurred.
VSD_GETDEVCAPS - Syntax
This command queries the device capabilities. These values should be constants that describe the device and driver characteristics. In general, the flags indicate what set of commands are supported. VSD_GETDEVCAPS is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_GETDEVCAPS.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_GETDEVCAPS_PARMS) Pointer to the VSD_GETDEVCAPS_PARMSdata structure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_REQUEST_BUF_TOO_SMALL The ulLengthin the request packet is too small.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_HARDWARE A hardware error occurred.
VSD_GETDEVCAPS - Remarks
This command requires the device to be opened. A device might have several types of device units, so this command must know which instance is involved . Once the device is opened, the device capabilities should be constant.
Each element in the bSupports[DC_MAX_DEVCAP]array of the VSD_GETDEVCAPS_ PARMSstructure is a boolean value that indicates if the capability is supported. TRUE indicates that it is supported. FALSE indicates that it is not supported.
VSD_GETDEVCAPS - Example Code
The following code illustrates how to determine device capabilities for a VSD.
HVSD hvsd;
VSD_GETDEVCAPS_PARMS vsdDevCaps;
rc = pInstance->pfnAUDIOIF( hvsd,
VSD_GETDEVCAPS
0,
(PVOID) &vsdDevCaps );
if (!rc)
{
/* If the VSD doesn't support volume */
if( !vsdDevCaps.bSupports[ DC_HASVOLUME] )
{
return ( rc );
}
VSD_GETDEVCAPS - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_ESCAPE
Select an item:
Syntax Returns Glossary
This optional command sends a buffer to the driver.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_ESCAPE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_ESCAPE_PARMS) A pointer to the VSD_ESCAPE_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_ESCAPE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_ESCAPE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_ESCAPE.
VSD_ESCAPE Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_ESCAPE Parameter - pRequest
pRequest(PVSD_ESCAPE_PARMS) A pointer to the VSD_ESCAPE_PARMSstructure.
VSD_ESCAPE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_ESCAPE - Syntax
This optional command sends a buffer to the driver.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_ESCAPE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_ESCAPE_PARMS) A pointer to the VSD_ESCAPE_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_ESCAPE - Topics
Select an item:
Syntax Returns Glossary
VSD_INSERTSETTINGSPAGE
Select an item:
Syntax Returns Glossary
This command enables a VSD to insert device-specific settings pages into the system configuration application.
hvsd(HVSD) Handle to a VSD instance.
ulFunc(ULONG) Set to VSD_INSERTSETTINGSPAGE.
ulFlags(ULONG) No flags used for this command.
pRequest(PMCI_DEVICESETTINGS_PARMS) Pointer to the MCI_DEVICESETTINGS_ PARMSdata structure.
hwndRC(HWND) The return code contains the handle to a settings page or zero if no page is inserted.
VSD_INSERTSETTINGSPAGE Parameter - hvsd
hvsd(HVSD) Handle to a VSD instance.
VSD_INSERTSETTINGSPAGE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_INSERTSETTINGSPAGE.
VSD_INSERTSETTINGSPAGE Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_INSERTSETTINGSPAGE Parameter - pRequest
pRequest(PMCI_DEVICESETTINGS_PARMS) Pointer to the MCI_DEVICESETTINGS_ PARMSdata structure.
VSD_INSERTSETTINGSPAGE Return Value - hwndRC
hwndRC(HWND) The return code contains the handle to a settings page or zero if no page is inserted.
VSD_INSERTSETTINGSPAGE - Syntax
This command enables a VSD to insert device-specific settings pages into the system configuration application.
hvsd(HVSD) Handle to a VSD instance.
ulFunc(ULONG) Set to VSD_INSERTSETTINGSPAGE.
ulFlags(ULONG) No flags used for this command.
pRequest(PMCI_DEVICESETTINGS_PARMS) Pointer to the MCI_DEVICESETTINGS_ PARMSdata structure.
hwndRC(HWND) The return code contains the handle to a settings page or zero if no page is inserted.
VSD_INSERTSETTINGSPAGE - Topics
Select an item:
Syntax Returns Glossary
VSD_OPEN
Select an item:
Syntax Returns Remarks Example Code Glossary
This command opens the device driver and returns a VSD handle or (HVSD). It should not allocate resources on the device (resource usage should be performed on the VSD restore).
VSD_OPEN is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Not used.
ulFunc(ULONG) Set to VSD_OPEN.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_OPEN_PARMS) Pointer to the VSD_OPEN_PARMSdata structure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_NO_DEVICE_DRIVER VSD is not connected to a device driver.
VSDERR_DEVICE_REJECTED Device driver rejected the request.
VSDERR_HARDWARE A hardware error occurred.
VSDERR_INVALID_BUFF pRequestis not valid.
VSD_OPEN Parameter - hvsd
hvsd(HVSD) Not used.
VSD_OPEN Parameter - ulFunc
ulFunc(ULONG) Set to VSD_OPEN.
VSD_OPEN Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_OPEN Parameter - pRequest
pRequest(PVSD_OPEN_PARMS) Pointer to the VSD_OPEN_PARMSdata structure.
VSD_OPEN Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_NO_DEVICE_DRIVER VSD is not connected to a device driver.
VSDERR_DEVICE_REJECTED Device driver rejected the request.
VSDERR_HARDWARE A hardware error occurred.
VSDERR_INVALID_BUFF pRequestis not valid.
VSD_OPEN - Syntax
This command opens the device driver and returns a VSD handle or (HVSD). It should not allocate resources on the device (resource usage should be performed on the VSD restore).
VSD_OPEN is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Not used.
ulFunc(ULONG) Set to VSD_OPEN.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_OPEN_PARMS) Pointer to the VSD_OPEN_PARMSdata structure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_NO_DEVICE_DRIVER VSD is not connected to a device driver.
VSDERR_DEVICE_REJECTED Device driver rejected the request.
VSDERR_HARDWARE A hardware error occurred.
VSDERR_INVALID_BUFF pRequestis not valid.
VSD_OPEN - Remarks
The installation name of the media control driver (MCD) is passed in so that the VSD can query device-specific parameters from the INI file.
For an audio VSD, the pDevInfopointer points to a VSD_AUDIOOPEN_PARMSstructure. This structure contains enough information to initialize the audio device. The VSD is responsible for filling in the ulDataSubTypefield of the VSD_AUDIOOPEN_PARMSstructure with a valid data subtype.
VSD_OPEN - Example Code
The following code illustrates how to open an audio VSD.
VSD_OPEN_PARMS vsdOpenParms;
VSD_AUDIOOPEN_PARMS vsdData;
vsdData.ulLength = sizeof(VSD_AUDIOOPEN_PARMS);
vsdData.ulFlags = 0;
vsdData.ulSamplingRate = pInstance->lSRate;
vsdData.ulBitsPerSample = pInstance->lBitsPerSRate;
vsdData.ulChannels = pInstance->sChannels;
vsdData.ulDataType = pInstance->sMode;
vsdData.ulDeviceID = pInstance->ulDeviceID;
vsdData.ulOperation = pInstance->ulOperation;
vsdOpenParms.pDevInfo = (PVOID)&vsdData;
vsdOpenParms.ulLength = sizeof(VSD_OPEN_PARMS);
memmove(&vsdOpenParms.szPDDName,
pInstance->szDeviceName,
strlen(pInstance->szDeviceName));
/* Open the audio VSD */
rc = pInstance->pfnAUDIOIF(0,
VSD_OPEN,
0L
(PVOID)&vsdOpenParms);
if (!rc)
}
pInstance->hvsd = vsdOpenParms.hvsd;
{
VSD_OPEN - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_QUERY
Select an item:
Syntax Returns Remarks Glossary
This command allows an application to query the status of the VSD.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) The following flags can be used with VSD_QUERY:
VSD_QUERYAUDIOATTRIBUTES See VSD_QUERYAUDIOATTRIBUTES.
VSD_QUERYCONNECTOR See VSD_QUERYCONNECTOR.
VSD_QUERYDATATYPE See VSD_QUERYDATATYPE.
VSD_QUERYMONITOR See VSD_QUERYMONITOR.
VSD_QUERYVOLUME See VSD_QUERYVOLUME.
VSD_QUERYMIXCONNECTIONS See VSD_QUERYMIXCONNECTIONS.
VSD_QUERYMIXCONTROL See VSD_QUERYMIXCONTROL.
VSD_QUERYMIXLINE See VSD_QUERYMIXLINE.
pRequest(PVOID) Pointer varies according to ulFlags.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERY Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERY Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERY Parameter - ulFlags
ulFlags(ULONG) The following flags can be used with VSD_QUERY:
VSD_QUERYAUDIOATTRIBUTES See VSD_QUERYAUDIOATTRIBUTES.
VSD_QUERYCONNECTOR See VSD_QUERYCONNECTOR.
VSD_QUERYDATATYPE See VSD_QUERYDATATYPE.
VSD_QUERYMONITOR See VSD_QUERYMONITOR.
VSD_QUERYVOLUME See VSD_QUERYVOLUME.
VSD_QUERYMIXCONNECTIONS See VSD_QUERYMIXCONNECTIONS.
VSD_QUERYMIXCONTROL See VSD_QUERYMIXCONTROL.
VSD_QUERYMIXLINE See VSD_QUERYMIXLINE.
VSD_QUERY Return Value - pRequest
pRequest(PVOID) Pointer varies according to ulFlags.
VSD_QUERY Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERY - Syntax
This command allows an application to query the status of the VSD.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) The following flags can be used with VSD_QUERY:
VSD_QUERYAUDIOATTRIBUTES See VSD_QUERYAUDIOATTRIBUTES.
VSD_QUERYCONNECTOR See VSD_QUERYCONNECTOR.
VSD_QUERYDATATYPE See VSD_QUERYDATATYPE.
VSD_QUERYMONITOR See VSD_QUERYMONITOR.
VSD_QUERYVOLUME See VSD_QUERYVOLUME.
VSD_QUERYMIXCONNECTIONS See VSD_QUERYMIXCONNECTIONS.
VSD_QUERYMIXCONTROL See VSD_QUERYMIXCONTROL.
VSD_QUERYMIXLINE See VSD_QUERYMIXLINE.
pRequest(PVOID) Pointer varies according to ulFlags.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERY - Remarks
This command uses flags to indicate what information is queried.
VSD_QUERY - Topics
Select an item:
Syntax Returns Remarks Glossary
VSD_QUERYAUDIOATTRIBUTES
Select an item:
Syntax Returns Remarks Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the current audio settings and capabilities. A valid length must be placed in the ulLengthfield of the VSD_AUDIOATTRIBUTES_PARMSstructure and the audio setting (such as treble, bass, and so on) must be placed in the ulFlagsfield of the VSD_ AUDIOATTRIBUTES_PARMSstructure.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYAUDIOATTRIBUTES.
pRequest(PVSD_AUDIOATTRIBUTES_PARMS) Pointer to the VSD_AUDIOATTRIBUTES_ PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYAUDIOATTRIBUTES Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYAUDIOATTRIBUTES Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYAUDIOATTRIBUTES Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYAUDIOATTRIBUTES.
VSD_QUERYAUDIOATTRIBUTES Parameter - pRequest
pRequest(PVSD_AUDIOATTRIBUTES_PARMS) Pointer to the VSD_AUDIOATTRIBUTES_ PARMSstructure.
VSD_QUERYAUDIOATTRIBUTES Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYAUDIOATTRIBUTES - Syntax
This subcommand of the VSD_QUERYcommand queries the current audio settings and capabilities. A valid length must be placed in the ulLengthfield of the VSD_AUDIOATTRIBUTES_PARMSstructure and the audio setting (such as treble, bass, and so on) must be placed in the ulFlagsfield of the VSD_ AUDIOATTRIBUTES_PARMSstructure.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYAUDIOATTRIBUTES.
pRequest(PVSD_AUDIOATTRIBUTES_PARMS) Pointer to the VSD_AUDIOATTRIBUTES_ PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYAUDIOATTRIBUTES - Remarks
All values are returned in the ulValuefield and can range from 0 - 100.
VSD_QUERYAUDIOATTRIBUTES - Example Code
The following code illustrates how to query audio attribute information from the VSD.
HVSD hvsd;
VSD_AUDIOATTRIBUTES_PARMS vsdAttr;
/* Prime the structure with necessary values */
vsdAttr.ulLength = sizeof (VSD_AUDIOATTRIBUTES_PARMS);
vsdAttr.ulFlags = VSD_BASS;
/*---------------------------------------------
* Ask the VSD to either set or query an audio
* attribute. The caller determines whether
* to set or query via the command variable.
*---------------------------------------------*/
rc = pInstance->pfnAUDIOIF(hvsd,
VSD_QUERY,
VSD_QUERYAUDIOATTRIBUTES,
(PVOID)&vsdAttr);
/* If Bass value is too high then...*/
if (!rc)
{
if (vsdAttr.ulValue > 70)
{
}
VSD_QUERYAUDIOATTRIBUTES - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_QUERYCONNECTOR
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the state of the connector . (A connector can be a hardware or software connection on the device the VSD is controlling.) If the connector is enabled, the fEnabledfield of the VSD_CONNECTOR_PARMSstructure will contain MCI_TRUE, otherwise it will contain MCI_FALSE. For further information regarding connectors, refer to the MCI connector command in the OS/2 Multimedia Programming Reference. Valid connectors can be found in MCIOS2.H.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYCONNECTOR.
pRequest(PVSD_CONNECTOR_PARMS) A pointer to the VSD_CONNECTOR_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_UNSUPPORTED_CONN_TYPE Connector type not supported.
VSDERR_INVALID_CONNECTOR_TYPE Invalid connector type.
VSDERR_INVALID_CONNECTOR_INDEX Invalid connector index.
VSDERR_CANNOT_MODIFY_CONNECTOR Cannot enable or disable this connector.
VSDERR_INVALID_CONNECTOR Invalid connector.
VSDERR_UNSUPPORTED_CONNECTOR Unsupported connector.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYCONNECTOR Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYCONNECTOR Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYCONNECTOR Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYCONNECTOR.
VSD_QUERYCONNECTOR Parameter - pRequest
pRequest(PVSD_CONNECTOR_PARMS) A pointer to the VSD_CONNECTOR_PARMSstructure.
VSD_QUERYCONNECTOR Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_UNSUPPORTED_CONN_TYPE Connector type not supported.
VSDERR_INVALID_CONNECTOR_TYPE Invalid connector type.
VSDERR_INVALID_CONNECTOR_INDEX Invalid connector index.
VSDERR_CANNOT_MODIFY_CONNECTOR Cannot enable or disable this connector.
VSDERR_INVALID_CONNECTOR Invalid connector.
VSDERR_UNSUPPORTED_CONNECTOR Unsupported connector.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYCONNECTOR - Syntax
This subcommand of the VSD_QUERYcommand queries the state of the connector . (A connector can be a hardware or software connection on the device the VSD is controlling.) If the connector is enabled, the fEnabledfield of the VSD_CONNECTOR_PARMSstructure will contain MCI_TRUE, otherwise it will contain MCI_FALSE. For further information regarding connectors, refer to the MCI connector command in the OS/2 Multimedia Programming Reference. Valid connectors can be found in MCIOS2.H.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYCONNECTOR.
pRequest(PVSD_CONNECTOR_PARMS) A pointer to the VSD_CONNECTOR_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_UNSUPPORTED_CONN_TYPE Connector type not supported.
VSDERR_INVALID_CONNECTOR_TYPE Invalid connector type.
VSDERR_INVALID_CONNECTOR_INDEX Invalid connector index.
VSDERR_CANNOT_MODIFY_CONNECTOR Cannot enable or disable this connector.
VSDERR_INVALID_CONNECTOR Invalid connector.
VSDERR_UNSUPPORTED_CONNECTOR Unsupported connector.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYCONNECTOR - Example Code
The following code illustrates how to query the state of the connector.
HVSD hvsd;
VSD_CONNECTOR_PARMS vsdConn;
vsdConn.ulConn_Type = pConnector->ulConnectorType;
vsdConn.ulIndex = pConnector->ulConnectorIndex;
lError = pInstance->pfnNewVSD(hvsd,
VSD_QUERY,
VSD_QUERYCONNECTOR,
(PVOID)&vsdConn);
prConnector->ulReturn = vsdConn.fEnabled;
VSD_QUERYCONNECTOR - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_QUERYDATATYPE
Select an item:
Syntax Returns Remarks Example Code Glossary
This subcommand of the VSD_QUERYcommand queries if a particular set of data types are supported. The ulSamplingRate, ulBitsPerSample, ulChannels, and ulDataTypewill be filled in on input. The ulDataSubTypeis filled in by the VSD on output. If the current mode is not supported, the VSD should fill in the ulSamplingRate, ulBitsPerSample, and ulChannelswith the closest that it supports.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYDATATYPE.
pRequest(PVSD_AUDIODATATYPE_PARMS) Pointer to the VSD_AUDIODATATYPE_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYDATATYPE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYDATATYPE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYDATATYPE Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYDATATYPE.
VSD_QUERYDATATYPE Parameter - pRequest
pRequest(PVSD_AUDIODATATYPE_PARMS) Pointer to the VSD_AUDIODATATYPE_PARMSstructure.
VSD_QUERYDATATYPE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYDATATYPE - Syntax
This subcommand of the VSD_QUERYcommand queries if a particular set of data types are supported. The ulSamplingRate, ulBitsPerSample, ulChannels, and ulDataTypewill be filled in on input. The ulDataSubTypeis filled in by the VSD on output. If the current mode is not supported, the VSD should fill in the ulSamplingRate, ulBitsPerSample, and ulChannelswith the closest that it supports.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYDATATYPE.
pRequest(PVSD_AUDIODATATYPE_PARMS) Pointer to the VSD_AUDIODATATYPE_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_QUERYDATATYPE - Remarks
This command is typically sent by applications which need to determine if the VSD supports a particular datatype.
VSD_QUERYDATATYPE - Example Code
The following code illustrates the use of VSD_QUERYDATATYPE:
HVSD hvsd;
VSD_AUDIODATATYPE_PARMS AudioCaps;
/*---------------------------------------
* Tell the VSD that we want to enable a
* connector.
*---------------------------------------*/
rc = pInstance->pfnNewVSD( hvsd ,
VSD_QUERY,
VSD_QUERYDATATYPE,
(PVOID ) &AudioCaps );
if ( rc )
{
rc = MCIERR_INVALID_CONNECTION ;
return (rc);
}
else
{
rc = MCIERR_SUCCESS;
}
return ( rc );
} /* TestConnection */
VSD_QUERYDATATYPE - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_QUERYMIXCONNECTIONS
Select an item:
Syntax Returns Remarks Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the output that a particular VSD line (or connector) is routed to. For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMIXCONNECTIONS.
pRequest(PLINECONNECTIONS) A pointer to the LINECONNECTIONSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXCONNECTIONS Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYMIXCONNECTIONS Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYMIXCONNECTIONS Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYMIXCONNECTIONS.
VSD_QUERYMIXCONNECTIONS Parameter - pRequest
pRequest(PLINECONNECTIONS) A pointer to the LINECONNECTIONSstructure.
VSD_QUERYMIXCONNECTIONS Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXCONNECTIONS - Syntax
This subcommand of the VSD_QUERYcommand queries the output that a particular VSD line (or connector) is routed to. For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMIXCONNECTIONS.
pRequest(PLINECONNECTIONS) A pointer to the LINECONNECTIONSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXCONNECTIONS - Remarks
The ulConnectionsfield of the LINECONNECTIONSstructure returns the particular output that a line is routed to. The ulLinefield of the LINECONNECTIONSstructure must contain a valid line on input. For more information on the values for ulLineand ulConnections, see the LINECONNECTIONSstructure.
VSD_QUERYMIXCONNECTIONS - Example Code
The following code illustrates how to query the output that a particular line is routed to.
HVSD hvsd;
LINECONNECTIONS LineCon;
/* Find out the setting for the synth. */
LineCon.ulLine = SOURCE_SYNTHESIZER;
LineCon.ulLength = sizeof(MIXERLINEINFO);
/* Ask VSD for the capabilities of this line. */
rc = pInstance->(hvsd,
VSD_QUERY,
VSD_QUERYMIXCONNECTIONS,
(PVOID)&LineCon);
/* Are we connected to the amp or record outputs... */
if (LineCon.ulConnection & (SINK_SPEAKERS))
{
pMixParms->ulReturn = MCI_OUTPUT_AMP;
}
else
{
pMixParms->ulReturn = MCI_OUTPUT_DIGITALAUDIO;
}
VSD_QUERYMIXCONNECTIONS - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_QUERYMIXCONTROL
Select an item:
Syntax Returns Remarks Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the audio attributes for an audio VSD connector (for example, the treble setting on a microphone connector). For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMIXCONTROL.
pRequest(PMIXERCONTROL) A pointer to the MIXERCONTROLstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXCONTROL Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYMIXCONTROL Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYMIXCONTROL Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYMIXCONTROL.
VSD_QUERYMIXCONTROL Parameter - pRequest
pRequest(PMIXERCONTROL) A pointer to the MIXERCONTROLstructure.
VSD_QUERYMIXCONTROL Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXCONTROL - Syntax
This subcommand of the VSD_QUERYcommand queries the audio attributes for an audio VSD connector (for example, the treble setting on a microphone connector). For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMIXCONTROL.
pRequest(PMIXERCONTROL) A pointer to the MIXERCONTROLstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXCONTROL - Remarks
The ulLinefield of the MIXERCONTROLstructure must be filled in with one of the VSD sources/sinks in the low-order byte of the low word.
The ulControlfield of the MIXERCONTROLstructure must be filled in with the desired setting. For stereo controls, the high-order word of this field contains the left channel setting and the low-order word contains the right channel setting. A value of 0xFFFF represents full intensity and a value of 0x0000 is full cutout.
VSD_QUERYMIXCONTROL - Example Code
The following code illustrates how to query the settings of audio attributes for a particular connector.
HVSD hvsd;
MIXERCONTROL MixerControl;
USHORT usBass;
/* Find out the setting for the synth. */
MixerControl.ulLine = SOURCE_SYNTHESIZER;
/* Ask VSD what is the current setting of the connector. */
MixerControl.ulControl = MIX_BASS;
rc = pInstance->(hvsd,
VSD_QUERY,
VSD_QUERYMIXCONTROL,
(PVOID)&MixerControl);
usBass = (MixControl.ulSetting)
}
VSD_QUERYMIXCONTROL - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_QUERYMIXLINE
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the audio attributes that are supported for the given VSD connector. For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMIXLINE.
pRequest(PMIXERLINEINFO) A pointer to the MIXERLINEINFOstructure. The ulSupportfield will be filled by the VSD with the supported setting or settings if the line supports multiple settings. The ulLinefield must be filled in by the caller.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXLINE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYMIXLINE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYMIXLINE Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYMIXLINE.
VSD_QUERYMIXLINE Parameter - pRequest
pRequest(PMIXERLINEINFO) A pointer to the MIXERLINEINFOstructure. The ulSupportfield will be filled by the VSD with the supported setting or settings if the line supports multiple settings. The ulLinefield must be filled in by the caller.
VSD_QUERYMIXLINE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXLINE - Syntax
This subcommand of the VSD_QUERYcommand queries the audio attributes that are supported for the given VSD connector. For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMIXLINE.
pRequest(PMIXERLINEINFO) A pointer to the MIXERLINEINFOstructure. The ulSupportfield will be filled by the VSD with the supported setting or settings if the line supports multiple settings. The ulLinefield must be filled in by the caller.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_QUERYMIXLINE - Example Code
The following code illustrates how to query the supported audio attributes from a mixer connector.
HVSD hvsd;
MIXERLINEINFO mixerinfo;
mixerinfo.ulLine = SYNTHESIZER_INPUT;
mixerinfo.ulLength = sizeof(MIXERLINEINFO);
rc = pInstance->pfnAUDIOIF( hsvd,
VSD_QUERY,
VSD_QUERYMIXLINE,
(PVOID) &mixerinfo);
if(!rc)
if(mixerinfo.ulSupport & MIX_VOLUME)
{
/* process volume */
}
} /* If no errors */
VSD_QUERYMIXLINE - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_QUERYMONITOR
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the device to determine if audio monitoring is enabled. The VSD returns TRUE if the monitor is enabled and FALSE if it is disabled.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD instance.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMONITOR.
pRequest(PULONG) Output.
rc(ULONG) VSD returns TRUE if the monitor is enabled and FALSE if it is disabled.
VSD_QUERYMONITOR Parameter - hvsd
hvsd(HVSD) Handle to a VSD instance.
VSD_QUERYMONITOR Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYMONITOR Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYMONITOR.
VSD_QUERYMONITOR Parameter - pRequest
pRequest(PULONG) Output.
VSD_QUERYMONITOR Return Value - rc
rc(ULONG) VSD returns TRUE if the monitor is enabled and FALSE if it is disabled.
VSD_QUERYMONITOR - Syntax
This subcommand of the VSD_QUERYcommand queries the device to determine if audio monitoring is enabled. The VSD returns TRUE if the monitor is enabled and FALSE if it is disabled.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD instance.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYMONITOR.
pRequest(PULONG) Output.
rc(ULONG) VSD returns TRUE if the monitor is enabled and FALSE if it is disabled.
VSD_QUERYMONITOR - Example Code
The following code illustrates how to query the state of monitoring.
rc = pInstance->pfnAUDIOIF((HVSD)pInstance->hvsd,
VSD_QUERY,
VSD_QUERYMONITOR,
(PVOID)&pStat->ulReturn);
VSD_QUERYMONITOR - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_QUERYSTATUSLEVEL
Select an item:
Syntax Returns Glossary
This subcommand of the VSD_QUERYcommand queries the status of the audio input level (percentage). This command is optional.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYSTATUSLEVEL.
pRequest(PULONG) Current level of device.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_QUERYSTATUSLEVEL Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYSTATUSLEVEL Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYSTATUSLEVEL Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYSTATUSLEVEL.
VSD_QUERYSTATUSLEVEL Parameter - pRequest
pRequest(PULONG) Current level of device.
VSD_QUERYSTATUSLEVEL Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_QUERYSTATUSLEVEL - Syntax
This subcommand of the VSD_QUERYcommand queries the status of the audio input level (percentage). This command is optional.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYSTATUSLEVEL.
pRequest(PULONG) Current level of device.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_QUERYSTATUSLEVEL - Topics
Select an item:
Syntax Returns Glossary
VSD_QUERYVOLUME
Select an item:
Syntax Returns Remarks Example Code Glossary
This subcommand of the VSD_QUERYcommand queries the volume level. The volume is returned as a percentage between 0% and 100%
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYVOLUME.
pRequest(PVSD_VOLUME_PARMS) Pointer to the VSD_VOLUME_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful. field.
VSD_QUERYVOLUME Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_QUERYVOLUME Parameter - ulFunc
ulFunc(ULONG) Set to VSD_QUERY.
VSD_QUERYVOLUME Parameter - ulFlags
ulFlags(ULONG) Set to VSD_QUERYVOLUME.
VSD_QUERYVOLUME Parameter - pRequest
pRequest(PVSD_VOLUME_PARMS) Pointer to the VSD_VOLUME_PARMSstructure.
VSD_QUERYVOLUME Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful. field.
VSD_QUERYVOLUME - Syntax
This subcommand of the VSD_QUERYcommand queries the volume level. The volume is returned as a percentage between 0% and 100%
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_QUERY.
ulFlags(ULONG) Set to VSD_QUERYVOLUME.
pRequest(PVSD_VOLUME_PARMS) Pointer to the VSD_VOLUME_PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful. field.
VSD_QUERYVOLUME - Remarks
On return, the VSD will fill in the ulVolumefield of the VSD_VOLUME_PARMSstructure.
VSD_QUERYVOLUME - Example Code
The following code illustrates how to query audio volume from the VSD.
VSD_VOLUME_PARMS vsdVol;
ULONG ulVol;
vsdVol.ulLength = sizeof(VSD_VOLUME_PARMS);
vsdVol.ulFlags = ulFlags;
/*------------------------------------------
* Ask the VSD to query audio volume.
*------------------------------------------*/
rc = pInstance->pfnAUDIOIF((HVSD)pInstance->hvsd,
VSD_QUERY,
VSD_QUERYVOLUME,
(PVOID)&vsdVol);
ulVol = vsdvol.ulVolume;
VSD_QUERYVOLUME - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_RESOURCE
Select an item:
Syntax Returns Remarks Example Code Glossary
This command can be issued only when the device is opened and is used for resource management.
VSD_RESOURCE is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_RESOURCE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_RESOURCE_PARMS) Pointer to the VSD_RESOURCE_PARMSdata structure.
The driver is responsible for filling in the ulResUnitsand ulClassfields. The caller is responsible for filling in the ulDataTypefield.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters is missing.
VSD_RESOURCE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_RESOURCE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_RESOURCE.
VSD_RESOURCE Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_RESOURCE Parameter - pRequest
pRequest(PVSD_RESOURCE_PARMS) Pointer to the VSD_RESOURCE_PARMSdata structure.
The driver is responsible for filling in the ulResUnitsand ulClassfields. The caller is responsible for filling in the ulDataTypefield.
VSD_RESOURCE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters is missing.
VSD_RESOURCE - Syntax
This command can be issued only when the device is opened and is used for resource management.
VSD_RESOURCE is a required command and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_RESOURCE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVSD_RESOURCE_PARMS) Pointer to the VSD_RESOURCE_PARMSdata structure.
The driver is responsible for filling in the ulResUnitsand ulClassfields. The caller is responsible for filling in the ulDataTypefield.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS Command completed successfully.
VSDERR_MISSING_PARAMETER One or more parameters is missing.
VSD_RESOURCE - Remarks
When an audio device driver is installed in MMPM/2, the installation routines place the following three keywords in the MMPM2.INI file:
�RESOURCEUNITS=
�RESOURCECLASS=
�VALIDCOMBINATIONS=
Because MMPM/2 allows many applications to simultaneously open the audio card, it uses these keywords to determine which applications can simultaneously use the audio device. All of the numbers are arbitrary and are defined on a device-by-device basis. However, device driver writers should use the numbering scheme defined below:
The keyword RESOURCECLASSESindicates the different resource types available on the audio device. The first parameter is the number of classes and it is followed by a listing of classes. A vendor should provide a class for each data type that they support. For instance, if the XYZ audio card can only play PCM files, it would only have one resource class - the PCM class. However, if the ABC audio card can play PCM, MIDI, and ADPCM, then it would have three classes. The VSD should fill in the ulClassfield with the class that is appropriate for this mode.
The keyword RESOURCEUNITSindicates the maximum number of instances that can be active on the card at any particular time. For example, if the XYZ card mentioned above had the ability to play three PCM files at the same time, the RESOURCEUNITS for this card would be three. In contrast, the ABC card can only play one PCM file and one MIDI file at any one time. Therefore, its resource units should be two. The VSD should fill in the ulResUnitsfield with the correct number of resources for the current mode (typically, one).
VSD_RESOURCE - Example Code
The following code illustrates how to determine the number of resources consumed for a particular mode on an audio VSD.
HVSD hvsd;
rc = pInstance->pfnAUDIOIF( hvsd,
VSD_RESOURCE,
0L,
(PVOID)&vsdResourceParms );
pInstance->ulResourcesUsed = vsdResourceParms.ulResUnits;
pInstance->ulClass = vsdResourceParms.ulClass;
VSD_RESOURCE - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_RESTORE
Select an item:
Syntax Returns Remarks Example Code Glossary
This command restores the current state of the device. VSD_RESTORE is a required function and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_RESTORE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVOID) Not used with this command.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command completed successfully.
VSD_RESTORE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_RESTORE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_RESTORE.
VSD_RESTORE Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_RESTORE Parameter - pRequest
pRequest(PVOID) Not used with this command.
VSD_RESTORE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command completed successfully.
VSD_RESTORE - Syntax
This command restores the current state of the device. VSD_RESTORE is a required function and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_RESTORE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVOID) Not used with this command.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command completed successfully.
VSD_RESTORE - Remarks
MMPM/2 supports the concept of suspending and resuming the state of a device at any point in time. Unlike other environments, multiple applications can simultaneously have a device open and the Media Device Manager will cooperate with the VSD in order to manage the device. The VSD is responsible for saving and restoring the actual hardware device. For further information, see the OS/2 Multimedia Programming Reference(MCI_ RESTORE).
VSD_RESTORE - Example Code
The following code illustrates how to activate an audio VSD using VSD_ RESTORE.
ULONG rc;
HVSD hvsd;
rc = pInstance->pfnAUDIOIF( hvsd,
VSD_RESTORE,
0L,
0 );
return(rc)
VSD_RESTORE - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_SAVE
Select an item:
Syntax Returns Remarks Example Code Glossary
This command saves the current state of the device. VSD_SAVE is a required function and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_SAVE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVOID) Not used with this command.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_SAVE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SAVE Parameter - ulFunc
ulFunc(ULONG) Set to VSD_SAVE.
VSD_SAVE Parameter - ulFlags
ulFlags(ULONG) No flags used for this command.
VSD_SAVE Parameter - pRequest
pRequest(PVOID) Not used with this command.
VSD_SAVE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_SAVE - Syntax
This command saves the current state of the device. VSD_SAVE is a required function and must be implemented by all VSD writers.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_SAVE.
ulFlags(ULONG) No flags used for this command.
pRequest(PVOID) Not used with this command.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_SAVE - Remarks
MMPM/2 supports the concept of suspending and resuming the state of a device at any point in time. Unlike other environments, multiple applications can simultaneously have a device open and the Media Device Manager will cooperate with the VSD in order to manage the device. The VSD is responsible for saving and restoring the actual hardware device. For further information, see the OS/2 Multimedia Programming Reference(MCIDRV_ SAVE).
VSD_SAVE - Example Code
The following code illustrates how to deactivate an audio VSD using VSD_ SAVE.
ULONG rc;
HVSD hvsd;
rc = pInstance->pfnAUDIOIF( hvsd,
VSD_SAVE,
0L,
0 );
return(rc);
VSD_SAVE - Topics
Select an item:
Syntax Returns Remarks Example Code Glossary
VSD_SET
Select an item:
Syntax Returns Remarks Glossary
This command allows an application to modify the settings of the VSD.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to VSD.
ulFunc(ULONG) Set to VSD_SET.
ulFlags(ULONG) The following flags can be used with VSD_SET.
VSD_SETAUDIOATTRIBUTES See VSD_SETAUDIOATTRIBUTES
VSD_SETCONNECTOR See VSD_SETCONNECTOR
VSD_SETDATATYPE See VSD_SETDATATYPE
VSD_SETMIXCONNECTIONS See VSD_SETMIXCONNECTIONS
VSD_SETMIXCONTROL See VSD_SETMIXCONTROL
VSD_SETMONITOR See VSD_SETMONITOR
VSD_SETVOLUME See VSD_SETVOLUME
pRequest(PVOID) Pointer value varies according to the value of ulFlags.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_INVALID_HVSD The hvsd(VSD handle) is not valid. Verify that the hvsdmatches the one provided on the VSD_OPEN.
VSD_SET Parameter - hvsd
hvsd(HVSD) Handle to VSD.
VSD_SET Parameter - ulFunc
ulFunc(ULONG) Set to VSD_SET.
VSD_SET Parameter - ulFlags
ulFlags(ULONG) The following flags can be used with VSD_SET.
VSD_SETAUDIOATTRIBUTES See VSD_SETAUDIOATTRIBUTES
VSD_SETCONNECTOR See VSD_SETCONNECTOR
VSD_SETDATATYPE See VSD_SETDATATYPE
VSD_SETMIXCONNECTIONS See VSD_SETMIXCONNECTIONS
VSD_SETMIXCONTROL See VSD_SETMIXCONTROL
VSD_SETMONITOR See VSD_SETMONITOR
VSD_SETVOLUME See VSD_SETVOLUME
VSD_SET Parameter - pRequest
pRequest(PVOID) Pointer value varies according to the value of ulFlags.
VSD_SET Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_INVALID_HVSD The hvsd(VSD handle) is not valid. Verify that the hvsdmatches the one provided on the VSD_OPEN.
VSD_SET - Syntax
This command allows an application to modify the settings of the VSD.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to VSD.
ulFunc(ULONG) Set to VSD_SET.
ulFlags(ULONG) The following flags can be used with VSD_SET.
VSD_SETAUDIOATTRIBUTES See VSD_SETAUDIOATTRIBUTES
VSD_SETCONNECTOR See VSD_SETCONNECTOR
VSD_SETDATATYPE See VSD_SETDATATYPE
VSD_SETMIXCONNECTIONS See VSD_SETMIXCONNECTIONS
VSD_SETMIXCONTROL See VSD_SETMIXCONTROL
VSD_SETMONITOR See VSD_SETMONITOR
VSD_SETVOLUME See VSD_SETVOLUME
pRequest(PVOID) Pointer value varies according to the value of ulFlags.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_INVALID_HVSD The hvsd(VSD handle) is not valid. Verify that the hvsdmatches the one provided on the VSD_OPEN.
VSD_SET - Remarks
This messages uses flags to specify what to set on the adapter.
VSD_SET - Topics
Select an item:
Syntax Returns Remarks Glossary
VSD_SETAUDIOATTRIBUTES
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand sets the audio attribute settings. A valid length must be placed in the ulLengthfield of the VSD_ AUDIOATTRIBUTES_PARMSstructure. The audio setting to modify (such as treble, bass, and so on) must be placed in the ulFlagsfield of the VSD_ AUDIOATTRIBUTES_PARMSstructure with the actual corresponding setting in the ulValuefield. The value should be between 0 and 100. The ulDelayindicates the length of time over which this effect should take place.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_SET.
ulFlags(ULONG) Set to VSD_SETAUDIOATTRIBUTES.
pRequest(PVSD_AUDIOATTRIBUTES_PARMS) Pointer to the VSD_AUDIOATTRIBUTES_ PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_SETAUDIOATTRIBUTES Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETAUDIOATTRIBUTES Parameter - ulFunc
ulFunc(ULONG) Set to VSD_SET.
VSD_SETAUDIOATTRIBUTES Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETAUDIOATTRIBUTES.
VSD_SETAUDIOATTRIBUTES Parameter - pRequest
pRequest(PVSD_AUDIOATTRIBUTES_PARMS) Pointer to the VSD_AUDIOATTRIBUTES_ PARMSstructure.
VSD_SETAUDIOATTRIBUTES Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_SETAUDIOATTRIBUTES - Syntax
This subcommand of the VSD_SETcommand sets the audio attribute settings. A valid length must be placed in the ulLengthfield of the VSD_ AUDIOATTRIBUTES_PARMSstructure. The audio setting to modify (such as treble, bass, and so on) must be placed in the ulFlagsfield of the VSD_ AUDIOATTRIBUTES_PARMSstructure with the actual corresponding setting in the ulValuefield. The value should be between 0 and 100. The ulDelayindicates the length of time over which this effect should take place.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFunc(ULONG) Set to VSD_SET.
ulFlags(ULONG) Set to VSD_SETAUDIOATTRIBUTES.
pRequest(PVSD_AUDIOATTRIBUTES_PARMS) Pointer to the VSD_AUDIOATTRIBUTES_ PARMSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSD_SETAUDIOATTRIBUTES - Example Code
The following code illustrates how to set audio attribute information.
VSD_AUDIOATTRIBUTES_PARMS vsdAttr;
/* Prime the structure with necessary values */
vsdAttr.ulLength = sizeof (VSD_AUDIOATTRIBUTES_PARMS);
vsdAttr.ulFlags = VSD_BASS;
vsdAttr.ulValue = 100;
/*---------------------------------------------
* Ask the VSD to either set or query an audio
* attribute. The caller determines whether
* to set or query via the command variable.
*---------------------------------------------*/
rc = pInstance->pfnAUDIOIF((HVSD)pInstance->hvsd,
VSD_SET,
VSD_SETAUDIOATTRIBUTES,
(PVOID)&vsdAttr);
VSD_SETAUDIOATTRIBUTES - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_SETCONNECTOR
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand enables or disables a connector. (A connector can be a hardware or software connection on the device the VSD is controlling.) Note that enabling a connector can by default, disable another connector. For further information regarding connectors, refer to the MCI_CONNECTOR command in the OS/2 Multimedia Programming Reference. Additional connectors can be found in MCIOS2.H.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETCONNECTOR.
pRequest(PVSD_CONNECTOR_PARMS) A pointer to the VSD_CONNECTOR_PARMSstructure.
The status of the connector, enable (VSD_ENABLE) or disable (VSD_DISABLE) must be indicated in the fEnabledfield. A valid connector must be placed in the ulConn_Typefield and a valid index in the ulIndexfield.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_UNSUPPORTED_CONNECTOR Connector setting is not supported.
VSDERR_INVALID_CONNECTOR Connector setting is invalid.
VSD_SETCONNECTOR Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETCONNECTOR Parameter - ulFunc
VSD_SETCONNECTOR Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETCONNECTOR.
VSD_SETCONNECTOR Parameter - pRequest
pRequest(PVSD_CONNECTOR_PARMS) A pointer to the VSD_CONNECTOR_PARMSstructure.
The status of the connector, enable (VSD_ENABLE) or disable (VSD_DISABLE) must be indicated in the fEnabledfield. A valid connector must be placed in the ulConn_Typefield and a valid index in the ulIndexfield.
VSD_SETCONNECTOR Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_UNSUPPORTED_CONNECTOR Connector setting is not supported.
VSDERR_INVALID_CONNECTOR Connector setting is invalid.
VSD_SETCONNECTOR - Syntax
This subcommand of the VSD_SETcommand enables or disables a connector. (A connector can be a hardware or software connection on the device the VSD is controlling.) Note that enabling a connector can by default, disable another connector. For further information regarding connectors, refer to the MCI_CONNECTOR command in the OS/2 Multimedia Programming Reference. Additional connectors can be found in MCIOS2.H.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETCONNECTOR.
pRequest(PVSD_CONNECTOR_PARMS) A pointer to the VSD_CONNECTOR_PARMSstructure.
The status of the connector, enable (VSD_ENABLE) or disable (VSD_DISABLE) must be indicated in the fEnabledfield. A valid connector must be placed in the ulConn_Typefield and a valid index in the ulIndexfield.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_UNSUPPORTED_CONNECTOR Connector setting is not supported.
VSDERR_INVALID_CONNECTOR Connector setting is invalid.
VSD_SETCONNECTOR - Example Code
The following code illustrates how to set the state of the connector.
HVSD hvsd;
VSD_CONNECTOR_PARMS vsdConn;
vsdConn.ulConn_Type = pConnector->ulConnectorType;
vsdConn.ulIndex = pConnector->ulConnectorIndex;
vsdConn.fEnabled = VSD_DISABLE;
/*--------------------------------------------------
* Tell the VSD that we want to disable a connector.
*--------------------------------------------------*/
lError = pInstance->pfnNewVSD(hvsd,
VSD_SET,
VSD_SETCONNECTOR,
(PVOID)&vsdConn);
VSD_SETCONNECTOR - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_SETDATATYPE
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand sets the current data type that the device is dealing with.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETDATATYPE.
pRequest(PVSD_AUDIODATATYPE_PARMS) Input. Pointer to a VSD_AUDIODATATYPE_ PARMSstructure.
Note:Every field in the VSD_AUDIODATATYPE_PARMSstructure contains a numeric value except for ulOperation. This field contains either VSD_ PRODUCE for recording or VSD_CONSUME for playback. The VSD is responsible for filling in the ulBlockAlignment, ulDataSubType, and ulAverageBytesPerSecfields in the VSD_AUDIODATATYPE_PARMSstructure.
The ulFlagsfield of the VSD_AUDIODATATYPE_PARMSstructure contains a flag for each field in the structure that can be set. Every field has a flag except for the ulOperationfield. The ulOperationfield is valid for every call.
The VSD_AUDIODATATYPE_PARMSstructure must contain at least one of the following flags:
�VSD_MODE
�VSD_CHANNELS
�VSD_SAMPLESPERSEC
�VSD_OPERATION
�VSD_BITSPERSAMPLE
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_SETDATATYPE Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETDATATYPE Parameter - ulFunc
VSD_SETDATATYPE Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETDATATYPE.
VSD_SETDATATYPE Parameter - pRequest
pRequest(PVSD_AUDIODATATYPE_PARMS) Input. Pointer to a VSD_AUDIODATATYPE_ PARMSstructure.
Note:Every field in the VSD_AUDIODATATYPE_PARMSstructure contains a numeric value except for ulOperation. This field contains either VSD_ PRODUCE for recording or VSD_CONSUME for playback. The VSD is responsible for filling in the ulBlockAlignment, ulDataSubType, and ulAverageBytesPerSecfields in the VSD_AUDIODATATYPE_PARMSstructure.
The ulFlagsfield of the VSD_AUDIODATATYPE_PARMSstructure contains a flag for each field in the structure that can be set. Every field has a flag except for the ulOperationfield. The ulOperationfield is valid for every call.
The VSD_AUDIODATATYPE_PARMSstructure must contain at least one of the following flags:
�VSD_MODE
�VSD_CHANNELS
�VSD_SAMPLESPERSEC
�VSD_OPERATION
�VSD_BITSPERSAMPLE
VSD_SETDATATYPE Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_SETDATATYPE - Syntax
This subcommand of the VSD_SETcommand sets the current data type that the device is dealing with.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETDATATYPE.
pRequest(PVSD_AUDIODATATYPE_PARMS) Input. Pointer to a VSD_AUDIODATATYPE_ PARMSstructure.
Note:Every field in the VSD_AUDIODATATYPE_PARMSstructure contains a numeric value except for ulOperation. This field contains either VSD_ PRODUCE for recording or VSD_CONSUME for playback. The VSD is responsible for filling in the ulBlockAlignment, ulDataSubType, and ulAverageBytesPerSecfields in the VSD_AUDIODATATYPE_PARMSstructure.
The ulFlagsfield of the VSD_AUDIODATATYPE_PARMSstructure contains a flag for each field in the structure that can be set. Every field has a flag except for the ulOperationfield. The ulOperationfield is valid for every call.
The VSD_AUDIODATATYPE_PARMSstructure must contain at least one of the following flags:
�VSD_MODE
�VSD_CHANNELS
�VSD_SAMPLESPERSEC
�VSD_OPERATION
�VSD_BITSPERSAMPLE
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSD_SETDATATYPE - Example Code
The following code illustrates how to set the data type, sampling rate, channels, and bits per sample for an audio VSD.
HVSD hvsd;
VSD_AUDIODATATYPE_PARMS AudioDatatype;
PMMAUDIOHEADER pmmaudioheader;
AudioDatatype.ulDataType = pmmaudioheader->mmXWAVHeader.WAVEHeader.usFormatTag;
AudioDatatype.ulBitsPerSample = pmmaudioheader->mmXWAVHeader.WAVEHeader.usBitsPerSample;
AudioDatatype.ulSamplingRate = pmmaudioheader->mmXWAVHeader.WAVEHeader.usSamplesPerSec;
AudioDatatype.ulChannels = pmmaudioheader->mmXWAVHeader.WAVEHeader.usChannels;
AudioDatatype.ulOperation = VSD_PLAY;
AudioDatatype.ulFlags = VSD_MODE|VSD_CHANNELS|VSD_SAMPLESPERSEC|
VSD_OPERATION|VSD_BITSPERSAMPLE;
rc = pInstance->pfnNewVSD(hvsd,
VSD_SET,
VSD_SETDATATYPE,
(PVOID)&AudioDatatype);
if(rc)
{
return(rc)
}
VSD_SETDATATYPE - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_SETMIXCONNECTIONS
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand routes the audio output of a connector to a particular output circuitry (that is, pass thru, internal mixer circuitry, and so on). For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETMIXCONNECTIONS.
pRequest(PLINECONNECTIONS) A pointer to the LINECONNECTIONSstructure.
The caller must fill in the ulConnectionsand the ulLinefields of the LINECONNECTIONSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_SETMIXCONNECTIONS Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETMIXCONNECTIONS Parameter - ulFunc
VSD_SETMIXCONNECTIONS Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETMIXCONNECTIONS.
VSD_SETMIXCONNECTIONS Parameter - pRequest
pRequest(PLINECONNECTIONS) A pointer to the LINECONNECTIONSstructure.
The caller must fill in the ulConnectionsand the ulLinefields of the LINECONNECTIONSstructure.
VSD_SETMIXCONNECTIONS Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_SETMIXCONNECTIONS - Syntax
This subcommand of the VSD_SETcommand routes the audio output of a connector to a particular output circuitry (that is, pass thru, internal mixer circuitry, and so on). For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETMIXCONNECTIONS.
pRequest(PLINECONNECTIONS) A pointer to the LINECONNECTIONSstructure.
The caller must fill in the ulConnectionsand the ulLinefields of the LINECONNECTIONSstructure.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_SETMIXCONNECTIONS - Example Code
The following code illustrates how to route the output of a connector to the internal mixer circuitry.
LINECONNECTIONS mixinfo;
mixinfo.ulLine = SOURCE_SYNTHESIZER;
mixinfo.ulConnection = SINK_SPEAKER;
rc = pInstance->((HVSD)pInstance->hvsd,
VSD_SET,
VSD_SETMIXCONNECTIONS,
(PVOID)&mixinfo);
return(rc);
VSD_SETMIXCONNECTIONS - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_SETMIXCONTROL
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand enables an application to set the current state of a particular line. For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETMIXCONTROL.
pRequest(PMIXERCONTROL) A pointer to the MIXERCONTROLstructure.
The ulControlfield of the MIXERCONTROLstructure must be filled in with the desired setting. For stereo controls, the high-order word of this field contains the left channel setting and the low-order word contains the right channel setting. A value of 0xFFFF represents full intensity and a value of 0x0000 is full cutout. The ulLinefield must also be filled in.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_SETMIXCONTROL Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETMIXCONTROL Parameter - ulFunc
VSD_SETMIXCONTROL Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETMIXCONTROL.
VSD_SETMIXCONTROL Parameter - pRequest
pRequest(PMIXERCONTROL) A pointer to the MIXERCONTROLstructure.
The ulControlfield of the MIXERCONTROLstructure must be filled in with the desired setting. For stereo controls, the high-order word of this field contains the left channel setting and the low-order word contains the right channel setting. A value of 0xFFFF represents full intensity and a value of 0x0000 is full cutout. The ulLinefield must also be filled in.
VSD_SETMIXCONTROL Return Value - rc
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_SETMIXCONTROL - Syntax
This subcommand of the VSD_SETcommand enables an application to set the current state of a particular line. For further information about VSD mixer support and functions, see Audio Sample for Vendor-Specific Driversand Mixer IOCtl Functions Introduction
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETMIXCONTROL.
pRequest(PMIXERCONTROL) A pointer to the MIXERCONTROLstructure.
The ulControlfield of the MIXERCONTROLstructure must be filled in with the desired setting. For stereo controls, the high-order word of this field contains the left channel setting and the low-order word contains the right channel setting. A value of 0xFFFF represents full intensity and a value of 0x0000 is full cutout. The ulLinefield must also be filled in.
rc(ULONG) Error code indicating success or the type of failure:
VSDERR_MISSING_PARAMETER One or more parameters are missing.
VSDERR_INVALID_SOURCE Invalid source.
VSDERR_INVALID_SINK Invalid sink.
VSDERR_INVALID_CONNECTION Invalid connection.
VSD_SETMIXCONTROL - Example Code
The following code illustrates how to query the settings of an audio attributes for a particular connector.
MIXERCONTROL MixerControl;
USHORT usBass;
MixerControl.ulControl = MIX_SUPPORT_VOLUME;
MixerControl.ulLine = SINK_LINE_OUT;
MixerControl.ulSetting = 100;
lError = pInstance->((HVSD)pInstance->hvsd,
VSD_SET,
VSD_SETMIXCONTROL,
(PVOID)&MixerControl);
return(lError);
VSD_SETMIXCONTROL - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_SETMONITOR
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand enables (MCI_TRUE) or disables (MCI_ FALSE) the audio monitor feature of the device.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETMONITOR.
pRequest(PULONG) Input. Set to MCI_TRUE or MCI_FALSE.
rc(ULONG) Error code indicating success.
VSDERR_SUCCESS The command was successful.
VSD_SETMONITOR Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETMONITOR Parameter - ulFunc
VSD_SETMONITOR Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETMONITOR.
VSD_SETMONITOR Parameter - pRequest
pRequest(PULONG) Input. Set to MCI_TRUE or MCI_FALSE.
VSD_SETMONITOR Return Value - rc
rc(ULONG) Error code indicating success.
VSDERR_SUCCESS The command was successful.
VSD_SETMONITOR - Syntax
This subcommand of the VSD_SETcommand enables (MCI_TRUE) or disables (MCI_ FALSE) the audio monitor feature of the device.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETMONITOR.
pRequest(PULONG) Input. Set to MCI_TRUE or MCI_FALSE.
rc(ULONG) Error code indicating success.
VSDERR_SUCCESS The command was successful.
VSD_SETMONITOR - Example Code
The following code illustrates how to set the state of the VSD monitor.
ULONG ulSetOn;
ulSetOn = MCI_TRUE;
/* Tell the VSD to change monitor status */
lError = prInstance->pfnAUDIOIF((HVSD)prInstance->pMix->hvsd
VSD_SET,
VSD_SETMONITOR,
(PVOID)lSetOn);
VSD_SETMONITOR - Topics
Select an item:
Syntax Returns Example Code Glossary
VSD_SETVOLUME
Select an item:
Syntax Returns Example Code Glossary
This subcommand of the VSD_SETcommand sets the volume level as a percentage (0 - 100). If the value is not one of the supported volume levels, it is rounded up to the nearest supported level. The ulFlagsfield indicates which fields are to be used.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETVOLUME.
pRequest(PVSD_VOLUME_PARMS) Pointer to the VSD_VOLUME_PARMSstructure.
The caller must fill in the ulVolumefield if VSD_VOLUME is specified. The caller must fill in the ulMasterAudiofield if VSD_MASTERVOLUME is specified. The caller must fill in the fMutefield with a boolean if VSD_ MUTE is specified. TRUE mutes the device; FALSE unmutes the device.
rc(ULONG) Error codes indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_VOL_OUT_OF_RANGE Invalid volume level.
VSD_SETVOLUME Parameter - hvsd
hvsd(HVSD) Handle to a VSD.
VSD_SETVOLUME Parameter - ulFunc
VSD_SETVOLUME Parameter - ulFlags
ulFlags(ULONG) Set to VSD_SETVOLUME.
VSD_SETVOLUME Parameter - pRequest
pRequest(PVSD_VOLUME_PARMS) Pointer to the VSD_VOLUME_PARMSstructure.
The caller must fill in the ulVolumefield if VSD_VOLUME is specified. The caller must fill in the ulMasterAudiofield if VSD_MASTERVOLUME is specified. The caller must fill in the fMutefield with a boolean if VSD_ MUTE is specified. TRUE mutes the device; FALSE unmutes the device.
VSD_SETVOLUME Return Value - rc
rc(ULONG) Error codes indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_VOL_OUT_OF_RANGE Invalid volume level.
VSD_SETVOLUME - Syntax
This subcommand of the VSD_SETcommand sets the volume level as a percentage (0 - 100). If the value is not one of the supported volume levels, it is rounded up to the nearest supported level. The ulFlagsfield indicates which fields are to be used.
This command is sent using VSDEntryas follows:
VSDEntry(hvsd, ulFunc, ulFlags, pRequest)
hvsd(HVSD) Handle to a VSD.
ulFlags(ULONG) Set to VSD_SETVOLUME.
pRequest(PVSD_VOLUME_PARMS) Pointer to the VSD_VOLUME_PARMSstructure.
The caller must fill in the ulVolumefield if VSD_VOLUME is specified. The caller must fill in the ulMasterAudiofield if VSD_MASTERVOLUME is specified. The caller must fill in the fMutefield with a boolean if VSD_ MUTE is specified. TRUE mutes the device; FALSE unmutes the device.
rc(ULONG) Error codes indicating success or the type of failure:
VSDERR_SUCCESS The command was successful.
VSDERR_VOL_OUT_OF_RANGE Invalid volume level.
VSD_SETVOLUME - Example Code
The following code illustrates how to set the volume on an audio VSD.
VSD_VOLUME_PARMS vsdVol;
vsdVol.ulVolume = pInstance->ulVolume;
vsdVol.ulMasterAudio = pInstance->ulMasterVolume;
vsdVol.fMute = pInstance->fMute;
vsdVol.ulVectoredVolume = pInstance->ulTime;
vsdVol.ulFlags = VSD_VOLUME | VSD_MASTERVOLUME;
lError = prInstance->pfnAUDIOIF((HVSD)prInstance->pMix->hvsd
VSD_SET,
VSD_SETVOLUME,
(PVOID)&vsdVol);
VSD_SETVOLUME - Topics
Select an item:
Syntax Returns Example Code Glossary
Reprint Courtesy of International Business Machines Corporation, © International Business Machines Corporation