API List¶

Whether or not each API can be used is determined according to the SDK control mode. The Mode column indicates the availability of RemoteControlMode, ContentsTransferMode and RemoteTransferMode in “R”, “C” and “T”.

Be sure to check Enable Status for APIs that have Enable Status. Examples are DownloadSettingFile and CrDeviceProperty_CameraSetting_SaveOperationEnableStatus, RequestLensInformation and Lens Information Enable Status. Operation cannot be guaranteed if executed in the Disable state.

No.

APIs

Outline

Mode

ILX-LR1

ILCE-1M2

ILCE-1

ILCE-9M3

ILCE-9M2

ILCE-7RM6

ILCE-7RM5

ILCE-7RM4A

ILCE-7RM4

ILCE-7CR

ILCE-7SM3

ILCE-7M5

ILCE-7M4

ILCE-7CM2

ILCE-7C

ILCE-6700

MPC-2610

ILME-FX6

ILME-FX2

ILME-FX3A

ILME-FX3

ILME-FX30

PXW-Z300

PXW-Z200

HXR-NX800

BRC-AM7

ILME-FR7

ZV-E1

ZV-E10M2

DSC-RX1RM3

DSC-RX0M2

1

Init

Initialize the Camera Remote SDK for use.

R/C/T

✔

2

Release

Terminate the Camera Remote SDK.

R/C/T

✔

3

GetSDKVersion

Get SDK version number.

R/C/T

✔

4

GetSDKSerial

Get SDK serial number.

R/C/T

✔

5

EditSDKInfo

Edit the information about the SDK stored in the config file.

R/C/T

✔

6

EnumCameraObjects

Make a list of corresponding camera for the Camera Remote SDK.

R/C/T

✔

7

CreateCameraObjectInfo

Create an ICrCameraObjectInfo object represents a Camera.

R/C/T

✔

8

CreateCameraObjectInfoUSBConnection

Create an ICrCameraObjectInfo object that represents a camera to be connecting via USB.

R/C/T

✔

-

✔

-

✔

9

CreateCameraObjectInfoEthernetConnection

Create an ICrCameraObjectInfo object that represents a camera to be connecting via Ethernet.

R/C/T

✔

-

✔

-

✔

-

10

GetFingerprint

Get the fingerprint of the camera to connect with SSH authentication.

R/C/T

✔

-

✔

-

✔

-

✔

-

11

Connect

Connect to a Camera using a ICrCameraObjectInfo object before manipulation.

R/C/T

✔

12

Disconnect

Disconnect from the Camera after use.

R/C/T

✔

13

ReleaseDevice

Remove resources allocated with the Connect function.

R/C/T

✔

14

GetDeviceProperties

Read camera settings.

R/C/T

✔

15

ReleaseDeviceProperties

Release the CrDeviceProperty objects allocated by GetDeviceProperties.

R/C/T

✔

16

SetDeviceProperty

Set camera settings.

R/C/T

✔

17

SendCommand

Send control command.

R/C/T

✔

18

GetLiveViewImage

Read the latest live-view image data from the Camera into the memory of the current machine.

R/T

✔

19

GetLiveViewImageInfo

This function returns the size of the live-view image.

R/T

✔

20

GetLiveViewProperties

Get live view properties from the camera.

R/T

✔

21

ReleaseLiveViewProperties

Release the CrLiveViewProperty objects allocated by GetLiveViewProperties.

R/T

✔

22

GetDeviceSetting

This function returns the value of settings in the Camera Remote SDK.

R/C/T

✔

23

SetDeviceSetting

This function modifies the value of settings in the Camera Remote SDK.

R/C/T

✔

24

SetDeviceSetting (Setting_Key_PartialBuffer)

The input parameter “Setting_Key_PartialBuffer” is available.

R/C/T

✔

-

✔

-

✔

25

SetSaveInfo

This function modifies settings for saving pictures.

R/C/T

✔

26

GetSelectDeviceProperties

Specify and read the device property from the camera.

R/C/T

✔

27

GetSelectLiveViewProperties

Specify and read the live view property from the camera.

R/T

✔

28

GetDateFolderList

Get date folder.

C

✔

-

✔

-

✔

-

✔

-

✔

29

GetContentsHandleList

Get content handle array in the date folder.

C

✔

-

✔

-

✔

-

✔

-

✔

30

GetContentsDetailInfo

Get contents Information.

C

✔

-

✔

-

✔

-

✔

-

✔

31

ReleaseDateFolderList

Release the CrMtpFolderInfo objects allocated by GetDateFolderList.

C

✔

-

✔

-

✔

-

✔

-

✔

32

ReleaseContentsHandleList

Release the CrMtpContentsInfo object allocated by GetContentsHandleList.

C

✔

-

✔

-

✔

-

✔

-

✔

33

PullContentsFile (*1)

Get(download) contents file.

