MWCapture SDK Linux
3.3.1.LAST_SVN_COMMIT_NUM
|
Functions | |
MW_RESULT LIBMWCAPTURE_API | MWUSBRegisterHotPlug (LPFN_HOT_PLUG_CALLBACK lpfnCallback, void *pParam) |
Registers hotplug callback function of USB capture device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBUnRegisterHotPlug () |
Unregisters hotplug callback function. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetNotifyEnable (HUSBCHANNEL hChannel, MWCAP_NOTIFY_ENABLE *pNotify) |
Sets notification types for specified channel. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetNotifyStatus (HUSBCHANNEL hChannel, uint64_t *pullStatusBit) |
Gets notification status of USB specified channel. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetFirmwareErase (HUSBCHANNEL hChannel, uint32_t cbOffset, uint32_t cbErase) |
Erases firmware data from USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetFirmwareReadAddress (HUSBCHANNEL hChannel, uint32_t *pdwAddress) |
Gets read address of USB device firmware. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetEDIDLoopThrough (HUSBCHANNEL hChannel, char *pbyEDID, uint32_t *pcbEDID) |
Gets EDID of the loopthrough interface in the USB device, only supported by devices with loopthrough interface. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetLoopThroughValid (HUSBCHANNEL hChannel, bool_t *pbValid) |
Gets whether the loopthrough interface in the USB device is valid. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetAudioVolume (HUSBCHANNEL hChannel, MWCAP_USB_AUDIO_NODE audioNode, MWCAP_AUDIO_VOLUME *pVolume) |
Gets the volume of USB audio device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetAudioVolume (HUSBCHANNEL hChannel, MWCAP_USB_AUDIO_NODE audioNode, MWCAP_AUDIO_VOLUME *pVolume) |
Sets the volume of USB audio device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetVideoOutputFOURCC (HUSBCHANNEL hChannel, MWCAP_VIDEO_OUTPUT_FOURCC *pOutputFourCC) |
Gets capture formats supported by the USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetVideoOutputFOURCC (HUSBCHANNEL hChannel, MWCAP_VIDEO_OUTPUT_FOURCC *pOutputFourCC) |
Sets capture formats supported by the USB device, 3 at most. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetVideoOutputFrameSize (HUSBCHANNEL hChannel, MWCAP_VIDEO_OUTPUT_FRAME_SIZE *pFrameSize) |
Gets resolutions of captured images supported by the USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetVideoOutputFrameSize (HUSBCHANNEL hChannel, MWCAP_VIDEO_OUTPUT_FRAME_SIZE *pFrameSize) |
Sets resolutions supported by the USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetVideoOutputFrameInterval (HUSBCHANNEL hChannel, MWCAP_VIDEO_OUTPUT_FRAME_INTERVAL *pFrameInterval) |
Gets capture intervals supported by USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetVideoOutputFrameInterval (HUSBCHANNEL hChannel, MWCAP_VIDEO_OUTPUT_FRAME_INTERVAL *pFrameInterval) |
Sets capture intervals supported by USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetStatusImageMode (HUSBCHANNEL hChannel, MWCAP_STATUS_IMAGE_MODE *pImageMode) |
Gets the image pattern showed when there is not a valid input signal. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetStatusImageMode (HUSBCHANNEL hChannel, MWCAP_STATUS_IMAGE_MODE *pImageMode) |
Sets the image pattern showed when there is not a valid input signal. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetDeviceNameMode (HUSBCHANNEL hChannel, MWCAP_DEVICE_NAME_MODE *pNameMode) |
Gets device name pattern of USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetDeviceNameMode (HUSBCHANNEL hChannel, MWCAP_DEVICE_NAME_MODE *pNameMode) |
Sets device name pattern of USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSaveOptions (HUSBCHANNEL hChannel) |
Saves configurations. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBLoadOptions (HUSBCHANNEL hChannel) |
Loads the saved configurations. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBResetOptions (HUSBCHANNEL hChannel) |
Restores to the default settings. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetExtensionSupported (HUSBCHANNEL hChannel, uint32_t *pdwFlag) |
Gets extended Hid interfaces supported by USB device. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetEDIDMode (HUSBCHANNEL hChannel, MWCAP_EDID_MODE *pMode) |
Gets current edid mode. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBSetEDIDMode (HUSBCHANNEL hChannel, MWCAP_EDID_MODE mode) |
Sets the edid mode. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetVideoCaptureSupportFrameRate (HCHANNEL hChannel, MWCAP_VIDEO_FRAMERATE *pFramerate, int *nCount) |
Gets frame rates supported by USB device based on v4l. More... | |
MW_RESULT LIBMWCAPTURE_API | MWUSBGetVideoCaptureSupportFrameRateEx (HCHANNEL hChannel, MWCAP_VIDEO_FRAMERATE_EX *pFramerate, int *nCount) |
Gets frame rates supported by USB device based on v4l. More... | |
MW_RESULT LIBMWCAPTURE_API MWUSBGetAudioVolume | ( | HUSBCHANNEL | hChannel, |
MWCAP_USB_AUDIO_NODE | audioNode, | ||
MWCAP_AUDIO_VOLUME * | pVolume | ||
) |
Gets the volume of USB audio device.
[in] | hChannel | Channel handle of USB device |
[in] | audioNode | Audio device |
[out] | pVolume | Volume of USB audio device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the volume of USB audio device.
MW_RESULT LIBMWCAPTURE_API MWUSBGetDeviceNameMode | ( | HUSBCHANNEL | hChannel, |
MWCAP_DEVICE_NAME_MODE * | pNameMode | ||
) |
Gets device name pattern of USB device.
[in] | hChannel | Channel handle of USB device |
[out] | pNameMode | Device name pattern |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetEDIDLoopThrough | ( | HUSBCHANNEL | hChannel, |
char * | pbyEDID, | ||
uint32_t * | pcbEDID | ||
) |
Gets EDID of the loopthrough interface in the USB device, only supported by devices with loopthrough interface.
[in] | hChannel | Channel handle of USB device |
[out] | pbyEDID | EDID |
[in,out] | pcbEDID | As an input parameter, it indicates the size of the area which is pointed by the pbyEDID. As an output parameter, it indicates the size of the returned EDID. |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets EDID of the loopthrough interface in the USB device, which is only supported by devices with loopthrough interface.
MW_RESULT LIBMWCAPTURE_API MWUSBGetEDIDMode | ( | HUSBCHANNEL | hChannel, |
MWCAP_EDID_MODE * | pMode | ||
) |
Gets current edid mode.
[in] | hChannel | Channel handle of USB device |
[out] | pMode | The edid mode of device |
MW_RESULT LIBMWCAPTURE_API MWUSBGetExtensionSupported | ( | HUSBCHANNEL | hChannel, |
uint32_t * | pdwFlag | ||
) |
Gets extended Hid interfaces supported by USB device.
[in] | hChannel | Channel handle of USB device |
[out] | pdwFlag | Flag of the extended supported Hid interfaces |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
The meaning of the pdwFlag refers to MWCAP_HID_EXTENSION_XX.
MW_RESULT LIBMWCAPTURE_API MWUSBGetFirmwareReadAddress | ( | HUSBCHANNEL | hChannel, |
uint32_t * | pdwAddress | ||
) |
Gets read address of USB device firmware.
[in] | hChannel | Channel handle of USB device |
[out] | pdwAddress | Read address of firmware |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetLoopThroughValid | ( | HUSBCHANNEL | hChannel, |
bool_t * | pbValid | ||
) |
Gets whether the loopthrough interface in the USB device is valid.
[in] | hChannel | Channel handle of USB device |
[out] | pbValid | Whether there is a valid loopthrough interface |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetNotifyStatus | ( | HUSBCHANNEL | hChannel, |
uint64_t * | pullStatusBit | ||
) |
Gets notification status of USB specified channel.
[in] | hChannel | Channel handle of USB device |
[out] | pullStatusBit | Notification mask |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets notification status of USB specified channel.
MW_RESULT LIBMWCAPTURE_API MWUSBGetStatusImageMode | ( | HUSBCHANNEL | hChannel, |
MWCAP_STATUS_IMAGE_MODE * | pImageMode | ||
) |
Gets the image pattern showed when there is not a valid input signal.
[in] | hChannel | Channel handle of USB device |
[out] | pImageMode | The image pattern showed when there is not a valid input signal |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Gets the image pattern showed when there is not a valid input signal.
MW_RESULT LIBMWCAPTURE_API MWUSBGetVideoCaptureSupportFrameRate | ( | HCHANNEL | hChannel, |
MWCAP_VIDEO_FRAMERATE * | pFramerate, | ||
int * | nCount | ||
) |
Gets frame rates supported by USB device based on v4l.
[in] | hChannel | Channel handle of USB device |
[out] | pFramerate | Frame rates supported by USB device. When it is set to NULL, only the number of supported frame rates is returned. |
[in,out] | nCount | As an input parameter, it indicates the pointer points to the size of pFramerate array. As an output parameter, it indicates the number of capture frame rates supported by USB device. |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetVideoCaptureSupportFrameRateEx | ( | HCHANNEL | hChannel, |
MWCAP_VIDEO_FRAMERATE_EX * | pFramerate, | ||
int * | nCount | ||
) |
Gets frame rates supported by USB device based on v4l.
[in] | hChannel | Channel handle of USB device |
[out] | pFramerate | Capture frame rates supported by USB device |
[in,out] | nCount | As an input parameter, it indicates the pointer points to the size of pFramerate array. As an output parameter, it indicates the number of capture frame rates supported by USB device. |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetVideoOutputFOURCC | ( | HUSBCHANNEL | hChannel, |
MWCAP_VIDEO_OUTPUT_FOURCC * | pOutputFourCC | ||
) |
Gets capture formats supported by the USB device.
[in] | hChannel | Channel handle of USB device |
[out] | pOutputFourCC | Supported capture formats |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetVideoOutputFrameInterval | ( | HUSBCHANNEL | hChannel, |
MWCAP_VIDEO_OUTPUT_FRAME_INTERVAL * | pFrameInterval | ||
) |
Gets capture intervals supported by USB device.
[in] | hChannel | Channel handle of USB device |
[out] | pFrameInterval | Capture intervals supported by USB device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBGetVideoOutputFrameSize | ( | HUSBCHANNEL | hChannel, |
MWCAP_VIDEO_OUTPUT_FRAME_SIZE * | pFrameSize | ||
) |
Gets resolutions of captured images supported by the USB device.
[in] | hChannel | Channel handle of USB device |
[out] | pFrameSize | Resolutions of captured images supported by the USB device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBLoadOptions | ( | HUSBCHANNEL | hChannel | ) |
Loads the saved configurations.
[in] | hChannel | Channel handle of USB device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBRegisterHotPlug | ( | LPFN_HOT_PLUG_CALLBACK | lpfnCallback, |
void * | pParam | ||
) |
Registers hotplug callback function of USB capture device.
[in] | lpfnCallback | Callback function |
[in] | pParam | Callback parameter |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Registers hotplug callback function of USB capture device to notify the plug states of USB capture devices.
MW_RESULT LIBMWCAPTURE_API MWUSBResetOptions | ( | HUSBCHANNEL | hChannel | ) |
Restores to the default settings.
[in] | hChannel | Channel handle of USB device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBSaveOptions | ( | HUSBCHANNEL | hChannel | ) |
Saves configurations.
[in] | hChannel | Channel handle of USB device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
The detailed usage refers to the following functions:
MWUSBSetVideoOutputFOURCC
MWUSBSetVideoOutputFrameSize
MWUSBSetVideoOutputFrameInterval
MWUSBSetStatusImageMode
MWUSBSetDeviceNameMode
MW_RESULT LIBMWCAPTURE_API MWUSBSetAudioVolume | ( | HUSBCHANNEL | hChannel, |
MWCAP_USB_AUDIO_NODE | audioNode, | ||
MWCAP_AUDIO_VOLUME * | pVolume | ||
) |
Sets the volume of USB audio device.
[in] | hChannel | Channel handle of USB device |
[in] | audioNode | Audio device |
[in] | pVolume | Audio device volume |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets the volume of USB audio device.
MW_RESULT LIBMWCAPTURE_API MWUSBSetDeviceNameMode | ( | HUSBCHANNEL | hChannel, |
MWCAP_DEVICE_NAME_MODE * | pNameMode | ||
) |
Sets device name pattern of USB device.
[in] | hChannel | Channel handle of USB device |
[in] | pNameMode | Device name pattern |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBSetEDIDMode | ( | HUSBCHANNEL | hChannel, |
MWCAP_EDID_MODE | mode | ||
) |
Sets the edid mode.
[in] | hChannel | Channel handle of USB device |
[out] | mode | The edid mode set to device |
MW_RESULT LIBMWCAPTURE_API MWUSBSetFirmwareErase | ( | HUSBCHANNEL | hChannel, |
uint32_t | cbOffset, | ||
uint32_t | cbErase | ||
) |
Erases firmware data from USB device.
[in] | hChannel | Channel handle of USB device |
[in] | cbOffset | Address offset |
[in] | cbErase | Erased size |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
MW_RESULT LIBMWCAPTURE_API MWUSBSetNotifyEnable | ( | HUSBCHANNEL | hChannel, |
MWCAP_NOTIFY_ENABLE * | pNotify | ||
) |
Sets notification types for specified channel.
[in] | hChannel | Channel handle of the USB device |
[in] | pNotify | Notification |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets notification types for the specified channel.
MW_RESULT LIBMWCAPTURE_API MWUSBSetStatusImageMode | ( | HUSBCHANNEL | hChannel, |
MWCAP_STATUS_IMAGE_MODE * | pImageMode | ||
) |
Sets the image pattern showed when there is not a valid input signal.
[in] | hChannel | Channel handle of USB device |
[in] | pImageMode | The image pattern showed when there is not a valid input signal |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets the image pattern showed when there is not a valid input signal.
MW_RESULT LIBMWCAPTURE_API MWUSBSetVideoOutputFOURCC | ( | HUSBCHANNEL | hChannel, |
MWCAP_VIDEO_OUTPUT_FOURCC * | pOutputFourCC | ||
) |
Sets capture formats supported by the USB device, 3 at most.
[in] | hChannel | Channel handle of USB device |
[in] | pOutputFourCC | Supported capture formats |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Sets capture formats supported by the USB device, which is 3 at most. The function must work with MWUSBSaveOptions, and plugs and reconnects the USB device after setting, then the function will work.
MW_RESULT LIBMWCAPTURE_API MWUSBSetVideoOutputFrameInterval | ( | HUSBCHANNEL | hChannel, |
MWCAP_VIDEO_OUTPUT_FRAME_INTERVAL * | pFrameInterval | ||
) |
Sets capture intervals supported by USB device.
[in] | hChannel | Channel handle of USB device |
[in] | pFrameInterval | Capture intervals |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBSetVideoOutputFrameSize | ( | HUSBCHANNEL | hChannel, |
MWCAP_VIDEO_OUTPUT_FRAME_SIZE * | pFrameSize | ||
) |
Sets resolutions supported by the USB device.
[in] | hChannel | Channel handle of USB device |
[in] | pFrameSize | Resolutions supported by the USB device |
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
MW_RESULT LIBMWCAPTURE_API MWUSBUnRegisterHotPlug | ( | ) |
Unregisters hotplug callback function.
MW_SUCCEEDED | Function call succeeded. |
MW_FAILED | Function call failed. |
MW_INVALID_PARAMS | Input invalid value(s). |
Usage:
Unregisters hotplug callback function of USB capture device.
Refers to MWUSBRegisterHotPlug