|
MWCapture SDK Mac
3.4.62314
|
Functions | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVersion (BYTE *pbyMaj, BYTE *pbyMin, WORD *pwBuild) |
| Gets the version number of SDK. | |
| BOOL LIBMWCAPTURE_API | MWCaptureInitInstance () |
| Initializes the MWCapture interfaces. | |
| void LIBMWCAPTURE_API | MWCaptureExitInstance () |
| Quits instance. | |
| MW_RESULT LIBMWCAPTURE_API | MWRefreshDevice () |
| Refreshes device list. | |
| int LIBMWCAPTURE_API | MWGetChannelCount () |
| Gets the total number of channels. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetChannelInfoByIndex (int nIndex, MWCAP_CHANNEL_INFO *pChannelInfo) |
| Gets the channel info by its index. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetFamilyInfoByIndex (int nIndex, LPVOID pFamilyInfo, DWORD dwSize) |
| Gets the product family based on the index. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetDevicePath (int nIndex, char *pDevicePath) |
| Gets the instance path of capture device based on the index. | |
| HCHANNEL LIBMWCAPTURE_API | MWOpenChannelByPath (const char *pszDevicePath) |
| Opens capture channel by device instance path. | |
| void LIBMWCAPTURE_API | MWCloseChannel (HCHANNEL hChannel) |
| Closes capture channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetChannelInfo (HCHANNEL hChannel, MWCAP_CHANNEL_INFO *pChannelInfo) |
| Gets channel information. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetFamilyInfo (HCHANNEL hChannel, LPVOID pFamilyInfo, DWORD dwSize) |
| Gets attributions of product family which the capture device belongs to. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoCaps (HCHANNEL hChannel, MWCAP_VIDEO_CAPS *pVideoCaps) |
| Gets video capture capability of the specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetAudioCaps (HCHANNEL hChannel, MWCAP_AUDIO_CAPS *pAudioCaps) |
| Gets audio capture capability of the channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoInputSourceArray (HCHANNEL hChannel, DWORD *pdwInputSource, DWORD *pdwInputCount) |
| Gets the input video signal types supported by the channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetAudioInputSourceArray (HCHANNEL hChannel, DWORD *pdwInputSource, DWORD *pdwInputCount) |
| Gets the input audio signal types supported by the channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetInputSourceScan (HCHANNEL hChannel, BOOLEAN *pbScan) |
| Gets the scan state of input source. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetInputSourceScan (HCHANNEL hChannel, BOOLEAN bScan) |
| Sets the states of scanned input video source. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetAVInputSourceLink (HCHANNEL hChannel, BOOLEAN *pbLink) |
| Gets the states of input audio/video sources. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetAVInputSourceLink (HCHANNEL hChannel, BOOLEAN bLink) |
| Sets whether the input video source is linked to its audio automatically. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoInputSource (HCHANNEL hChannel, DWORD *pdwSource) |
| Gets current video input source of the channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetVideoInputSource (HCHANNEL hChannel, DWORD dwSource) |
| Sets the video input source of the specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetAudioInputSource (HCHANNEL hChannel, DWORD *pdwSource) |
| Gets current input audio of the specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetAudioInputSource (HCHANNEL hChannel, DWORD dwSource) |
| Sets current audio input source of specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetEDID (HCHANNEL hChannel, BYTE *pbyData, ULONG *pulSize) |
| Gets the EDID of specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetEDID (HCHANNEL hChannel, BYTE *pbyData, ULONG ulSize) |
| Sets EDID of specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetInputSpecificStatus (HCHANNEL hChannel, MWCAP_INPUT_SPECIFIC_STATUS *pInputStatus) |
| Gets the specific status of input signal. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoSignalStatus (HCHANNEL hChannel, MWCAP_VIDEO_SIGNAL_STATUS *pSignalStatus) |
| Gets video signal status of specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetAudioSignalStatus (HCHANNEL hChannel, MWCAP_AUDIO_SIGNAL_STATUS *pSignalStatus) |
| Gets the audio signal status of specified channel. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetHDMIInfoFrameValidFlag (HCHANNEL hChannel, DWORD *pdwValidFlag) |
| Gets valid flag of HDMI InfoFrame. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetHDMIInfoFramePacket (HCHANNEL hChannel, MWCAP_HDMI_INFOFRAME_ID id, HDMI_INFOFRAME_PACKET *pPacket) |
| Gets HDMI InfoFrame data. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetVideoInputAspectRatio (HCHANNEL hChannel, int nAspectX, int nAspectY) |
| Sets aspect ratio of input video. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoInputAspectRatio (HCHANNEL hChannel, int *pnAspectX, int *pnAspectY) |
| Gets aspect ratio of input video. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetVideoInputColorFormat (HCHANNEL hChannel, MWCAP_VIDEO_COLOR_FORMAT colorFormat) |
| Sets color format of input video. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoInputColorFormat (HCHANNEL hChannel, MWCAP_VIDEO_COLOR_FORMAT *pColorFormat) |
| Gets color format of input video. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetVideoInputQuantizationRange (HCHANNEL hChannel, MWCAP_VIDEO_QUANTIZATION_RANGE quantRange) |
| Sets quantization range of input video. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoInputQuantizationRange (HCHANNEL hChannel, MWCAP_VIDEO_QUANTIZATION_RANGE *pQuantRange) |
| Gets quantization range of input video. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetLEDMode (HCHANNEL hChannel, DWORD dwMode) |
| Sets LED mode. | |
| MW_RESULT | MWGetVideoDevicePathByChannel (HCHANNEL hChannel, char *pszVideoDevicePath) |
| ** | |
| HANDLE LIBMWCAPTURE_API | MWCreateVideoCapture (char *pszVideoDevicePath, int nWidth, int nHeight, int nFourcc, int nFrameDuration, VIDEO_CAPTURE_CALLBACK callback, void *pParam) |
| Captures videos using dshow. Supports all capture devices. | |
| MW_RESULT LIBMWCAPTURE_API | MWDestoryVideoCapture (HANDLE hVideo) |
| Stops to capture video. | |
| HANDLE LIBMWCAPTURE_API | MWCreateAudioCapture (HCHANNEL hChannel, MWCAP_AUDIO_CAPTURE_NODE captureNode, DWORD dwSamplesPerSec, WORD wBitsPerSample, WORD wChannels, AUDIO_CAPTURE_CALLBACK callback, void *pParam) |
| Captures audio data for all capture devices. | |
| MW_RESULT LIBMWCAPTURE_API | MWDestoryAudioCapture (HANDLE hAudio) |
| Stops to capture audio. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetAudioVolume (HCHANNEL hChannel, MWCAP_AUDIO_NODE audioNode, MWCAP_AUDIO_VOLUME *pVolume) |
| Gets the volume value of audio capture device. | |
| MW_RESULT LIBMWCAPTURE_API | MWSetAudioVolume (HCHANNEL hChannel, MWCAP_AUDIO_NODE audioNode, MWCAP_AUDIO_VOLUME *pVolume) |
| Sets the volume of audio capture device. | |
| MW_RESULT LIBMWCAPTURE_API | MWCaptureSetSDIANCType (HCHANNEL hChannel, BYTE byIndex, BOOLEAN bHANC, BOOLEAN bVANC, BYTE byDID, BYTE bySDID) |
| Sets the ANC data types to be captured for SDI signal. | |
| MW_RESULT LIBMWCAPTURE_API | MWCaptureGetSDIANCPacket (HCHANNEL hChannel, MWCAP_SDI_ANC_PACKET *pPacket) |
| Captures specified SDI ANC types. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoCaptureSupportResolutionMode (HCHANNEL hChannel, MWCAP_VIDEO_RESOLUTION_MODE *pMode, int *pCount) |
| Gets resolution modes supported by devices, including MWCAP_VIDEO_RESOLUTION_MODE_LIST when the resolutions are discrete values, and MWCAP_VIDEO_RESOLUTION_MODE_RANGE when the resolutions are continuous values. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoCaptureSupportRangeResolution (HCHANNEL hChannel, MWCAP_VIDEO_RESOLUTION_RANGE *pRange) |
| Gets resolution range supported by the device, when the return mode of MWGetVideoCaptureSupportResolutionMode is MWCAP_VIDEO_RESOLUTION_MODE_RANGE. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoCaptureSupportListResolution (HCHANNEL hChannel, MWCAP_VIDEO_RESOLUTION_LIST *pList) |
| Gets resolutions supported by devices when the return mode of MWGetVideoCaptureSupportResolutionMode is MWCAP_VIDEO_RESOLUTION_MODE_LIST. | |
| MW_RESULT LIBMWCAPTURE_API | MWGetVideoCaptureSupportColorFormat (HCHANNEL hChannel, DWORD *pColorFourcc, int *nCount) |
| Uses DShow to get the device supported color spaces. | |
| void LIBMWCAPTURE_API MWCaptureExitInstance | ( | ) |
Quits instance.
The API is used to quit the current instance. It always used with MWCaptureInitInstance.
Calls the API at the end of your instance. You can find it in all of the provided examples.
| MW_RESULT LIBMWCAPTURE_API MWCaptureGetSDIANCPacket | ( | HCHANNEL | hChannel, |
| MWCAP_SDI_ANC_PACKET * | pPacket | ||
| ) |
Captures specified SDI ANC types.
| [in] | hChannel | Channel handle |
| [in] | pPacket | ANC data packet |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets the capture ANC data types of SDI signal, 4 types at most.
The detailed usage refers to example GetANCPacket.
| BOOL LIBMWCAPTURE_API MWCaptureInitInstance | ( | ) |
Initializes the MWCapture interfaces.
| MW_RESULT LIBMWCAPTURE_API MWCaptureSetSDIANCType | ( | HCHANNEL | hChannel, |
| BYTE | byIndex, | ||
| BOOLEAN | bHANC, | ||
| BOOLEAN | bVANC, | ||
| BYTE | byDID, | ||
| BYTE | bySDID | ||
| ) |
Sets the ANC data types to be captured for SDI signal.
| [in] | hChannel | The opened channel handle |
| [in] | byIndex | Index of ANC data types, from 0 to 3. |
| [in] | bHANC | Whether it is HANC |
| [in] | bVANC | Whether it is VANC |
| [in] | byDID | SMPTE ANC ID |
| [in] | bySDID | SMPTE ANC ID |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets the ANC data types of SDI signal, 4 types at most.
The usage refers to example GetANCPacket.
| void LIBMWCAPTURE_API MWCloseChannel | ( | HCHANNEL | hChannel | ) |
Closes capture channel.
| [in] | hChannel | The opened channel handle |
Usage:
Closes the capture channel according to the channel handle of the capture device.
You can find the API in every examples.
| HANDLE LIBMWCAPTURE_API MWCreateAudioCapture | ( | HCHANNEL | hChannel, |
| MWCAP_AUDIO_CAPTURE_NODE | captureNode, | ||
| DWORD | dwSamplesPerSec, | ||
| WORD | wBitsPerSample, | ||
| WORD | wChannels, | ||
| AUDIO_CAPTURE_CALLBACK | callback, | ||
| void * | pParam | ||
| ) |
Captures audio data for all capture devices.
| [in] | hChannel | The opened channel handle |
| [in] | captureNode | Audio capture device type |
| [in] | dwSamplesPerSec | Sampling rate |
| [in] | wBitsPerSample | Depth |
| [in] | wChannels | The number of audio capture channels |
| [in] | callback | The callback function |
| [in] | pParam | Callback objects |
| Not null | Function call succeeded. The device is ready to start capturing. |
| NULL | Function call failed. Failed to start capturing. |
Usage:
Captures audio data using Core Audio for 2 channels at most. It is supported by all capture devices.
The usage refers to example AVCapture2.
| HANDLE LIBMWCAPTURE_API MWCreateVideoCapture | ( | char * | pszVideoDevicePath, |
| int | nWidth, | ||
| int | nHeight, | ||
| int | nFourcc, | ||
| int | nFrameDuration, | ||
| VIDEO_CAPTURE_CALLBACK | callback, | ||
| void * | pParam | ||
| ) |
Captures videos using dshow. Supports all capture devices.
| [in] | hChannel | The opened channel handle |
| [in] | nWidth | The width of captured image |
| [in] | nHeight | The height of captured image |
| [in] | nFourcc | Capture format |
| [in] | nFrameDuration | The capture interval between two frames |
| [in] | callback | The callback function |
| [in] | pParam | Callback objects |
| Not null | Function call succeeded. The device is ready to start to capture videos. |
| NULL | Function call failed. Failed to start capturing. |
Usage:
Captures videos from the specified channel.
| MW_RESULT LIBMWCAPTURE_API MWDestoryAudioCapture | ( | HANDLE | hAudio | ) |
Stops to capture audio.
| [in] | hAudio | Opened audio capture handle |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Works with MWCreateAudioCapture.
| MW_RESULT LIBMWCAPTURE_API MWDestoryVideoCapture | ( | HANDLE | hVideo | ) |
Stops to capture video.
| [in] | hVideo | The opened capture channel handle |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Stops video capturing. Works with MWCreateVideoCapture
| MW_RESULT LIBMWCAPTURE_API MWGetAudioCaps | ( | HCHANNEL | hChannel, |
| MWCAP_AUDIO_CAPS * | pAudioCaps | ||
| ) |
Gets audio capture capability of the channel.
| [in] | hChannel | Channel handle |
| [out] | pAudioCaps | A pointer to struct MWCAP_AUDIO_CAPS, which returns audio capture capability of the channel. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
| MW_RESULT LIBMWCAPTURE_API MWGetAudioInputSource | ( | HCHANNEL | hChannel, |
| DWORD * | pdwSource | ||
| ) |
Gets current input audio of the specified channel.
| [in] | hChannel | Channel handle |
| [out] | pdwSource | Returns current input audio source. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets current input audio of the specified channel. For details, see example InputSource.
The definition of pdwSource refers to INPUT_TYPE.
| MW_RESULT LIBMWCAPTURE_API MWGetAudioInputSourceArray | ( | HCHANNEL | hChannel, |
| DWORD * | pdwInputSource, | ||
| DWORD * | pdwInputCount | ||
| ) |
Gets the input audio signal types supported by the channel.
| [in] | hChannel | Channel handle |
| [out] | pdwInputSource | Returns the input audio signal type supported by the channel. When being set to NULL, the API returns the number of video signal types supported by the channel. |
| [in,out] | pdwInputCount | As an input parameter, it indicates the size of area that pdwInputSource points to. As an output parameter, it returns the number of audio signal types supported by the channel. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
The detailed usage refers to example InputSource.
| MW_RESULT LIBMWCAPTURE_API MWGetAudioSignalStatus | ( | HCHANNEL | hChannel, |
| MWCAP_AUDIO_SIGNAL_STATUS * | pSignalStatus | ||
| ) |
Gets the audio signal status of specified channel.
| [in] | hChannel | Channel handle |
| [out] | pSignalStatus | A pointer to struc MWCAP_AUDIO_SIGNAL_STATUS, which returns the audio signal status. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the audio signal status of specified channel.
For details, see example AudioCapture and InputSignal.
| MW_RESULT LIBMWCAPTURE_API MWGetAudioVolume | ( | HCHANNEL | hChannel, |
| MWCAP_AUDIO_NODE | audioNode, | ||
| MWCAP_AUDIO_VOLUME * | pVolume | ||
| ) |
Gets the volume value of audio capture device.
| [in] | hChannel | Channel handle |
| [in] | audioNode | Audio device type |
| [out] | pVolume | Returns the volume of audio capture device |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets volume of audio capture device.
| MW_RESULT LIBMWCAPTURE_API MWGetAVInputSourceLink | ( | HCHANNEL | hChannel, |
| BOOLEAN * | pbLink | ||
| ) |
Gets the states of input audio/video sources.
| [in] | hChannel | Channel handle |
| [out] | pbLink | Returns whether the audio input source is related to the video input source |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets whether the audio input source is linked with video according to the channel handle. If it is TRUE, audio link video source is enabled by default. Which means when there are multiple input sources, the video input source will automate its audio. If it returns FALSE, the video input would not match probably, you can use MWSetVideoInputSource and
MWSetAudioInputSource to set the related link state.
| int LIBMWCAPTURE_API MWGetChannelCount | ( | ) |
Gets the total number of channels.
Usage:
You can find the API in every examples.
| MW_RESULT LIBMWCAPTURE_API MWGetChannelInfo | ( | HCHANNEL | hChannel, |
| MWCAP_CHANNEL_INFO * | pChannelInfo | ||
| ) |
Gets channel information.
| [in] | hChannel | The Channel handle |
| [out] | pChannelInfo | Channel information |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
You can find the API in every examples.
| MW_RESULT LIBMWCAPTURE_API MWGetChannelInfoByIndex | ( | int | nIndex, |
| MWCAP_CHANNEL_INFO * | pChannelInfo | ||
| ) |
Gets the channel info by its index.
| [in] | nIndex | Channel index, ranges from 0 to (MWGetChannelCount() - 1). |
| [out] | pChannelInfo | Channel infomation |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
You can find the API in every examples.
| MW_RESULT LIBMWCAPTURE_API MWGetDevicePath | ( | int | nIndex, |
| char * | pDevicePath | ||
| ) |
Gets the instance path of capture device based on the index.
| [in] | nIndex | Channel index, from 0 to (MWGetChannelCount() - 1) |
| [out] | pDevicePath | Path of the device |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the instance path of capture device on its index
You can find the API in every examples.
| MW_RESULT LIBMWCAPTURE_API MWGetEDID | ( | HCHANNEL | hChannel, |
| BYTE * | pbyData, | ||
| ULONG * | pulSize | ||
| ) |
Gets the EDID of specified channel.
| [in] | hChannel | Channel handle |
| [out] | pbyData | Returns EDID |
| [in,out] | pulSize | As input parameter, it indicates the memory size that pbyData points to. As output parameter, it returns the data length of EDID. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the EDID of specified channel.
EDID is supplied by HDMI capture device. It is invalid for other capture devices.
For details, refers to example ReadWriteEDID.
| MW_RESULT LIBMWCAPTURE_API MWGetFamilyInfo | ( | HCHANNEL | hChannel, |
| LPVOID | pFamilyInfo, | ||
| DWORD | dwSize | ||
| ) |
Gets attributions of product family which the capture device belongs to.
| [in] | hChannel | Channel handle |
| [out] | pFamilyInfo | Returns attributions of product family which the capture device belongs to. |
| [in] | dwSize | The size of the struct which pFamilyInfo points to. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets attributions of product family which the capture device belongs to, according to its channel handle.
| MW_RESULT LIBMWCAPTURE_API MWGetFamilyInfoByIndex | ( | int | nIndex, |
| LPVOID | pFamilyInfo, | ||
| DWORD | dwSize | ||
| ) |
Gets the product family based on the index.
| [in] | nIndex | Channel index, from 0 to (MWGetChannelCount() - 1) |
| [out] | pFamilyInfo | A pointer to the struct of MWCAP_PRO_CAPTURE_INFO, #MWCAP_ECO_CAPTURE_INFO or MWUSBCAP_CAPTURE_INFO that retures the product family of your device. |
| [in] | dwSize | The size of the struct that the pFamilyInfo points to. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the product family of the device based on the index.
It is supported by the Pro/Eco/USB family.
Code for Pro capture family:
Code for Eco capture family:
Code for USB capture family:
| MW_RESULT LIBMWCAPTURE_API MWGetHDMIInfoFramePacket | ( | HCHANNEL | hChannel, |
| MWCAP_HDMI_INFOFRAME_ID | id, | ||
| HDMI_INFOFRAME_PACKET * | pPacket | ||
| ) |
Gets HDMI InfoFrame data.
| [in] | hChannel | Channel handle |
| [in] | id | HDMI InfoFrame ID |
| [out] | pPacket | A pointer to struc HDMI_INFOFRAME_PACKET, which returns HDMI InfoFrame data. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets data of HDMI InfoFrame.
For details, see example HDMIInfoFrame.
| MW_RESULT LIBMWCAPTURE_API MWGetHDMIInfoFrameValidFlag | ( | HCHANNEL | hChannel, |
| DWORD * | pdwValidFlag | ||
| ) |
Gets valid flag of HDMI InfoFrame.
| [in] | hChannel | Channel handle |
| [out] | pdwValidFlag | Returns valid flag of HDMI InfoFrame |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets valid flag of HDMI InfoFrame. Only supported by HDMI capture devices, other devices are not supported.
For details, see example HDMIInfoFrame.
The value of pdwValidFlag refers to MWCAP_HDMI_INFOFRAME_MASK.
| MW_RESULT LIBMWCAPTURE_API MWGetInputSourceScan | ( | HCHANNEL | hChannel, |
| BOOLEAN * | pbScan | ||
| ) |
Gets the scan state of input source.
| [in] | hChannel | Channel handle |
| [out] | pbScan | The return value indicates whether it is under scanning. 1 indicates true, AutoScan; 0 indicates false, not to Autoscan. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the scan state of input source. That is whether the input source is automatically scanned. If multiple sources are connected, the device will automatically capture the valid one.
| MW_RESULT LIBMWCAPTURE_API MWGetInputSpecificStatus | ( | HCHANNEL | hChannel, |
| MWCAP_INPUT_SPECIFIC_STATUS * | pInputStatus | ||
| ) |
Gets the specific status of input signal.
| [in] | hChannel | Channel handle |
| [out] | pInputStatus | A pointer to struct MWCAP_INPUT_SPECIFIC_STATUS, which returns the input signal state. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the detailed state of specified input source.
For details, refer to example HDMIInfoFrame.
| MW_RESULT LIBMWCAPTURE_API MWGetVersion | ( | BYTE * | pbyMaj, |
| BYTE * | pbyMin, | ||
| WORD * | pwBuild | ||
| ) |
Gets the version number of SDK.
| [out] | pbyMaj | Major version number |
| [out] | pbyMin | Minor version number |
| [out] | pwBuild | Build version number |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Calls the API wherever you need, even before the MWCaptureInitInstance().
Usually, it is used by examples such as CaptureByInput and CaptureByTimer, etc.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoCaps | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_CAPS * | pVideoCaps | ||
| ) |
Gets video capture capability of the specified channel.
| [in] | hChannel | Channel handle |
| [out] | pVideoCaps | A pointer to struct MWCAP_VIDEO_CAPS, which returns video capture capability of the channel |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
| MW_RESULT LIBMWCAPTURE_API MWGetVideoCaptureSupportColorFormat | ( | HCHANNEL | hChannel, |
| DWORD * | pColorFourcc, | ||
| int * | nCount | ||
| ) |
Uses DShow to get the device supported color spaces.
| [in] | hChannel | The opened channel handle |
| [out] | pColorFmt | Returns the device supported color spaces. For details, see MWFOURCC.h. When being set to NULL, the returned value is the number of device supported color spaces. |
| [out] | nCount | The number of color format supported by the capture device. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets capture formats supported by devices.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoCaptureSupportListResolution | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_RESOLUTION_LIST * | pList | ||
| ) |
Gets resolutions supported by devices when the return mode of MWGetVideoCaptureSupportResolutionMode is MWCAP_VIDEO_RESOLUTION_MODE_LIST.
| [in] | hChannel | The opened channel handle |
| [out] | pList | Supported discrete resolution values |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
| MW_RESULT LIBMWCAPTURE_API MWGetVideoCaptureSupportRangeResolution | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_RESOLUTION_RANGE * | pRange | ||
| ) |
Gets resolution range supported by the device, when the return mode of MWGetVideoCaptureSupportResolutionMode is MWCAP_VIDEO_RESOLUTION_MODE_RANGE.
| [in] | hChannel | The opened channel handle |
| [out] | pRange | Supported resolution range |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
| MW_RESULT LIBMWCAPTURE_API MWGetVideoCaptureSupportResolutionMode | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_RESOLUTION_MODE * | pMode, | ||
| int * | pCount | ||
| ) |
Gets resolution modes supported by devices, including MWCAP_VIDEO_RESOLUTION_MODE_LIST when the resolutions are discrete values, and MWCAP_VIDEO_RESOLUTION_MODE_RANGE when the resolutions are continuous values.
| [in] | hChannel | The opened channel handle |
| [out] | pMode | Returns the device supported resolution modes: MWCAP_VIDEO_RESOLUTION_MODE_LIST, MWCAP_VIDEO_RESOLUTION_MODE_RANGE. |
| [out] | pCount | Only available when the format is MWCAP_VIDEO_RESOLUTION_MODE_LIST, indicats the device supported number of resolution formats. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
| MW_RESULT MWGetVideoDevicePathByChannel | ( | HCHANNEL | hChannel, |
| char * | pszVideoDevicePath | ||
| ) |
**
** ** **
Gets the path of the channel
| [in] | hChannel | The opened channel handle. |
| [out] | pszVideoDevicePath | Path of the device. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the path of the specified channel.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoInputAspectRatio | ( | HCHANNEL | hChannel, |
| int * | pnAspectX, | ||
| int * | pnAspectY | ||
| ) |
Gets aspect ratio of input video.
| [in] | hChannel | The opened channel handle |
| [out] | pnAspectX | The returned width of aspect ratio |
| [out] | pnAspectY | The returned height of aspect ratio |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets aspect ratio of specified input source.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoInputColorFormat | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_COLOR_FORMAT * | pColorFormat | ||
| ) |
Gets color format of input video.
| [in] | hChannel | The opened channel handle |
| [out] | pColorFormat | A pointer to MWCAP_VIDEO_COLOR_FORMAT, which returns color format value |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets color format of specified input channel.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoInputQuantizationRange | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_QUANTIZATION_RANGE * | pQuantRange | ||
| ) |
Gets quantization range of input video.
| [in] | hChannel | The opened channel handle |
| [out] | pQuantRange | A pointer to MWCAP_VIDEO_QUANTIZATION_RANGE, which returns the quantization range value |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets quantization range of specified input channel.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoInputSource | ( | HCHANNEL | hChannel, |
| DWORD * | pdwSource | ||
| ) |
Gets current video input source of the channel.
| [in] | hChannel | Channel handle |
| [out] | pdwSource | Returns current video input source |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets current video input source of the channel.
For detailed information, refer to example InputSource The definition of pdwSource refers to MWCAP_VIDEO_INPUT_TYPE.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoInputSourceArray | ( | HCHANNEL | hChannel, |
| DWORD * | pdwInputSource, | ||
| DWORD * | pdwInputCount | ||
| ) |
Gets the input video signal types supported by the channel.
| [in] | hChannel | Channel handle |
| [out] | pdwInputSource | Returns the input video signal types supported by the channel. When being set to NULL, the API returns the number of video signal types supported by the channel. |
| [in,out] | pdwInputCount | As an input parameter, it indicates the size of area that pdwInputSource points to. As an output parameter, it returns the number of video signal types supported by the channel. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
For details, refer to the sample InputSource.
| MW_RESULT LIBMWCAPTURE_API MWGetVideoSignalStatus | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_SIGNAL_STATUS * | pSignalStatus | ||
| ) |
Gets video signal status of specified channel.
| [in] | hChannel | Channel handle |
| [out] | pSignalStatus | A pointer to struc MWCAP_VIDEO_SIGNAL_STATUS, which returns video signal status. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the video signal status of specified channel. For details, see example CaptureByInput, CaptureByTimer.
| HCHANNEL LIBMWCAPTURE_API MWOpenChannelByPath | ( | const char * | pszDevicePath | ) |
Opens capture channel by device instance path.
| [in] | pszDevicePath | Device instance path |
Usage:
Opens capture channel according to device instance path. Gets ready for work.
You can find the API in every examples.
| MW_RESULT LIBMWCAPTURE_API MWRefreshDevice | ( | ) |
Refreshes device list.
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Calls the API to refresh device list when the connected devices changed.
You can find the API in all of the provided examples.
| MW_RESULT LIBMWCAPTURE_API MWSetAudioInputSource | ( | HCHANNEL | hChannel, |
| DWORD | dwSource | ||
| ) |
Sets current audio input source of specified channel.
| [in] | hChannel | Channel handle |
| [in] | dwSource | Sets current audio input source |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets current audio input source of specified channel.
The definition of dwSource refers to INPUT_TYPE.
| MW_RESULT LIBMWCAPTURE_API MWSetAudioVolume | ( | HCHANNEL | hChannel, |
| MWCAP_AUDIO_NODE | audioNode, | ||
| MWCAP_AUDIO_VOLUME * | pVolume | ||
| ) |
Sets the volume of audio capture device.
| [in] | hChannel | Channel handle |
| [in] | audioNode | Audio device type |
| [in] | pVolume | The volume of audio capture device |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets the volume of audio capture device.
| MW_RESULT LIBMWCAPTURE_API MWSetAVInputSourceLink | ( | HCHANNEL | hChannel, |
| BOOLEAN | bLink | ||
| ) |
Sets whether the input video source is linked to its audio automatically.
| [in] | hChannel | Channel handle |
| [in] | bLink | Sets whether the audio input source follows the video input source |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets whether the audio input source follows the video input source automatically.
| MW_RESULT LIBMWCAPTURE_API MWSetEDID | ( | HCHANNEL | hChannel, |
| BYTE * | pbyData, | ||
| ULONG | ulSize | ||
| ) |
Sets EDID of specified channel.
| [in] | hChannel | Channel handle |
| [in] | pbyData | New EDID |
| [in] | ulSize | Data length of EDID |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
EDID is supplied by HDMI capture device. The API is invalid for other capture devices when being called.
For details, see example ReadWriteEDID.
Make sure you are familiar with EDID when you use this API. Otherwise we do not recommend you to use it.
| MW_RESULT LIBMWCAPTURE_API MWSetInputSourceScan | ( | HCHANNEL | hChannel, |
| BOOLEAN | bScan | ||
| ) |
Sets the states of scanned input video source.
| [in] | hChannel | Channel handle |
| [in] | bScan | Indicates the scanned states. 1 indicates true, AutoScan; 0 indicates false, not to Autoscans. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets whether to automatically scan the input interface captured channel.
| MW_RESULT LIBMWCAPTURE_API MWSetLEDMode | ( | HCHANNEL | hChannel, |
| DWORD | dwMode | ||
| ) |
Sets LED mode.
| [in] | hChannel | The opened channel handle |
| [in] | dwMode | LED mode. For details, see MWCAP_LED_MODE. |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets LED flash mode of specified channel.
For detailed information of dwMode value, see MWCAP_LED_MODE.
| MW_RESULT LIBMWCAPTURE_API MWSetVideoInputAspectRatio | ( | HCHANNEL | hChannel, |
| int | nAspectX, | ||
| int | nAspectY | ||
| ) |
Sets aspect ratio of input video.
| [in] | hChannel | The opened channel handle |
| [in] | nAspectX | width |
| [in] | nAspectY | Height |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets aspect ratio of specified input signal. It works with the other video processing parameters.
| MW_RESULT LIBMWCAPTURE_API MWSetVideoInputColorFormat | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_COLOR_FORMAT | colorFormat | ||
| ) |
Sets color format of input video.
| [in] | hChannel | The opened channel handle |
| [in] | colorFormat | Color format |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets color format of specified input channel.
| MW_RESULT LIBMWCAPTURE_API MWSetVideoInputQuantizationRange | ( | HCHANNEL | hChannel, |
| MWCAP_VIDEO_QUANTIZATION_RANGE | quantRange | ||
| ) |
Sets quantization range of input video.
| [in] | hChannel | The opened channel handle |
| [in] | quantRange | Quantization range |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets quantization range of specified input channel
| MW_RESULT LIBMWCAPTURE_API MWSetVideoInputSource | ( | HCHANNEL | hChannel, |
| DWORD | dwSource | ||
| ) |
Sets the video input source of the specified channel.
| [in] | hChannel | Channel handle |
| [in] | dwSource | Sets current video input source |
| MW_SUCCEEDED | Function call succeeded. |
| MW_FAILED | Function call failed. |
| MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets the video input source of the specified channel.