C

✔

-

✔

-

✔

-

✔

-

✔

34

GetContentsThumbnailImage

Read thumbnail image data into the memory of the current machine.

C

✔

-

✔

-

✔

-

✔

-

✔

35

DownloadSettingFile

Get(download) the camera settings file.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

36

UploadSettingFile

Update(upload) the camera settings file.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

37

RequestDisplayStringList

Request a list of display menu strings.

R/T

✔

-

✔

-

✔

-

✔

-

38

GetDisplayStringTypes

Get referenceable display menu string type.

R/T

✔

-

✔

-

✔

-

✔

-

39

GetDisplayStringList

Get the list of display menu strings.

R/T

✔

-

✔

-

✔

-

✔

-

40

ReleaseDisplayStringTypes

Release the CrDisplayStringType objects allocated by GetDisplayStringTypes.

R/T

✔

-

✔

-

✔

-

✔

-

41

ReleaseDisplayStringList

Release the CrDisplayStringListInfo objects allocated by GetDisplayStringList.

R/T

✔

-

✔

-

✔

-

✔

-

42

GetMediaProfile

Get the MediaProfile Lists.

R/T

-

✔

-

✔

-

43

ReleaseMediaProfile

Release the CrMediaProfileInfo objects allocated by GetMediaProfile.

R/T

-

✔

-

✔

-

44

RequestLensInformation

Request the acquisition of Lens information.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

45

GetLensInformation

Get the Lens information Lists.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

46

ReleaseLensInformation

Release the CrLensInformation objects allocated by GetLensInformation.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

47

ImportLUTFile

Import the LUT file.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

48

RequestFTPServerSettingList

Request the FTP Server setting lists.

R/T

✔

-

✔

-

✔

-

✔

-

49

GetFTPServerSettingList

Get the FTP Server setting lists.

R/T

✔

-

✔

-

✔

-

✔

-

50

ReleaseFTPServerSettingList

Release the CrFTPServerSetting objects allocated by GetFTPServerSettingList.

R/T

✔

-

✔

-

✔

-

✔

-

51

SetFTPServerSetting

Update FTP Server setting.

R/T

✔

-

✔

-

✔

-

✔

-

52

RequestFTPJobList

Request the FTP Job lists.

R/T

-

✔

-

✔

-

53

GetFTPJobList

Get the FTP Job lists.

R/T

-

✔

-

✔

-

54

ReleaseFTPJobList

Release the CrFTPJobInfo objects allocated by GetFTPJobList.

R/T

-

✔

-

✔

-

55

ControlFTPJobList

Add, delete, suspend, and resume FTP Jobs.

R/T

-

✔

-

✔

-

56

GetCRSDKOperationResultsSupported

Get a list of “API” and “Function” that will notify you of the results.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

57

ReleaseCRSDKOperationResultsSupported

Release the CrOperationResultSupportedInfo objects allocated by GetCRSDKOperationResultsSupported.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

58

SetMonitoringDeliverySetting

Set the Monitoring delivery setting.

R/T

-

✔

-

✔

-

✔

-

✔

-

59

GetMonitoringDeliverySetting

Get the Monitoring delivery setting.

R/T

-

✔

-

✔

-

✔

-

✔

-

60

ReleaseMonitoringDeliverySetting

Release the CrMonitoringDeliverySetting objects allocated by GetMonitoringDeliverySetting.

R/T

-

✔

-

✔

-

✔

-

✔

-

61

ControlMonitoring

Control Monitoring.

R/T

-

✔

-

✔

-

✔

-

✔

-

62

RequestZoomAndFocusPreset

Request the Zoom&Focus Preset information lists.

R/T

-

✔

-

✔

-

✔

-

✔

-

✔

-

63

GetZoomAndFocusPreset

Get the Zoom&Focus Preset information lists.

R/T

-

✔

-

✔

-

✔

-

✔

-

✔

-

64

ReleaseZoomAndFocusPreset

Release the CrZoomAndFocusPresetInfo objects allocated by GetZoomAndFocusPreset.

R/T

-

✔

-

✔

-

✔

-

✔

-

✔

-

65

RequestFTPTransferResult

Request the FTP Transfer Result information.

R/T

✔

-

✔

-

✔

-

✔

-

66

GetOSDImage

Get the OSD image data.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

67

GetRemoteTransferCapturedDateList

Get the list of captured date.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

68

GetRemoteTransferContentsInfoList

Get the list of contents info.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

69

GetRemoteTransferContentsData

Get the contents data buffer.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

70

GetRemoteTransferContentsDataFile (*1)

Get the contents data file.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

71

ControlGetRemoteTransferContentsDataFile

Control get contents data file function.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

72

GetRemoteTransferContentsCompressedData

Get contents compressed data buffer.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

73

GetRemoteTransferContentsCompressedDataFile

Get contents compressed data file.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

74

ReleaseRemoteTransferCapturedDateList

Release the list of captured date.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

75

ReleaseRemoteTransferContentsInfoList

Release the list of contents info.

T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

76

SetMoviePlaybackSetting

Set the movie playback setting.

T

-

✔

-

✔

-

✔

-

✔

-

✔

-

77

GetMoviePlaybackSetting

Get the movie playback setting.

T

-

✔

-

✔

-

✔

-

✔

-

✔

-

78

ReleaseMoviePlaybackSetting

Release the movie playback setting object allocated by GetMoviePlaybackSetting.

T

-

✔

-

✔

-

✔

-

✔

-

✔

-

79

ControlMoviePlayback

Control movie playback operation.

T

-

✔

-

✔

-

✔

-

✔

-

✔

-

80

RequestMoviePlaybackStatus

Request the movie playback status.

T

-

✔

-

✔

-

✔

-

✔

-

✔

-

81

GetMoviePlaybackStatus

Get the movie playback status.

T

-

✔

-

✔

-

✔

-

✔

-

✔

-

82

PrecheckFirmwareUpdate

Precheck remote firmware update.

R/T

✔

-

✔

-

✔

-

✔

-

83

UploadPartialFile

Upload file by partial.

R/T

✔

-

✔

-

✔

-

✔

-

84

CancelFirmwareUpload

Cancel upload firmware file.

R/T

✔

-

✔

-

✔

-

✔

-

85

RequestFirmwareUpdaterInfo

Request firmware updater info.

R/T

✔

-

✔

-

✔

-

✔

-

86

StartFirmwareUpdate

Start firmware update.

R/T

✔

-

✔

-

✔

-

✔

-

87

ControlPTZF

Control the Pan/Tilt.

R/T

-

✔

-

88

PresetPTZFClear

Clear the Preset PTZF.

R/T

-

✔

-

89

PresetPTZFSet

Set the Preset PTZF.

R/T

-

✔

-

90

SetTimeZoneSetting

Set the TImeZone Settings.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

91

RequestTimeZoneSetting

Request the TimeZone Settings in camera.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

92

GetTimeZoneSetting

Get the TImeZone Settings in camera.

R/T

✔

-

✔

-

✔

-

✔

-

✔

-

✔

-

93

DeleteRemoteTransferContentsFile

Delete Contents in camera.

T

✔

-

✔

-

✔

-

✔

-

94

UploadSceneFile

Upload the Scene file.

R/T

-

✔

-

✔

-

95

DownloadSceneFile

Download the Scene file.

R/T

-

✔

-

✔

-

96

ExecuteEframing

Execute the Eframing by Absolute position.

R/T

-

✔

-

97

UpdateEframingArea

Execute the Eframing by Relative position and size.

R/T

-

✔

-

98

RequestStreamSettingList

Request the Stream setting lists.

R/T

-

✔

-

99

GetStreamSettingList

Get the Stream setting lists.

R/T

-

✔

-

100

ReleaseStreamSettingList

Release the CrVideoStreamSetting objects allocated by GetStreamSettingList.

R/T

-

✔

-

101

SetStreamSettingList

Update Stream setting lists.

R/T

-

✔

-

102

UploadCustomGridLineFile

Upload CustomGridLineFile

R/T

-

✔

-

✔

-

✔

-

✔

-

103

ControlGeneralSettingFile

Control general setting file.

R/T

-

✔

-

✔

-

104

RequestControlGeneralSettingResultFile

Request the result file of ControlGeneralSettingFile.

R/T

-

✔

-

✔

-

105

GetControlGeneralSettingResultFile

Get the result file of ControlGeneralSettingFile.

R/T

-

✔

-

✔

-

106

RequestOperation

Execute specified operation. For operation compatibility status, see the Operation Code List.

R/T

✔

107

ReleaseOperationResultObject

Release the object that result of RequestOperation.

R/T

✔

108

GetSelectControlCode

Specify and read the control code from the camera.

R/C/T

✔

109

GetSupportedControlCodes

Read supported control codes.

R/C/T

✔

110

ReleaseControlCodes

Release the CrControlCodeInfo objects allocated by GetSupportedControlCodes/GetSelectControlCode.

R/C/T

✔

111

ExecuteControlCodeValue

Execute specified control code that type of numeric. For Control Code compatibility status, see the Control Code List.

R/C/T

✔

112

ExecuteControlCodeString

Execute specified control code that type of string. For Control Code compatibility status, see the Control Code List.

R/C/T

✔

113

PullPostViewImage

Get PostView image data from RAM in the SDK.

R/T

✔

-

✔

-

✔

114

GetCommandQueueCount

Get command queue count in the SDK.

R/C/T

✔

*1 : Large files may not be handled depending on the OS.

Note : The content transfer function cannot guarantee the transfer of content taken by other cameras.